Solution for matching JSON response into RSpec request tests.
Add this line to your application's Gemfile:
gem 'response_matcher'And then execute:
$ bundle
Or install it yourself as:
$ gem install response_matcher
In registration_spec.rb
describe RegistrationsController do
describe 'POST /auth' do
it 'response' do
post user_registration_path, params: params
expect(response).to response_match('schema_path', user: User.last)
end
end
end└─ spec
├─ schemas
│ ├─ my_schema.rb
│ └─ ...
└─ ...
In my_schema.rb you can describe by ruby language how looks like your response
# All the parameters that you transmit will be available as variables, like 'user'
{
data: {
id: user.id,
type: user.class.name,
attributes: {
email: user.email,
provider: user.provider,
uid: user.uid
}
}
}└─ spec
├─ schemas
│ ├─ my_schema.rb
│ ├─ attributes.rb
│ └─ ...
└─ ...
In my_schema.rb
# All the parameters that you transmit will be available as variables, like 'user'
{
data: {
id: user.id,
type: user.class.name,
attributes: call('attributes', user: user)
}
}In attributes.rb
{
email: user.email,
provider: user.provider,
uid: user.uid
}└─ spec
├─ schemas
│ ├─ my_schema.rb
│ ├─ attributes.rb
│ └─ ...
├─ helpers
│ ├─ my_helper.rb
│ └─ ...
├─ rails_helper.rb
└─ ...
In my_helper.rb
module Helpers
module MyHelper
def entity_class(entity)
entity.class.name
end
end
endIn rails_helper.rb
ResponseMatcher::Settings.configure do |config|
config.helpers = [
Helpers::MyHelper,
...
]
endIn my_schema.rb
{
data: {
id: user.id,
type: entity_class(user),
attributes: call('attributes', user: user)
}
}In rails_helper.rb
ResponseMatcher::Settings.configure do |config|
config.directory = 'spec/schemas/api/v1'
endBug reports and pull requests are welcome on GitHub at https://github.com/bezrukavyi/response_matcher
The gem is available as open source under the terms of the MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent