json-schema-rspec 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE +22 -0
- data/README.md +59 -0
- data/Rakefile +2 -0
- data/json-schema-rspec.gemspec +19 -0
- data/lib/json-schema-rspec.rb +1 -0
- data/lib/json-schema-rspec/matchers/json_schema_matcher.rb +55 -0
- data/lib/json-schema-rspec/version.rb +7 -0
- metadata +86 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Michael Jensen
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
# JSON::SchemaMatchers
|
2
|
+
|
3
|
+
This gem adds matchers to rspec for validating JSON strings against [JSON schemas](http://json-schema.org).
|
4
|
+
|
5
|
+
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.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'json-schema-rspec'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install json-schema-rspec
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
In your `spec_helper.rb`:
|
24
|
+
|
25
|
+
config.include JSON::SchemaMatchers
|
26
|
+
|
27
|
+
#schema file
|
28
|
+
config.json_schemas[:my_schema] = "path/to/schema.json"
|
29
|
+
#inline
|
30
|
+
config.json_schemas[:inline_schema] = '{"type": "string"}'
|
31
|
+
|
32
|
+
You can then write tests such as:
|
33
|
+
|
34
|
+
#passing spec
|
35
|
+
expect('"hello world"').to match_json_schema(:inline_schema)
|
36
|
+
|
37
|
+
#failing spec
|
38
|
+
expect('[1, 2, 3]').to match_json_schema(:inline_schema)
|
39
|
+
|
40
|
+
### Schema in a file
|
41
|
+
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.
|
42
|
+
|
43
|
+
### Inline Schema
|
44
|
+
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.
|
45
|
+
|
46
|
+
### Remote Schemas
|
47
|
+
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.
|
48
|
+
|
49
|
+
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.
|
50
|
+
|
51
|
+
config.json_schemas[:remote_protected_object] = RestClient.get("http://username:password@artifacts.sharethrough.com/object.schema.json")
|
52
|
+
|
53
|
+
## Contributing
|
54
|
+
|
55
|
+
1. Fork it
|
56
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
57
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
58
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
59
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require File.expand_path('../lib/json-schema-rspec/version', __FILE__)
|
3
|
+
|
4
|
+
Gem::Specification.new do |gem|
|
5
|
+
gem.authors = ["Michael Jensen"]
|
6
|
+
gem.email = ["emjay1988@gmail.com"]
|
7
|
+
gem.description = %q{Adds RSpec matchers for validating JSON schemas}
|
8
|
+
gem.summary = %q{JSON Schema RSpec matchers}
|
9
|
+
gem.homepage = ""
|
10
|
+
|
11
|
+
gem.files = `git ls-files`.split($\)
|
12
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
13
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
14
|
+
gem.name = "json-schema-rspec"
|
15
|
+
gem.require_paths = ["lib"]
|
16
|
+
gem.version = Json::Schema::Rspec::VERSION
|
17
|
+
gem.add_dependency "rspec"
|
18
|
+
gem.add_dependency "json-schema", "~> 2.2.2"
|
19
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'json-schema-rspec/matchers/json_schema_matcher'
|
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'rspec'
|
2
|
+
require 'json-schema'
|
3
|
+
|
4
|
+
module JSON
|
5
|
+
module SchemaMatchers
|
6
|
+
RSpec.configure do |c|
|
7
|
+
c.add_setting :json_schemas, default: {}
|
8
|
+
end
|
9
|
+
|
10
|
+
class MatchJsonSchemaMatcher
|
11
|
+
def initialize(schema_name)
|
12
|
+
@schema_name = schema_name
|
13
|
+
end
|
14
|
+
|
15
|
+
def matches?(actual)
|
16
|
+
@actual = actual
|
17
|
+
schema = schema_for_name(@schema_name)
|
18
|
+
if schema.nil?
|
19
|
+
@errors = [
|
20
|
+
"No schema defined for #{@schema_name}",
|
21
|
+
"Add a line to your RSpec.configure block to define the schema:",
|
22
|
+
" RSpec.configure do |config|",
|
23
|
+
" config.json_schemas[:my_remote_schema] = 'path/to/schema'",
|
24
|
+
" config.json_schemas[:my_inline_schema] = '{\"json\": \"schema\"}'",
|
25
|
+
" end"]
|
26
|
+
return false
|
27
|
+
end
|
28
|
+
@errors = JSON::Validator.fully_validate(schema_for_name(@schema_name), @actual)
|
29
|
+
|
30
|
+
if @errors.any?
|
31
|
+
@errors.unshift("Expected JSON object to match schema identified by #{@schema_name}, #{@errors.count} errors in validating")
|
32
|
+
return false
|
33
|
+
else
|
34
|
+
return true
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
def failure_message
|
39
|
+
@errors.join("\n")
|
40
|
+
end
|
41
|
+
|
42
|
+
def failure_message_when_negated
|
43
|
+
"Expected JSON object not to match schema identified by #{@schema_name}"
|
44
|
+
end
|
45
|
+
|
46
|
+
def schema_for_name(schema)
|
47
|
+
RSpec.configuration.json_schemas[schema]
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def match_json_schema(schema_name)
|
52
|
+
MatchJsonSchemaMatcher.new(schema_name)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
metadata
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: json-schema-rspec
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Michael Jensen
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2014-04-19 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: rspec
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: json-schema
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: 2.2.2
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: 2.2.2
|
46
|
+
description: Adds RSpec matchers for validating JSON schemas
|
47
|
+
email:
|
48
|
+
- emjay1988@gmail.com
|
49
|
+
executables: []
|
50
|
+
extensions: []
|
51
|
+
extra_rdoc_files: []
|
52
|
+
files:
|
53
|
+
- .gitignore
|
54
|
+
- Gemfile
|
55
|
+
- LICENSE
|
56
|
+
- README.md
|
57
|
+
- Rakefile
|
58
|
+
- json-schema-rspec.gemspec
|
59
|
+
- lib/json-schema-rspec.rb
|
60
|
+
- lib/json-schema-rspec/matchers/json_schema_matcher.rb
|
61
|
+
- lib/json-schema-rspec/version.rb
|
62
|
+
homepage: ''
|
63
|
+
licenses: []
|
64
|
+
post_install_message:
|
65
|
+
rdoc_options: []
|
66
|
+
require_paths:
|
67
|
+
- lib
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
+
none: false
|
70
|
+
requirements:
|
71
|
+
- - ! '>='
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: '0'
|
74
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
75
|
+
none: false
|
76
|
+
requirements:
|
77
|
+
- - ! '>='
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: '0'
|
80
|
+
requirements: []
|
81
|
+
rubyforge_project:
|
82
|
+
rubygems_version: 1.8.24
|
83
|
+
signing_key:
|
84
|
+
specification_version: 3
|
85
|
+
summary: JSON Schema RSpec matchers
|
86
|
+
test_files: []
|