fun_with_json_api 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03a0a51461ca7c0beb30adde5911c84914aac1df
-  data.tar.gz: 83b30747b3e9f9422b9a72271fed0f864b84a015
+  metadata.gz: c629eb0a61551c035ffa28b439da889e9c6ba194
+  data.tar.gz: bc2f98c742c8f96ffd17c25ea75654652ddc9438
 SHA512:
-  metadata.gz: 223b4f2c50b9f936df1dffbd68913620d14cb2d50e51fd79e6e566e82ffe4ee9a1986fff20615ce762061a750567b9633cc1d5d97e443d179d1d16cdade6b8e1
-  data.tar.gz: 34230a10368a1c03eb405dd70d1d46e49ae8486ea7f2b3302beef8e7cee8d723804280ca4835a4a7ca409d2bcf15ed8a3cd95a031b3405857b6621735d75d225
+  metadata.gz: ae0935dde41f79bc080fe865456aeff52398a60553f78ffa71ae99be675b05f54742ff768ec4af40bdf47802d71fb9b1d7fb86a4f14eb5b5d82c9ab779ed761a
+  data.tar.gz: 3c98aa5070682c2ebb33bf836dd8d141729dcf8cfdb8ddc6bdd478c26019414aeba5b8b6088d1a20fd67e31c01db6ed12d6bc4a6fde1bfa5f2de304434e05a82

data/config/locales/fun_with_json_api.en.yml

@@ -7,6 +7,7 @@ en:
       illegal_client_generated_identifier: 'Request json_api attempted to set an unsupported client-generated id'
       invalid_document_type: 'Request json_api data type does not match endpoint'
       missing_resource: 'Unable to find the requested resource'
+      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'
@@ -22,6 +23,7 @@ en:
       invalid_integer_attribute: "Integer value must be a integer number (i.e. 123)"
       invalid_string_attribute: 'String value must be a JSON String (i.e. "Example")'
       invalid_uuid_v4_attribute: 'UUID value must be RFC 4122 Version 4 UUID (i.e. "f47ac10b-58cc-4372-a567-0e02b2c3d479")'
+      collection_method_not_supported: 'The current relationship does not support this action'
     schema_validators:
       document_id_does_not_match_resource: "Expected data id to match resource at endpoint: %{expected}"
       document_type_does_not_match_endpoint: "Expected data type to be a '%{expected}' resource"
@@ -41,3 +43,8 @@ en:
       invalid_document_type: "Expected '%{type}' to be a '%{resource}' resource"
       missing_resource: "Unable to find '%{resource}' with matching id: '%{resource_id}'"
       unauthorized_resource: "Unable to assign the requested '%{resource}' (%{resource_id}) to the current resource"
+    collection_manager:
+      invalid_resource: "Unable to update the relationship with this '%{resource}'"
+      insert_not_supported: "Unable to insert '%{resource}' items from this endpoint"
+      remove_not_supported: "Unable to remove '%{resource}' items from this endpoint"
+      replace_all_not_supported: "Unable to replace all '%{resource}' items from this endpoint"

data/lib/fun_with_json_api/collection_manager.rb

@@ -0,0 +1,116 @@
+require 'fun_with_json_api/exception'
+
+module FunWithJsonApi
+  # Abstract Handles updating a collection relationship.
+  # Override the `insert`, `remove` and `replace` methods, and make use of `parent_resource`
+  # `load_collection` and `report_invalid_resources_at_index!` to load and update a relationship
+  # collection.
+  class CollectionManager
+    attr_reader :parent_resource
+    attr_reader :deserializer_class
+    attr_reader :deserializer_options
+
+    def initialize(parent_resource, deserializer_class, deserializer_options)
+      @parent_resource = parent_resource
+      @deserializer_class = deserializer_class
+      @deserializer_options = deserializer_options
+    end
+
+    # Loads a collection from the document
+    # Use this method when implementinog a CollectionManager
+    def load_collection(document)
+      FunWithJsonApi.find_collection(document, deserializer_class, deserializer_options)
+    end
+
+    def insert_records(_document)
+      # Action is not supported unless overridden
+      raise build_relationship_not_supported_exception(
+        "Override #{self.class.name}#insert_records to implement insert",
+        insert_not_supported_message
+      )
+    end
+
+    def remove_records(_document)
+      # Action is not supported unless overridden
+      raise build_relationship_not_supported_exception(
+        "Override #{self.class.name}#remove_records to implement remove",
+        remove_not_supported_message
+      )
+    end
+
+    def replace_all_records(_document)
+      # Action is not supported unless overridden
+      raise build_relationship_not_supported_exception(
+        "Override #{self.class.name}#replace_all_records to implement replace all",
+        replace_all_not_supported_message
+      )
+    end
+
+    def report_invalid_resources_at_index!(resource_indexes, reason_message_or_callable = nil)
+      raise build_invalid_resource_exception(resource_indexes, reason_message_or_callable)
+    end
+
+    protected
+
+    def insert_not_supported_message
+      I18n.t(
+        'insert_not_supported',
+        resource: deserializer_class.type,
+        scope: 'fun_with_json_api.collection_manager'
+      )
+    end
+
+    def remove_not_supported_message
+      I18n.t(
+        'remove_not_supported',
+        resource: deserializer_class.type,
+        scope: 'fun_with_json_api.collection_manager'
+      )
+    end
+
+    def replace_all_not_supported_message
+      I18n.t(
+        'replace_all_not_supported',
+        resource: deserializer_class.type,
+        scope: 'fun_with_json_api.collection_manager'
+      )
+    end
+
+    def default_invalid_resource_message
+      I18n.t(
+        'invalid_resource',
+        resource: deserializer_class.type,
+        scope: 'fun_with_json_api.collection_manager'
+      )
+    end
+
+    private
+
+    def build_relationship_not_supported_exception(debug_message, exception_message)
+      Exceptions::RelationshipMethodNotSupported.new(
+        debug_message, ExceptionPayload.new(detail: exception_message)
+      )
+    end
+
+    def build_invalid_resource_exception(resource_index_or_indexes, reason_message_or_callable)
+      resource_indexes = Array.wrap(resource_index_or_indexes)
+      Exceptions::InvalidResource.new(
+        'Unable to update relationship due to errors with collection',
+        build_invalid_resource_exception_payload(resource_indexes, reason_message_or_callable)
+      )
+    end
+
+    def build_invalid_resource_exception_payload(resource_indexes, reason_message_or_callable)
+      resource_indexes.map do |index|
+        reason_message = reason_message_or_callable
+        reason_message = reason_message.call(index) if reason_message.respond_to?(:call)
+        reason_message ||= default_invalid_resource_message
+
+        ExceptionPayload.new(
+          pointer: "/data/#{index}/id",
+          detail: reason_message
+        )
+      end
+    end
+  end
+end

data/lib/fun_with_json_api/exceptions/invalid_resource.rb

@@ -0,0 +1,15 @@
+module FunWithJsonApi
+  module Exceptions
+    # Indicates a Resource was unable to be used with performing an update
+    class InvalidResource < FunWithJsonApi::Exception
+      def initialize(message, payload = ExceptionPayload.new)
+        payload = Array.wrap(payload).each do |invalid|
+          invalid.code ||= 'invalid_resource'
+          invalid.title ||= I18n.t('invalid_resource', scope: 'fun_with_json_api.exceptions')
+          invalid.status ||= '422'
+        end
+        super
+      end
+    end
+  end
+end

data/lib/fun_with_json_api/exceptions/relationship_method_not_supported.rb

@@ -0,0 +1,16 @@
+module FunWithJsonApi
+  module Exceptions
+    class RelationshipMethodNotSupported < FunWithJsonApi::Exception
+      EXCEPTION_CODE = 'collection_method_not_supported'.freeze
+
+      def initialize(message, payload = ExceptionPayload.new)
+        payload = Array.wrap(payload).each do |unsupported|
+          unsupported.code ||= EXCEPTION_CODE
+          unsupported.title ||= I18n.t(EXCEPTION_CODE, scope: 'fun_with_json_api.exceptions')
+          unsupported.status ||= '403'
+        end
+        super
+      end
+    end
+  end
+end

data/lib/fun_with_json_api/version.rb

@@ -1,3 +1,3 @@
 module FunWithJsonApi
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/lib/fun_with_json_api.rb

@@ -6,6 +6,7 @@ require 'fun_with_json_api/deserializer'
 require 'fun_with_json_api/schema_validator'
 require 'fun_with_json_api/find_collection_from_document'
 require 'fun_with_json_api/find_resource_from_document'
+require 'fun_with_json_api/collection_manager'
 
 # Makes working with JSON:API fun!
 module FunWithJsonApi