jsonapi_spec 0.1.0
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.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +41 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/jsonapi_spec.gemspec +28 -0
- data/lib/jsonapi_spec/helpers.rb +11 -0
- data/lib/jsonapi_spec/matchers/be_valid_jsonapi.rb +23 -0
- data/lib/jsonapi_spec/matchers/have_jsonapi_attribute.rb +26 -0
- data/lib/jsonapi_spec/matchers/have_jsonapi_error.rb +24 -0
- data/lib/jsonapi_spec/matchers/have_jsonapi_link.rb +26 -0
- data/lib/jsonapi_spec/matchers/have_jsonapi_relationship.rb +26 -0
- data/lib/jsonapi_spec/matchers.rb +33 -0
- data/lib/jsonapi_spec/version.rb +3 -0
- data/lib/jsonapi_spec.rb +8 -0
- metadata +139 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 4767c13831a0abcbed0a27c692268e55971e32ef
|
4
|
+
data.tar.gz: 94849dbb71963911cda3bac371eb5c0603c311e2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8e89bd9950ce409316eac173146ffa7b99c298901fde426db1d99a70a42eb47eacd11a3e57d4b19b1eb7f7685cf479ca79c75807da668bd9d52c18eaae884817
|
7
|
+
data.tar.gz: 46f0885fb38b6bf91527ec1b4a89184cb076b0801b543cf17ad859cbe1ed469d1354455e2496d0d081cc1a326a0ca92e8368dc84040d651891a578dc6285f880
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Ahmad Suhendri
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# JsonapiSpec
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi_spec`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'jsonapi_spec'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install jsonapi_spec
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
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).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsonapi_spec.
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
41
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "jsonapi_spec"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'jsonapi_spec/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "jsonapi_spec"
|
8
|
+
spec.version = JsonapiSpec::VERSION
|
9
|
+
spec.authors = ["Ahmad Suhendri"]
|
10
|
+
spec.email = ["ahmadsoe@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{RSpec matchers for testing JSON API content}
|
13
|
+
spec.description = %q{RSpec matchers for testing JSON API content}
|
14
|
+
spec.homepage = "https://github.com/ahmadsoe/jsonapi_spec"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_dependency "jsonapi_parser", "~> 0.4"
|
23
|
+
spec.add_dependency "rspec", "~> 3.0", ">= 3.0.0"
|
24
|
+
|
25
|
+
spec.add_development_dependency "bundler", "~> 1.12.a"
|
26
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
27
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
28
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module JsonapiSpec
|
2
|
+
module Matchers
|
3
|
+
class BeValidJsonapi
|
4
|
+
include JsonapiSpec::Helpers
|
5
|
+
|
6
|
+
def matches?(json)
|
7
|
+
parse_jsonapi(json)
|
8
|
+
true
|
9
|
+
rescue JSON::API::InvalidDocument => ex
|
10
|
+
@validate_error_message = ex.message
|
11
|
+
false
|
12
|
+
end
|
13
|
+
|
14
|
+
def failure_message
|
15
|
+
"Not a valid jsonapi #{@validate_error_message}"
|
16
|
+
end
|
17
|
+
|
18
|
+
def failure_message_when_negated
|
19
|
+
"Valid jsonapi"
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module JsonapiSpec
|
2
|
+
module Matchers
|
3
|
+
class HaveJsonapiAttribute
|
4
|
+
include JsonapiSpec::Helpers
|
5
|
+
|
6
|
+
def initialize(attribute)
|
7
|
+
@attribute = attribute
|
8
|
+
end
|
9
|
+
|
10
|
+
def matches?(json)
|
11
|
+
document = parse_jsonapi(json)
|
12
|
+
document.data.attributes.defined?(@attribute)
|
13
|
+
rescue JSON::API::InvalidDocument
|
14
|
+
false
|
15
|
+
end
|
16
|
+
|
17
|
+
def failure_message
|
18
|
+
"Not have a attribute #{@attribute}"
|
19
|
+
end
|
20
|
+
|
21
|
+
def failure_message_when_negated
|
22
|
+
"have jsonapi attribute #{@attribute}"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
module JsonapiSpec
|
2
|
+
module Matchers
|
3
|
+
class HaveJsonapiError
|
4
|
+
include JsonapiSpec::Helpers
|
5
|
+
|
6
|
+
def matches?(json)
|
7
|
+
document = parse_jsonapi(json)
|
8
|
+
return false if document.errors.nil?
|
9
|
+
true
|
10
|
+
rescue JSON::API::InvalidDocument => ex
|
11
|
+
@validate_error_message = ex.message
|
12
|
+
false
|
13
|
+
end
|
14
|
+
|
15
|
+
def failure_message
|
16
|
+
"Not a valid jsonapi error #{@validate_error_message}"
|
17
|
+
end
|
18
|
+
|
19
|
+
def failure_message_when_negated
|
20
|
+
"Valid jsonapi error"
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module JsonapiSpec
|
2
|
+
module Matchers
|
3
|
+
class HaveJsonapiLink
|
4
|
+
include JsonapiSpec::Helpers
|
5
|
+
|
6
|
+
def initialize(link)
|
7
|
+
@link = link
|
8
|
+
end
|
9
|
+
|
10
|
+
def matches?(json)
|
11
|
+
document = parse_jsonapi(json)
|
12
|
+
document.links.defined?(@link)
|
13
|
+
rescue JSON::API::InvalidDocument
|
14
|
+
false
|
15
|
+
end
|
16
|
+
|
17
|
+
def failure_message
|
18
|
+
"Not have a links #{@link}"
|
19
|
+
end
|
20
|
+
|
21
|
+
def failure_message_when_negated
|
22
|
+
"have jsonapi link #{@link}"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module JsonapiSpec
|
2
|
+
module Matchers
|
3
|
+
class HaveJsonapiRelationship
|
4
|
+
include JsonapiSpec::Helpers
|
5
|
+
|
6
|
+
def initialize(relationship)
|
7
|
+
@relationship = relationship
|
8
|
+
end
|
9
|
+
|
10
|
+
def matches?(json)
|
11
|
+
document = parse_jsonapi(json)
|
12
|
+
document.data.relationships.defined?(@relationship)
|
13
|
+
rescue JSON::API::InvalidDocument
|
14
|
+
false
|
15
|
+
end
|
16
|
+
|
17
|
+
def failure_message
|
18
|
+
"Not have a relationship #{@relationship}"
|
19
|
+
end
|
20
|
+
|
21
|
+
def failure_message_when_negated
|
22
|
+
"have jsonapi relationship #{@relationship}"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
require 'jsonapi_spec/matchers/be_valid_jsonapi'
|
2
|
+
require 'jsonapi_spec/matchers/have_jsonapi_link'
|
3
|
+
require 'jsonapi_spec/matchers/have_jsonapi_relationship'
|
4
|
+
require 'jsonapi_spec/matchers/have_jsonapi_attribute'
|
5
|
+
require 'jsonapi_spec/matchers/have_jsonapi_error'
|
6
|
+
|
7
|
+
module JsonapiSpec
|
8
|
+
module Matchers
|
9
|
+
def be_valid_jsonapi
|
10
|
+
JsonapiSpec::Matchers::BeValidJsonapi.new
|
11
|
+
end
|
12
|
+
|
13
|
+
def have_jsonapi_link(link)
|
14
|
+
JsonapiSpec::Matchers::HaveJsonapiLink.new(link)
|
15
|
+
end
|
16
|
+
|
17
|
+
def have_jsonapi_relationship(relationship)
|
18
|
+
JsonapiSpec::Matchers::HaveJsonapiRelationship.new(relationship)
|
19
|
+
end
|
20
|
+
|
21
|
+
def have_jsonapi_attribute(attribute)
|
22
|
+
JsonapiSpec::Matchers::HaveJsonapiAttribute.new(attribute)
|
23
|
+
end
|
24
|
+
|
25
|
+
def have_jsonapi_error
|
26
|
+
JsonapiSpec::Matchers::HaveJsonapiError.new
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
RSpec.configure do |config|
|
32
|
+
config.include JsonapiSpec::Matchers
|
33
|
+
end
|
data/lib/jsonapi_spec.rb
ADDED
metadata
ADDED
@@ -0,0 +1,139 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: jsonapi_spec
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ahmad Suhendri
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-03-28 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: jsonapi_parser
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.4'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.4'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rspec
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '3.0'
|
34
|
+
- - ">="
|
35
|
+
- !ruby/object:Gem::Version
|
36
|
+
version: 3.0.0
|
37
|
+
type: :runtime
|
38
|
+
prerelease: false
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
40
|
+
requirements:
|
41
|
+
- - "~>"
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: '3.0'
|
44
|
+
- - ">="
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: 3.0.0
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: bundler
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 1.12.a
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 1.12.a
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: rake
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '10.0'
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '10.0'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: rspec
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '3.0'
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '3.0'
|
89
|
+
description: RSpec matchers for testing JSON API content
|
90
|
+
email:
|
91
|
+
- ahmadsoe@gmail.com
|
92
|
+
executables: []
|
93
|
+
extensions: []
|
94
|
+
extra_rdoc_files: []
|
95
|
+
files:
|
96
|
+
- ".gitignore"
|
97
|
+
- ".rspec"
|
98
|
+
- ".travis.yml"
|
99
|
+
- Gemfile
|
100
|
+
- LICENSE.txt
|
101
|
+
- README.md
|
102
|
+
- Rakefile
|
103
|
+
- bin/console
|
104
|
+
- bin/setup
|
105
|
+
- jsonapi_spec.gemspec
|
106
|
+
- lib/jsonapi_spec.rb
|
107
|
+
- lib/jsonapi_spec/helpers.rb
|
108
|
+
- lib/jsonapi_spec/matchers.rb
|
109
|
+
- lib/jsonapi_spec/matchers/be_valid_jsonapi.rb
|
110
|
+
- lib/jsonapi_spec/matchers/have_jsonapi_attribute.rb
|
111
|
+
- lib/jsonapi_spec/matchers/have_jsonapi_error.rb
|
112
|
+
- lib/jsonapi_spec/matchers/have_jsonapi_link.rb
|
113
|
+
- lib/jsonapi_spec/matchers/have_jsonapi_relationship.rb
|
114
|
+
- lib/jsonapi_spec/version.rb
|
115
|
+
homepage: https://github.com/ahmadsoe/jsonapi_spec
|
116
|
+
licenses:
|
117
|
+
- MIT
|
118
|
+
metadata: {}
|
119
|
+
post_install_message:
|
120
|
+
rdoc_options: []
|
121
|
+
require_paths:
|
122
|
+
- lib
|
123
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
124
|
+
requirements:
|
125
|
+
- - ">="
|
126
|
+
- !ruby/object:Gem::Version
|
127
|
+
version: '0'
|
128
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
129
|
+
requirements:
|
130
|
+
- - ">="
|
131
|
+
- !ruby/object:Gem::Version
|
132
|
+
version: '0'
|
133
|
+
requirements: []
|
134
|
+
rubyforge_project:
|
135
|
+
rubygems_version: 2.5.1
|
136
|
+
signing_key:
|
137
|
+
specification_version: 4
|
138
|
+
summary: RSpec matchers for testing JSON API content
|
139
|
+
test_files: []
|