json_api_conformant 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92291efde255c5c90b95e15c05e83bf78847cfaf
+  data.tar.gz: af194f8d29d1c213ed446298e78530ee65edfa6c
+SHA512:
+  metadata.gz: a1ad1aea511b450f83e5b761b5dc2fb55a1f493e73fa9e3fbd9b3bb72875214b6287e49d782462a77a18bb027cf05c485ce26f723597a9519ef82064378d5f49
+  data.tar.gz: 50d9dbc0363d0f0619b619fa8bc210ccfb69463c3ce759e0f75e61d739de5bf00f259c630453afc4f7c6af891f89e70daf940f2950b9a90eaa42b827f1b56f02

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_api_conformant.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sebastian Sogamoso
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# 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.
+
+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 
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_conformant'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_conformant
+
+## Usage
+
+Validate if your JSON object is JSON API conformant.
+```ruby
+valid_schema   = {"posts" => [{"id" => "1"}]}
+invalid_schema = {"comments" => "Nice gem!"}
+
+JSON::API::Conformant.valid?(valid_schema)        # => true
+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!"}
+
+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 wraps [json-schema](https://github.com/hoxworth/json-schema, 
+so other options that validator accepts will work here too.
+
+### RSpec Matcher
+
+It is pretty straighword to use.
+```ruby
+it "..." do
+  data = {"posts" => [{"id" => "1"}]}
+
+  expect(data).to be_json_api_conformant
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/json_api_conformant/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the test suite (`rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+See [LICENSE](https://github.com/sebasoga/json_api_conformant/blob/master/LICENSE.txt)
+for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/json_api_conformant.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_conformant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_conformant"
+  spec.version       = JSON::API::Conformant::VERSION
+  spec.authors       = ["Sebastian Sogamoso"]
+  spec.email         = ["sebasoga@gmail.com"]
+  spec.summary       = %q{Ruby JSON API validator.}
+  spec.description   = %q{Interface for validating JSON objects against a JSON API schema.}
+  spec.homepage      = "https://github.com/sebasoga/json_api_conformant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"
+end

data/lib/json_api_conformant/conformant.rb

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

data/lib/json_api_conformant/matchers/rspec.rb

@@ -0,0 +1,32 @@
+require 'rspec/expectations'
+require 'json_api_conformant/conformant'
+
+RSpec::Matchers.define :be_json_api_conformant do
+  match do |data|
+    json_api_conformant? data
+  end
+
+  failure_message do |data|
+    errors = get_errors_in data
+    message_for errors
+  end
+
+  failure_message_when_negated do |data|
+    "Expected data not to be JSON API conformant"
+  end
+
+  private
+
+  def json_api_conformant?(data)
+    JSON::API::Conformant.valid?(data)
+  end
+
+  def get_errors_in(data)
+    JSON::API::Conformant.validate(data)
+  end
+
+  def message_for(errors)
+    error_message = ['Expected data to be JSON API conformant:'] + errors
+    error_message.join("\n* ")
+  end
+end

data/lib/json_api_conformant/version.rb

@@ -0,0 +1,7 @@
+module JSON
+  module API
+    class Conformant
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/json_api_conformant.rb

@@ -0,0 +1,3 @@
+require "json_api_conformant/version"
+require "json_api_conformant/conformant"
+require "json_api_conformant/matchers/rspec"

data/schemas/draft.json

@@ -0,0 +1,40 @@
+{
+  "id": "http://jsonapi.org/schema#",
+  "$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",
+  "type": "object",
+  "resources":{
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+          "id": { "type":["string"] },
+          "href": { "type":"string" },
+          "links": { "type": "object" }
+      },
+      "required": ["id"]
+    }
+  },
+  "patternProperties": {
+    "^(?!href$)(?!links$)(?!id$)(?!meta)(?!linked)": {
+      "$ref":"#/resources"
+    }
+  },
+  "properties": {
+    "meta": {
+      "type": "object"
+    },
+    "links":{
+      "type": "object"
+    },
+    "linked": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "$ref":"#/resources"
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/invalid.json

@@ -0,0 +1,24 @@
+{
+  "links": {
+    "posts.author": {
+      "link": "http://example.com/people/{posts.author}"
+    }
+  },
+  "posts": [{
+    "title": "Rails is Omakase",
+    "links": {
+      "comments": [ "1", "2", "3" ]
+    }}, {
+    "id": "3",
+    "title": "Dependency Injection is Not a Virtue",
+    "links": {
+      "author": "9",
+      "comments": "6"
+    }
+  }],
+  "linked": {
+    "people": [{
+      "name": "@d2h"
+    }]
+  }
+}

data/spec/fixtures/valid.json

@@ -0,0 +1,57 @@
+{
+  "links": {
+    "posts.author": {
+      "href": "http://example.com/people/{posts.author}",
+      "type": "people"
+    },
+    "posts.comments": {
+      "href": "http://example.com/comments/{posts.comments}",
+      "type": "comments"
+    }
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9",
+      "comments": [ "1", "2", "3" ]
+    }}, {
+    "id": "2",
+    "title": "The Parley Letter",
+    "links": {
+      "author": "9",
+      "comments": [ "4", "5" ]
+   }}, {
+    "id": "3",
+    "title": "Dependency Injection is Not a Virtue",
+    "links": {
+      "author": "9",
+      "comments": [ "6" ]
+    }
+  }],
+  "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"
+    }]
+  }
+}

data/spec/json_api_conformant/conformant_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe JSON::API::Conformant do
+
+  let(:valid_data)   { parse_fixture('valid') }
+  let(:invalid_data) { parse_fixture('invalid') }
+
+  subject { JSON::API::Conformant }
+
+  describe ".validate" do
+    context "when data is valid" do
+      it "is true" do
+        expect(subject.valid? valid_data).to be true
+      end
+    end
+
+    context "when data is invalid" do
+      it "is false" do
+        expect(subject.valid? invalid_data).to be false
+      end
+    end
+  end
+
+  describe ".validate" do
+    context "when data is valid" do
+      it "returns an empty array" do
+        expect(subject.validate valid_data).to eq []
+      end
+    end
+
+    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#"]
+        expect(subject.validate invalid_data).to eq errors
+      end
+    end
+  end
+end

data/spec/json_api_conformant/matchers/rspec_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe "be_json_api_conformant matcher" do
+
+  context "when the JSON object is valid" do
+    it "is JSON API conformant" do
+      json = parse_fixture('valid')
+      expect(json).to be_json_api_conformant
+    end
+
+    it "returns the correct message when the test fails" do
+      json = parse_fixture('valid')
+      expected_message = 'Expected data not to be JSON API conformant'
+      begin
+        expect(json).not_to be_json_api_conformant
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+       expect(e.to_s).to eq expected_message
+      end
+    end
+  end
+
+  context "when then JSON object is invalid" do
+    it "is not JSON API conformant" do
+      json = parse_fixture('invalid')
+      expect(json).not_to be_json_api_conformant
+    end
+
+    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#"]
+      begin
+        expect(json).to be_json_api_conformant
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+       expect(e.to_s).to eq expected_message.join("\n* ")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV["env"] ||= "test"
+
+require 'json_api_conformant'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include RSpecHelper
+end

data/spec/support/json_parser.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+module RSpecHelper
+  def parse_fixture(filename)
+    filepath = File.join(Pathname.new(File.dirname(__FILE__)).parent, 'fixtures', "#{filename}.json")
+    file = File.read(filepath)
+    JSON.parse(file)
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: json_api_conformant
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastian Sogamoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Interface for validating JSON objects against a JSON API schema.
+email:
+- sebasoga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_api_conformant.gemspec
+- lib/json_api_conformant.rb
+- lib/json_api_conformant/conformant.rb
+- lib/json_api_conformant/matchers/rspec.rb
+- lib/json_api_conformant/version.rb
+- schemas/draft.json
+- spec/fixtures/invalid.json
+- spec/fixtures/valid.json
+- spec/json_api_conformant/conformant_spec.rb
+- spec/json_api_conformant/matchers/rspec_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_parser.rb
+homepage: https://github.com/sebasoga/json_api_conformant
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby JSON API validator.
+test_files:
+- spec/fixtures/invalid.json
+- spec/fixtures/valid.json
+- spec/json_api_conformant/conformant_spec.rb
+- spec/json_api_conformant/matchers/rspec_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_parser.rb
+has_rdoc: