harper 0.0.4 → 0.1.0

data/README.md

@@ -0,0 +1,59 @@
+# Harper: Dead-simple, out-of-process, HTTP mocks
+
+To mock a service using as Harper, POST a mock definition to Harper
+before making your request. It's simple, and you've probably written
+something similar a half-dozen times. Well, you don't need to anymore.
+
+You might be interested in using Harper when you're building an app
+that depends on an HTTP service, but you can't mock it out
+in-process. For example, a single page JavaScript app running in a
+mobile browser.
+
+## Ruby Client API
+
+Unfortunately there aren't yet interfaces to Harper from other languages.
+
+* Use `HarperClient::start` to start the Harper service in the
+  background.
+
+* Use `HarperClient::stop` to stop the background service.
+
+These two calls do start and stop another Ruby interpreter running in
+the background, so you might want to run these at the beginning and
+the end of your cucumber run, rather than before and after every
+scenario.
+
+This interface is incomplete. It is also possible to delete a
+mock. This can be done by deleting the URL provided in the `Location`
+header when creating a new mock.
+
+If you require more control of Harper, or you want to support a new
+language, check out `features/mock_http_rpc_service.feature`. And pull
+requests are always welcomed.
+
+### Defining Mocks
+
+Use `HarperClient::mock` to define a new mock. This method takes a
+hash defining the mock. If a mock has already been defined for a URL,
+Harper will silently replace it with the new mock.
+
+* *url*: The URL path to mock out. This also identifies the mock. Required.
+* *method*: The HTTP method to respond to. Required.
+
+* *status*: The HTTP status code to provide. Optional. Defaults to 200.
+* *content_type*: What content-type header to set when responding with
+   the mock. Required.
+* *body*: A string to be used as the HTTP response body. Required.
+
+* *delay*: A delay to include when responding to the mock,
+   in milliseconds. Optional. Defaults to no delay.
+
+## Typical Use
+
+1. Start Harper at the very start of your test run.
+2. In the Given steps or Background for your scenarios, define the
+mocks that will be required for that scenario. If a similar mock has
+already been defined, Harper will silently replace it.
+3. At the very end of your test run, stop Harper.
+
+That's it.

data/bin/harper

@@ -10,6 +10,8 @@ opts = Trollop::options do
 end
 
 def start(port)
+  # Harper needs access to the server hosting itself so that it can shut
+  # it down on demand
   server = Rack::Server.new :app => Harper::App, :Port => port, :server => 'webrick'
   Harper::App.server(server.server)
   server.start
@@ -35,8 +37,6 @@ def start_in_background(port)
   read.readline
 end
 
-# Harper needs access to the server hosting itself so that it can shut
-# it down on demand
 if opts[:bg]
   start_in_background(opts[:port])
 else

data/lib/harper/app.rb

@@ -6,8 +6,6 @@ require 'json'
 module Harper
   class App < Sinatra::Base
 
-    Version = "0.0.2"
-
     @@mocks = {}
     @@server = nil
 

data/lib/harper/client.rb

@@ -15,13 +15,16 @@ class HarperClient
   end
 
   def start
-    system("harper --port 4568 --bg")
+    Kernel.system("harper --port 4568 --bg")
     @started = true
   end
 
   def stop
     self.class.put "/h/control", :body => {:command => "quit"}.to_json
     @started = false
+  rescue Exception => e
+    # Ignore the error here as it's pretty common for the connection
+    # to be killed out from under the app
   end
 
   def mock(mock)

data/lib/harper/version.rb

@@ -1,3 +1,3 @@
 module Harper
-  Version = "0.0.4"
+  Version = "0.1.0"
 end

data/spec/client_spec.rb

@@ -0,0 +1,66 @@
+$: << File.dirname(__FILE__) + "/.."
+
+require 'spec/spec_helper'
+require 'harper/client'
+
+describe HarperClient do
+
+  subject { HarperClient.new }
+
+  describe '#start' do
+    it "should start on port 4568" do
+      Kernel.should_receive(:system).with("harper --port 4568 --bg")
+      subject.start
+    end
+
+    it "should be started after calling start" do
+      Kernel.stub!(:system)
+      subject.start
+      subject.should be_started
+    end
+  end
+
+  describe '#stop' do
+    before(:each) do
+      Kernel.stub!(:system)
+      subject.start
+    end
+
+    it "should put a quit command to the control interface" do
+      HarperClient.should_receive(:put).with("/h/control", :body => "{\"command\":\"quit\"}")
+      subject.stop
+    end
+
+    it "should not be started" do
+      HarperClient.stub!(:put)
+      subject.stop
+      subject.should_not be_started
+    end
+
+    it "should swallow any errors that might result" do
+      HarperClient.stub!(:put).and_throw(:anything)
+      expect { subject.stop }.to_not raise_error
+    end
+  end
+
+  describe '#mock' do
+    describe 'using a hash' do
+      let(:mock_def) { {:sample => "hash" } }
+      
+      it "should post to the mocks interface" do
+        HarperClient.should_receive(:post).with("/h/mocks", :body => mock_def.to_json)
+        subject.mock(mock_def)
+      end
+    end
+
+    describe 'using a string' do
+      let(:mock_def) { "sample" }
+
+      it "should post to the mocks interface" do
+        HarperClient.should_receive(:post).with("/h/mocks", :body => mock_def)
+        subject.mock(mock_def)
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harper
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70306501088500 !ruby/object:Gem::Requirement
+  requirement: &70294496714100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70306501088500
+  version_requirements: *70294496714100
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70306501087560 !ruby/object:Gem::Requirement
+  requirement: &70294496713200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70306501087560
+  version_requirements: *70294496713200
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70306501086480 !ruby/object:Gem::Requirement
+  requirement: &70294496712180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70306501086480
+  version_requirements: *70294496712180
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70306501085640 !ruby/object:Gem::Requirement
+  requirement: &70294496711320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70306501085640
+  version_requirements: *70294496711320
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70306501084920 !ruby/object:Gem::Requirement
+  requirement: &70294496710600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306501084920
+  version_requirements: *70294496710600
 - !ruby/object:Gem::Dependency
   name: sham_rack
-  requirement: &70306501084320 !ruby/object:Gem::Requirement
+  requirement: &70294496710000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306501084320
+  version_requirements: *70294496710000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70306501083780 !ruby/object:Gem::Requirement
+  requirement: &70294496709440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306501083780
+  version_requirements: *70294496709440
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70306501083040 !ruby/object:Gem::Requirement
+  requirement: &70294496708720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70306501083040
+  version_requirements: *70294496708720
 - !ruby/object:Gem::Dependency
   name: cucumber-sinatra
-  requirement: &70306501075940 !ruby/object:Gem::Requirement
+  requirement: &70294496701580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306501075940
+  version_requirements: *70294496701580
 description: Dead simple mocking for HTTP services, a Sinatra app
 email:
 - giles.alexander@gmail.com
@@ -122,6 +122,7 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - bin/harper
 - features/mock_http_rpc_service.feature
@@ -136,6 +137,7 @@ files:
 - lib/harper/app.rb
 - lib/harper/client.rb
 - lib/harper/version.rb
+- spec/client_spec.rb
 - spec/harper_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/gga/harper
@@ -170,5 +172,6 @@ test_files:
 - features/support/client_application.rb
 - features/support/env.rb
 - features/support/paths.rb
+- spec/client_spec.rb
 - spec/harper_spec.rb
 - spec/spec_helper.rb