Class: ActiveResource::HttpMock

Overview

One thing that has always been a pain with remote web services is testing. The HttpMock class makes it easy to test your Active Resource models by creating a set of mock responses to specific requests.

To test your Active Resource model, you simply call the ActiveResource::HttpMock.respond_to method with an attached block. The block declares a set of URIs with expected input, and the output each request should return. The passed in block has any number of entries in the following generalized format:

http_method - The HTTP method to listen for. This can be get, post, put, delete or head.

path - A string, starting with a “/”, defining the URI that is expected to be called.

request_headers - Headers that are expected along with the request. This argument uses a hash format, such as { "Content-Type" => "application/json" }. This mock will only trigger if your tests sends a request with identical headers.

body - The data to be returned. This should be a string of Active Resource parseable content, such as Json.

status - The HTTP response code, as an integer, to return with the response.

response_headers - Headers to be returned with the response. Uses the same hash format as request_headers listed above.

In order for a mock to deliver its content, the incoming request must match by the http_method, path and request_headers. If no match is found an InvalidRequestError exception will be raised showing you what request it could not find a response for and also what requests and response pairs have been recorded so you can create a new mock for that request.

Returns an array of all request objects that have been sent to the mock. You can use this to check if your model actually sent an HTTP request.

Example

defsetup@matz={:person=>{:id=>1,:name=>"Matz"}}.to_jsonActiveResource::HttpMock.respond_todo|mock|mock.get"/people/1.json",{},@matzendenddeftest_should_request_remote_serviceperson=Person.find(1)# Call the remote service# This request object has the same HTTP method and path as declared by the mockexpected_request=ActiveResource::Request.new(:get,"/people/1.json")# Assert that the mock received, and responded to, the expected request from the modelassertActiveResource::HttpMock.requests.include?(expected_request)end

This also works with passing in generated pairs of requests and responses, again, just pass in false as the last argument:

Example

ActiveResource::HttpMock.respond_todo|mock|mock.send(:get,"/people/1",{},"JSON1")endActiveResource::HttpMock.responses.length#=> 1get_matz=ActiveResource::Request.new(:get,'/people/1.json',nil)ok_response=ActiveResource::Response.new("",200,{})pairs={get_matz=>ok_response}ActiveResource::HttpMock.respond_to(pairs,false)ActiveResource::HttpMock.responses.length#=> 2# If you add a response with an existing request, it will be replacedfail_response=ActiveResource::Response.new("",404,{})pairs={get_matz=>fail_response}ActiveResource::HttpMock.respond_to(pairs,false)ActiveResource::HttpMock.responses.length#=> 2