json-api-vanilla 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5760a75bcea2f2870e2641f246b36bd63ffcdb9
+  data.tar.gz: 8208a9f5cd8089bf6c356e4548c3d22c4ceea73a
+SHA512:
+  metadata.gz: 6c30f227cd52a825173bcfc39ca3f319c9d3796e812542611482e2a29ed65cd4a9427d537453498524891c669abbcfad6d7b5490708784831be17f1bc27062af
+  data.tar.gz: aa5d645da7d059f6bb1f436093b6bb3161174f777b8485eac56e3de5fda5700700f84bc77f40acf14580b25ef155181bb680478f5e766a483ec19ad1b3c9acc6

data/.gitignore

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

data/ContributorAgreement.txt

@@ -0,0 +1,17 @@
+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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Trainline.com Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. 

data/Makefile

@@ -0,0 +1,5 @@
+# Copyright © Trainline Limited, 2016. 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

data/README.md

@@ -0,0 +1,51 @@
+# JSON API *VANILLA*
+
+Deserialize JSON API formats into *vanilla* Ruby objects.
+The simplest JSON API library at all altitudes above Earth centre.
+
+```ruby
+# gem install json-api-vanilla
+require "json-api-vanilla"
+json = IO.read("articles.json")  # From http://jsonapi.org
+doc = JSON::Api::Vanilla.parse(json)
+doc.data[0].comments[1].author.last_name  # "Gebhardt"
+```
+
+Compare with [jsonapi](https://github.com/beauby/jsonapi):
+
+```ruby
+# gem install jsonapi --pre
+require "jsonapi"
+json = IO.read("articles.json")
+doc = JSONAPI.parse(json)
+comment_ref = doc.data[0].relationships.comments.data[1]
+comment = doc.included.select do |obj|
+  obj.type == comment_ref.type && obj.id == comment_ref.id
+end[0]
+author_ref = comment.relationships.author.data
+author = doc.included.select do |obj|
+  obj.type == author_ref.type && obj.id == author_ref.id
+end[0]
+author.attributes['last-name']
+```
+
+# Documentation
+
+`JSON::Api::Vanilla.parse(json_string)` returns a document with the following
+fields:
+
+- `data` is an object corresponding to the JSON API's data object.
+- `errors` is an array containing [errors](http://jsonapi.org/format/#error-objects). Each error is a Hash.
+- `links` is a Hash from objects (obtained from `data`) to their links, as a
+  Hash.
+- `rel_links` is a Hash from objects' relationships (obtained from `data`) to
+  the links defined in that relationship, as a Hash.
+- `meta` is a Hash from objects to their meta information (a Hash).
+- `find('type', 'id')` returns the object with that type and that id.
+- `find_all('type')` returns an Array of all objects with that type.
+- `keys` is a Hash from objects to a Hash from their original field names
+  (non-snake\_case'd) to the corresponding object.
+
+# License
+
+Copyright © Trainline.com Limited. All rights reserved. See LICENSE.txt in the project root for license information.

data/Rakefile

@@ -0,0 +1,10 @@
+# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/contributors/TadasTamosauskas.txt

@@ -0,0 +1,18 @@
+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

data/json-api-vanilla.gemspec

@@ -0,0 +1,16 @@
+# Copyright © Trainline Limited, 2016. 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'
+
+Gem::Specification.new do |s|
+  s.name        = 'json-api-vanilla'
+  s.license     = 'Apache-2.0'
+  s.version     = JSON::Api::Vanilla::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Thaddée Tyl']
+  s.email       = ['thaddee.tyl@gmail.com']
+  s.homepage    = 'http://github.com/trainline/json-api-vanilla'
+  s.summary     = %q{Deserialize JSON API formats into vanilla Ruby objects.}
+  s.description = %q{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.}
+  s.files       = `git ls-files`.split("\n")
+end

data/lib/json-api-vanilla.rb

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

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

@@ -0,0 +1,235 @@
+# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+require "json"
+
+module JSON::Api; end
+module JSON::Api::Vanilla
+  class InvalidRootStructure < StandardError; end
+
+  # Convert a String JSON API payload to vanilla Ruby objects.
+  #
+  # Example:
+  #   >> json = IO.read("articles.json")  # From http://jsonapi.org
+  #   >> doc = JSON::Api::Vanilla.parse(json)
+  #   >> doc.data[0].comments[1].author.last_name
+  #   => "Gebhardt"
+  #
+  # @param json [String] the JSON API payload.
+  # @return [JSON::Api::Vanilla::Document] a wrapper for the objects.
+  def self.parse(json)
+    hash = JSON.parse(json)
+    build(hash)
+  end
+
+  # Convert a ruby hash JSON API representation to vanilla Ruby objects.
+  # Similar to .parse but takes hash as a parameter.
+  #
+  # Example:
+  #   >> hash = { errors: [{ source: { pointer: "" }, detail:  "Missing `data` Member at document's top level." }]}
+  #   >> doc = JSON::Api::Vanilla.build(hash)
+  #   >> doc.errors.first["detail"]
+  #   => "Missing `data` Member at document's top level."
+  #
+  # @param hash [Hash] parsed JSON API payload.
+  # @return [JSON::Api::Vanilla::Document] a wrapper for the objects.
+  def self.build(hash)
+    naive_validate(hash)
+    # Object storage.
+    container = Module.new
+    superclass = Class.new
+
+    data_hash = hash['data']
+    data_hash_array = if data_hash.is_a?(Array)
+      data_hash
+    else
+      [data_hash].compact
+    end
+    obj_hashes = (hash['included'] || []) + data_hash_array
+    errors = hash['errors']
+
+    # Create all the objects.
+    # Store them in the `objects` hash from [type, id] to the object.
+    objects = {}
+    links = {}  # Object links.
+    rel_links = {}  # Relationship links.
+    meta = {}  # Meta information.
+    # Map from objects to map from keys to values, for use when two keys are
+    # converted to the same ruby method identifier.
+    original_keys = {}
+
+    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
+      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|
+          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']]]
+              end
+            else
+              ref = objects[[data['type'], data['id']]]
+            end
+          end
+
+          ref = ref || Object.new
+          set_key(obj, key, ref, original_keys)
+
+          rel_links[ref] = value['links']
+          meta[ref] = value['meta']
+        end
+      end
+    end
+
+    # Create the main object.
+    data = if data_hash.is_a?(Array)
+      data_hash.map do |o_hash|
+        objects[[o_hash['type'], o_hash['id']]]
+      end
+    elsif data_hash
+      objects[[data_hash['type'], data_hash['id']]]
+    end
+    links[data] = hash['links']
+    meta[data] = hash['meta']
+    Document.new(data, links: links, rel_links: rel_links, meta: meta,
+                 objects: objects, keys: original_keys, errors: errors,
+                 container: container, superclass: superclass)
+  end
+
+  def self.prepare_class(hash, superclass, container)
+    name = ruby_class_name(hash['type']).to_sym
+    if container.const_defined?(name)
+      klass = container.const_get(name)
+    else
+      klass = generate_object(name, superclass, container)
+    end
+    add_accessor(klass, 'id')
+    add_accessor(klass, 'type')
+    attr_keys = hash['attributes'] ? hash['attributes'].keys : []
+    rel_keys = hash['relationships'] ? hash['relationships'].keys : []
+    (attr_keys + rel_keys).each do |key|
+      add_accessor(klass, key)
+    end
+    klass
+  end
+
+  def self.generate_object(ruby_name, superclass, container)
+    klass = Class.new(superclass)
+    container.const_set(ruby_name, klass)
+    klass
+  end
+
+  def self.add_accessor(klass, name)
+    ruby_name = ruby_ident_name(name)
+    if !klass.method_defined?(ruby_name)
+      klass.send(:attr_accessor, ruby_name)
+    end
+  end
+
+  # Set a value to an object's key through its setter.
+  # original_keys is a map from objects to a map from String keys to their
+  # values.
+  def self.set_key(obj, key, value, original_keys)
+    ruby_key = ruby_ident_name(key)
+    obj.send("#{ruby_key}=", value)
+    original_keys[obj] ||= {}
+    original_keys[obj][key] = value
+  end
+
+  # Convert a name String to a String that is a valid Ruby class name.
+  def self.ruby_class_name(name)
+    name.scan(/[a-zA-Z_][a-zA-Z_0-9]+/).map(&:capitalize).join
+  end
+
+  # Convert a name String to a String that is a valid snake-case Ruby
+  # identifier.
+  def self.ruby_ident_name(name)
+    name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+       .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+       .tr("-", "_")
+       .downcase
+  end
+
+  # Naïvely validate the top level document structure
+  # @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(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?
+      raise InvalidRootStructure.new("JSON:API document 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
+    # @return [Hash] a map from objects (obtained from .data) to their links,
+    #   as a Hash.
+    attr_reader :links
+    # @return [Hash] a map from objects' relationships (obtained from .data)
+    #   to the links defined in that relationship, as a Hash.
+    attr_reader :rel_links
+    # @return [Hash] a map from objects to their meta information (a Hash).
+    attr_reader :meta
+    # @return [Array] a list of errors, if any, otherwise nil.
+    attr_reader :errors
+    # @return [Hash] a map from objects to a Hash from their original field
+    #   names (non-snake_case'd) to the corresponding object.
+    attr_reader :keys
+    attr_reader :container
+    attr_reader :superclass
+    def initialize(data, links: {}, rel_links: {}, meta: {},
+                   keys: {}, objects: {}, errors: [],
+                   container: Module.new, superclass: Class.new)
+      @data = data
+      @links = links
+      @rel_links = rel_links
+      @meta = meta
+      @keys = keys
+      @objects = objects
+      @errors = errors
+      @container = container
+      @superclass = superclass
+    end
+
+    # Get a JSON API object.
+    #
+    # @param type [String] the type of the object we want returned.
+    # @param id [String] its id.
+    # @return [Object] the object with that type and id.
+    def find(type, id)
+      @objects[[type, id]]
+    end
+
+    # Get all JSON API objects of a given type.
+    #
+    # @param type [String] the type of the objects we want returned.
+    # @return [Array<Object>] the list of objects with that type.
+    def find_all(type)
+      @objects.values.select { |obj| obj.type == type }
+    end
+  end
+end

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

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

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

@@ -0,0 +1,88 @@
+# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+require 'spec_helper'
+
+describe JSON::Api::Vanilla do
+  let(:doc) { JSON::Api::Vanilla.parse(IO.read("#{__dir__}/example.json")) }
+
+  it "should cross arrays and fields of objects" do
+    expect(doc.data[0].comments[1].author.last_name).to eql("Gebhardt")
+  end
+
+  it "should read relationship links" do
+    expect(doc.rel_links[doc.data[0].comments]['related']).to eql("http://example.com/articles/1/comments")
+  end
+
+  it "should read object links" do
+    expect(doc.links[doc.data[0].author]['self']).to eql("http://example.com/people/9")
+  end
+
+  it "should read links at the root" do
+    expect(doc.links[doc.data]['self']).to eql("http://example.com/articles")
+  end
+
+  it "should find objects by type and id" do
+    expect(doc.find('comments', '5').body).to eql("First!")
+  end
+
+  it "should find all objects given a type" do
+    expect(doc.find_all('comments').size).to eql(2)
+  end
+
+  it "should give access to data through the original key" do
+    expect(doc.keys[doc.find('people', '9')]['first-name']).to eql("Dan")
+  end
+
+  it "should give access to meta information" do
+    expect(doc.meta[doc.data]['from']).to eql("http://jsonapi.org")
+  end
+
+  it "should support reference cycles" do
+    json = <<-JSON
+    {
+      "data": {
+        "type": "cycle",
+        "id": "1",
+        "relationships": { "cycle": { "data": { "type": "cycle", "id": "2" } } }
+      },
+      "included": [{
+        "type": "cycle",
+        "id": "2",
+        "attributes": { "body": "content" },
+        "relationships": { "cycle": { "data": { "type": "cycle", "id": "2" } } }
+      }]
+    }
+    JSON
+    doc = JSON::Api::Vanilla.parse(json)
+    expect(doc.data.cycle.cycle.cycle.body).to eql("content")
+  end
+
+  it "should support errors when present" do
+    json = <<-JSON
+    {
+      "errors": [{
+        "status": "400",
+        "detail": "JSON parse error - Expecting property name at line 1 column 2 (char 1)."
+      }]
+    }
+    JSON
+    doc = JSON::Api::Vanilla.parse(json)
+    expect(doc.errors.size).to eql(1)
+    expect(doc.errors.first["status"]).to eql("400")
+    expect(doc.errors.first["detail"]).to eql("JSON parse error - Expecting property name at line 1 column 2 (char 1).")
+  end
+
+  it "should return nil for errors when there are no errors" do
+    expect(doc.errors).to be_nil
+  end
+
+  it "should raise an error if the document does not contain required root elements" do
+    json = <<-JSON
+    {
+      "jsonapi": { "version": "1" }
+    }
+    JSON
+    expect do
+      JSON::Api::Vanilla.parse(json)
+    end.to raise_error(JSON::Api::Vanilla::InvalidRootStructure)
+  end
+end

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

@@ -0,0 +1,79 @@
+{
+  "meta": {
+    "from": "http://jsonapi.org"
+  },
+  "links": {
+    "self": "http://example.com/articles",
+    "next": "http://example.com/articles?page[offset]=2",
+    "last": "http://example.com/articles?page[offset]=10"
+  },
+  "data": [{
+    "type": "articles",
+    "id": "1",
+    "attributes": {
+      "title": "JSON API paints my bikeshed!"
+    },
+    "relationships": {
+      "author": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/author",
+          "related": "http://example.com/articles/1/author"
+        },
+        "data": { "type": "people", "id": "9" }
+      },
+      "comments": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/comments",
+          "related": "http://example.com/articles/1/comments"
+        },
+        "data": [
+          { "type": "comments", "id": "5" },
+          { "type": "comments", "id": "12" }
+        ]
+      }
+    },
+    "links": {
+      "self": "http://example.com/articles/1"
+    }
+  }],
+  "included": [{
+    "type": "people",
+    "id": "9",
+    "attributes": {
+      "first-name": "Dan",
+      "last-name": "Gebhardt",
+      "twitter": "dgeb"
+    },
+    "links": {
+      "self": "http://example.com/people/9"
+    }
+  }, {
+    "type": "comments",
+    "id": "5",
+    "attributes": {
+      "body": "First!"
+    },
+    "relationships": {
+      "author": {
+        "data": { "type": "people", "id": "2" }
+      }
+    },
+    "links": {
+      "self": "http://example.com/comments/5"
+    }
+  }, {
+    "type": "comments",
+    "id": "12",
+    "attributes": {
+      "body": "I like XML better"
+    },
+    "relationships": {
+      "author": {
+        "data": { "type": "people", "id": "9" }
+      }
+    },
+    "links": {
+      "self": "http://example.com/comments/12"
+    }
+  }]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# Copyright © Trainline Limited, 2016. All rights reserved. See LICENSE.txt in the project root for license information.
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'json-api-vanilla'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: json-api-vanilla
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thaddée Tyl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-14 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.
+email:
+- thaddee.tyl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".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
+- lib/json-api-vanilla/version.rb
+- spec/json-api-vanilla/diff_spec.rb
+- spec/json-api-vanilla/example.json
+- spec/spec_helper.rb
+homepage: http://github.com/trainline/json-api-vanilla
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Deserialize JSON API formats into vanilla Ruby objects.
+test_files: []