jsonapi-object-mapper 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35390dfcd2da06f3fadc628d41986b07891efa2590a4271896a9717ed44ed7b6
-  data.tar.gz: eb48c0ab5e7409c53ba03828704adcef9e27377443498b4f5a97430cde8cd5ad
+  metadata.gz: 8f1ffe31b2bc6266364e9ce22de8f3326fe91d7b6209f421a12a70d9cbe68cdc
+  data.tar.gz: 8603e6c43ae05a4159811a64fe041e2470cdb011b24223b759d405ddbf2e8e01
 SHA512:
-  metadata.gz: 96a5b2682366e3d45ff87b768c1ace3463847721293a0237b7661fe4c0d19b2049ed2f1616b73f9d47eea4a62b69d7fb359e1e86753ff1123388c171a7f62e97
-  data.tar.gz: 5d75d3a36a2cd47ef118dcd4e51f31129e5f7cd8e8e7b0daaa93077e8d809551261f52a2ef321e4c20a30a8a82d75dad2344056413e95d740234978b45d6fe72
+  metadata.gz: 1d6a3abc3c030e77d4ca61c26610c46772e3fa1f98b7add1f486502e42036998d7f76a7c7896375efd76f336558b6e0e6d0c1bec7611a76727b7cb6101194a27
+  data.tar.gz: 05226150aac758f77f1d8e0af7b13624b97194e42dd075f4e80b544cb674414563a69ed3fc609c42f44585bd47f44c1c8440320c5f79860f15e716d5eb7f02f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jsonapi-object-mapper (0.4.0)
+    jsonapi-object-mapper (0.5.0)
       oj (~> 3.0)
 
 GEM

data/{jsonapi_object_mapper.gemspec → jsonapi-object-mapper.gemspec}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
-require "jsonapi_object_mapper/version"
+require "jsonapi-object-mapper/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jsonapi-object-mapper"

data/lib/jsonapi-object-mapper/deserializer/collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "jsonapi-object-mapper/parser/errors"
+
+module JsonAPIObjectMapper
+  module Deserializer
+    class Collection
+      include Enumerable
+      include JsonAPIObjectMapper::Parser::Errors
+
+      attr_accessor :collection_data
+
+      def initialize(parser, klass:)
+        raise ArgumentError, "Must provide a valid resource klass" unless klass.is_a?(Class)
+        raise ArgumentError, "Must provide a parsed document" unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
+        @errors            = parser.errors
+        @collection_data   =
+          if document_invalid?
+            []
+          else
+            Array(parser.document["data"]).map do |doc|
+              klass.new(parser, document: doc)
+            end
+          end.freeze
+
+        freeze
+      end
+
+      def each
+        @collection_data.each do |data|
+          yield data
+        end
+      end
+    end
+  end
+end

data/lib/{jsonapi_object_mapper → jsonapi-object-mapper}/deserializer/dsl.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "jsonapi_object_mapper/deserializer/included_resources"
-
 module JsonAPIObjectMapper
   module Deserializer
     module DSL
@@ -43,13 +41,16 @@ module JsonAPIObjectMapper
 
       module ClassMethods
         def initialize(*args)
-          super
           @_class_attributes    = {}
           @_class_relationships = {}
+          super
         end
 
         def to_hash
-          [@_class_attributes, @_class_relationships].reduce(:merge)
+          hashed_relationships = @_class_relationships.map do |key, value|
+            { key => value.respond_to?(:to_hash) ? value.to_hash : value }
+          end
+          [@_class_attributes, *hashed_relationships].reduce({}, :merge)
         end
         alias to_h to_hash
 
@@ -73,13 +74,15 @@ module JsonAPIObjectMapper
         end
 
         def assign_relationship(key, value)
-          block           = self.class.rel_blocks[key.to_s] || DEFAULT_ATTR_BLOCK
-          rel_embed_class = self.class.rel_options[key.to_s]
+          block             = self.class.rel_blocks[key.to_s] || DEFAULT_ATTR_BLOCK
+          rel_embed_class   = self.class.rel_options[key.to_s]
+          rel_value         = @includes.fetch(value)
+
           @_class_relationships[key.to_s] =
-            if rel_embed_class.respond_to?(:embed!)
-              block.call(rel_embed_class.embed!(value))
+            if rel_value != value && rel_embed_class.respond_to?(:embed!)
+              block.call(rel_embed_class.embed!(rel_value))
             else
-              block.call(value)
+              block.call(rel_value)
             end
         end
 

data/lib/{jsonapi_object_mapper → jsonapi-object-mapper}/deserializer/resource.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require "jsonapi_object_mapper/deserializer/dsl"
-require "jsonapi_object_mapper/deserializer/included_resources"
+require "jsonapi-object-mapper/deserializer/dsl"
+require "jsonapi-object-mapper/deserializer/collection"
+require "jsonapi-object-mapper/parser/errors"
 
 module JsonAPIObjectMapper
   module Deserializer
     class Resource
+      include JsonAPIObjectMapper::Parser::Errors
       extend DSL
 
       class << self
@@ -24,37 +26,48 @@ module JsonAPIObjectMapper
         klass.instance_variable_set("@type_block", type_block)
       end
 
-      def self.call_collection(document)
-        parsed_document = document.is_a?(Hash) ? document : ::Oj.load(document)
-        parsed_includes = IncludedResources.load(parsed_document["included"])
-        Array(parsed_document["data"]).map { |doc| new(doc, parsed_includes) }
-      end
-
-      def self.call(document, parsed_includes = nil)
-        parsed_document = document.is_a?(Hash) ? document : ::Oj.load(document)
-        parsed_includes ||= IncludedResources.load(parsed_document["included"])
-        new(parsed_document["data"], parsed_includes)
+      def self.call(document)
+        parser = JsonAPIObjectMapper::Parser::Document.new(document)
+        if parser.document["data"].is_a?(Array) || parser.invalid?
+          Collection.new(parser, klass: self)
+        else
+          new(parser)
+        end
       end
 
       def self.embed!(attributes)
-        new("attributes" => attributes)
+        parser = JsonAPIObjectMapper::Parser::Document.new("attributes" => attributes)
+        new(parser)
       end
 
-      def initialize(payload = nil, included = nil)
+      def initialize(parser, document: nil)
         super()
-        data           = payload || {}
-        @id            = data["id"]
-        @type          = data["type"]
-        @attributes    = data["attributes"] || {}
-        @relationships = data["relationships"] || {}
-        @includes      = IncludedResources.load(included)
-        deserialize!
+        raise ArgumentError, "Must provide a parsed document" unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
+        @errors = parser.errors
+
+        if document_valid?
+          @includes      = parser.includes
+          @data          = document_data(parser, document)
+          @id            = @data["id"]
+          @type          = @data["type"]
+          @attributes    = @data.fetch("attributes", {})
+          @relationships = @data.fetch("relationships", {})
+          deserialize!
+        end
 
         freeze
       end
 
+      def each
+        yield self
+      end
+
       private
 
+      def document_data(parser, document)
+        document.nil? ? (parser.document["data"] || parser.document) : (document["data"] || document)
+      end
+
       def deserialize!
         deserialize_id_type!
         deserialize_attributes!
@@ -62,8 +75,8 @@ module JsonAPIObjectMapper
       end
 
       def deserialize_id_type!
-        assign_attribute("id", self.class.id_block&.call(@id))
-        assign_attribute("type", self.class.type_block&.call(@id))
+        assign_attribute("id", self.class.id_block.call(@id))       if self.class.id_block
+        assign_attribute("type", self.class.type_block.call(@type)) if self.class.type_block
       end
 
       def deserialize_attributes!
@@ -83,7 +96,7 @@ module JsonAPIObjectMapper
 
       def initialize_relationship(rel_type, rel_value)
         return unless include_relationship?(rel_type)
-        assign_relationship(rel_type, @includes.fetch(rel_value["data"]))
+        assign_relationship(rel_type, rel_value["data"])
       end
     end
   end

data/lib/jsonapi-object-mapper/parser/document.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "jsonapi-object-mapper/parser/included_resources"
+require "jsonapi-object-mapper/parser/errors"
+
+module JsonAPIObjectMapper
+  module Parser
+    class Document
+      include Errors
+
+      attr_accessor :document, :includes
+
+      def initialize(document)
+        @document = document.is_a?(Hash) ? document : ::Oj.load(document)
+        @includes = IncludedResources.load(@document["included"])
+        @errors   = deserialize_errors!.freeze
+        freeze
+      end
+
+      def deserialize_errors!
+        return [] unless @document.key?("errors")
+        Set.new(@document["errors"]) { |error| OpenStruct.new(error) }
+      end
+    end
+  end
+end

data/lib/jsonapi-object-mapper/parser/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JsonAPIObjectMapper
+  module Parser
+    module Errors
+      attr_accessor :errors
+
+      def valid?
+        @errors.nil? || @errors.empty?
+      end
+      alias document_valid? valid?
+
+      def invalid?
+        !valid?
+      end
+      alias errors? invalid?
+      alias document_invalid? invalid?
+    end
+  end
+end

data/lib/{jsonapi_object_mapper/deserializer → jsonapi-object-mapper/parser}/included_resources.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module JsonAPIObjectMapper
-  module Deserializer
+  module Parser
     class IncludedResources
       extend Forwardable
 
@@ -15,14 +15,15 @@ module JsonAPIObjectMapper
 
       def initialize(included_resources = [])
         included_resources ||= []
-
         @resource = included_resources.each_with_object({}) do |include, hash|
           hash[format_key(include)] = include["attributes"]
         end
+
+        freeze
       end
 
-      def fetch(relationship)
-        @resource.fetch(format_key(relationship), relationship)
+      def fetch(relationship, fallback = nil)
+        @resource.fetch(format_key(relationship), fallback || relationship)
       end
 
       def included?(relationship)

data/lib/{jsonapi_object_mapper → jsonapi-object-mapper}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonAPIObjectMapper
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/jsonapi-object-mapper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "oj"
+require "jsonapi-object-mapper/parser/document"
+require "jsonapi-object-mapper/deserializer/resource"
+require "jsonapi-object-mapper/version"
+
+module JsonAPIObjectMapper
+end

data/spec/deserializer/resource_spec.rb

@@ -21,7 +21,7 @@ module JsonAPIObjectMapper
             attribute :baz
           end
 
-          actual = klass.new(payload)
+          actual = klass.call(payload)
           expect(actual.foo).to eq("bar")
           expect(actual.baz).to eq("nas")
         end
@@ -34,7 +34,7 @@ module JsonAPIObjectMapper
             end
           end
 
-          actual = klass.new(payload)
+          actual = klass.call(payload)
           expect(actual.baz).to eq("THIS IS THE REAL DEAL!")
         end
       end
@@ -55,13 +55,15 @@ module JsonAPIObjectMapper
 
         context "Has included Resource" do
           let(:included_payload) do
-            [
-              {
-                "id" => "1",
-                "type" => "photo",
-                "attributes" => { "image" => "good_day_sir.jpg" },
-              },
-            ]
+            payload.merge(
+              "included" => [
+                {
+                  "id" => "1",
+                  "type" => "photo",
+                  "attributes" => { "image" => "good_day_sir.jpg" },
+                },
+              ],
+            )
           end
 
           it "Should embed the included resource into the relationship" do
@@ -69,7 +71,7 @@ module JsonAPIObjectMapper
               has_one :photo
             end
 
-            actual = klass.new(payload, included_payload)
+            actual = klass.call(included_payload)
             expect(actual.photo).to eq("image" => "good_day_sir.jpg")
           end
 
@@ -82,7 +84,7 @@ module JsonAPIObjectMapper
               has_one :photo, embed_with: photo_klass
             end
 
-            actual = core_klass.new(payload, included_payload)
+            actual = core_klass.call(included_payload)
             expect(actual.photo).to be_a(photo_klass)
             expect(actual.photo.image).to eq("good_day_sir.jpg")
           end
@@ -94,11 +96,11 @@ module JsonAPIObjectMapper
               has_one :photo
             end
 
-            actual = klass.new(payload)
+            actual = klass.call(payload)
             expect(actual.photo).to eq("id" => "1", "type" => "photo")
           end
 
-          it "Should set the attribute to nil when no included resource is present" do
+          it "Should set the default relationship values if no includes can be found" do
             photo_klass = Class.new(described_class) do
               attribute :image
             end
@@ -107,9 +109,9 @@ module JsonAPIObjectMapper
               has_one :photo, embed_with: photo_klass
             end
 
-            actual = core_klass.new(payload)
-            expect(actual.photo).to be_a(photo_klass)
-            expect(actual.photo.image).to be_nil
+            actual = core_klass.call(payload)
+            expect(actual.photo).to be_a(Hash)
+            expect(actual.photo).to eq("id" => "1", "type" => "photo")
           end
         end
       end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "jsonapi_object_mapper"
+require "jsonapi-object-mapper"
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require File.expand_path(f) }
 Dir["#{File.dirname(__FILE__)}/**/*examples.rb"].each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-object-mapper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - George Protacio-Karaszi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -89,12 +89,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- jsonapi_object_mapper.gemspec
-- lib/jsonapi_object_mapper.rb
-- lib/jsonapi_object_mapper/deserializer/dsl.rb
-- lib/jsonapi_object_mapper/deserializer/included_resources.rb
-- lib/jsonapi_object_mapper/deserializer/resource.rb
-- lib/jsonapi_object_mapper/version.rb
+- jsonapi-object-mapper.gemspec
+- lib/jsonapi-object-mapper.rb
+- lib/jsonapi-object-mapper/deserializer/collection.rb
+- lib/jsonapi-object-mapper/deserializer/dsl.rb
+- lib/jsonapi-object-mapper/deserializer/resource.rb
+- lib/jsonapi-object-mapper/parser/document.rb
+- lib/jsonapi-object-mapper/parser/errors.rb
+- lib/jsonapi-object-mapper/parser/included_resources.rb
+- lib/jsonapi-object-mapper/version.rb
 - spec/deserializer/resource_spec.rb
 - spec/jsonapi_object_mapper_spec.rb
 - spec/spec_helper.rb

data/lib/jsonapi_object_mapper.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "oj"
-require "jsonapi_object_mapper/deserializer/resource"
-require "jsonapi_object_mapper/version"
-
-module JsonAPIObjectMapper
-end