fun_with_json_api 0.0.2 → 0.0.3

data/spec/fun_with_json_api_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe FunWithJsonApi do
-  it 'should have a Semantic Versioning compatible VERSION' do
+  it 'has a semantic-versioning compatible VERSION' do
     # based on https://github.com/npm/node-semver/issues/32
     version_regex = /
       \A([0-9]+) # major
@@ -15,7 +15,42 @@ describe FunWithJsonApi do
 
   describe '.deserialize' do
     context 'with an PostDeserializer' do
-      it 'should convert a json api to post params' do
+      it 'converts a json api document into create post params' do
+        ARModels::Author.create(id: 9)
+        ARModels::Comment.create(id: 5)
+        ARModels::Comment.create(id: 12)
+
+        post_json = {
+          'data': {
+            'type': 'posts',
+            'attributes': {
+              'title': 'Rails is Omakase',
+              'body': 'This is my post body'
+            },
+            'relationships': {
+              'author': {
+                'data': { 'type': 'person', 'id': '9' }
+              },
+              'comments': {
+                'data': [
+                  { 'type': 'comments', 'id': '5' },
+                  { 'type': 'comments', 'id': '12' }
+                ]
+              }
+            }
+          }
+        }
+
+        post_params = described_class.deserialize(post_json, ARModels::PostDeserializer)
+        expect(post_params).to eq(
+          title: 'Rails is Omakase',
+          body: 'This is my post body',
+          author_id: 9,
+          comment_ids: [5, 12]
+        )
+      end
+      it 'converts a json api document into update post params' do
+        post = ARModels::Post.create(id: 1)
         ARModels::Author.create(id: 9)
         ARModels::Comment.create(id: 5)
         ARModels::Comment.create(id: 12)
@@ -30,7 +65,7 @@ describe FunWithJsonApi do
             },
             'relationships': {
               'author': {
-                'data': { 'type': 'people', 'id': '9' }
+                'data': { 'type': 'person', 'id': '9' }
               },
               'comments': {
                 'data': [
@@ -42,7 +77,7 @@ describe FunWithJsonApi do
           }
         }
 
-        post_params = FunWithJsonApi.deserialize(post_json, ARModels::PostDeserializer)
+        post_params = described_class.deserialize(post_json, ARModels::PostDeserializer, post)
         expect(post_params).to eq(
           title: 'Rails is Omakase',
           body: 'This is my post body',
@@ -50,6 +85,115 @@ describe FunWithJsonApi do
           comment_ids: [5, 12]
         )
       end
+      it 'allows for relationships to be scoped' do
+        post = ARModels::Post.create(id: 1)
+        ARModels::Author.create(id: 9, name: 'John', code: 'foo')
+        ARModels::Author.create(id: 10, name: 'John', code: 'bar')
+        ARModels::Comment.create(id: 5)
+        ARModels::Comment.create(id: 12)
+
+        post_json = {
+          'data': {
+            'type': 'posts',
+            'id': '1',
+            'attributes': {
+              'title': 'Rails is Omakase',
+              'body': 'This is my post body'
+            },
+            'relationships': {
+              'author': {
+                'data': { 'type': 'person', 'id': 'John' }
+              },
+              'comments': {
+                'data': [
+                  { 'type': 'comments', 'id': '5' },
+                  { 'type': 'comments', 'id': '12' }
+                ]
+              }
+            }
+          }
+        }
+
+        post_params = described_class.deserialize(
+          post_json,
+          ARModels::PostDeserializer,
+          post,
+          author: { id_param: :name, resource_collection: ARModels::Author.where(code: 'foo') }
+        )
+        expect(post_params).to eq(
+          title: 'Rails is Omakase',
+          body: 'This is my post body',
+          author_id: 9,
+          comment_ids: [5, 12]
+        )
+      end
+    end
+  end
+
+  describe '.find_resource' do
+    context 'with a resource matching the document' do
+      let!(:resource) { ARModels::Author.create(id: 42) }
+      let(:document) { { data: { id: '42', type: 'person' } } }
+
+      it 'returns the matching resource' do
+        actual = described_class.find_resource(document, ARModels::AuthorDeserializer)
+        expect(actual).to eq(resource)
+      end
+    end
+
+    context 'with a resource_collection argument' do
+      let!(:resource_a) { ARModels::Author.create(id: 42, name: 'Jack', code: 'foo') }
+      let!(:resource_b) { ARModels::Author.create(id: 43, name: 'John', code: 'foo') }
+      let(:document) { { data: { id: 'foo', type: 'person' } } }
+
+      it 'returns the resource scoped to the resource_collection' do
+        actual = described_class.find_resource(
+          document,
+          ARModels::AuthorDeserializer,
+          id_param: 'code',
+          resource_collection: ARModels::Author.where(name: 'Jack')
+        )
+        expect(actual).to eq(resource_a)
+      end
+    end
+  end
+
+  describe '.find_collection' do
+    context 'with resources matching the document' do
+      let!(:resource_a) { ARModels::Author.create(id: 42) }
+      let!(:resource_b) { ARModels::Author.create(id: 43) }
+      let(:document) { { data: [{ id: '42', type: 'person' }, { id: '43', type: 'person' }] } }
+
+      it 'returns all matching resources' do
+        actual = described_class.find_collection(document, ARModels::AuthorDeserializer)
+        expect(actual).to eq([resource_a, resource_b])
+      end
+    end
+
+    context 'with a resource_collection argument' do
+      let!(:resource_a) { ARModels::Author.create(id: 42, name: 'Jack', code: 'foo') }
+      let!(:resource_b) { ARModels::Author.create(id: 43, name: 'John', code: 'foo') }
+      let!(:resource_c) { ARModels::Author.create(id: 44, name: 'Jack', code: 'bar') }
+      let(:document) { { data: [{ id: 'foo', type: 'person' }, { id: 'bar', type: 'person' }] } }
+
+      it 'returns the resource scoped to the resource_collection' do
+        actual = described_class.find_collection(
+          document,
+          ARModels::AuthorDeserializer,
+          id_param: 'code',
+          resource_collection: ARModels::Author.where(name: 'Jack')
+        )
+        expect(actual).to eq([resource_a, resource_c])
+      end
+    end
+
+    context 'with an empty array' do
+      let(:document) { { data: [] } }
+
+      it 'returns an empty array' do
+        actual = described_class.find_collection(document, ARModels::AuthorDeserializer)
+        expect(actual).to eq([])
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Morrall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.38.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +148,7 @@ files:
 - Rakefile
 - config/locales/fun_with_json_api.en.yml
 - lib/fun_with_json_api.rb
+- lib/fun_with_json_api/action_controller_extensions/serialization.rb
 - lib/fun_with_json_api/attribute.rb
 - lib/fun_with_json_api/attributes/boolean_attribute.rb
 - lib/fun_with_json_api/attributes/date_attribute.rb
@@ -144,6 +159,7 @@ files:
 - lib/fun_with_json_api/attributes/relationship.rb
 - lib/fun_with_json_api/attributes/relationship_collection.rb
 - lib/fun_with_json_api/attributes/string_attribute.rb
+- lib/fun_with_json_api/attributes/uuid_v4_attribute.rb
 - lib/fun_with_json_api/controller_methods.rb
 - lib/fun_with_json_api/deserializer.rb
 - lib/fun_with_json_api/deserializer_class_methods.rb
@@ -152,12 +168,27 @@ files:
 - lib/fun_with_json_api/exception_payload.rb
 - lib/fun_with_json_api/exception_payload_serializer.rb
 - lib/fun_with_json_api/exception_serializer.rb
+- lib/fun_with_json_api/exceptions/illegal_client_generated_identifier.rb
 - lib/fun_with_json_api/exceptions/invalid_attribute.rb
+- lib/fun_with_json_api/exceptions/invalid_client_generated_identifier.rb
 - lib/fun_with_json_api/exceptions/invalid_document.rb
+- lib/fun_with_json_api/exceptions/invalid_document_identifier.rb
+- lib/fun_with_json_api/exceptions/invalid_document_type.rb
 - lib/fun_with_json_api/exceptions/invalid_relationship.rb
+- lib/fun_with_json_api/exceptions/invalid_relationship_type.rb
 - lib/fun_with_json_api/exceptions/missing_relationship.rb
+- lib/fun_with_json_api/exceptions/missing_resource.rb
+- lib/fun_with_json_api/exceptions/unknown_attribute.rb
+- lib/fun_with_json_api/exceptions/unknown_relationship.rb
+- lib/fun_with_json_api/find_collection_from_document.rb
+- lib/fun_with_json_api/find_resource_from_document.rb
 - lib/fun_with_json_api/pre_deserializer.rb
 - lib/fun_with_json_api/railtie.rb
+- lib/fun_with_json_api/schema_validator.rb
+- lib/fun_with_json_api/schema_validators/check_attributes.rb
+- lib/fun_with_json_api/schema_validators/check_document_id_matches_resource.rb
+- lib/fun_with_json_api/schema_validators/check_document_type_matches_resource.rb
+- lib/fun_with_json_api/schema_validators/check_relationships.rb
 - lib/fun_with_json_api/version.rb
 - lib/tasks/fun_with_json_api_tasks.rake
 - spec/dummy/README.rdoc
@@ -195,13 +226,20 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/example_spec.rb
 - spec/fixtures/active_record.rb
 - spec/fun_with_json_api/controller_methods_spec.rb
 - spec/fun_with_json_api/deserializer_class_methods_spec.rb
 - spec/fun_with_json_api/deserializer_spec.rb
 - spec/fun_with_json_api/exception_spec.rb
+- spec/fun_with_json_api/find_collection_from_document_spec.rb
+- spec/fun_with_json_api/find_resource_from_document_spec.rb
 - spec/fun_with_json_api/pre_deserializer_spec.rb
+- spec/fun_with_json_api/railtie_spec.rb
+- spec/fun_with_json_api/schema_validator_spec.rb
+- spec/fun_with_json_api/schema_validators/check_attributes_spec.rb
+- spec/fun_with_json_api/schema_validators/check_document_id_matches_resource_spec.rb
+- spec/fun_with_json_api/schema_validators/check_document_type_matches_resource_spec.rb
+- spec/fun_with_json_api/schema_validators/check_relationships_spec.rb
 - spec/fun_with_json_api_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bmorrall/fun_with_json_api
@@ -264,12 +302,19 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/README.rdoc
-- spec/example_spec.rb
 - spec/fixtures/active_record.rb
 - spec/fun_with_json_api/controller_methods_spec.rb
 - spec/fun_with_json_api/deserializer_class_methods_spec.rb
 - spec/fun_with_json_api/deserializer_spec.rb
 - spec/fun_with_json_api/exception_spec.rb
+- spec/fun_with_json_api/find_collection_from_document_spec.rb
+- spec/fun_with_json_api/find_resource_from_document_spec.rb
 - spec/fun_with_json_api/pre_deserializer_spec.rb
+- spec/fun_with_json_api/railtie_spec.rb
+- spec/fun_with_json_api/schema_validator_spec.rb
+- spec/fun_with_json_api/schema_validators/check_attributes_spec.rb
+- spec/fun_with_json_api/schema_validators/check_document_id_matches_resource_spec.rb
+- spec/fun_with_json_api/schema_validators/check_document_type_matches_resource_spec.rb
+- spec/fun_with_json_api/schema_validators/check_relationships_spec.rb
 - spec/fun_with_json_api_spec.rb
 - spec/spec_helper.rb

data/spec/example_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-
-describe 'Example' do
-  xit 'prints out the thing' do
-    params = {
-      id: 'zorglub',
-      title: 'Ember Hamster',
-      published_at: '2016-03-12',
-      enabled_at: '2016-03-12T17:19:28+11:00',
-      promoted: false,
-      times_read: '414',
-      author_id: nil,
-      editor_id: '9',
-      comment_ids: %w(1 2)
-    }
-
-    puts "attributes: #{ArticleDeserializer.attributes.map(&:name).inspect}"
-
-    deserializer = ArticleDeserializer.create
-    deserialized_params = deserializer.sanitize_params(params)
-    puts "title: #{deserialized_params[:title].inspect}"
-    puts "published_at: #{deserialized_params[:published_at].inspect}"
-    puts "enabled_at: #{deserialized_params[:enabled_at].inspect}"
-    puts "times_read: #{deserialized_params[:times_read].inspect}"
-    puts deserialized_params.inspect
-
-    expect(deserializer.type).to eq 'articles'
-    expect(deserializer.resource_class).to eq Article
-  end
-
-  xit 'deserializes params' do
-    document_data = {
-      # id: 'zorglub',
-      type: 'articles',
-      attributes: {
-        title: 'Ember Hamster',
-        date: '2016-03-12',
-        enabled_at: '2016-03-12T13:45:40+09:30',
-        promoted: false,
-        times_read: '414'
-      },
-      relationships: {
-        author: { data: nil },
-        editor: { data: { id: 'demouser', type: 'persons' } },
-        comments: { data: [{ id: '1', type: 'comments' }, { id: '2', type: 'comments' }] }
-      }
-    }
-    document = { data: document_data }.as_json
-
-    document_params = FunWithJsonApi.deserialize(document, ArticleDeserializer)
-    expect(document_params).to eq(
-      # id: Article.find(code: 'zorglub').id,
-      title: 'Ember Hamster',
-      published_at: Date.new(2016, 03, 12),
-      enabled_at: DateTime.new(2016, 03, 12, 4, 15, 40, 0),
-      promoted: false,
-      times_read: 414,
-      author_id: nil,
-      editor_id: Person.find_by!(username: 'demouser').id,
-      comment_ids: [1, 2]
-    )
-    puts "deserialized: #{document_params.inspect}"
-  end
-end