fun_with_json_api 0.0.8.2 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d71babdb90d947dbd0f2bd870df7f3533d02f53d
-  data.tar.gz: bc0ac2fced2bcf61227c181f7014e88bbae8ef90
+  metadata.gz: 24f1af89657a79d42e1aec3122486e3196635738
+  data.tar.gz: 8631e1b1c88dc60f130a3abfbe4c68c0fc067287
 SHA512:
-  metadata.gz: 00eeedfbd311bf68aea7b4436fe25c9076bc4f32e4c6cda9df06dec54a33356fe875ea488f20f811a2417f024a86d485c3c920bc89e82aed2d8bfa80a3b62df4
-  data.tar.gz: bedef994edb9b4c3cf170f1339b38d1a842d09eeb8697bb9e45f5fdc573e0feee419dfb417efcd4808477974747d54125d1fa8931613ada08c7aab74ea9ce446
+  metadata.gz: 935eddfa83c835df7c086db35e11a22b8df4a3fc765d482b84508cd5007eddc35231b3f9c319f79b7874bf8054ff79663c153641da02b6f9ef651be5e3d510eb
+  data.tar.gz: 78aa8524d664300cdc9d2baceb3e817235964afb46c7021824806ff2f97055fddd431e3168549300fb4ae8f3a806dde0494594bae242a083da44f20587a48446

data/config/locales/fun_with_json_api.en.yml

@@ -10,10 +10,10 @@ en:
       invalid_resource: 'Unable to update the relationship with this resource'
       unauthorized_resource: 'Unable to access the requested resource'
       invalid_attribute: 'Request json_api attribute data is invalid'
-      unknown_attribute: 'Request json_api attribute is unsupported by the current endpoint'
+      unknown_attribute: 'Request json_api attribute is not recognised by the current endpoint'
       invalid_relationship: 'Request json_api relationship data is invalid'
       missing_relationship: 'Unable to find the requested relationship'
-      unknown_relationship: 'Request json_api relationship is unsupported by the current endpoint'
+      unknown_relationship: 'Request json_api relationship is not recognised by the current endpoint'
       invalid_relationship_type: 'Request json_api relationship type does not match expected resource'
       invalid_boolean_attribute: "Boolean value should only be true, false, or null"
       invalid_date_attribute: "Date value should be in the format YYYY-MM-DD"
@@ -31,8 +31,10 @@ en:
       invalid_relationship_type_in_hash: "Expected '%{relationship}' relationship to be null or a '%{relationship_type}' resource identifier Hash"
       resource_id_can_not_be_client_generated: "The current endpoint does not allow you to set an id for a new '%{resource}' resource"
       resource_id_has_already_been_assigned: "The provided id for a new '%{resource}' resource has already been used by another resource: %{id}"
-      unknown_attribute_for_resource: "The provided attribute '%{attribute}' can not be assigned to a '%{resource}' resource from the current endpoint"
-      unknown_relationship_for_resource: "The provided relationship '%{relationship}' can not be assigned to a '%{resource}' resource from the current endpoint"
+      unknown_attribute_for_resource: "The provided attribute '%{attribute}' can not be assigned to a '%{resource}' resource"
+      forbidden_attribute_for_request: "The provided attribute '%{attribute}' can not be assigned to a '%{resource}' resource from the current endpoint"
+      unknown_relationship_for_resource: "The provided relationship '%{relationship}' can not be directly assigned to a '%{resource}' resource"
+      forbidden_relationship_for_request: "The provided relationship '%{relationship}' can not be assigned to a '%{resource}' resource from the current endpoint"
     find_resource_from_document:
       invalid_document: "Expected data to be a Hash or null"
       invalid_document_type: "Expected data type to be a '%{resource}' resource"

data/lib/fun_with_json_api/exceptions/unknown_attribute.rb

@@ -6,7 +6,7 @@ module FunWithJsonApi
         payload = Array.wrap(payload).each do |unknown|
           unknown.code ||= 'unknown_attribute'
           unknown.title ||= I18n.t(:unknown_attribute, scope: 'fun_with_json_api.exceptions')
-          unknown.status ||= '422'
+          unknown.status ||= '400'
         end
         super
       end

data/lib/fun_with_json_api/exceptions/unknown_relationship.rb

@@ -6,7 +6,7 @@ module FunWithJsonApi
         payload = Array.wrap(payload).each do |unknown|
           unknown.code ||= 'unknown_relationship'
           unknown.title ||= I18n.t(:unknown_relationship, scope: 'fun_with_json_api.exceptions')
-          unknown.status ||= '422'
+          unknown.status ||= '400'
         end
         super
       end

data/lib/fun_with_json_api/schema_validators/check_attributes.rb

@@ -26,19 +26,39 @@ module FunWithJsonApi
         @resource_attributes ||= deserializer.attributes.map(&:name).map(&:to_s)
       end
 
+      def known_attributes
+        @known_attributes ||= deserializer.class.attribute_names.map(&:to_s)
+      end
+
       private
 
       def build_unknown_attribute_error(unknown_attributes)
         payload = unknown_attributes.map do |attribute|
-          ExceptionPayload.new(
-            detail: unknown_attribute_error(attribute),
-            pointer: "/data/attributes/#{attribute}"
-          )
+          if known_attributes.include?(attribute)
+            build_forbidden_attribute_payload(attribute)
+          else
+            build_unknown_attribute_payload(attribute)
+          end
         end
         message = 'Unknown attributes were provided by endpoint'
         FunWithJsonApi::Exceptions::UnknownAttribute.new(message, payload)
       end
 
+      def build_unknown_attribute_payload(attribute)
+        ExceptionPayload.new(
+          detail: unknown_attribute_error(attribute),
+          pointer: "/data/attributes/#{attribute}"
+        )
+      end
+
+      def build_forbidden_attribute_payload(attribute)
+        ExceptionPayload.new(
+          detail: forbidden_attribute_error(attribute),
+          pointer: "/data/attributes/#{attribute}",
+          status: '403'
+        )
+      end
+
       def unknown_attribute_error(attribute)
         I18n.t(
           :unknown_attribute_for_resource,
@@ -47,6 +67,15 @@ module FunWithJsonApi
           scope: 'fun_with_json_api.schema_validators'
         )
       end
+
+      def forbidden_attribute_error(attribute)
+        I18n.t(
+          :forbidden_attribute_for_request,
+          attribute: attribute,
+          resource: deserializer.type,
+          scope: 'fun_with_json_api.schema_validators'
+        )
+      end
     end
   end
 end

data/lib/fun_with_json_api/schema_validators/check_relationship_names.rb

@@ -0,0 +1,86 @@
+module FunWithJsonApi
+  module SchemaValidators
+    # Ensures all provided relationship names are known
+    class CheckRelationshipNames
+      def self.call(*args)
+        new(*args).call
+      end
+
+      attr_reader :document
+      attr_reader :deserializer
+      attr_reader :relationship_keys
+
+      def initialize(document, deserializer, relationship_keys)
+        @document = document
+        @deserializer = deserializer
+        @relationship_keys = relationship_keys
+      end
+
+      def call
+        unknown = relationship_keys.reject { |rel| resource_relationships.include?(rel) }
+        return if unknown.empty?
+
+        raise build_unknown_relationship_error(unknown)
+      end
+
+      protected
+
+      def build_unknown_relationship_error(unknown_relationships)
+        payload = unknown_relationships.map do |relationship|
+          if known_relationships.include?(relationship)
+            build_forbidden_relationship_payload(relationship)
+          else
+            build_unknown_relationship_payload(relationship)
+          end
+        end
+        message = 'Unknown relationships were provided by endpoint'
+        FunWithJsonApi::Exceptions::UnknownRelationship.new(message, payload)
+      end
+
+      def resource_relationships
+        @resource_relationships ||= deserializer.relationships.map(&:name).map(&:to_s)
+      end
+
+      def known_relationships
+        @known_relationships ||= deserializer.class.relationship_names.map(&:to_s)
+      end
+
+      private
+
+      # Relationship is known, but not supported by this request
+      def build_forbidden_relationship_payload(relationship)
+        ExceptionPayload.new(
+          detail: forbidden_relationship_error(relationship),
+          pointer: "/data/relationships/#{relationship}",
+          status: '403'
+        )
+      end
+
+      # Relationship is completely unknown, can cannot be assigned to this resource type (ever!)
+      def build_unknown_relationship_payload(relationship)
+        ExceptionPayload.new(
+          detail: unknown_relationship_error(relationship),
+          pointer: "/data/relationships/#{relationship}"
+        )
+      end
+
+      def unknown_relationship_error(relationship)
+        I18n.t(
+          :unknown_relationship_for_resource,
+          relationship: relationship,
+          resource: deserializer.type,
+          scope: 'fun_with_json_api.schema_validators'
+        )
+      end
+
+      def forbidden_relationship_error(relationship)
+        I18n.t(
+          :forbidden_relationship_for_request,
+          relationship: relationship,
+          resource: deserializer.type,
+          scope: 'fun_with_json_api.schema_validators'
+        )
+      end
+    end
+  end
+end

data/lib/fun_with_json_api/schema_validators/check_relationships.rb

@@ -1,3 +1,5 @@
+require 'fun_with_json_api/schema_validators/check_relationship_names'
+
 module FunWithJsonApi
   module SchemaValidators
     class CheckRelationships
@@ -16,19 +18,13 @@ module FunWithJsonApi
       def call
         relationships = document['data'].fetch('relationships', {})
 
-        check_for_unknown_relationships! relationships.keys
+        CheckRelationshipNames.call(document, deserializer, relationships.keys)
+
         check_for_invalid_relationship_type! relationships
 
         true
       end
 
-      def check_for_unknown_relationships!(relationship_keys)
-        unknown = relationship_keys.reject { |rel| resource_relationships.include?(rel) }
-        return if unknown.empty?
-
-        raise build_unknown_relationship_error(unknown)
-      end
-
       def check_for_invalid_relationship_type!(relationships_hash)
         payload = build_invalid_relationship_type_payload(relationships_hash)
         return if payload.empty?
@@ -54,10 +50,6 @@ module FunWithJsonApi
         build_invalid_relationship_item_payload(relationship)
       end
 
-      def resource_relationships
-        @resource_relationships ||= deserializer.relationships.map(&:name).map(&:to_s)
-      end
-
       private
 
       def invalid_relationship_type_in_array_message(relationship)
@@ -102,26 +94,6 @@ module FunWithJsonApi
           pointer: "/data/relationships/#{relationship.name}/data/type"
         )
       end
-
-      def build_unknown_relationship_error(unknown_relationships)
-        payload = unknown_relationships.map do |relationship|
-          ExceptionPayload.new(
-            detail: unknown_relationship_error(relationship),
-            pointer: "/data/relationships/#{relationship}"
-          )
-        end
-        message = 'Unknown relationships were provided by endpoint'
-        FunWithJsonApi::Exceptions::UnknownRelationship.new(message, payload)
-      end
-
-      def unknown_relationship_error(relationship)
-        I18n.t(
-          :unknown_relationship_for_resource,
-          relationship: relationship,
-          resource: deserializer.type,
-          scope: 'fun_with_json_api.schema_validators'
-        )
-      end
     end
   end
 end

data/lib/fun_with_json_api/version.rb

@@ -1,3 +1,3 @@
 module FunWithJsonApi
-  VERSION = '0.0.8.2'.freeze
+  VERSION = '0.0.9'.freeze
 end