http-double 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a721d997225c62ba548ee917eae40eefdb4d8e3
-  data.tar.gz: 5fe372379cdeec4b1256e51a8b649afb9d59ef61
+  metadata.gz: f23faa1f6653d54edc6a1b1584c02720859b5f56
+  data.tar.gz: 23e07dbfc8058a0f85ac642cc6ec2b1e466743c3
 SHA512:
-  metadata.gz: 51c09d187246bf27b45ddb38222652ffd42d0a4269a3ebc461ffff4da8c4cada55c02b2cf5ff763acee724a2e9c686411b0742d95b4e8d24e72be0744a2b98e1
-  data.tar.gz: a4205a95567b1862a7133496aaa7b385022b8281bda15e75646924c1c157224dc578d0fddb9b8f4d793c06ea172d9c2cee80e17d7238ebe2816b38b25e104115
+  metadata.gz: 052c0e4cadc430e204ae4a0e00554d0eafd1d3e1f37586200bdce216dc1546907a6f45e5edacaa49374d22d014561ed71511ddfa0a99c583c269207c42f6e072
+  data.tar.gz: 593c08637600a28ca534f2a3d6b2b51f0cc51fb04edca47dd33af0a43c2e950e76e21fd4fee60b6f2cdef5b7fbbf26371ac4a003146c31f406b8bb964a7cbee4

data/README.md

@@ -1 +1,95 @@
-TODO
+This gem allows you to double external HTTP services using [Sinatra](http://www.sinatrarb.com/). Your server(s) will be run in the background using [Thin](http://code.macournoyer.com/thin/) each time you run your tests/specs.
+
+## Installation
+
+```bash
+$ gem install http-double
+```
+
+## Usage
+
+First, define a server double:
+
+```ruby
+require 'http-double'
+
+class HelloDouble < HttpDouble::Base
+  get '/hello' do
+    [
+      200, 
+      {'Content-Type' => 'application/json'}, 
+      ['{"greeting":"Hello!"}']
+    ]
+  end
+end
+```
+
+Then background it in your spec helper or test setup routine, specifying a local address and port:
+
+```ruby
+HelloDouble.background '127.0.0.1', 1357
+```
+
+You can now write functional tests against your double, using no-nonsense HTTP over honest-to-goodness TCP.
+
+```ruby
+describe 'The "Hello" server' do
+  it 'should greet me politely' do
+    response = Net::HTTP.get_response(URI 'http://127.0.0.1:1357/hello').body
+    expect(response).to include 'Hello!'
+  end
+end
+```
+
+### Expectations on Traffic
+
+Every request/response to/from an HTTP double is recorded in its `log`. To use the log effectively, clear it before each test.
+
+```ruby
+before :each do
+  HelloDouble.log.clear
+end
+```
+
+Each member of the `log` array contains a `request` and a `response`. Here's a contrived example:
+
+```ruby
+describe 'The "Hello" server' do
+  it 'should record traffic' do
+    log = HelloDouble.log
+    Net::HTTP.get_response URI 'http://127.0.0.1:1357/hello'
+    
+    expect(log.count).to be 1
+    
+    expect(log.last.request.verb).to be :get
+    expect(log.last.request.path).to eq '/hello'
+    expect(log.last.request.body).to be_nil
+    
+    expect(log.last.response.code).to be 200
+    expect(log.last.response.headers['Content-Type']).to eq 'application/json'
+    expect(JSON.parse(log.last.response.body)['greeting']).to eq 'Hello!'
+  end
+end
+```
+
+In functional tests, you will tend to mostly want to test what your application sends. The log's request object lets you set expectations using indexed access:
+
+```ruby
+def be_a_cowboy!
+  uri = URI 'http://127.0.0.1:1357/hello'
+  Net::HTTP.post_form uri, 'new_greeting' => 'Howdy!'
+end
+
+describe 'Something that changes my greeting' do
+  it 'should act like a cowboy' do
+    be_a_cowboy!
+    request = HelloDouble.log.last.request
+    
+    expect(request.verb).to be :post
+    expect(request.path).to eq '/hello'
+    expect(request['new_greeting']).to eq 'Howdy!'
+  end
+end
+```
+
+You can use indexed access on any request sent as valid `application/x-www-form-urlencoded` or `application/json`.

data/lib/http_double/base.rb

@@ -12,7 +12,7 @@ module HttpDouble
         @initializer = block
       end
 
-      def foreground(addr, port, log_path: '/dev/null', logger: nil)
+      def foreground(addr, port, log_path: '/dev/null', logger: nil, &block)
         server_class = self
         app_class = @app_class || server_class
 
@@ -26,13 +26,14 @@ module HttpDouble
         Thin::Server.start(addr, port) do
           initializer.call if initializer
           use RequestLogger, server_class.log
+          instance_exec &block if block
           run Class === app_class ? app_class.new : app_class
         end
 
       end
 
-      def background(addr, port, **args)
-        thread = Thread.new{ foreground addr, port, **args }
+      def background(addr, port, **args, &block)
+        thread = Thread.new{ foreground addr, port, **args, &block }
         thread.abort_on_exception = true
         sleep 0.05 until test_background addr, port
         thread

data/lib/http_double/version.rb

@@ -1,3 +1,3 @@
 module HttpDouble
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-double
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -98,30 +98,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 description: Provides a simple way to double HTTP services, APIs etc, for testing.
 email:
 - neil@helium.net.au
@@ -156,9 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Sinatra-based HTTP test doubling
 test_files: []
-has_rdoc: