json_matchers 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebd2f6c2a65cd0ad316c68b20ab44b7319b9fb47
+  data.tar.gz: 2a09b12a688897b183f76678991985042d3cc3db
+SHA512:
+  metadata.gz: c6404d6214cb53692199e0533f9b824c54feb6f3961ac34d43bfb69ce7c1212794f4e36de5fd7972aa3744d9f49318ad280798cc016d620ef215e0e3ed8545de
+  data.tar.gz: 4068995034f0ad147fe14f4640b91cfb0d8d6262f17d900daf0b91af80f87d278b2ebca054c24553d644a43ae9de1eaa0d483e38b16be0a186d4dfd3c3202138

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,7 @@
+cache: bundler
+sudo: false
+language: ruby
+notifications:
+  email: false
+rvm:
+- 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+master
+------
+
+0.4.0
+-----
+
+* BREAKING CHANGE: Rename the gem to `json_matchers`.
+
+0.3.1
+-----
+
+* BREAKING CHANGE: Rename module to `JsonMatchers`. This resolves clashing with
+  gems like `oj` / `oj_mimic_json` that take control of the standard library's
+  `json` module. As a result, the file to require is now `json_matchers`,
+  instead of `json/matchers`.
+
+* No longer condone auto-loading RSpec. Add documentation around adding `require
+  "json_matchers/rspec"` to consumers' `spec/spec_helper.rb`
+
+0.3.0
+-----
+
+* Pass options from matcher to `JSON::Validator`
+
+0.2.2
+-----
+
+* Includes validation failure message in RSpec output
+
+0.2.1
+-----
+
+* Supports RSpec 2 syntax `failure_message_for_should` and
+  `failure_message_for_should_not`

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+Contributing to json_matchers:
+
+1. Fork the [official repository](https://github.com/thoughtbot/json_matchers/tree/master).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version.

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,23 @@
+Copyright (c) 2014 Sean Doyle
+Copyright (c) 2015 Sean Doyle and thoughtbot, inc.
+
+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,17 @@
+# 0.2.0
+
+* RSpec failure messages include both the body of the response, and the body of
+  the JSON Schema file
+
+# 0.1.0
+
+## Breaking Changes
+
+* Remove `schema_for` in favor of using `$ref`. To learn more about `$ref`,
+  check out [Understanding JSON Schema Structuring](http://spacetelescope.github.io/understanding-json-schema/structuring.html)
+
+# 0.0.1
+
+## Features
+
+* Validate your Rails response JSON with `match_response_schema`

data/README.md

@@ -0,0 +1,184 @@
+# JsonMatchers
+
+Validate the JSON returned by your Rails JSON APIs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem "json_matchers"
+end
+```
+
+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/rspec"
+```
+
+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
+```
+
+### Passing options to the validator
+
+The matcher accepts options, which it'll pass to the validator:
+
+```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", strict: false)
+  end
+end
+```
+
+A list of available options can be found [here][options]
+
+[options]: https://github.com/ruby-json-schema/json-schema/blob/2.2.4/lib/json-schema/validator.rb#L160-L162
+
+### Embedding other Schemas
+
+To DRY up your schema definitions, use JSON schema's `$ref`.
+
+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, reference your singular schemas.
+
+```json
+# spec/support/api/schemas/posts.json
+
+{
+  "type": "object",
+  "required": ["posts"],
+  "properties": {
+    "posts": {
+      "type": "array",
+      "items": { "$ref": "post.json" }
+    }
+  }
+}
+```
+
+NOTE: `$ref` resolves paths relative to the schema in question.
+
+In this case `"post.json"` will be resolved relative to
+`"spec/support/api/schemas"`.
+
+To learn more about `$ref`, check out [Understanding JSON Schema Structuring](http://spacetelescope.github.io/understanding-json-schema/structuring.html)
+
+## Configuration
+
+By default, the schema directory is `spec/support/api/schemas`.
+
+This can be configured via `JsonMatchers.schema_root`.
+
+
+```ruby
+# spec/support/json_matchers.rb
+
+JsonMatchers.schema_root = "docs/api/schemas"
+```
+
+## Contributing
+
+Please see [CONTRIBUTING].
+
+`json_matchers` was inspired by [Validating JSON Schemas with an
+RSpec Matcher][blog post] by Laila Winner.
+
+`json_matchers` was written and is maintained by Sean Doyle.
+
+Many improvements and bugfixes were contributed by the [open source community].
+
+[blog post]: https://robots.thoughtbot.com/validating-json-schemas-with-an-rspec-matcher
+[CONTRIBUTING]: https://github.com/thoughtbot/json_matchers/blob/master/CONTRIBUTING.md
+[open source community]: https://github.com/thoughtbot/json_matchers/graphs/contributors
+
+## License
+
+json_matchers is Copyright © 2015 Sean Doyle and thoughtbot.
+
+It is free software, and may be redistributed under the terms specified in the
+[LICENSE] file.
+
+[LICENSE]: LICENSE.txt
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/logo.png)
+
+`json_matchers` is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com?utm_source=github

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       = JsonMatchers::VERSION
+  spec.authors       = ["Sean Doyle"]
+  spec.email         = ["sean.p.doyle24@gmail.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/thoughtbot/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", "~> 2.2.5")
+  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,14 @@
+require "json_matchers/version"
+require "json_matchers/matcher"
+require "json_matchers/errors"
+require "active_support/all"
+
+module JsonMatchers
+  mattr_accessor :schema_root
+
+  self.schema_root = "#{Dir.pwd}/spec/support/api/schemas"
+
+  def self.path_to_schema(schema_name)
+    Pathname(schema_root).join("#{schema_name}.json")
+  end
+end

data/lib/json_matchers/errors.rb

@@ -0,0 +1,4 @@
+module JsonMatchers
+  InvalidSchemaError = Class.new(StandardError)
+  MissingSchema = Class.new(Errno::ENOENT)
+end

data/lib/json_matchers/matcher.rb

@@ -0,0 +1,37 @@
+require "json-schema"
+
+module JsonMatchers
+  class Matcher
+    def initialize(schema_path, **options)
+      @schema_path = schema_path
+      @options = options
+    end
+
+    def matches?(response)
+      @response = response
+
+      validator_options = {
+        strict: true,
+      }.merge(options)
+
+      JSON::Validator.validate!(
+        schema_path.to_s,
+        response.body,
+        validator_options,
+      )
+    rescue JSON::Schema::ValidationError => ex
+      @validation_failure_message = ex.message
+      false
+    rescue JSON::ParserError
+      raise InvalidSchemaError
+    end
+
+    def validation_failure_message
+      @validation_failure_message.to_s
+    end
+
+    private
+
+    attr_reader :schema_path, :options
+  end
+end

data/lib/json_matchers/rspec.rb

@@ -0,0 +1,83 @@
+require "json_matchers"
+
+module JsonMatchers
+  class RSpec < SimpleDelegator
+    attr_reader :schema_name
+
+    def initialize(schema_name, **options)
+      @schema_name = schema_name
+
+      super(JsonMatchers::Matcher.new(schema_path, options))
+    end
+
+    def failure_message(response)
+      <<-FAIL.strip_heredoc
+      expected
+
+      #{response.body}
+
+      to match schema "#{schema_name}":
+
+      #{schema_body}
+
+      ---
+
+      #{validation_failure_message}
+
+      FAIL
+    end
+
+    def failure_message_when_negated(response)
+      <<-FAIL.strip_heredoc
+      expected
+
+      #{response.body}
+
+      not to match schema "#{schema_name}":
+
+      #{schema_body}
+
+      ---
+
+      #{validation_failure_message}
+
+      FAIL
+    end
+
+    def schema_path
+      JsonMatchers.path_to_schema(schema_name)
+    end
+
+    def schema_body
+      File.read(schema_path)
+    end
+  end
+end
+
+if RSpec.respond_to?(:configure)
+  RSpec::Matchers.define :match_response_schema do |schema_name, **options|
+    matcher = JsonMatchers::RSpec.new(schema_name, options)
+
+    match do |response|
+      matcher.matches?(response)
+    end
+
+    if respond_to?(:failure_message)
+      failure_message do |response|
+        matcher.failure_message(response)
+      end
+
+      failure_message_when_negated do |response|
+        matcher.failure_message_when_negated(response)
+      end
+    else
+      failure_message_for_should do |response|
+        matcher.failure_message(response)
+      end
+
+      failure_message_for_should_not do |response|
+        matcher.failure_message_when_negated(response)
+      end
+    end
+  end
+end

data/lib/json_matchers/version.rb

@@ -0,0 +1,3 @@
+module JsonMatchers
+  VERSION = "0.4.0"
+end

data/spec/json_matchers/match_response_schema_spec.rb

@@ -0,0 +1,116 @@
+describe JsonMatchers, "#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(JsonMatchers::InvalidSchemaError)
+  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("foo_schema", {
+      "type" => "object",
+      "required" => ["foo"],
+    })
+
+    expect(response_for({})).not_to match_response_schema("foo_schema")
+  end
+
+  it "accepts options for the validator" do
+    create_schema("foo_schema", {
+      "type" => "object",
+      "required" => [
+        "id",
+      ],
+      "properties" => {
+        "id" => { "type" => "number" },
+        "title" => {"type" => "string"},
+      },
+      "additionalProperties" => false,
+    })
+
+    expect(response_for({ "id" => 1, "title" => "bar" })).
+      to match_response_schema("foo_schema", strict: false)
+  end
+
+  it "fails when the body contains a property with the wrong type" do
+    create_schema("foo_schema", {
+      "type" => "object",
+      "properties" => {
+        "foo" => { "type" => "string" },
+      }
+    })
+
+    expect(response_for("foo" => 1)).
+      not_to match_response_schema("foo_schema")
+  end
+
+  it "contains the body in the failure message" do
+    create_schema("foo", { "type" => "array" })
+
+    expect {
+      expect(response_for("bar" => 5)).to match_response_schema("foo")
+    }.to raise_error(/{"bar":5}/)
+  end
+
+  it "contains the body in the failure message when negated" do
+    create_schema("foo", { "type" => "array" })
+
+    expect {
+      expect(response_for([])).not_to match_response_schema("foo")
+    }.to raise_error(/\[\]/)
+  end
+
+  it "contains the schema in the failure message" do
+    schema = { "type" => "array" }
+    create_schema("foo", schema)
+
+    expect {
+      expect(response_for("bar" => 5)).to match_response_schema("foo")
+    }.to raise_error(/#{schema.to_json}/)
+  end
+
+  it "contains the schema in the failure message when negated" do
+    schema = { "type" => "array" }
+    create_schema("foo", schema)
+
+    expect {
+      expect(response_for([])).not_to match_response_schema("foo")
+    }.to raise_error(/#{schema.to_json}/)
+  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 $ref" do
+    create_schema("single", {
+      "type" => "object",
+      "required" => ["foo"],
+      "properties" => {
+        "foo" => { "type" => "string" },
+      }
+    })
+    create_schema("collection", {
+      "type" => "array",
+      "items" => { "$ref" => "single.json" },
+    })
+
+    valid_response = response_for([{ "foo" => "is a string" }])
+    invalid_response = response_for([{ "foo" => 0 }])
+
+    expect(valid_response).to match_response_schema("collection")
+    expect(invalid_response).not_to match_response_schema("collection")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "json_matchers/rspec"
+
+Dir["./spec/support/*"].each { |file| require file }
+
+RSpec.configure do |config|
+  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,42 @@
+module FileHelpers
+  ORIGINAL_SCHEMA_ROOT = JsonMatchers.schema_root
+
+  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
+    JsonMatchers.schema_root
+  end
+end
+
+RSpec.configure do |config|
+  config.include FileHelpers
+
+  config.around do |example|
+    JsonMatchers.schema_root = File.join(Dir.pwd, "spec", "fixtures", "schemas")
+    FileUtils.mkdir_p(JsonMatchers.schema_root)
+
+    example.run
+
+    FileUtils.rm_rf(JsonMatchers.schema_root)
+    JsonMatchers.schema_root = FileHelpers::ORIGINAL_SCHEMA_ROOT
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: json_matchers
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+- !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:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- 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/version.rb
+- spec/json_matchers/match_response_schema_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_helpers.rb
+homepage: https://github.com/thoughtbot/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.8
+signing_key: 
+specification_version: 4
+summary: Validate your Rails JSON API's JSON
+test_files:
+- spec/json_matchers/match_response_schema_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_helpers.rb
+has_rdoc: