json-api-vanilla 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5760a75bcea2f2870e2641f246b36bd63ffcdb9
-  data.tar.gz: 8208a9f5cd8089bf6c356e4548c3d22c4ceea73a
+SHA256:
+  metadata.gz: f596658618531c4fcf2aed7ff39a9656b5050739abb19a7cf893ab0b5bcadc74
+  data.tar.gz: a2c6b0fc63242520d2910127eb2235e80f4c28c5b198872dc2805e71c5ec2bd8
 SHA512:
-  metadata.gz: 6c30f227cd52a825173bcfc39ca3f319c9d3796e812542611482e2a29ed65cd4a9427d537453498524891c669abbcfad6d7b5490708784831be17f1bc27062af
-  data.tar.gz: aa5d645da7d059f6bb1f436093b6bb3161174f777b8485eac56e3de5fda5700700f84bc77f40acf14580b25ef155181bb680478f5e766a483ec19ad1b3c9acc6
+  metadata.gz: b620c77f17f81ca2a271a0a30771e2ec6937c45efe2940e5a2c6a9f4b4616b3fbe4dba7f79f9254c0b5ef6e61f1df4507ef8162b0a2495af2e0dfab89f8ebfdf
+  data.tar.gz: 65777666d5db295d3cc31993a8f80f0a69d651abcde67d3b209a987b0adbe21bd789303d8f0fa2e49277672e420157cd73392aecca78cc57f257691bd8387b38

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        make test

data/.gitignore

@@ -1,4 +1,5 @@
 Gemfile.lock
 .ruby-version
 .rvmrc
+.idea
 *.gem

data/Gemfile

@@ -2,5 +2,6 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
+  gem 'rspec'
   gem 'rake'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2016 Trainline.com Ltd
+Copyright 2016 Trainline.com Ltd, 2016-2022 Thaddée Tyl
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Makefile

@@ -1,5 +1,8 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 install:
 	gem build json-api-vanilla.gemspec && gem install ./json-api-vanilla-*.gem
 
-.PHONY: install
+test:
+	rspec
+
+.PHONY: install test

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 $:.push File.expand_path("../lib", __FILE__)
 
 require 'bundler'

data/json-api-vanilla.gemspec

@@ -1,4 +1,4 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'json-api-vanilla/version'
 

data/lib/json-api-vanilla/parser.rb

@@ -1,4 +1,4 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 require "json"
 
 module JSON::Api; end
@@ -58,35 +58,43 @@ module JSON::Api::Vanilla
 
     obj_hashes.each do |o_hash|
       klass = prepare_class(o_hash, superclass, container)
-      obj = klass.new
-      obj.type = o_hash['type']
-      obj.id = o_hash['id']
-      if o_hash['attributes']
-        o_hash['attributes'].each do |key, value|
-          set_key(obj, key, value, original_keys)
-        end
-      end
+      obj = prepare_object(o_hash, klass, original_keys)
+
       if o_hash['links']
         links[obj] = o_hash['links']
       end
+
       objects[[obj.type, obj.id]] = obj
     end
 
     # Now that all objects have been created, we can link everything together.
     obj_hashes.each do |o_hash|
-      klass = container.const_get(ruby_class_name(o_hash['type']).to_sym)
       obj = objects[[o_hash['type'], o_hash['id']]]
       if o_hash['relationships']
         o_hash['relationships'].each do |key, value|
+          naive_validate_relationship_object(value)
+
           if value['data']
             data = value['data']
             if data.is_a?(Array)
               # One-to-many relationship.
               ref = data.map do |ref_hash|
-                objects[[ref_hash['type'], ref_hash['id']]]
+                _ref = objects[[ref_hash['type'], ref_hash['id']]]
+
+                if _ref.nil?
+                  klass = prepare_class(ref_hash, superclass, container)
+                  _ref = prepare_object(ref_hash, klass)
+                end
+
+                _ref
               end
             else
               ref = objects[[data['type'], data['id']]]
+
+              if ref.nil?
+                klass = prepare_class(data, superclass, container)
+                ref = prepare_object(data, klass)
+              end
             end
           end
 
@@ -116,7 +124,7 @@ module JSON::Api::Vanilla
 
   def self.prepare_class(hash, superclass, container)
     name = ruby_class_name(hash['type']).to_sym
-    if container.const_defined?(name)
+    if container.constants.include?(name)
       klass = container.const_get(name)
     else
       klass = generate_object(name, superclass, container)
@@ -131,6 +139,18 @@ module JSON::Api::Vanilla
     klass
   end
 
+  def self.prepare_object(hash, klass, original_keys = {})
+    (klass.new).tap do |obj|
+      obj.type = hash['type']
+      obj.id = hash['id']
+      if hash['attributes']
+        hash['attributes'].each do |key, value|
+          set_key(obj, key, value, original_keys)
+        end
+      end
+    end
+  end
+
   def self.generate_object(ruby_name, superclass, container)
     klass = Class.new(superclass)
     container.const_set(ruby_name, klass)
@@ -173,16 +193,25 @@ module JSON::Api::Vanilla
   # @raise [InvalidRootStructure] raised if the document doesn't have
   # data, errors nor meta objects at its root.
   def self.naive_validate(hash)
-    root_keys = %w(data errors meta)
-    present_structures = root_keys.map do |key|
-      obj = hash[key]
-      obj.respond_to?(:empty?) ? !obj.empty? : !!obj
-    end
-    if present_structures.none?
+    root_keys = %i(data errors meta)
+    present_structures = root_keys & hash.keys.map(&:to_sym)
+    if present_structures.empty?
       raise InvalidRootStructure.new("JSON:API document must contain at least one of these objects: #{root_keys.join(', ')}")
     end
   end
 
+  # Naïvely validate a relationship object.
+  # @param hash [Hash] json:api document as a hash
+  # @raise [InvalidRootStructure] raised if the document doesn't have data, errors nor meta objects
+  # at its root.
+  def self.naive_validate_relationship_object(hash)
+    root_keys = %i(data meta links)
+    present_structures = root_keys & hash.keys.map(&:to_sym)
+    if present_structures.empty?
+      raise InvalidRootStructure.new("JSON:API relationship must contain at least one of these objects: #{root_keys.join(', ')}")
+    end
+  end
+
   class Document
     # @return [Object, Array<Object>] the content of the JSON API data.
     attr_reader :data

data/lib/json-api-vanilla/version.rb

@@ -1,8 +1,8 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 module JSON
   module Api
     module Vanilla
-      VERSION = '1.0.0'
+      VERSION = '1.0.3'
     end
   end
 end

data/lib/json-api-vanilla.rb

@@ -1,3 +1,3 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 require 'json-api-vanilla/parser'
 require 'json-api-vanilla/version'

data/spec/json-api-vanilla/diff_spec.rb

@@ -1,4 +1,4 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 require 'spec_helper'
 
 describe JSON::Api::Vanilla do
@@ -20,6 +20,14 @@ describe JSON::Api::Vanilla do
     expect(doc.links[doc.data]['self']).to eql("http://example.com/articles")
   end
 
+  it "should read objects that are only in relationships of included" do
+    expect(doc.data.first.comments.first.post.id).to eql("42")
+  end
+
+  it "should read objects that are only in relationships of included when it is an array" do
+    expect(doc.data.first.comments.first.tags[0].id).to eql("42")
+  end
+
   it "should find objects by type and id" do
     expect(doc.find('comments', '5').body).to eql("First!")
   end
@@ -85,4 +93,82 @@ describe JSON::Api::Vanilla do
       JSON::Api::Vanilla.parse(json)
     end.to raise_error(JSON::Api::Vanilla::InvalidRootStructure)
   end
+
+  it "should raise an error if the document contains an unrecognized element" do
+    json = <<-JSON
+    {
+      "type": "object",
+      "id": "123",
+      "attributes": {},
+      "foo": "bar"
+    }
+    JSON
+    expect do
+      JSON::Api::Vanilla.parse(json)
+    end.to raise_error(JSON::Api::Vanilla::InvalidRootStructure)
+  end
+
+  it "should raise an error if a relationship object does not have one of the required fields" do
+    json = <<-JSON
+    {
+      "data": {
+        "type": "cycle",
+        "id": "1",
+        "relationships": { "cycle": { "type": "cycle", "id": "2" } }
+      }
+    }
+    JSON
+    expect do
+      JSON::Api::Vanilla.parse(json)
+    end.to raise_error(JSON::Api::Vanilla::InvalidRootStructure)
+  end
+
+  it "should not raise any errors if the document contains root elements as symbols" do
+    expect do
+      JSON::Api::Vanilla.naive_validate(data: { id: 1, type: 'mvp' })
+    end.to_not raise_error
+  end
+
+  it "should not raise any errors if the document contains an empty array for data" do
+    expect do
+      JSON::Api::Vanilla.naive_validate(data: [])
+    end.to_not raise_error
+  end
+
+  describe '.prepare_class' do
+    let(:container) {Module.new}
+    let(:superclass) {Class.new}
+    let(:hash) {{'type' => 'test-classes'}}
+    subject {described_class.prepare_class(hash, superclass, container)}
+
+    context 'when same name class in global scope' do
+      class TestClasses
+      end
+
+      it 'should create dynamic class in container' do
+        subject
+        expect(container.constants).to include(:TestClasses)
+      end
+    end
+  end
+
+  describe '.prepare_object' do
+    let(:data) do
+      {
+        'type' => 'example',
+        'id' => '1',
+        'attributes' => {
+          'name' => 'example name'
+        }
+      }
+    end
+    let(:klass) { described_class.prepare_class(data, Class.new, Module.new) }
+    subject { described_class.prepare_object(data, klass) }
+
+    it 'creates an object with the attributes mapped' do
+      expect(subject.type).to eql(data['type'])
+      expect(subject.id).to eql(data['id'])
+      expect(subject.name).to eql(data['attributes']['name'])
+    end
+  end
 end

data/spec/json-api-vanilla/example.json

@@ -56,6 +56,17 @@
     "relationships": {
       "author": {
         "data": { "type": "people", "id": "2" }
+      },
+      "tags": {
+        "data": [
+          { "type": "tag", "id": "42" }
+        ]
+      },
+      "post": {
+        "data": {
+          "type": "post",
+          "id": "42"
+        }
       }
     },
     "links": {

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+# Copyright © Trainline Limited, 2016, Thaddée Tyl, 2016-2022. All rights reserved. See LICENSE.txt in the project root for license information.
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-api-vanilla
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Thaddée Tyl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies: []
 description: Given a JSON API string, we parse it and return a document that can be
   browsed — as if the objects defined in the file were plain old Ruby objects.
@@ -18,15 +18,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ContributorAgreement.txt
 - Gemfile
 - LICENSE.txt
 - Makefile
 - NOTICE.txt
 - README.md
 - Rakefile
-- contributors/TadasTamosauskas.txt
 - json-api-vanilla.gemspec
 - lib/json-api-vanilla.rb
 - lib/json-api-vanilla/parser.rb
@@ -38,7 +37,7 @@ homepage: http://github.com/trainline/json-api-vanilla
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,9 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Deserialize JSON API formats into vanilla Ruby objects.
 test_files: []

data/ContributorAgreement.txt

@@ -1,17 +0,0 @@
-Contributor Agreement
-Thank you for your interest in Trainline.  In order to clarify the intellectual property license granted with code contributions from any person or entity, Trainline.com Limited ("Trainline") requires a Contributor License Agreement on file that has been signed by each contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Trainline and its users; it does not change your rights to use your own contributions for any other purpose.
-Please send confirmation that you accept the terms set out below to osscontribs@thetrainline.com. Please read the terms carefully before accepting  and keep a copy for your records.
-You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Trainline. Except for the license granted herein to Trainline and recipients of software distributed by Trainline, You reserve all right, title, and interest in and to Your Contributions.
-
-1. Definitions.
-"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Trainline. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty per cent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Trainline for inclusion in, or documentation of, any of the products owned or managed by Trainline (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Trainline or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Trainline for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
-2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Trainline and to recipients of software distributed by Trainline a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
-3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Trainline and to recipients of software distributed by Trainline a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
-4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Trainline, or that your employer has executed a separate agreement with Trainline.
-5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others).  You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
-6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
-7. Should You wish to submit work that is not Your original creation, You may submit it to Trainline separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
-8. You agree to notify Trainline of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
-
-Please sign: __________________________________ Date: ________________

data/contributors/TadasTamosauskas.txt

@@ -1,18 +0,0 @@
-Contributor Agreement
-Thank you for your interest in Trainline.  In order to clarify the intellectual property license granted with code contributions from any person or entity, Trainline.com Limited ("Trainline") requires a Contributor License Agreement on file that has been signed by each contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Trainline and its users; it does not change your rights to use your own contributions for any other purpose.
-Please send confirmation that you accept the terms set out below to osscontribs@thetrainline.com. Please read the terms carefully before accepting  and keep a copy for your records.
-You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Trainline. Except for the license granted herein to Trainline and recipients of software distributed by Trainline, You reserve all right, title, and interest in and to Your Contributions.
-
-1. Definitions.
-"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Trainline. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty per cent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Trainline for inclusion in, or documentation of, any of the products owned or managed by Trainline (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Trainline or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Trainline for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
-2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Trainline and to recipients of software distributed by Trainline a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
-3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Trainline and to recipients of software distributed by Trainline a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
-4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Trainline, or that your employer has executed a separate agreement with Trainline.
-5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others).  You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
-6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
-7. Should You wish to submit work that is not Your original creation, You may submit it to Trainline separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
-8. You agree to notify Trainline of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
-
-Please sign: Tadas Tamošauskas
-Date: 2016-10-06