json_api_conformant 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4634ddceab8a179d9c13de30a94cf8592db96bf9
-  data.tar.gz: 66ca7f6573f8bb44f5badf9dd29dda5de8593bd9
+  metadata.gz: fc3bcb951985dd2a665cdb84f7b1c6ce2c539b86
+  data.tar.gz: 88e96d8554af56e995f8b3dca3161473209e31c5
 SHA512:
-  metadata.gz: f5a94c9cad6f10c1c64d5e5c28e32a249b366b83a27264d6e1522056808eb5a2c68f2cfb050aaf853a7012f67c5644f82eca6d74a02636f827c07bc70d111997
-  data.tar.gz: 0e09e145ab952ac4eab546015bf4d3cc61397e460838a773a21f18ef4f430f00ed4c630fa9d2ce7f2df5beeda1415cd90571683bf8337eeb334fa76397271acb
+  metadata.gz: 7808472e832d55a99c7daade9c44a370a66f443bf353b775d60a53781e86e41ea6f764473f91c288c359403f16eb90e2d819adfc3ab3364e7dc8e84a737e3b9b
+  data.tar.gz: 3749fa0fc26839e391630fc0d61e4e506036b1441dfa2f42474f64cf039d5a8b34961d0595eb0d519b0a688aed9e3c6d7a176f7ffb3f89b57ffe0116c5a750b1

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,12 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.4.1
   - ruby-head
-  - jruby-1.7.9 
-  - jruby-head
-  - rbx-2.2.7
-matrix:
-  allow_failures:
-    - rvm: jruby-head

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, sexual identity and
+orientation, or sexual proclivities between consenting adults.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project maintainer at [sebasoga@gmail.com]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4.1,
+available at [http://contributor-covenant.org/version/1/4/1][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Sebastian Sogamoso
+Copyright (c) 2017 Sebastian Sogamoso
 
 MIT License
 

data/README.md

@@ -2,19 +2,19 @@
 [![Build Status](https://travis-ci.org/sebasoga/json_api_conformant.svg?branch=master)](https://travis-ci.org/sebasoga/json_api_conformant)
 [![Code Climate](https://codeclimate.com/github/sebasoga/json_api_conformant/badges/gpa.svg)](https://codeclimate.com/github/sebasoga/json_api_conformant)
 
-When building an API in JSON it is important to follow conventions for the so 
-that your system clients know how to send a request for the available resources 
-to be fetched or modified and how your system will respond to those requests.
+When building an API in JSON it is important to follow conventions so that the
+clients know how what to expect in the response when operating on the available
+resources.
 
-JSON API Conformant provides a narrow interface for validating JSON objects 
-against a [JSON API](http://jsonapi.org/) conforming 
-[JSON API schema](http://jsonapi.org/schema) and provides a custom RSpec 
+JSON API Conformant provides a narrow interface for validating JSON objects
+against the [JSON API specification](http://jsonapi.org/) using
+[the official schema](http://jsonapi.org/schema) and provides a custom RSpec
 matcher for use in your tests.
 
-**Important:** JSON API is a work in progress. The base schema is not a perfect 
-document. The fact that a JSON document validates against this schema, it does 
-not necessarily mean it is a valid JSON API document. The schema is provided by 
-JSON API for a base level sanity check.
+**Important:** Currently v1.0 specification is used as the default base schema.
+The base schema is not a perfect document. The fact that a JSON document
+validates against this schema, it does not necessarily mean it is a valid JSON
+API document. The schema is provided by JSON API for a base level sanity check.
 
 ## Installation
 
@@ -36,8 +36,8 @@ Or install it yourself as:
 
 Validate if your JSON object is JSON API conformant.
 ```ruby
-valid_schema   = {"posts" => [{"id" => "1"}]}
-invalid_schema = {"comments" => "Nice gem!"}
+valid_schema   = { "data" => [{ "type" => "posts", "id" => "1" }] }
+invalid_schema = { "data" => [{ "posts" => "1" }] }
 
 JSON::API::Conformant.valid?(valid_schema)        # => true
 JSON::API::Conformant.valid?(invalid_schema)      # => false
@@ -45,30 +45,30 @@ JSON::API::Conformant.valid?(invalid_schema)      # => false
 
 Get errors when your JSON object is JSON API not conformant.
 ```ruby
-valid_schema   = {"posts" => [{"id" => "1"}]}
-invalid_schema = {"comments" => "Nice gem!"}
+valid_schema   = { "data" => [{ "type" => "posts", "id" => "1" }] }
+invalid_schema = { "data" => [{ "posts" => "1" }] }
 
 JSON::API::Conformant.validate(valid_schema)      # => []
-JSON::API::Conformant.validate(invalid_schema)    # => ["The property '#/comments' of type String did not match the..."]
+JSON::API::Conformant.validate(invalid_schema)    # => ["The property '#/' of type object did not match any of the..."]
 ```
 
-JSON API Conformant wraps [json-schema](https://github.com/hoxworth/json-schema), 
+JSON API Conformant wraps [json-schema](https://github.com/hoxworth/json-schema),
 so other options that validator accepts will work here too.
 ```ruby
-schema = {"posts" => [{"id" => "1"}]}
+schema = { "data" => [{ "posts" => "1" }] }
 
-JSON::API::Conformant.valid?(valid_schema, insert_defaults: true)
-JSON::API::Conformant.validate(valid_schema, errors_as_objects: true)
+JSON::API::Conformant.valid?(schema, insert_defaults: true)
+JSON::API::Conformant.validate(schema, errors_as_objects: true)
 ```
 
 
 ### RSpec Matcher
-Only tested with RSpec 3.
+Only tested for RSpec 3.
 
 It is pretty straighword to use.
 ```ruby
 it "validates that's JSON API conformant" do
-  data = {"posts" => [{"id" => "1"}]}
+  data = { "data" => [{ "posts" => "1" }] }
   expect(data).to be_json_api_conformant
 end
 ```
@@ -82,6 +82,9 @@ end
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
+Everyone interacting in this codebase and issue tracker is expected to follow
+the [code of conduct](https://github.com/sebasoga/json_api_conformant/blob/master/CODE_OF_CONDUCT.md).
+
 ## License
 
 See [LICENSE](https://github.com/sebasoga/json_api_conformant/blob/master/LICENSE.txt)

data/json_api_conformant.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "json-schema", "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_dependency "rspec", "~> 3.5"
+  spec.add_dependency "json-schema", "~> 2.8"
 end

data/lib/json_api_conformant/conformant.rb

@@ -3,15 +3,15 @@ require 'json-schema'
 module JSON
   module API
     class Conformant
-      SCHEMA_VERSION = 'draft'
+      DEFAULT_SCHEMA_VERSION = '1.0'
 
       class << self
-        def valid?(data, options={})
-          validator.validate(schema, data, options)
+        def valid?(data, version: DEFAULT_SCHEMA_VERSION, **options)
+          validator.validate(schema(version), data, options)
         end
 
-        def validate(data, options={})
-          validator.fully_validate(schema, data, options)
+        def validate(data, version: DEFAULT_SCHEMA_VERSION, **options)
+          validator.fully_validate(schema(version), data, options)
         end
 
         private
@@ -20,10 +20,10 @@ module JSON
           JSON::Validator
         end
 
-        def schema
+        def schema(version)
           File.join(Pathname.new(File.dirname(__FILE__)).parent.parent,
                                  'schemas',
-                                 "#{SCHEMA_VERSION}.json"
+                                 "#{version}.json"
                    )
         end
       end

data/lib/json_api_conformant/version.rb

@@ -1,7 +1,7 @@
 module JSON
   module API
     class Conformant
-      VERSION = "0.0.2"
+      VERSION = "1.0.0"
     end
   end
 end

data/schemas/1.0.json

@@ -0,0 +1,370 @@
+{
+  "$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"
+            }
+          },
+          "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/fixtures/invalid.json

@@ -1,24 +1,46 @@
 {
   "links": {
-    "posts.author": {
-      "link": "http://example.com/people/{posts.author}"
-    }
+    "self": "http://example.com/articles",
+    "next": "http://example.com/articles?page[offset]=2",
+    "last": "http://example.com/articles?page[offset]=10"
   },
-  "posts": [{
-    "title": "Rails is Omakase",
-    "links": {
-      "comments": [ "1", "2", "3" ]
-    }}, {
-    "id": "3",
-    "title": "Dependency Injection is Not a Virtue",
+  "data": [{
+    "type": "articles",
+    "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": {
-      "author": "9",
-      "comments": "6"
+      "self": "http://example.com/articles/1"
     }
   }],
-  "linked": {
-    "people": [{
-      "name": "@d2h"
-    }]
-  }
+  "included": [{
+    "type": "people",
+    "attributes": {
+      "first-name": "Dan",
+      "last-name": "Gebhardt",
+      "twitter": "dgeb"
+    },
+    "links": {
+      "self": "http://example.com/people/9"
+    }
+  }]
 }

data/spec/fixtures/valid.json

@@ -1,57 +1,76 @@
 {
   "links": {
-    "posts.author": {
-      "href": "http://example.com/people/{posts.author}",
-      "type": "people"
-    },
-    "posts.comments": {
-      "href": "http://example.com/comments/{posts.comments}",
-      "type": "comments"
-    }
+    "self": "http://example.com/articles",
+    "next": "http://example.com/articles?page[offset]=2",
+    "last": "http://example.com/articles?page[offset]=10"
   },
-  "posts": [{
+  "data": [{
+    "type": "articles",
     "id": "1",
-    "title": "Rails is Omakase",
+    "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": {
-      "author": "9",
-      "comments": [ "1", "2", "3" ]
-    }}, {
-    "id": "2",
-    "title": "The Parley Letter",
+      "self": "http://example.com/articles/1"
+    }
+  }],
+  "included": [{
+    "type": "people",
+    "id": "9",
+    "attributes": {
+      "first-name": "Dan",
+      "last-name": "Gebhardt",
+      "twitter": "dgeb"
+    },
     "links": {
-      "author": "9",
-      "comments": [ "4", "5" ]
-   }}, {
-    "id": "3",
-    "title": "Dependency Injection is Not a Virtue",
+      "self": "http://example.com/people/9"
+    }
+  }, {
+    "type": "comments",
+    "id": "5",
+    "attributes": {
+      "body": "First!"
+    },
+    "relationships": {
+      "author": {
+        "data": { "type": "people", "id": "2" }
+      }
+    },
     "links": {
-      "author": "9",
-      "comments": [ "6" ]
+      "self": "http://example.com/comments/5"
     }
-  }],
-  "linked": {
-    "people": [{
-      "id": "9",
-      "name": "@d2h"
-    }],
-    "comments": [{
-      "id": "1",
-      "body": "Mmmmmakase"
-    }, {
-      "id": "2",
-      "body": "I prefer unagi"
-    }, {
-      "id": "3",
-      "body": "What's Omakase?"
-    }, {
-      "id": "4",
-      "body": "Parley is a discussion, especially one between enemies"
-    }, {
-      "id": "5",
-      "body": "The parsley letter"
-    }, {
-      "id": "6",
-      "body": "Dependency Injection is Not a Vice"
-    }]
-  }
+  }, {
+    "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/json_api_conformant/conformant_spec.rb

@@ -7,7 +7,7 @@ describe JSON::API::Conformant do
 
   subject { JSON::API::Conformant }
 
-  describe ".validate" do
+  describe ".valid?" do
     context "when data is valid" do
       it "is true" do
         expect(subject.valid? valid_data).to be true
@@ -19,6 +19,18 @@ describe JSON::API::Conformant do
         expect(subject.valid? invalid_data).to be false
       end
     end
+
+    describe "version" do
+      it "defaults to draft" do
+        expect(subject).to receive(:schema).with("1.0").and_call_original
+        subject.validate({})
+      end
+
+      it "can be overridden" do
+        expect(subject).to receive(:schema).with("draft").and_call_original
+        subject.validate({}, version: "draft")
+      end
+    end
   end
 
   describe ".validate" do
@@ -30,11 +42,47 @@ describe JSON::API::Conformant do
 
     context "when data is invalid" do
       it "returns an array with the errors" do
-        errors = [
-          "The property '#/posts/0' did not contain a required property of 'id' in schema http://jsonapi.org/schema#",
-          "The property '#/linked/people/0' did not contain a required property of 'id' in schema http://jsonapi.org/schema#"]
+        errors = [<<ERROR.chomp]
+The property '#/' of type object did not match any of the required schemas. The schema specific errors were:
+
+- oneOf #0:
+    - The property '#/included/0' did not contain a required property of 'id'
+    -     The property '#/data' of type array did not match any of the required schemas. The schema specific errors were:
+
+    - oneOf #0:
+        - The property '#/data' of type array did not match the following type: object
+    - oneOf #1:
+        - The property '#/data/0' did not contain a required property of 'id'
+    - oneOf #2:
+        - The property '#/data' of type array did not match the following type: null
+- oneOf #1:
+    - The property '#/' contains additional properties ["links", "data", "included"] outside of the schema when none are allowed
+    - The property '#/' did not contain a required property of 'errors'
+- oneOf #2:
+    - The property '#/' contains additional properties ["data", "included"] outside of the schema when none are allowed
+    - The property '#/' did not contain a required property of 'meta'
+ERROR
         expect(subject.validate invalid_data).to eq errors
       end
     end
+
+    describe "version" do
+      it "defaults to draft" do
+        expect(subject).to receive(:schema).with("1.0").and_call_original
+        subject.validate({})
+      end
+
+      it "can be overridden" do
+        expect(subject).to receive(:schema).with("draft").and_call_original
+        subject.validate({}, version: "draft")
+      end
+    end
+  end
+
+  describe "#schema" do
+    it "allows version to be specified" do
+      expect(subject.send(:schema, "1.0")).to end_with "1.0.json"
+      expect(subject.send(:schema, "draft")).to end_with "draft.json"
+    end
   end
 end

data/spec/json_api_conformant/matchers/rspec_spec.rb

@@ -27,9 +27,27 @@ RSpec.describe "be_json_api_conformant matcher" do
 
     it "returns the correct message when the test fails" do
       json = parse_fixture('invalid')
-      expected_message = ["Expected data to be JSON API conformant:",
-                          "The property '#/posts/0' did not contain a required property of 'id' in schema http://jsonapi.org/schema#",
-                          "The property '#/linked/people/0' did not contain a required property of 'id' in schema http://jsonapi.org/schema#"]
+      expected_message = [<<-ERROR.chomp]
+Expected data to be JSON API conformant:
+* The property '#/' of type object did not match any of the required schemas. The schema specific errors were:
+
+- oneOf #0:
+    - The property '#/included/0' did not contain a required property of 'id'
+    -     The property '#/data' of type array did not match any of the required schemas. The schema specific errors were:
+
+    - oneOf #0:
+        - The property '#/data' of type array did not match the following type: object
+    - oneOf #1:
+        - The property '#/data/0' did not contain a required property of 'id'
+    - oneOf #2:
+        - The property '#/data' of type array did not match the following type: null
+- oneOf #1:
+    - The property '#/' contains additional properties ["links", "data", "included"] outside of the schema when none are allowed
+    - The property '#/' did not contain a required property of 'errors'
+- oneOf #2:
+    - The property '#/' contains additional properties ["data", "included"] outside of the schema when none are allowed
+    - The property '#/' did not contain a required property of 'meta'
+ERROR
       begin
         expect(json).to be_json_api_conformant
       rescue RSpec::Expectations::ExpectationNotMetError => e

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: json_api_conformant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Sebastian Sogamoso
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: '1.14'
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '12.0'
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '3.5'
+  name: rspec
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
+        version: '2.8'
+  name: json-schema
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
 description: Interface for validating JSON objects against a JSON API schema.
 email:
 - sebasoga@gmail.com
@@ -74,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,6 +86,7 @@ files:
 - lib/json_api_conformant/conformant.rb
 - lib/json_api_conformant/matchers/rspec.rb
 - lib/json_api_conformant/version.rb
+- schemas/1.0.json
 - schemas/draft.json
 - spec/fixtures/invalid.json
 - spec/fixtures/valid.json
@@ -95,7 +98,7 @@ homepage: https://github.com/sebasoga/json_api_conformant
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,9 +113,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.8
+signing_key:
 specification_version: 4
 summary: Ruby JSON API validator.
 test_files:
@@ -122,4 +125,3 @@ test_files:
 - spec/json_api_conformant/matchers/rspec_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_parser.rb
-has_rdoc: