ivy-serializers 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cc58ca39399bdcc72ecb47fd0aeecac296be43
-  data.tar.gz: ad5208023b028606b093a3056added2c7574ba82
+  metadata.gz: c4f730c6f599627a61aa2d51d349ac7bfa0b893a
+  data.tar.gz: e2b0e59978d005a5ffc7decb845f8d782965d061
 SHA512:
-  metadata.gz: 329051d45ee2fbbd118e992ffcd83e69fcac05128e96606ba2fdd64e53ee1b2b74ad75649d1c48c32fddd83fa04c121706b6f0b79b15eb67171f34e368f0cb12
-  data.tar.gz: 6a6540f204ccb754c0c0846924708e4ee0a5caed80827ef1abcea481176c4d7f2a8a3f8c44ed9f45deb93f203d7b450b3098fde5ab003029a75f9445b998880e
+  metadata.gz: eb1814bce93d75c634a8ef055c7ea494c5d665a379a3ba0abcf790b0aece91b2f8b8dc68ed12f330c4aca260de48b3f55d49659362d589eaae91fc23a8909ae6
+  data.tar.gz: 4aee5deab59fcf959d77f46fb9c8cd928c78c6d6fbaaa699b67e4a40fd9bcf33055c16c4bb8b2f5f95ce9b0bf789d9d280eeae086628e643fa61582a5921a01a

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 
 rvm:
-  - 2.2.2
-  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
 
 cache: bundler
 

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# ivy-serializers
+
+See [changes since release][HEAD]
+
+## [0.4.0][] / 2016-11-12
+
+* Drop Ruby 1.9 support.
+* Remove `activesupport` dependency in favor of `inflecto`.
+* Change `included` into an array, per the JSON-API spec.
+
+## [0.3.0][] / 2015-06-05
+
+* Gracefully handle `nil` in belongs-to relationships.
+* Update JSON-API format for 1.0.
+* Always include an `id` attribute for all resources, per JSON-API spec.
+
+## [0.2.0][] / 2015-05-05
+
+* Fixes a bug where the JSON-API format wouldn't use the `:data` key as the
+  top-level when rendering a collection, and ensures that the
+  `ActiveModel::Serializers` format uses a singular key when rendering an
+  individual resource.
+* Extract Rails integration into [ivy-serializers-rails][].
+
+## [0.1.0][] / 2015-05-01
+
+* Initial release.
+
+[0.1.0]: https://github.com/IvyApp/ivy-serializers/tree/v0.1.0
+[0.2.0]: https://github.com/IvyApp/ivy-serializers/compare/v0.1.0...v0.2.0
+[0.3.0]: https://github.com/IvyApp/ivy-serializers/compare/v0.2.0...v0.3.0
+[0.4.0]: https://github.com/IvyApp/ivy-serializers/compare/v0.3.0...v0.4.0
+[HEAD]: https://github.com/IvyApp/ivy-serializers/compare/v0.4.0...master
+[ivy-serializers-rails]: https://github.com/IvyApp/ivy-serializers-rails

data/ivy-serializers.gemspec

@@ -14,11 +14,12 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 2.2.1'
   spec.add_dependency 'hash_generator', '~> 1.1'
+  spec.add_dependency 'inflecto', '~> 0.0.2'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'json-schema-rspec', '~> 0.0.4'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
 end

data/lib/ivy/serializers/documents/document.rb

@@ -28,7 +28,7 @@ module Ivy
         end
 
         def generate_included_resources(generator)
-          @included_resources.each_pair { |klass, resources| generator.included_resources(klass, resources) }
+          generator.included_resources(@included_resources)
         end
 
         def generate_relationships(generator, resource)

data/lib/ivy/serializers/formats/active_model_serializers.rb

@@ -1,4 +1,4 @@
-require 'active_support/inflector'
+require 'inflecto'
 require 'ivy/serializers/formats/json'
 
 module Ivy
@@ -41,7 +41,7 @@ module Ivy
         end
 
         def singularize(name)
-          ActiveSupport::Inflector.singularize(name.to_s)
+          Inflecto.singularize(name.to_s)
         end
       end
     end

data/lib/ivy/serializers/formats/json.rb

@@ -1,5 +1,5 @@
-require 'active_support/inflector'
 require 'hash_generator'
+require 'inflecto'
 
 module Ivy
   module Serializers
@@ -48,9 +48,11 @@ module Ivy
           document.generate_included_resources(self)
         end
 
-        def included_resources(resource_class, resources)
-          key = key_for_collection(resource_class).to_sym
-          @hash_gen.store_array(key) { resources(resources) }
+        def included_resources(included_resources)
+          included_resources.each_pair do |resource_class, resources|
+            key = key_for_collection(resource_class).to_sym
+            @hash_gen.store_array(key) { resources(resources) }
+          end
         end
 
         def primary_resource(primary_resource_name, primary_resource)
@@ -85,15 +87,15 @@ module Ivy
         end
 
         def extract_type(resource)
-          ActiveSupport::Inflector.dasherize(key_for_individual(resource.class))
+          Inflecto.dasherize(key_for_individual(resource.class))
         end
 
         def key_for_collection(resource_class)
-          ActiveSupport::Inflector.pluralize(key_for_individual(resource_class))
+          Inflecto.pluralize(key_for_individual(resource_class))
         end
 
         def key_for_individual(resource_class)
-          ActiveSupport::Inflector.underscore(resource_class.name)
+          Inflecto.underscore(resource_class.name)
         end
       end
     end

data/lib/ivy/serializers/formats/json_api.rb

@@ -21,7 +21,11 @@ module Ivy
         end
 
         def included(document)
-          @hash_gen.store_object(:included) { super }
+          @hash_gen.store_array(:included) { super }
+        end
+
+        def included_resources(included_resources)
+          included_resources.each_value { |resources| resources(resources) }
         end
 
         def primary_resource(primary_resource_name, primary_resource)

data/lib/ivy/serializers/mapping.rb

@@ -5,13 +5,13 @@ module Ivy
   module Serializers
     class Mapping
       def initialize(klass)
-        @attrs = {}
+        @attributes = {}
         @relationships = {}
         @klass = klass
       end
 
       def attribute(name, &block)
-        @attrs[name] = Attribute.new(name, &block)
+        @attributes[name] = Attribute.new(name, &block)
       end
 
       def attributes(*names)
@@ -23,7 +23,7 @@ module Ivy
       end
 
       def generate_attributes(generator, resource)
-        @attrs.each_value { |attr| attr.generate(generator, resource) }
+        @attributes.each_value { |attribute| attribute.generate(generator, resource) }
       end
 
       def has_many(name, options={}, &block)
@@ -35,7 +35,7 @@ module Ivy
       end
 
       def resource(generator, resource)
-        generator.attributes(resource) unless @attrs.empty?
+        generator.attributes(resource) unless @attributes.empty?
         generator.relationships(resource) unless @relationships.empty?
       end
     end

data/lib/ivy/serializers/version.rb

@@ -1,5 +1,5 @@
 module Ivy
   module Serializers
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/spec/integration/formats/json_api_spec.rb

@@ -16,6 +16,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
       context 'for an individual resource' do
         let(:resource) { post }
 
+        it { should match_json_schema(:json_api) }
+
         it { should eq({
           :data => {
             :type => 'post',
@@ -27,6 +29,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
       context 'for a resource collection' do
         let(:resource) { [post] }
 
+        it { should match_json_schema(:json_api) }
+
         it { should eq({
           :data => [{
             :type => 'post',
@@ -50,6 +54,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -64,6 +70,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -86,6 +94,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -100,6 +110,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -129,6 +141,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -144,6 +158,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
           context 'with no related resource' do
             let(:author) { nil }
 
+            it { should match_json_schema(:json_api) }
+
             it { should eq({
               :data => {
                 :type => 'post',
@@ -159,6 +175,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -183,6 +201,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -198,6 +218,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
           context 'with no related resource' do
             let(:author) { nil }
 
+            it { should match_json_schema(:json_api) }
+
             it { should eq({
               :data => {
                 :type => 'post',
@@ -213,6 +235,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -237,6 +261,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -248,17 +274,17 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
               }
             },
 
-            :included => {
-              :authors => [{
-                :id => '1',
-                :type => 'author'
-              }]
-            }
+            :included => [{
+              :id => '1',
+              :type => 'author'
+            }]
           }) }
 
           context 'with no related resource' do
             let(:author) { nil }
 
+            it { should match_json_schema(:json_api) }
+
             it { should eq({
               :data => {
                 :type => 'post',
@@ -274,6 +300,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -285,12 +313,10 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
               }
             }],
 
-            :included => {
-              :authors => [{
-                :id => '1',
-                :type => 'author'
-              }]
-            }
+            :included => [{
+              :id => '1',
+              :type => 'author'
+            }]
           }) }
         end
       end
@@ -305,6 +331,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -320,6 +348,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
           context 'with no related resource' do
             let(:author) { nil }
 
+            it { should match_json_schema(:json_api) }
+
             it { should eq({
               :data => {
                 :type => 'post',
@@ -335,6 +365,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -366,6 +398,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -382,6 +416,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -406,6 +442,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -422,6 +460,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -446,6 +486,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -457,18 +499,18 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
               }
             },
 
-            :included => {
-              :comments => [{
-                :type => 'comment',
-                :id => '1'
-              }]
-            }
+            :included => [{
+              :type => 'comment',
+              :id => '1'
+            }]
           }) }
         end
 
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',
@@ -480,12 +522,10 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
               }
             }],
 
-            :included => {
-              :comments => [{
-                :type => 'comment',
-                :id => '1'
-              }]
-            }
+            :included => [{
+              :type => 'comment',
+              :id => '1'
+            }]
           }) }
         end
       end
@@ -500,6 +540,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for an individual resource' do
           let(:resource) { post }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => {
               :type => 'post',
@@ -516,6 +558,8 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         context 'for a resource collection' do
           let(:resource) { [post] }
 
+          it { should match_json_schema(:json_api) }
+
           it { should eq({
             :data => [{
               :type => 'post',

data/spec/schemas/json_api.json

@@ -0,0 +1,375 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "JSON API Schema",
+  "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
+  "oneOf": [
+    {
+      "$ref": "#/definitions/success"
+    },
+    {
+      "$ref": "#/definitions/failure"
+    },
+    {
+      "$ref": "#/definitions/info"
+    }
+  ],
+
+  "definitions": {
+    "success": {
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/data"
+        },
+        "included": {
+          "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/resource"
+          },
+          "uniqueItems": true
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "links": {
+          "description": "Link members related to the primary data.",
+          "allOf": [
+            {
+              "$ref": "#/definitions/links"
+            },
+            {
+              "$ref": "#/definitions/pagination"
+            }
+          ]
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+    "failure": {
+      "type": "object",
+      "required": [
+        "errors"
+      ],
+      "properties": {
+        "errors": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/error"
+          },
+          "uniqueItems": true
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+    "info": {
+      "type": "object",
+      "required": [
+        "meta"
+      ],
+      "properties": {
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "meta": {
+      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
+      "type": "object",
+      "additionalProperties": true
+    },
+    "data": {
+      "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/resource"
+        },
+        {
+          "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/resource"
+          },
+          "uniqueItems": true
+        },
+        {
+          "description": "null if the request is one that might correspond to a single resource, but doesn't currently.",
+          "type": "null"
+        }
+      ]
+    },
+    "resource": {
+      "description": "\"Resource objects\" appear in a JSON API document to represent resources.",
+      "type": "object",
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "attributes": {
+          "$ref": "#/definitions/attributes"
+        },
+        "relationships": {
+          "$ref": "#/definitions/relationships"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "links": {
+      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
+      "type": "object",
+      "properties": {
+        "self": {
+          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
+          "type": "string",
+          "format": "uri"
+        },
+        "related": {
+          "$ref": "#/definitions/link"
+        }
+      },
+      "additionalProperties": true
+    },
+    "link": {
+      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
+      "oneOf": [
+        {
+          "description": "A string containing the link's URL.",
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object",
+          "required": [
+            "href"
+          ],
+          "properties": {
+            "href": {
+              "description": "A string containing the link's URL.",
+              "type": "string",
+              "format": "uri"
+            },
+            "meta": {
+              "$ref": "#/definitions/meta"
+            }
+          }
+        }
+      ]
+    },
+
+    "attributes": {
+      "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
+      "type": "object",
+      "patternProperties": {
+        "^(?!relationships$|links$)\\w[-\\w]*$": {
+          "description": "Attributes may contain any valid JSON value."
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "relationships": {
+      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
+      "type": "object",
+      "patternProperties": {
+        "^\\w[-\\w]*$": {
+          "properties": {
+            "links": {
+              "$ref": "#/definitions/links"
+            },
+            "data": {
+              "description": "Member, whose value represents \"resource linkage\".",
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/relationshipToOne"
+                },
+                {
+                  "$ref": "#/definitions/relationshipToMany"
+                }
+              ]
+            },
+            "meta": {
+              "$ref": "#/definitions/meta"
+            }
+          },
+          "anyOf": [
+            {"required": ["data"]},
+            {"required": ["meta"]},
+            {"required": ["links"]}
+          ],
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "relationshipToOne": {
+      "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/empty"
+        },
+        {
+          "$ref": "#/definitions/linkage"
+        }
+      ]
+    },
+    "relationshipToMany": {
+      "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/linkage"
+      },
+      "uniqueItems": true
+    },
+    "empty": {
+      "description": "Describes an empty to-one relationship.",
+      "type": "null"
+    },
+    "linkage": {
+      "description": "The \"type\" and \"id\" to non-empty members.",
+      "type": "object",
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+    "pagination": {
+      "type": "object",
+      "properties": {
+        "first": {
+          "description": "The first page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "last": {
+          "description": "The last page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "prev": {
+          "description": "The previous page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "next": {
+          "description": "The next page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        }
+      }
+    },
+
+    "jsonapi": {
+      "description": "An object describing the server's implementation",
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "error": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "A unique identifier for this particular occurrence of the problem.",
+          "type": "string"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "status": {
+          "description": "The HTTP status code applicable to this problem, expressed as a string value.",
+          "type": "string"
+        },
+        "code": {
+          "description": "An application-specific error code, expressed as a string value.",
+          "type": "string"
+        },
+        "title": {
+          "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
+          "type": "string"
+        },
+        "detail": {
+          "description": "A human-readable explanation specific to this occurrence of the problem.",
+          "type": "string"
+        },
+        "source": {
+          "type": "object",
+          "properties": {
+            "pointer": {
+              "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
+              "type": "string"
+            },
+            "parameter": {
+              "description": "A string indicating which query parameter caused the error.",
+              "type": "string"
+            }
+          }
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'simplecov'
 
 SimpleCov.start
 
+require 'json-schema-rspec'
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
@@ -21,6 +23,13 @@ SimpleCov.start
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  config.include JSON::SchemaMatchers
+
+  # Load schema files into config.json_schemas.
+  Dir[File.join(File.expand_path('../schemas', __FILE__), '**', '*.json')].each do |file|
+    config.json_schemas[File.basename(file, '.json').to_sym] = file
+  end
+
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
   # assertions if you prefer.

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ivy-serializers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dray Lacy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2016-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: hash_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: hash_generator
+  name: inflecto
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json-schema-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
 description: 
 email:
 - dray@envylabs.com
@@ -104,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -132,6 +147,7 @@ files:
 - spec/integration/formats/json_api_spec.rb
 - spec/integration/formats/json_spec.rb
 - spec/integration/serializer_spec.rb
+- spec/schemas/json_api.json
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -153,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: JSON serialization for client-side apps.
@@ -162,4 +178,5 @@ test_files:
 - spec/integration/formats/json_api_spec.rb
 - spec/integration/formats/json_spec.rb
 - spec/integration/serializer_spec.rb
+- spec/schemas/json_api.json
 - spec/spec_helper.rb