Merge pull request #315 from pmukerji/error-source-instead-of-path

Use source for errors instead of path

Author: lgebhardt

lib/jsonapi/error.rb

@@ -1,6 +1,6 @@
 module JSONAPI
   class Error
-    attr_accessor :title, :detail, :id, :href, :code, :path, :links, :status
+    attr_accessor :title, :detail, :id, :href, :code, :source, :links, :status
 
     def initialize(options = {})
       @title          = options[:title]
@@ -12,7 +12,7 @@ def initialize(options = {})
                         else
                           options[:code]
                         end
-      @path           = options[:path]
+      @source         = options[:source]
       @links          = options[:links]
       @status         = options[:status]
     end

lib/jsonapi/exceptions.rb

@@ -294,9 +294,11 @@ def errors
     end
 
     class ValidationErrors < Error
-      attr_accessor :messages
-      def initialize(messages)
-        @messages = messages
+      attr_reader :error_messages, :resource_associations
+
+      def initialize(resource)
+        @error_messages = resource.model.errors.messages
+        @resource_associations = resource.class._associations.keys
         @key_formatter = JSONAPI.configuration.key_formatter
       end
 
@@ -305,16 +307,26 @@ def format_key(key)
       end
 
       def errors
-        messages.inject([]) do |arr, element|
-          arr.concat(
-            element[1].map do |message|
-              JSONAPI::Error.new(code: JSONAPI::VALIDATION_ERROR,
-                                 status: :unprocessable_entity,
-                                 title: "#{format_key(element[0])} - #{message}",
-                                 detail: message,
-                                 path: "/#{element[0]}")
-            end
-          )
+        error_messages.flat_map do |attr_key, messages|
+          messages.map { |message| json_api_error(attr_key, message) }
+        end
+      end
+
+      private
+
+      def json_api_error(attr_key, message)
+        JSONAPI::Error.new(code: JSONAPI::VALIDATION_ERROR,
+                           status: :unprocessable_entity,
+                           title: "#{format_key(attr_key)} - #{message}",
+                           detail: message,
+                           source: { pointer: pointer(attr_key) })
+      end
+
+      def pointer(attr_or_association_name)
+        if resource_associations.include?(attr_or_association_name)
+          "/data/relationships/#{attr_or_association_name}"
+        else
+          "/data/attributes/#{attr_or_association_name}"
         end
       end
     end
@@ -358,7 +370,7 @@ class InvalidPageValue < Error
       def initialize(page, value, msg = nil)
         @page = page
         @value = value
-        @msg = msg.nil? ? "#{value} is not a valid value for #{page} page parameter." : msg
+        @msg = msg || "#{value} is not a valid value for #{page} page parameter."
       end
 
       def errors

lib/jsonapi/resource.rb

@@ -138,7 +138,7 @@ def save
     # ```
     def _save
       unless @model.valid?
-        fail JSONAPI::Exceptions::ValidationErrors.new(@model.errors.messages)
+        fail JSONAPI::Exceptions::ValidationErrors.new(self)
       end
 
       if defined? @model.save

test/controllers/controller_test.rb

@@ -391,11 +391,11 @@ def test_create_with_invalid_data
 
     assert_response :unprocessable_entity
 
-    assert_equal "/author", json_response['errors'][0]['path']
+    assert_equal "/data/relationships/author", json_response['errors'][0]['source']['pointer']
     assert_equal "can't be blank", json_response['errors'][0]['detail']
     assert_equal "author - can't be blank", json_response['errors'][0]['title']
 
-    assert_equal "/title", json_response['errors'][1]['path']
+    assert_equal "/data/attributes/title", json_response['errors'][1]['source']['pointer']
     assert_equal "is too long (maximum is 35 characters)", json_response['errors'][1]['detail']
     assert_equal "title - is too long (maximum is 35 characters)", json_response['errors'][1]['title']
   end