json-schema-rspec 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Jensen
+
+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,59 @@
+# JSON::SchemaMatchers
+
+This gem adds matchers to rspec for validating JSON strings against [JSON schemas](http://json-schema.org).
+
+JSON schemas are great for ensuring that changes in applications don't break their integrations, without having to write complex integration tests or run many application environments on your development machine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'json-schema-rspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-schema-rspec
+
+## Usage
+
+In your `spec_helper.rb`:
+
+    config.include JSON::SchemaMatchers
+
+	#schema file
+    config.json_schemas[:my_schema] = "path/to/schema.json"
+    #inline
+    config.json_schemas[:inline_schema] = '{"type": "string"}'
+    
+You can then write tests such as:
+
+	#passing spec
+    expect('"hello world"').to match_json_schema(:inline_schema)
+    
+    #failing spec
+    expect('[1, 2, 3]').to match_json_schema(:inline_schema)
+    
+### 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.
+
+### Inline Schema
+While not recommended due to their size, inline schemas are supported. This may be useful for very simple schemas or if schemas are generated dynamically from some other process.
+
+### Remote Schemas
+Reading a schema from a web address is also supported, but with some limitations. Under the covers, the json-schema gem uses simple ruby `open` and `read` methods, so tread lightly. Accessing resources that are restricted by even simple HTTP auth will probably not work.
+
+One work-around here would be to read your schema using some other mechanism (such as the `RestClient` gem) and passing it to `config.json_schemas` as an inline schema.
+
+    config.json_schemas[:remote_protected_object] = RestClient.get("http://username:password@artifacts.sharethrough.com/object.schema.json")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/json-schema-rspec.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-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.description   = %q{Adds RSpec matchers for validating JSON schemas}
+  gem.summary       = %q{JSON Schema RSpec matchers}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "json-schema-rspec"
+  gem.require_paths = ["lib"]
+  gem.version       = Json::Schema::Rspec::VERSION
+  gem.add_dependency "rspec"
+  gem.add_dependency "json-schema", "~> 2.2.2"
+end

data/lib/json-schema-rspec.rb

@@ -0,0 +1 @@
+require 'json-schema-rspec/matchers/json_schema_matcher'

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

@@ -0,0 +1,55 @@
+require 'rspec'
+require 'json-schema'
+
+module JSON
+  module SchemaMatchers
+    RSpec.configure do |c|
+      c.add_setting :json_schemas, default: {}
+    end
+
+    class MatchJsonSchemaMatcher
+      def initialize(schema_name)
+        @schema_name = schema_name
+      end
+
+      def matches?(actual)
+        @actual = actual
+        schema = schema_for_name(@schema_name)
+        if schema.nil?
+          @errors = [
+            "No schema defined for #{@schema_name}",
+            "Add a line to your RSpec.configure block to define the schema:",
+            "  RSpec.configure do |config|",
+            "    config.json_schemas[:my_remote_schema] = 'path/to/schema'",
+            "    config.json_schemas[:my_inline_schema] = '{\"json\": \"schema\"}'",
+            "  end"]
+          return false
+        end
+        @errors = JSON::Validator.fully_validate(schema_for_name(@schema_name), @actual)
+
+        if @errors.any?
+          @errors.unshift("Expected JSON object to match schema identified by #{@schema_name}, #{@errors.count} errors in validating")
+          return false
+        else
+          return true
+        end
+      end
+
+      def failure_message
+        @errors.join("\n")
+      end
+
+      def failure_message_when_negated
+        "Expected JSON object not to match 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)
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: json-schema-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: Adds RSpec matchers for validating JSON schemas
+email:
+- emjay1988@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- json-schema-rspec.gemspec
+- lib/json-schema-rspec.rb
+- lib/json-schema-rspec/matchers/json_schema_matcher.rb
+- lib/json-schema-rspec/version.rb
+homepage: ''
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: JSON Schema RSpec matchers
+test_files: []