webmock
webmock.cr
Library for stubbing HTTP::Client
requests in Crystal. Current version requires Crystal 0.11.0.
Inspired by webmock ruby gem.
Installation
Add it to shards.yml
:
development_dependencies:
webmock:
github: manastech/webmock.cr
branch: master
Usage
require "webmock"
By requiring webmock
unregistered HTTP::Client
requests will raise an exception.
If you still want to execute real requests, do this:
WebMock.allow_net_connect = true
Stub request based on uri only and with the default response
WebMock.stub(:any, "www.example.com")
response = HTTP::Client.get("http://www.example.com")
response.body #=> ""
response.status_code #=> 200
Stub requests based on method, uri, body, headers and custom response
WebMock.stub(:post, "www.example.com/foo").
with(body: "abc", headers: {"Content-Type" => "text/plain"}).
to_return(status: 500, body: "oops", headers: {"X-Error" => "true"})
response = HTTP::Client.post("http://www.example.com/foo",
body: "abc",
headers: HTTP::Headers{"Content-Type" => "text/plain"})
response.status_code #=> 500
response.body #=> "oops"
response.headers["X-Error"] #=> "true"
# Executing the same request gives the same response
response = HTTP::Client.post("http://www.example.com/foo",
body: "abc",
headers: HTTP::Headers{"Content-Type" => "text/plain"})
response.body #=> "oops"
Stub requests based on query string
WebMock.stub(:get, "www.example.com").
with(query: {"page" => "1", "count" => "10"})
response = HTTP::Client.get("http://www.example.com?count=10&page=1")
response.status_code #=> 200
Resetting
WebMock.reset
This clears all stubs and sets allow_net_connect
to false
.
To execute this automatically before each spec, you can do:
Spec.before_each &->WebMock.reset
Or, for individual specs you can use WebMock.wrap
and a block to make sure WebMock
is reset at the end of a spec:
WebMock.wrap do
WebMock.stub(:get, "www.example.com").to_return(body: "Example")
HTTP::Client.get("http://www.example.com").body #=> "Example"
end
HTTP::Client.get("http://www.example.com") # Raises WebMock::NetConnectNotAllowedError
Todo
Bring more features found in the webmock ruby gem.
Contributing
- Fork it ( https://github.com/manastech/webmock.cr/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request