json-matchers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be6efc3180dbb7fd3f49c438edb2c1d5c096342d
+  data.tar.gz: 1808696767e661d8393224272dd30a7cc5dd9a23
+SHA512:
+  metadata.gz: ed7c67b4b54f84cf64cabe106c54aac6da88fda5432e948e7bf993a8e5caef1aa20fa3a8a151eedc0efff256d6646cb12c4980df3161d1d91b44fe60e40b4c29
+  data.tar.gz: 6575e174274e7be924af6dce791b590d10d6f4fb16d392c24e497afe8c171c7a892f0238cc37f3f1d3261c98ad99d66ebf691221f0312c3132a0e80f23647d33

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.0.0
+- jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sean Doyle
+
+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/NEWS.md

@@ -0,0 +1,5 @@
+# 0.0.1
+
+## Features
+
+* Validate your Rails response JSON with `match_response_schema`

data/README.md

@@ -0,0 +1,123 @@
+# JSON::Matchers
+
+Validate the JSON returned by your Rails JSON APIs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-matchers', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-matchers
+
+## Usage
+
+Inspired by [Validating JSON Schemas with an RSpec Matcher](http://robots.thoughtbot.com/validating-json-schemas-with-an-rspec-matcher)
+
+First, include it in your `spec_helper`:
+
+```ruby
+# spec/spec_helper.rb
+
+require "json/matchers"
+```
+
+Define your [JSON Schema](http://json-schema.org/example1.html) in the schema directory:
+
+```json
+# spec/support/api/schemas/posts.json
+
+{
+  "type": "object",
+  "required": ["posts"],
+  "properties": {
+    "type": "object",
+    "required": ["id", "title", "body"],
+    "properties": {
+      "id": { "type": "integer" },
+      "title": { "type": "string" },
+      "body": { "type": "string" }
+    }
+  }
+}
+```
+
+Then, validate your response against your schema with `match_response_schema`
+
+```ruby
+# spec/requests/posts_spec.rb
+
+describe "GET /posts" do
+  it "returns Posts" do
+    get posts_path, format: :json
+
+    expect(response.status).to eq 200
+    expect(response).to match_response_schema("posts")
+  end
+end
+```
+
+You can even embed schemas inside other schemas!
+
+First, declare the singular version of your schema.
+
+```json
+# spec/support/api/schemas/post.json
+
+{
+  "type": "object",
+  "required": ["id", "title", "body"],
+  "properties": {
+    "id": { "type": "integer" },
+    "title": { "type": "string" },
+    "body": { "type": "string" }
+  }
+}
+```
+
+Then, when you declare your collection schema, embed the singular schema with
+`ERB` and `schema_for`!
+
+```json
+# spec/support/api/schemas/posts.json
+
+{
+  "type": "object",
+  "required": ["posts"],
+  "properties": {
+    "posts": {
+      "type": "array",
+      "items": <%= schema_for("post") %>
+    }
+  }
+}
+```
+
+## Configuration
+
+By default, the schema directory is `spec/support/api/schemas`.
+
+This can be configured via `JSON::Matchers.schema_root`.
+
+
+```ruby
+# spec/support/shoulda-matchers-json.rb
+
+JSON::Matchers.schema_root = "docs/api/schemas"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shoulda-matchers-json/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task(:default).clear
+task default: [:spec]

data/json-matchers.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json/matchers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-matchers"
+  spec.version       = JSON::Matchers::VERSION
+  spec.authors       = ["Sean Doyle"]
+  spec.email         = ["seandoyle@thoughtbot.com"]
+  spec.summary       = %q{Validate your Rails JSON API's JSON}
+  spec.description   = %q{Validate your Rails JSON API's JSON}
+  spec.homepage      = "https://github.com/seanpdoyle/json-matchers"
+  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_dependency("json-schema", ">= 1.2.1")
+  spec.add_dependency("activesupport", '>= 3.0.0')
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails", ">= 2.0"
+end

data/lib/json/matchers.rb

@@ -0,0 +1,24 @@
+require "json/matchers/version"
+require "json/matchers/matcher"
+require "json/matchers/schema_parser"
+require "json/matchers/errors"
+require "active_support/all"
+
+module JSON
+  module Matchers
+    mattr_accessor :schema_root
+
+    self.schema_root = "#{Dir.pwd}/spec/support/api/schemas"
+
+    def match_response_schema(schema_name)
+      schema_parser = SchemaParser.new(schema_root)
+
+      Matcher.new(schema_parser.schema_for(schema_name))
+    end
+    alias match_json_schema match_response_schema
+  end
+end
+
+if defined?(RSpec)
+  require "json/matchers/rspec"
+end

data/lib/json/matchers/errors.rb

@@ -0,0 +1,7 @@
+module JSON
+  module Matchers
+    InvalidError = Class.new(StandardError)
+    DoesNotMatch = Class.new(InvalidError)
+    MissingSchema = Class.new(Errno::ENOENT)
+  end
+end

data/lib/json/matchers/matcher.rb

@@ -0,0 +1,21 @@
+require "json-schema"
+
+module JSON
+  module Matchers
+    Matcher = Struct.new(:schema) do
+      def matches?(response)
+        JSON::Validator.validate!(json_schema, response.body, strict: true)
+      rescue JSON::Schema::ValidationError
+        raise DoesNotMatch, response.body
+      rescue JSON::ParserError
+        raise InvalidError
+      end
+
+      private
+
+      def json_schema
+        JSON.parse(schema)
+      end
+    end
+  end
+end

data/lib/json/matchers/rspec.rb

@@ -0,0 +1,5 @@
+if RSpec.respond_to?(:configure)
+  RSpec.configure do |config|
+    config.include JSON::Matchers
+  end
+end

data/lib/json/matchers/schema_parser.rb

@@ -0,0 +1,22 @@
+module JSON
+  module Matchers
+    class SchemaParser
+
+      attr_reader :schema_path
+
+      def initialize(schema_path)
+        @schema_path = Pathname(schema_path)
+      end
+
+      def schema_for(schema_name)
+        file = schema_path.join("#{schema_name}.json")
+
+        if file.exist?
+          ERB.new(file.read).result(binding)
+        else
+          raise MissingSchema, file.to_s
+        end
+      end
+    end
+  end
+end

data/lib/json/matchers/version.rb

@@ -0,0 +1,5 @@
+module JSON
+  module Matchers
+    VERSION = "0.0.1"
+  end
+end

data/spec/json/matchers/match_response_schema_spec.rb

@@ -0,0 +1,59 @@
+describe JSON::Matchers, "#match_response_schema" do
+  it "fails with an invalid JSON body" do
+    create_schema("foo", "")
+
+    expect {
+      expect(response_for("")).to match_response_schema("foo")
+    }.to raise_error(JSON::Matchers::InvalidError)
+  end
+
+  it "does not fail with an empty JSON body" do
+    create_schema("foo", {})
+
+    expect(response_for({})).to match_response_schema("foo")
+  end
+
+  it "fails when the body is missing a required property" do
+    create_schema("array_schema", {
+      type: "object",
+      required: ["foo"],
+    })
+
+    expect {
+      expect(response_for({})).to match_response_schema("array_schema")
+    }.to raise_error(JSON::Matchers::DoesNotMatch, /{}/)
+  end
+
+  it "fails when the body contains a property with the wrong type" do
+    create_schema("array_schema", {
+      type: "object",
+      properties: {
+        foo: { type: "string" }
+      }
+    })
+
+    expect {
+      expect(response_for({foo: 1})).to match_response_schema("array_schema")
+    }.to raise_error(JSON::Matchers::DoesNotMatch, /{"foo":1}/)
+  end
+
+  it "does not fail when the schema matches" do
+    create_schema("array_schema", {
+      type: "array",
+      items: { type: "string" }
+    })
+
+    expect(response_for(["valid"])).to match_response_schema("array_schema")
+  end
+
+  it "supports ERB" do
+    create_schema "array_schema", <<-JSON.strip_heredoc
+    {
+      "type": "array",
+      "items": <%= { type: "string" }.to_json %>
+    }
+    JSON
+
+    expect(response_for(["valid"])).to match_response_schema("array_schema")
+  end
+end

data/spec/json/matchers/schema_parser_spec.rb

@@ -0,0 +1,68 @@
+require "json/matchers/schema_parser"
+
+describe JSON::Matchers::SchemaParser do
+  describe "#schema_for" do
+    it "returns the JSON string for a given schema" do
+      create_schema("foo", { type: "array" })
+
+      schema_parser = JSON::Matchers::SchemaParser.new(schema_root)
+
+      expect(schema_parser.schema_for("foo")).to eq '{"type":"array"}'
+    end
+
+    it "can embed other schemas" do
+      create_schema "post", <<-JSON.strip
+      {
+        "type": "object",
+        "required": ["id", "title", "body"],
+        "properties": {
+          "id": { "type": "integer" },
+          "title": { "type": "string" },
+          "body": { "type": "string" }
+        }
+      }
+      JSON
+      create_schema "posts", <<-JSON.strip
+      {
+        "type": "object",
+        "required": ["posts"],
+        "properties": {
+          "posts": {
+            "type": "array",
+            "items": <%= schema_for("post") %>
+          }
+        }
+      }
+      JSON
+
+      schema_parser = JSON::Matchers::SchemaParser.new(schema_root)
+      schema = schema_parser.schema_for("posts")
+
+      expect(JSON.parse(schema)).to eq({
+        "type" => "object",
+        "required" => ["posts"],
+        "properties" => {
+          "posts" => {
+            "type" => "array",
+            "items" => {
+              "type" => "object",
+              "required" => ["id", "title", "body"],
+              "properties" => {
+                "id" => { "type" => "integer" },
+                "title" => { "type" => "string" },
+                "body" => { "type" => "string" }
+              }
+            }
+          }
+        }
+      })
+    end
+
+    it "fails when the schema is missing" do
+      schema_parser = JSON::Matchers::SchemaParser.new(schema_root)
+      expect {
+        schema_parser.schema_for("missing")
+      }.to raise_error(JSON::Matchers::MissingSchema, /missing.json/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "json/matchers"
+
+Dir["./spec/support/*"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include JSON::Matchers
+  config.expect_with :rspec do |expectations|
+
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/file_helpers.rb

@@ -0,0 +1,41 @@
+module FileHelpers
+  def create_schema(name, json)
+    File.open("#{schema_root}/#{name}.json", "w") do |file|
+      case json
+      when NilClass, String
+        file.write(json.to_s)
+      else
+        file.write(json.to_json)
+      end
+    end
+  end
+
+  def response_for(json)
+    response_body = case json
+                    when String, NilClass
+                      json.to_s
+                    else
+                      json.to_json
+                    end
+    double(body: response_body)
+  end
+
+  def schema_root
+    JSON::Matchers.schema_root
+  end
+end
+
+RSpec.configure do |config|
+  config.include FileHelpers
+
+  config.around do |example|
+    original_schema_root = JSON::Matchers.schema_root
+    JSON::Matchers.schema_root = "#{Dir.pwd}/spec/fixtures/schemas"
+    FileUtils.mkdir_p(JSON::Matchers.schema_root)
+
+    example.run
+
+    FileUtils.rm_rf(JSON::Matchers.schema_root)
+    JSON::Matchers.schema_root = original_schema_root
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: json-matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Validate your Rails JSON API's JSON
+email:
+- seandoyle@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- NEWS.md
+- README.md
+- Rakefile
+- json-matchers.gemspec
+- lib/json/matchers.rb
+- lib/json/matchers/errors.rb
+- lib/json/matchers/matcher.rb
+- lib/json/matchers/rspec.rb
+- lib/json/matchers/schema_parser.rb
+- lib/json/matchers/version.rb
+- spec/json/matchers/match_response_schema_spec.rb
+- spec/json/matchers/schema_parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_helpers.rb
+homepage: https://github.com/seanpdoyle/json-matchers
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Validate your Rails JSON API's JSON
+test_files:
+- spec/json/matchers/match_response_schema_spec.rb
+- spec/json/matchers/schema_parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_helpers.rb
+has_rdoc: