RSpec plugin to write self-documenting request-specs.
This gem is designed for:
Add this line to your application's Gemfile:
group :test do
gem 'rspec-request_describer'
endAnd then include RSpec::RequestDescriber:
# spec/rails_helper.rb
RSpec.configure do |config|
config.include RSpec::RequestDescriber, type: :request
endWrite HTTP method and URL path in the top-level description of your request-specs.
# spec/requests/users/index_spec.rb
RSpec.describe 'GET /users' do
it 'returns 200' do
subject
expect(response).to have_http_status(200)
end
endInternally, RSpec::RequestDescriber defines subject and some let from its top-level description like this:
RSpec.describe 'GET /users' do
subject do
__send__(http_method, path, headers:, params:)
end
let(:http_method) do
'get'
end
let(:path) do
'/users'
end
let(:headers) do
{}
end
let(:params) do
{}
end
it 'returns 200' do
subject
expect(response).to have_http_status(200)
end
endIf you want to modify request headers, change headers:
RSpec.describe 'GET /users' do
context 'with Authorization header' do
before do
headers['Authorization'] = 'token 12345'
end
it 'returns 200' do
subject
expect(response).to have_http_status(200)
end
end
endIf you want to modify request parameters, change params:
RSpec.describe 'GET /users' do
context 'with sort parameter' do
before do
params['sort'] = 'id'
end
it 'returns 200 with expected JSON body' do
subject
expect(response).to have_http_status(200)
expect(response.parsed_body).to match(
[
hash_including('id' => 1),
hash_including('id' => 2),
]
)
end
end
endYou can embed variables in URL path like /users/:user_id.
In this example, the returned value from #user_id method will be embedded as its real value.
RSpec.describe 'GET /users/:user_id' do
let(:user) do
User.create(name: 'alice')
end
let(:user_id) do
user.id
end
it 'returns 200' do
subject
expect(response).to have_http_status(200)
end
end