ybonjour / restspy

RESTSpy can mock REST endpoints or proxy them to real endpoints.

RESTSpy

Mock REST endpoints or proxy them to real endpoints.

Spies

A Spy is a local proxy server that by default redirects all requests to another server. You can then start to mock certain endpoints.

In a test setup you will create a Spy for every REST service that your application depends on and that you want to spy on.

Once a Spy is created, you can start mocking certain endpoints, by providing Doubles. A Double represents a HTTP response as a triplet of a status code, headers and body.

Examples

To get easy access to the RestSpy API you can include RestSpy::Api

include RestSpy::Api

Mock http://localhost:1234/stream endpoint, while requests to all other endpoints are proxied to https://www.facebook.com

facebook = Spy.server_on_local_port('https://www.facebook.com', 1234)
facebook.endpoint('/stream').should(return_response('Hello world!'))

Endpoints can also be matched using a regular expression. The following example shows how to mock all endpoints on localhost:1234 that start with stream.

facebook.endpoint('/stream.*').should(return_response(`Hello world!`, headers={'Token' => 'abcd'}))

Simulate an error code on the http://localhost:1234/search endpoint, while requests to all other endpoints are proxied to http://www.google.com

google = Spy.server_on_local_port('http://www.google.com', 1234)
google.endpoint('/search').should(return_error_code 401)

You can also define series of doubles and proxies for an endpoint:

google.endpoint('/mail').should(
          first(return_error_code 500)
          .and_then(return_error_code 401)
          .and_then(proxy_to(facebook.remote_url)))

restspy's Issues

Stub Endpoints only on specific HTTP-Methods

When a double is created for an endpoint it currently stubs the endpoint for all HTTP methods.
It should be possible to create a double only for specific HTTP methods.

Something along the lines of :

spy.endpoint('/foo').should_return_error_code(500) # Stubs all HTTP methods
spy.endpoint('/foo', GET).should_return_error_code(500) # Stubs only GET
spy.endpoint('/foo', [GET, POST]).should_return_error_code(500) # Stubs GET and POST

Add timestamp to requests

When retrieving the executed requests on the /spy endpoint, the timestamps for each request should be returned. This would allow the client to order the requests chronological.

Turn example.rb into proper tests

Currently the API level is only tested through the example.rb script.

This needs to be converted into proper tests.