jsonapi-object-mapper 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f1ffe31b2bc6266364e9ce22de8f3326fe91d7b6209f421a12a70d9cbe68cdc
-  data.tar.gz: 8603e6c43ae05a4159811a64fe041e2470cdb011b24223b759d405ddbf2e8e01
+  metadata.gz: cc15e84ef11d68ce266929e2a420eefb0526b05eabd8a63065747721fef0c3a3
+  data.tar.gz: a3a9a57a7d7492124f505cad9c05e509cd5deb5a33f1afec59c7c01295153a5e
 SHA512:
-  metadata.gz: 1d6a3abc3c030e77d4ca61c26610c46772e3fa1f98b7add1f486502e42036998d7f76a7c7896375efd76f336558b6e0e6d0c1bec7611a76727b7cb6101194a27
-  data.tar.gz: 05226150aac758f77f1d8e0af7b13624b97194e42dd075f4e80b544cb674414563a69ed3fc609c42f44585bd47f44c1c8440320c5f79860f15e716d5eb7f02f1
+  metadata.gz: 7b18f64a3c70061e4860862fd8d8b766bbc5a78de8bf728f52b34b04eeadfc3a1ed9ac0a6e598d1bc8b083e7f82ffb9d85ab3c1a1bd00a62b536c02c2fe72f19
+  data.tar.gz: 43ba9a81a83f4824ed4aedddc6e947cd7812cd1775efc4d925c6e14a5a41d3ed7a86ce3317516429da17a90c42427ce29742f6168fb557fd08678565473b0c8c

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,6 @@
 # JsonapiObjectMapper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi_object_mapper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Deserialize's raw or pre-hashed JsonAPI objects into plan ruby objects as well as embeds any included relational resources.
 
 ## Installation
 
@@ -23,13 +21,13 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require "jsonapi_object_mapper"
+require "jsonapi-object-mapper"
 
-class Photo < JsonAPIObjectMapper::Deserializer::Resource
+class Photo < JsonAPIObjectMapper::Deserialize::Resource
   attribute :image
 end
 
-class User < JsonAPIObjectMapper::Deserializer::Resource
+class User < JsonAPIObjectMapper::Deserialize::Resource
   # Embedding with another Resource class, will deserialize the `included` resource with the given class
   has_one :photo, embed_with: Photo
   
@@ -51,12 +49,32 @@ class User < JsonAPIObjectMapper::Deserializer::Resource
 end
   
 
-User.call_collection(json_payload) #=> [<#User:123>, <#User:432>]
 user = User.call(json_payload) #=> <#User:123>
 
 user.first_name #=> "FOOER"
 user.last_name  #=> "Bar"
 
+# If json API Payload is a collection of data points
+users = User.call(json_payload) #=> <# JsonAPIObjectMapper::Deserialize::Collection #>
+
+users.each do |user|
+  user.first_name
+  user.last_name
+end
+
+```
+
+### Errors
+
+```ruby
+
+user = User.call(json_payload)
+
+# Aliases: document_valid?
+# Inverses: errors?, invalid?, document_invalid? 
+user.valid?  #=> false
+user.errors  #=> [<# OpenStruct title:..., detail: ..., source: {...}, ...>, ...]
+
 ```
 
 ## Development

data/lib/jsonapi-object-mapper.rb

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

data/lib/jsonapi-object-mapper/{deserializer → deserialize}/collection.rb

@@ -3,7 +3,7 @@
 require "jsonapi-object-mapper/parser/errors"
 
 module JsonAPIObjectMapper
-  module Deserializer
+  module Deserialize
     class Collection
       include Enumerable
       include JsonAPIObjectMapper::Parser::Errors
@@ -11,8 +11,8 @@ module JsonAPIObjectMapper
       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)
+        raise InvalidResource, "Must provide a valid resource klass" unless klass.is_a?(Class)
+        raise InvalidParser, "Must provide a parsed document" unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
         @errors            = parser.errors
         @collection_data   =
           if document_invalid?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module JsonAPIObjectMapper
-  module Deserializer
+  module Deserialize
     module DSL
       DEFAULT_ID_BLOCK      = proc { |id| id }
       DEFAULT_TYPE_BLOCK    = proc { |type| type }

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "jsonapi-object-mapper/deserializer/dsl"
-require "jsonapi-object-mapper/deserializer/collection"
+require "jsonapi-object-mapper/deserialize/dsl"
+require "jsonapi-object-mapper/deserialize/collection"
 require "jsonapi-object-mapper/parser/errors"
 
 module JsonAPIObjectMapper
-  module Deserializer
+  module Deserialize
     class Resource
       include JsonAPIObjectMapper::Parser::Errors
       extend DSL
@@ -42,7 +42,7 @@ module JsonAPIObjectMapper
 
       def initialize(parser, document: nil)
         super()
-        raise ArgumentError, "Must provide a parsed document" unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
+        raise InvalidParser, "Must provide a parsed document" unless parser.is_a?(JsonAPIObjectMapper::Parser::Document)
         @errors = parser.errors
 
         if document_valid?

data/lib/jsonapi-object-mapper/exceptions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JsonAPIObjectMapper
+  class InvalidResource < StandardError
+  end
+
+  class InvalidParser < StandardError
+  end
+end

data/lib/jsonapi-object-mapper/version.rb

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

data/spec/deserialize/collection_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module JsonAPIObjectMapper
+  module Deserialize
+    RSpec.describe Collection do
+      let(:parser) { JsonAPIObjectMapper::Parser::Document.new(payload) }
+      let(:payload) { {} }
+
+      describe ".new" do
+        context "Rising Exceptions" do
+          it "is expected to raise an error if the resource isn't a class object" do
+            expect { described_class.new(nil, klass: "Class") }.to raise_error(InvalidResource)
+          end
+
+          it "is expected to raise an error if the parser isn't a parsed json document" do
+            expect { described_class.new({}, { klass: Class }) }.to raise_error(InvalidParser)
+          end
+        end
+
+        context "Creating a collection of resources" do
+          let(:payload) do
+            {
+              "data" => [
+                {
+                  "id" => "1",
+                  "type" => "foobar",
+                  "attributes" => {
+                    "name" => "Bert",
+                  },
+                },
+                {
+                  "id" => "2",
+                  "type" => "foobar",
+                  "attributes" => {
+                    "name" => "Johnson",
+                  },
+                },
+              ],
+            }
+          end
+          it "Should collect all resources into a enumerable resource" do
+            foobar_klass = Class.new(JsonAPIObjectMapper::Deserialize::Resource) do
+              attribute :name
+            end
+
+            result = described_class.new(parser, klass: foobar_klass)
+            expect(result.valid?).to be_truthy
+            expect(result.count).to eq(2)
+            expect(result.map(&:name)).to eq(%w[Bert Johnson])
+          end
+        end
+
+        context "Results containing errors" do
+          let(:payload) do
+            {
+              "errors" => [
+                {
+                  "title" => "Invalid name",
+                  "detail" => "Look like foobar to me",
+                  "source" => {
+                    "pointer" => "name",
+                  },
+                },
+              ],
+            }
+          end
+
+          it "Should return as an invalid or error document" do
+            result = described_class.new(parser, klass: Class.new)
+            expect(result).to be_invalid
+          end
+
+          it "Should contain all error responses the in #errors field" do
+            result = described_class.new(parser, klass: Class.new).errors.first
+            expect(result.title).to eq("Invalid name")
+            expect(result.detail).to eq("Look like foobar to me")
+            expect(result.source).to include("pointer" => "name")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/{deserializer → deserialize}/resource_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 
 module JsonAPIObjectMapper
-  module Deserializer
+  module Deserialize
     RSpec.describe Resource do
       describe "Attributes" do
         let(:payload) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-object-mapper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - George Protacio-Karaszi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -91,14 +91,16 @@ files:
 - bin/setup
 - 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/deserialize/collection.rb
+- lib/jsonapi-object-mapper/deserialize/dsl.rb
+- lib/jsonapi-object-mapper/deserialize/resource.rb
+- lib/jsonapi-object-mapper/exceptions.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/deserialize/collection_spec.rb
+- spec/deserialize/resource_spec.rb
 - spec/jsonapi_object_mapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/GeorgeKaraszi/jsonapi-object-mapper
@@ -126,6 +128,7 @@ signing_key:
 specification_version: 4
 summary: Digests JSON-API responses to plain old ruby objects
 test_files:
-- spec/deserializer/resource_spec.rb
+- spec/deserialize/collection_spec.rb
+- spec/deserialize/resource_spec.rb
 - spec/jsonapi_object_mapper_spec.rb
 - spec/spec_helper.rb