rspec_json_schema_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c21d41faef5b0c35209ee8f6688d1ee07e88d8a
+  data.tar.gz: 7c926063ec39b2584b6ab0a0ca96f0b0e95766c0
+SHA512:
+  metadata.gz: d78eaea305ac45aaeda64b144d5322ef42f056d22a54d42a52378748ec93f67102c717a940d313418bfe9364b8da54ab0c1f71e6da2d407e494c9d57be36e4e6
+  data.tar.gz: 95aa5560e69456d22126f80dc427524c2c417b9706561e778e4ca4b7f49eea095b3d3e9dc85ca82543a04ddb336c9e7259285d5d3ee800c2a2007730dfa899e4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0-p598
+  - 2.1.6
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/LICENSING.md

@@ -0,0 +1,16 @@
+ISC licence
+-----------
+
+Copyright (c) 2015, Leo Nikkilä <hello@lnikki.la>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+RSpec JSON schema matcher
+=========================
+
+[![Build status][travis-badge]][travis]
+
+Validate JSON in your specs using [JSON schema](http://json-schema.org/):
+
+```ruby
+it "returns a valid user resource" do
+  expect(response.body).to match_schema "user"
+end
+```
+
+Handy for testing JSON-based web APIs!
+
+### Installation ###
+
+Add this to your application's Gemfile:
+
+```ruby
+group :test do
+  gem "rspec_json_schema_matcher"
+end
+```
+
+Then install the gem:
+
+```sh-session
+$ bundle
+```
+
+And finally add this to your `spec_helper.rb`:
+
+```ruby
+require 'rspec_json_schema_matcher'
+```
+
+### Usage ###
+
+Provides a single RSpec matcher called `match_schema` that accepts a relative
+path to a JSON schema without the .json extension.
+
+The matcher assumes that your schemas are stored in `./spec/support/schemas` or
+in its subdirectories.
+
+For example, if you want to use `./spec/support/schemas/users/instance.json`,
+write `match_schema "users/instance"`.
+
+### Development ###
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+### Contributing ###
+
+Bug reports and pull requests are welcome!
+
+### Licence ###
+
+The gem is available as open source under the terms of the
+[ISC License](http://opensource.org/licenses/ISC).
+
+[travis]: https://travis-ci.org/lnikkila/rspec_json_schema_matcher
+[travis-badge]: https://img.shields.io/travis/lnikkila/rspec_json_schema_matcher.svg?style=flat-square

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_json_schema_matcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec_json_schema_matcher/version.rb

@@ -0,0 +1,3 @@
+module RSpecJSONSchemaMatcher
+  VERSION = "0.1.0"
+end

data/lib/rspec_json_schema_matcher.rb

@@ -0,0 +1,41 @@
+require "rspec_json_schema_matcher/version"
+
+require 'rspec'
+require 'rspec/expectations'
+require 'json-schema'
+
+# Validates JSON responses against a schema
+RSpec::Matchers.define :match_schema do |schema|
+  match do |body|
+    schema_directory = "#{Dir.pwd}/spec/support/schemas"
+    schema_path = "#{schema_directory}/#{schema}.json"
+    opts = { validate_schema: true }
+
+    begin
+      @result = JSON::Validator.fully_validate_json(schema_path, body, opts)
+    rescue JSON::Schema::ValidationError => e
+      @result = "Schema '#{schema}' did not pass validation:\n\n- #{e.message}"
+    end
+
+    expect(@result).to eq []
+  end
+
+  failure_message do |body|
+    "#{messages}\n\n#{body}"
+  end
+
+  description do
+    "match the JSON schema '#{schema}'"
+  end
+
+private
+
+  def messages
+    if @result.respond_to?(:join)
+      @result.join("\n")
+    else
+      @result
+    end
+  end
+end
+

data/rspec_json_schema_matcher.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'rspec_json_schema_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_json_schema_matcher"
+  spec.version       = RSpecJSONSchemaMatcher::VERSION
+  spec.authors       = ["Leo Nikkilä"]
+  spec.email         = ["hello@lnikki.la"]
+
+  spec.summary       = "Validate JSON in your specs using JSON schema."
+  spec.homepage      = "https://github.com/lnikkila/rspec_json_schema_matcher"
+  spec.license       = "ISC"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec",       "~> 3.0.0"
+  spec.add_runtime_dependency "json-schema", "~> 2.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rspec_json_schema_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leo Nikkilä
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+description: 
+email:
+- hello@lnikki.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSING.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_json_schema_matcher.rb
+- lib/rspec_json_schema_matcher/version.rb
+- rspec_json_schema_matcher.gemspec
+homepage: https://github.com/lnikkila/rspec_json_schema_matcher
+licenses:
+- ISC
+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.5
+signing_key: 
+specification_version: 4
+summary: Validate JSON in your specs using JSON schema.
+test_files: []