json-matchers 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eb4da42712b9d05834e8600bbae9834c1f306ae
-  data.tar.gz: 247f1f80aad4fe545c6437c6b08a69dbd47a176b
+  metadata.gz: b2bc10af4131d3f0ed42c314a9a9647547051e6f
+  data.tar.gz: bd823542ce64cab597d9f9689a7b49bce21494e8
 SHA512:
-  metadata.gz: 1986b67043756ddbae800c9e6f6b593461bd8a32000cc2ac5091eaba72c8f77d0ee46d5d3554c4db7975ff9b8b952864811f0f828a7224d93398edfa599ae0ec
-  data.tar.gz: a418df00dd43112eceefceff27e35367daba2bba642318a8696c428d124722aeaa2bd45800e323e44e45fdd55297b8e09d57a9f305f0cc5e1e28938e707b0cc1
+  metadata.gz: 8ce7b02e972556b4d961a245b4766e537d21b7adef732c4f0cab6aecc990ca01258a062acbb73a6773fc051769f374ead55a474aeb402a4d8311fdc2f52a4a30
+  data.tar.gz: e8b8f5c80dfe722447f5bea3cf95c369b23c1eab49439383e5a31a87d2ab27126a5ac1d6b38d685f31883629aa4e558e4d4bce06d3589c384323b419b6ee19ac

data/.travis.yml

@@ -1,4 +1,7 @@
+cache: bundler
+sudo: false
 language: ruby
+notifications:
+  email: false
 rvm:
-- 2.0.0
-- jruby-19mode
+- 2.2.0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 master
 ------
 
+0.3.0
+-----
+
+* Pass options from matcher to `JSON::Validator`
+
 0.2.2
 -----
 

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/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2014 Sean Doyle
+Copyright (c) 2015 Sean Doyle and thoughtbot, inc.
 
 MIT License
 

data/README.md

@@ -65,6 +65,27 @@ describe "GET /posts" do
 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`.
@@ -124,8 +145,38 @@ JSON::Matchers.schema_root = "docs/api/schemas"
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/json-matchers/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
+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/json-matchers.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "json-matchers"
   spec.version       = JSON::Matchers::VERSION
   spec.authors       = ["Sean Doyle"]
-  spec.email         = ["seandoyle@thoughtbot.com"]
+  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/seanpdoyle/json-matchers"
+  spec.homepage      = "https://github.com/thoughtbot/json-matchers"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/json/matchers/matcher.rb

@@ -2,11 +2,24 @@ require "json-schema"
 
 module JSON
   module Matchers
-    Matcher = Struct.new(:schema_path) do
+    class Matcher
+      def initialize(schema_path, **options)
+        @schema_path = schema_path
+        @options = options
+      end
+
       def matches?(response)
         @response = response
 
-        JSON::Validator.validate!(schema_path.to_s, response.body, strict: true)
+        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
@@ -17,6 +30,10 @@ module JSON
       def validation_failure_message
         @validation_failure_message.to_s
       end
+
+      private
+
+      attr_reader :schema_path, :options
     end
   end
 end

data/lib/json/matchers/rspec.rb

@@ -3,10 +3,10 @@ module JSON
     class RSpec < SimpleDelegator
       attr_reader :schema_name
 
-      def initialize(schema_name)
+      def initialize(schema_name, **options)
         @schema_name = schema_name
 
-        super(JSON::Matchers::Matcher.new(schema_path))
+        super(JSON::Matchers::Matcher.new(schema_path, options))
       end
 
       def failure_message(response)
@@ -55,8 +55,8 @@ module JSON
 end
 
 if RSpec.respond_to?(:configure)
-  RSpec::Matchers.define :match_response_schema do |schema_name|
-    matcher = JSON::Matchers::RSpec.new(schema_name)
+  RSpec::Matchers.define :match_response_schema do |schema_name, **options|
+    matcher = JSON::Matchers::RSpec.new(schema_name, options)
 
     match do |response|
       matcher.matches?(response)

data/lib/json/matchers/version.rb

@@ -1,5 +1,5 @@
 module JSON
   module Matchers
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/spec/json/matchers/match_response_schema_spec.rb

@@ -15,34 +15,52 @@ describe JSON::Matchers, "#match_response_schema" do
 
   it "fails when the body is missing a required property" do
     create_schema("foo_schema", {
-      type: "object",
-      required: ["foo"],
+      "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" }
+      "type" => "object",
+      "properties" => {
+        "foo" => { "type" => "string" },
       }
     })
 
-    expect(response_for({foo: 1})).not_to match_response_schema("foo_schema")
+    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" })
+    create_schema("foo", { "type" => "array" })
 
     expect {
-      expect(response_for(bar: 5)).to match_response_schema("foo")
+      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" })
+    create_schema("foo", { "type" => "array" })
 
     expect {
       expect(response_for([])).not_to match_response_schema("foo")
@@ -50,16 +68,16 @@ describe JSON::Matchers, "#match_response_schema" do
   end
 
   it "contains the schema in the failure message" do
-    schema = { type: "array" }
+    schema = { "type" => "array" }
     create_schema("foo", schema)
 
     expect {
-      expect(response_for(bar: 5)).to match_response_schema("foo")
+      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" }
+    schema = { "type" => "array" }
     create_schema("foo", schema)
 
     expect {
@@ -69,8 +87,8 @@ describe JSON::Matchers, "#match_response_schema" do
 
   it "does not fail when the schema matches" do
     create_schema("array_schema", {
-      type: "array",
-      items: { type: "string" }
+      "type" => "array",
+      "items" => { "type" => "string" },
     })
 
     expect(response_for(["valid"])).to match_response_schema("array_schema")
@@ -81,16 +99,16 @@ describe JSON::Matchers, "#match_response_schema" do
       "type" => "object",
       "required" => ["foo"],
       "properties" => {
-        "foo" => { "type" => "string" }
+        "foo" => { "type" => "string" },
       }
     })
     create_schema("collection", {
       "type" => "array",
-      "items" => { "$ref" => "single.json" }
+      "items" => { "$ref" => "single.json" },
     })
 
-    valid_response = response_for([{foo: "is a string"}])
-    invalid_response = response_for([{foo: 0}])
+    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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -96,7 +96,7 @@ dependencies:
         version: '2.0'
 description: Validate your Rails JSON API's JSON
 email:
-- seandoyle@thoughtbot.com
+- sean.p.doyle24@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -105,6 +105,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - NEWS.md
@@ -119,7 +120,7 @@ files:
 - spec/json/matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_helpers.rb
-homepage: https://github.com/seanpdoyle/json-matchers
+homepage: https://github.com/thoughtbot/json-matchers
 licenses:
 - MIT
 metadata: {}
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Validate your Rails JSON API's JSON
@@ -147,3 +148,4 @@ test_files:
 - spec/json/matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_helpers.rb
+has_rdoc: