harper 1.0.0 → 1.1.0

data/README.md

@@ -43,11 +43,24 @@ Harper will silently replace it with the new mock.
 * *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.
+* *body*: Either a string to be used as the HTTP response body, or an
+   array of strings. If an array is provided Harper will cycle through
+   the array as the response body for requests. Required.
 
 * *delay*: A delay to include when responding to the mock,
    in milliseconds. Optional. Defaults to no delay.
 
+* *request_body*: The params are used to compare with the actual request
+   body to find out whether the mock applies. This request_body is
+   optional and is required only in scenarios where you want multiple
+   requests to the same url return different response based on some
+   parameter sent in the request. The value passed in can actually be xml
+   read from a file, json read from a file or simply values in the request.
+   They need not be the whole request body - partial request params work.
+   However these must be conspicuously different across the requests i.e
+   they should not be so generic that they appear in all requests to
+   that url.
+
 ## Typical Use
 
 1. Start Harper at the very start of your test run.

data/features/mock_http_rpc_service.feature

@@ -69,6 +69,7 @@ Feature: Mock an HTTP RPC web service
     Given a defined response mock with a "status" of "<STATUS>"
     When  the application issues a "GET" request to the mock
     Then  the response code should be "<STATUS>"
+    When the application removes all registered mocks
   Examples:
     | STATUS |
     |    200 |
@@ -86,6 +87,7 @@ Feature: Mock an HTTP RPC web service
     Given a defined response mock with a "delay" of "<MILLISECONDS>"
     When  the application issues a "GET" request to the mock
     Then  the response time should be at least "<MILLISECONDS>"
+    When the application removes all registered mocks
   Examples:
     | MILLISECONDS |
     |            0 |

data/features/step_definitions/mock_definition_steps.rb

@@ -24,3 +24,7 @@ Then /^the "([^"]*)" mock is available at the URL in the "([^"]*)" header$/ do |
   get :from => id_url
   response.code.should == 200
 end
+
+When /^the application removes all registered mocks$/ do
+  delete_all_mocks
+end

data/features/support/client_application.rb

@@ -31,6 +31,10 @@ class ClientApplication
     @response = self.class.delete @known_mocks[name][:url]
   end
 
+  def delete_all_mocks
+    self.class.delete "/h/mocks"
+  end
+
   def get(options)
     timed { @response = self.class.get options[:from] }
   end

data/lib/harper/app.rb

@@ -27,6 +27,15 @@ module Harper
       def mock_id(url)
         [url].pack('m').tr("+/=", "-_.").gsub("\n", '')
       end
+
+      def retrieve_mock(mock_id, http_method, request_body)
+        if @@mocks[mock_id]
+          return @@mocks[mock_id].first if @@mocks[mock_id].length == 1
+          mocks_for_requested_http_method = @@mocks[mock_id].select { |m| m['method'] == http_method}
+          mock = mocks_for_requested_http_method.detect{|m| m["request_body"] && request_body =~ /#{m["request_body"]}/} if request_body
+          mock ||= mocks_for_requested_http_method.detect{|m| m["request_body"].nil?}
+        end
+      end
     end
 
     post '/h/mocks' do
@@ -37,10 +46,11 @@ module Harper
       mock['id'] = mock_id(mock['url'])
       mock['method'].upcase!
       mock['delay'] = mock['delay'].to_f / 1000.0
-      @@mocks[mock['id']] = mock
+      @@mocks[mock['id']] ||= []
+      @@mocks[mock['id']] << mock
 
       logger.info("Created mock for endpoint: '#{mock['url']}'")
-      
+
       headers['location'] = "/h/mocks/#{mock['id']}"
       status "201"
     end
@@ -76,12 +86,14 @@ module Harper
 
         logger.debug("#{request.request_method} request for a mock: '#{request.path}'")
 
-        mock = @@mocks[mock_id]
-        if mock && request.request_method == mock['method']
+        request_body = request.body.read if request.body
+        mock = retrieve_mock(mock_id, request.request_method, request_body)
+
+        if mock
           content_type mock['content-type']
           status mock['status'] || "200"
           sleep mock['delay']
-          
+
           logger.info("Serving mocked body for endpoint: '#{mock['url']}'")
 
           case mock['body']

data/lib/harper/version.rb

@@ -1,3 +1,3 @@
 module Harper
-  Version = "1.0.0"
+  Version = "1.1.0"
 end

data/spec/harper_spec.rb

@@ -5,7 +5,6 @@ require 'harper'
 
 describe Harper::App do
   include Rack::Test::Methods
-
   supported_verbs = ["GET", "POST", "PUT", "DELETE"]
 
   let(:app) { Harper::App.new }
@@ -68,7 +67,7 @@ describe Harper::App do
       before(:each) do
         post '/h/mocks', mock_def
       end
-      
+
       it "should respond with a 201 created" do
         last_response.status.should == 201
       end
@@ -180,4 +179,119 @@ describe Harper::App do
 
   end
 
+  context "supporting multiple mocks for same request url" do
+    it "should return the mock response corresponding to the request body for xml requests" do
+      url = "/service-url"
+
+      xml_string_for_request_one = <<-EOF
+        <mydoc>
+          <someelement attribute="nanoo">first request</someelement>
+        </mydoc>
+      EOF
+      body_one = "response body for request one"
+      mock_def_for_first_request =
+        { :method => "POST",
+          :url => url,
+          :'content-type' => "application/xml",
+          :body => body_one,
+          :request_body => xml_string_for_request_one
+        }.to_json
+
+      post '/h/mocks', mock_def_for_first_request
+
+      xml_string_for_request_two = <<-EOF
+        <mydoc>
+          <someelement attribute="nanoo">Other request</someelement>
+        </mydoc>
+      EOF
+      body_two = "response body for request two"
+      mock_def_for_second_request =
+      { :method => "POST",
+        :url => url,
+        :'content-type' => "application/xml",
+        :body => body_two,
+        :request_body => xml_string_for_request_two
+      }.to_json
+
+      post '/h/mocks', mock_def_for_second_request
+
+      post url, xml_string_for_request_one
+      last_response.body.should == body_one
+
+      post url, xml_string_for_request_two
+      last_response.body.should == body_two
+    end
+
+    it "should return the mock response corresponding to the request body for json requests" do
+      url = "/service-url"
+
+      request_json_one = {:param => "param 1"}.to_json
+      body_one = "response body for request one"
+      mock_def_for_first_request =
+        { :method => "POST",
+          :url => url,
+          :'content-type' => "application/json",
+          :body => body_one,
+          :request_body => request_json_one
+        }.to_json
+
+      post '/h/mocks', mock_def_for_first_request
+
+      request_json_two = {:param => "param 2"}.to_json
+      body_two = "response body for request two"
+      mock_def_for_second_request =
+        { :method => "POST",
+          :url => url,
+          :'content-type' => "application/json",
+          :body => body_two,
+          :request_body => request_json_two
+        }.to_json
+
+      post '/h/mocks', mock_def_for_second_request
+
+      post url, request_json_one
+      last_response.body.should == body_one
+
+      post url, request_json_two
+      last_response.body.should == body_two
+    end
+
+    it "should return the correct response for mocks registered without any request body" do
+      url = "/service-url"
+
+      xml_string_for_request_one = <<-EOF
+        <mydoc>
+          <someelement attribute="nanoo">first request</someelement>
+        </mydoc>
+      EOF
+
+      body_one = "response body for request one"
+      mock_def_for_first_request =
+        { :method => "POST",
+          :url => url,
+          :'content-type' => "application/xml",
+          :body => body_one,
+          :request_body => xml_string_for_request_one
+        }.to_json
+
+      post '/h/mocks', mock_def_for_first_request
+
+      body_two = "response body for request two"
+      mock_def_for_second_request_without_request_body =
+        { :method => "POST",
+          :url => url,
+          :'content-type' => "application/xml",
+          :body => body_two
+        }.to_json
+
+      post '/h/mocks', mock_def_for_second_request_without_request_body
+
+      post url, xml_string_for_request_one
+      last_response.body.should == body_one
+
+      post url
+      last_response.body.should == body_two
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70133087544280 !ruby/object:Gem::Requirement
+  requirement: &70183758661480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70133087544280
+  version_requirements: *70183758661480
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70133087543880 !ruby/object:Gem::Requirement
+  requirement: &70183758661020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70133087543880
+  version_requirements: *70183758661020
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70133087543060 !ruby/object:Gem::Requirement
+  requirement: &70183758676260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70133087543060
+  version_requirements: *70183758676260
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70133087542500 !ruby/object:Gem::Requirement
+  requirement: &70183758674400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70133087542500
+  version_requirements: *70183758674400
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70133087541880 !ruby/object:Gem::Requirement
+  requirement: &70183758673380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133087541880
+  version_requirements: *70183758673380
 - !ruby/object:Gem::Dependency
   name: sham_rack
-  requirement: &70133087541260 !ruby/object:Gem::Requirement
+  requirement: &70183758672900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133087541260
+  version_requirements: *70183758672900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70133087540700 !ruby/object:Gem::Requirement
+  requirement: &70183758672340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133087540700
+  version_requirements: *70183758672340
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70133087540100 !ruby/object:Gem::Requirement
+  requirement: &70183758671800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70133087540100
+  version_requirements: *70183758671800
 - !ruby/object:Gem::Dependency
   name: cucumber-sinatra
-  requirement: &70133087535840 !ruby/object:Gem::Requirement
+  requirement: &70183758670580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133087535840
+  version_requirements: *70183758670580
 description: Dead simple mocking for HTTP services, a Sinatra app
 email:
 - giles.alexander@gmail.com