json-schema-rspec 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78897a15eee63f17fbe327166c1cc79a4cab7d98
+  data.tar.gz: 365ee5bf15d49a0d4a8c534122570babd2669613
+SHA512:
+  metadata.gz: 7bda5f7a71289c987070eef0212c03e12915cf8b5ac318a7c96c235a4f436a004279a1371dd1653f0695fb8f30a5c4d8ff4f00f6fd68dc9c1c892440538c564e
+  data.tar.gz: 23f7b5a39d5c14036eb49063736cb0dc941b9097e5e0568a134411184850c439b5bfaf885beda9101e0d526b773faed99672ca7bd1464d44eb830fe3c5ca01bd

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+0.0.2 / 2015-05-06
+==================
+
+  * Updated to json-schema gem version to 2.5
+  * Added description method on matchers
+  * Allow for passing in validation options
+  * Added tests
+
+0.0.1 / 2014-04-18
+==================
+
+  * Initial commit
+

data/README.md

@@ -36,6 +36,16 @@ You can then write tests such as:
     
     #failing spec
     expect('[1, 2, 3]').to match_json_schema(:inline_schema)
+
+#### Strict schema validation
+
+If you wish to use strict schema validation you can do so by passing an additional argument to the matcher.
+strict validation can be useful if you want to ensure there are no additional properties in the JSON than
+those explicitly defined in your schema
+
+```
+expect(response.body).to match_json_schema(:my_schema, strict: true)
+```
     
 ### Schema in a file
 You can also use rails path utilities such as `Rails.root.join("spec/support/schemas/my_business_object.schema.json").to_s` when defining schema locations. This gem is backed by the [json-schema](http://github.com/hoxworth/json-schema) gem, so whatever that validator accepts  for paths should work.

data/json-schema-rspec.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/json-schema-rspec/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Michael Jensen"]
-  gem.email         = ["emjay1988@gmail.com"]
+  gem.authors       = ["Sharethrough Engineering", "Michael Jensen"]
+  gem.email         = ["engineers@sharethrough.com", "emjay1988@gmail.com"]
   gem.description   = %q{Adds RSpec matchers for validating JSON schemas}
   gem.summary       = %q{JSON Schema RSpec matchers}
   gem.homepage      = ""
@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Json::Schema::Rspec::VERSION
   gem.add_dependency "rspec"
-  gem.add_dependency "json-schema", "~> 2.2.2"
+  gem.add_dependency "json-schema", "~> 2.5"
 end

data/lib/json-schema-rspec/matchers/json_schema_matcher.rb

@@ -8,8 +8,9 @@ module JSON
     end
 
     class MatchJsonSchemaMatcher
-      def initialize(schema_name)
+      def initialize(schema_name, validation_opts = {})
         @schema_name = schema_name
+        @validation_opts = validation_opts
       end
 
       def matches?(actual)
@@ -25,7 +26,7 @@ module JSON
             "  end"]
           return false
         end
-        @errors = JSON::Validator.fully_validate(schema_for_name(@schema_name), @actual)
+        @errors = JSON::Validator.fully_validate(schema_for_name(@schema_name), @actual, @validation_opts)
 
         if @errors.any?
           @errors.unshift("Expected JSON object to match schema identified by #{@schema_name}, #{@errors.count} errors in validating")
@@ -43,13 +44,17 @@ module JSON
         "Expected JSON object not to match schema identified by #{@schema_name}"
       end
 
+      def description
+        "match JSON schema identified by #{@schema_name}"
+      end
+
       def schema_for_name(schema)
         RSpec.configuration.json_schemas[schema]
       end
     end
 
-    def match_json_schema(schema_name)
-      MatchJsonSchemaMatcher.new(schema_name)
+    def match_json_schema(schema_name, validation_opts = {})
+      MatchJsonSchemaMatcher.new(schema_name, validation_opts)
     end
   end
 end

data/lib/json-schema-rspec/version.rb

@@ -1,7 +1,7 @@
 module Json
   module Schema
     module Rspec
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/spec/json-schema-rspec/matchers/json_schema_matcher_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe JSON::SchemaMatchers::MatchJsonSchemaMatcher do
+  let(:valid_json)    { '"hello world"' }
+  let(:invalid_json)  { '{"key": "value"}' }
+  let(:inline_schema) { '{"type": "string"}' }
+
+  context 'without valid schema_name' do
+    let(:unconfigured_schema) { :unconfigured_schema }
+    specify 'matches fail' do
+      expect(valid_json).not_to match_json_schema(unconfigured_schema)
+    end
+
+    specify 'strict matches fail' do
+      expect(valid_json).not_to match_json_schema(unconfigured_schema, strict: true)
+    end
+
+    specify 'assigns a failure message' do
+      matcher = match_json_schema(unconfigured_schema)
+      expect(matcher.matches?(valid_json)).to eq(false)
+      expect(matcher.failure_message).to match(/^No schema defined for #{unconfigured_schema}/)
+    end
+  end
+
+  context 'with valid schema_name' do
+    before :each do
+      RSpec.configuration.json_schemas[:inline_schema] = inline_schema
+    end
+
+    specify 'calls JSON::Validator' do
+      schema_value = inline_schema
+      json_value = valid_json
+      validation_options = {strict: true}
+      no_errors = []
+
+      expect(JSON::Validator).to receive(:fully_validate) do |schema_value_arg, json_value_arg, validation_options_arg|
+        expect(schema_value_arg).to eq(schema_value)
+        expect(json_value_arg).to eq(json_value)
+        expect(validation_options_arg).to eq(validation_options)
+        no_errors
+      end
+
+      expect(valid_json).to match_json_schema(:inline_schema, validation_options)
+    end
+
+    context 'finds a match' do
+      specify 'when tested against valid json' do
+        expect(valid_json).to match_json_schema(:inline_schema)
+      end
+    end
+
+    context 'does not find a match' do
+      let(:validator_errors) { [:error1, :error2] }
+
+      specify 'when tested against invalid json' do
+        expect(invalid_json).not_to match_json_schema(:inline_schema)
+      end
+
+      specify 'assigns a failure message' do
+        expect(JSON::Validator).to receive(:fully_validate) { validator_errors.clone }
+        matcher = match_json_schema(:inline_schema)
+        expect(matcher.matches?(invalid_json)).to eq(false)
+        expect(matcher.failure_message).to eq(expected_failure_message)
+      end
+
+      def expected_failure_message
+        first_failure_message = "Expected JSON object to match schema identified by inline_schema, #{validator_errors.count} errors in validating"
+        all_failure_messages = [first_failure_message, *validator_errors]
+        all_failure_messages.join("\n")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'json-schema-rspec'
+
+Dir[File.expand_path("../../spec/support/**/*.rb",__FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.filter_run_excluding wip: true
+
+  config.include JSON::SchemaMatchers
+end

metadata

@@ -1,56 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
+- Sharethrough Engineering
 - Michael Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.5'
 description: Adds RSpec matchers for validating JSON schemas
 email:
+- engineers@sharethrough.com
 - emjay1988@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -59,28 +57,31 @@ files:
 - lib/json-schema-rspec.rb
 - lib/json-schema-rspec/matchers/json_schema_matcher.rb
 - lib/json-schema-rspec/version.rb
+- spec/json-schema-rspec/matchers/json_schema_matcher_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: JSON Schema RSpec matchers
-test_files: []
+test_files:
+- spec/json-schema-rspec/matchers/json_schema_matcher_spec.rb
+- spec/spec_helper.rb