fun_with_json_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb6fa5d08ff453c7adef23b0c5a608e98897228
-  data.tar.gz: 1cb7de4f0f03fc553af3da253fea06bf33704cbe
+  metadata.gz: f55b1fe9410ae79f919c01c47eb0ddeb9f36cdbe
+  data.tar.gz: e2de7e873ddcf3d90ed1393945cda375d259d130
 SHA512:
-  metadata.gz: be8824b7d81fc131fe50591cb9ff83495407d17f053845279add97a6eeccd8a473dba036df315f45db3b7097d84c9105fc6d1228308d195edc488dbfde054a9f
-  data.tar.gz: 2d5c7af796c4224c4868a66bf876d447337304ac9616da5a254f0253e4563dd003700774187f2075ef76e6d28b12551974c00c20fb203d559fa15a23929506fd
+  metadata.gz: bc7c26e745a58aee978e9d304af430128da69eab851b40b34180cec29ec958403ed2ab557ed091957db607bff2a8ea24ae286a9b8b135f19deaea468dbad0c86
+  data.tar.gz: 32f760eccedf1bea8c8d51ea1d74603273289da4953cefa76c2be8c0b0303b698fb4b2a9a8bb4124f51b7282deff0eebebfa2a1ed092e7e6f41391d659abd107

data/lib/fun_with_json_api/find_collection_from_document.rb

@@ -6,12 +6,12 @@ module FunWithJsonApi
 
     private_class_method :new
 
-    attr_reader :api_document
+    attr_reader :document
     attr_reader :deserializer
     delegate :id_param, :id_param, :resource_class, to: :deserializer
 
-    def initialize(api_document, deserializer)
-      @api_document = api_document.deep_stringify_keys
+    def initialize(document, deserializer)
+      @document = FunWithJsonApi.sanitize_document(document)
       @deserializer = deserializer
     end
 
@@ -31,11 +31,11 @@ module FunWithJsonApi
     end
 
     def document_ids
-      @document_id ||= api_document['data'].map { |item| item['id'] }
+      @document_id ||= document['data'].map { |item| item['id'] }
     end
 
     def document_types
-      @document_type ||= api_document['data'].map { |item| item['type'] }.uniq
+      @document_type ||= document['data'].map { |item| item['type'] }.uniq
     end
 
     def resource_type
@@ -43,7 +43,7 @@ module FunWithJsonApi
     end
 
     def document_is_valid_collection?
-      api_document.key?('data') && api_document['data'].is_a?(Array)
+      document.key?('data') && document['data'].is_a?(Array)
     end
 
     private
@@ -65,7 +65,7 @@ module FunWithJsonApi
       payload.pointer = '/data'
       payload.detail = 'Expected data to be an Array of resources'
       Exceptions::InvalidDocument.new(
-        "Expected root data element with an Array: #{api_document.inspect}",
+        "Expected root data element with an Array: #{document.inspect}",
         payload
       )
     end
@@ -73,7 +73,7 @@ module FunWithJsonApi
     def build_invalid_document_types_error
       message = 'Expected type for each item to match expected resource type'\
                 ": '#{resource_type}'"
-      payload = api_document['data'].each_with_index.map do |data, index|
+      payload = document['data'].each_with_index.map do |data, index|
         next if data['type'] == resource_type
         ExceptionPayload.new(
           pointer: "/data/#{index}/type",

data/lib/fun_with_json_api/find_resource_from_document.rb

@@ -6,11 +6,11 @@ module FunWithJsonApi
 
     private_class_method :new
 
-    attr_reader :api_document
+    attr_reader :document
     attr_reader :deserializer
 
-    def initialize(api_document, deserializer)
-      @api_document = api_document.deep_stringify_keys
+    def initialize(document, deserializer)
+      @document = FunWithJsonApi.sanitize_document(document)
       @deserializer = deserializer
     end
 
@@ -30,11 +30,11 @@ module FunWithJsonApi
     end
 
     def document_id
-      @document_id ||= api_document['data']['id']
+      @document_id ||= document['data']['id']
     end
 
     def document_type
-      @document_type ||= api_document['data']['type']
+      @document_type ||= document['data']['type']
     end
 
     def resource_type
@@ -42,13 +42,13 @@ module FunWithJsonApi
     end
 
     def document_is_valid?
-      api_document.key?('data') && (
-        api_document['data'].is_a?(Hash) || document_is_null_resource?
+      document.key?('data') && (
+        document['data'].is_a?(Hash) || document_is_null_resource?
       )
     end
 
     def document_is_null_resource?
-      api_document['data'].nil?
+      document['data'].nil?
     end
 
     def document_matches_resource_type?
@@ -62,7 +62,7 @@ module FunWithJsonApi
       payload.pointer = '/data'
       payload.detail = document_is_invalid_message
       Exceptions::InvalidDocument.new(
-        "Expected root data element with hash or null: #{api_document.inspect}",
+        "Expected root data element with hash or null: #{document.inspect}",
         payload
       )
     end

data/lib/fun_with_json_api/schema_validator.rb

@@ -2,18 +2,18 @@ require 'fun_with_json_api/exception'
 
 module FunWithJsonApi
   class SchemaValidator
-    def self.check(api_document, deserializer, resource)
-      new(api_document, deserializer, resource).check
+    def self.check(document, deserializer, resource)
+      new(document, deserializer, resource).check
     end
 
     private_class_method :new
 
-    attr_reader :api_document
+    attr_reader :document
     attr_reader :deserializer
     attr_reader :resource
 
-    def initialize(api_document, deserializer, resource)
-      @api_document = api_document.deep_stringify_keys
+    def initialize(document, deserializer, resource)
+      @document = FunWithJsonApi.sanitize_document(document)
       @deserializer = deserializer
       @resource = resource
     end
@@ -21,16 +21,16 @@ module FunWithJsonApi
     def check
       FunWithJsonApi::SchemaValidators::CheckDocumentTypeMatchesResource.call(self)
       FunWithJsonApi::SchemaValidators::CheckDocumentIdMatchesResource.call(self)
-      FunWithJsonApi::SchemaValidators::CheckAttributes.call(api_document, deserializer)
-      FunWithJsonApi::SchemaValidators::CheckRelationships.call(api_document, deserializer)
+      FunWithJsonApi::SchemaValidators::CheckAttributes.call(document, deserializer)
+      FunWithJsonApi::SchemaValidators::CheckRelationships.call(document, deserializer)
     end
 
     def document_id
-      @document_id ||= api_document['data']['id']
+      @document_id ||= document['data']['id']
     end
 
     def document_type
-      @document_type ||= api_document['data']['type']
+      @document_type ||= document['data']['type']
     end
 
     def resource_id

data/lib/fun_with_json_api/schema_validators/check_attributes.rb

@@ -1,20 +1,20 @@
 module FunWithJsonApi
   module SchemaValidators
     class CheckAttributes
-      def self.call(api_document, deserializer)
-        new(api_document, deserializer).call
+      def self.call(document, deserializer)
+        new(document, deserializer).call
       end
 
-      attr_reader :api_document
+      attr_reader :document
       attr_reader :deserializer
 
-      def initialize(api_document, deserializer)
-        @api_document = api_document
+      def initialize(document, deserializer)
+        @document = document
         @deserializer = deserializer
       end
 
       def call
-        attributes = api_document['data'].fetch('attributes', {}).keys
+        attributes = document['data'].fetch('attributes', {}).keys
         unknown = attributes.reject { |attribute| resource_attributes.include?(attribute) }
 
         return true if unknown.empty?

data/lib/fun_with_json_api/schema_validators/check_relationships.rb

@@ -1,20 +1,20 @@
 module FunWithJsonApi
   module SchemaValidators
     class CheckRelationships
-      def self.call(api_document, deserializer)
-        new(api_document, deserializer).call
+      def self.call(document, deserializer)
+        new(document, deserializer).call
       end
 
-      attr_reader :api_document
+      attr_reader :document
       attr_reader :deserializer
 
-      def initialize(api_document, deserializer)
-        @api_document = api_document
+      def initialize(document, deserializer)
+        @document = document
         @deserializer = deserializer
       end
 
       def call
-        relationships = api_document['data'].fetch('relationships', {})
+        relationships = document['data'].fetch('relationships', {})
 
         check_for_unknown_relationships! relationships.keys
         check_for_invalid_relationship_type! relationships

data/lib/fun_with_json_api/version.rb

@@ -1,3 +1,3 @@
 module FunWithJsonApi
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/lib/fun_with_json_api.rb

@@ -13,39 +13,44 @@ module FunWithJsonApi
 
   module_function
 
-  def deserialize(api_document, deserializer_class, resource = nil, options = {})
+  def deserialize(document, deserializer_class, resource = nil, options = {})
     # Prepare the deserializer and the expected config
     deserializer = deserializer_class.create(options)
 
     # Run through initial document structure validation and deserialization
-    unfiltered = FunWithJsonApi::PreDeserializer.parse(api_document, deserializer)
+    unfiltered = FunWithJsonApi::PreDeserializer.parse(document, deserializer)
 
     # Check the document matches up with expected resource parameters
-    FunWithJsonApi::SchemaValidator.check(api_document, deserializer, resource)
+    FunWithJsonApi::SchemaValidator.check(document, deserializer, resource)
 
     # Ensure document matches schema, and sanitize values
     deserializer.sanitize_params(unfiltered)
   end
 
-  def deserialize_resource(api_document, deserializer_class, resource, options = {})
+  def deserialize_resource(document, deserializer_class, resource, options = {})
     raise ArgumentError, 'resource cannot be nil' if resource.nil?
-    deserialize(api_document, deserializer_class, resource, options)
+    deserialize(document, deserializer_class, resource, options)
   end
 
-  def find_resource(api_document, deserializer_class, options = {})
+  def sanitize_document(document)
+    document = document.dup.permit!.to_h if document.is_a?(ActionController::Parameters)
+    document.deep_stringify_keys
+  end
+
+  def find_resource(document, deserializer_class, options = {})
     # Prepare the deserializer for loading a resource
     deserializer = deserializer_class.create(options.merge(attributes: [], relationships: []))
 
     # Load the resource from the document id
-    FunWithJsonApi::FindResourceFromDocument.find(api_document, deserializer)
+    FunWithJsonApi::FindResourceFromDocument.find(document, deserializer)
   end
 
-  def find_collection(api_document, deserializer_class, options = {})
+  def find_collection(document, deserializer_class, options = {})
     # Prepare the deserializer for loading a resource
     deserializer = deserializer_class.create(options.merge(attributes: [], relationships: []))
 
     # Load the collection from the document
-    FunWithJsonApi::FindCollectionFromDocument.find(api_document, deserializer)
+    FunWithJsonApi::FindCollectionFromDocument.find(document, deserializer)
   end
 end