harper 1.1.0 → 1.2.0

data/.rvmrc

@@ -1,2 +1,2 @@
 rvm_install_on_use_flag=1
-rvm --create use ruby-1.9.3-p0@harper
+rvm --create use ruby-1.9.3@harper

data/README.md

@@ -61,6 +61,32 @@ Harper will silently replace it with the new mock.
    they should not be so generic that they appear in all requests to
    that url.
 
+* *request_cookies*: This is a hash of key value pairs of cookies being
+   expected in the actual request, which will be used by harper for matching
+   before sending back the mock response.
+
+   sample usage:
+
+      harperClient.mock({:method => "POST",
+                   :url => "/url",
+                   :'content-type' => "application/xml",
+                   :request_body => request_json,
+                   :body => "response body",
+                   :request_cookies => {"UserID" => "JohnDoe"}
+                  })
+
+* *cookies*: This is a hash of key value pairs of cookies that harper will
+   send back in the mock response.
+
+   sample usage:
+
+      harperClient.mock({:method => "POST",
+                      :url => "/url",
+                      :'content-type' => "application/xml",
+                      :body => "response body",
+                      :cookies => {"UserID" => "JohnDoe","sampleCookie" => "cookieValue"}
+                     })
+
 ## Typical Use
 
 1. Start Harper at the very start of your test run.

data/lib/harper/app.rb

@@ -3,6 +3,8 @@ require 'sinatra/base'
 require 'logger'
 require 'json'
 
+require 'harper/mock_filter'
+
 module Harper
   class App < Sinatra::Base
 
@@ -20,6 +22,10 @@ module Harper
     end
 
     helpers do
+      def cookies(mocked_cookies)
+        mocked_cookies.each_pair { |k, v| response.set_cookie(k, v) } if mocked_cookies
+      end
+
       def logger
         LOGGER
       end
@@ -28,14 +34,23 @@ module Harper
         [url].pack('m').tr("+/=", "-_.").gsub("\n", '')
       end
 
-      def retrieve_mock(mock_id, http_method, request_body)
+      def retrieve_mock(mock_id, request)
         if @@mocks[mock_id]
+          # If there is only one mock with the id, then ignore all other filters
           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?}
+
+          # Mock parameters
+          method = request.request_method
+          body = request.body ? request.body.read : ''
+          cookies = request.cookies
+
+          mocks_for(mock_id).by_method(method).by_body(body).by_cookies(cookies).value
         end
       end
+
+      def mocks_for(mock_id)
+        MockFilter.new(@@mocks[mock_id])
+      end
     end
 
     post '/h/mocks' do
@@ -86,10 +101,10 @@ module Harper
 
         logger.debug("#{request.request_method} request for a mock: '#{request.path}'")
 
-        request_body = request.body.read if request.body
-        mock = retrieve_mock(mock_id, request.request_method, request_body)
+        mock = retrieve_mock(mock_id, request)
 
         if mock
+          cookies mock['cookies']
           content_type mock['content-type']
           status mock['status'] || "200"
           sleep mock['delay']

data/lib/harper/mock_filter.rb

@@ -0,0 +1,33 @@
+module Harper
+  class MockFilter
+
+    def initialize(mocks)
+      @mocks = mocks
+    end
+
+    def value
+      @mocks.first
+    end
+    
+    def all
+      @mocks
+    end
+
+    def by_method(actual)
+      MockFilter.new(@mocks.select { |m| m['method'] == actual })
+    end
+
+    def by_body(actual)
+      MockFilter.new(@mocks.select { |m| !m['request_body'] || actual =~ /#{m["request_body"]}/ })
+    end
+
+    def by_cookies(actual)
+      MockFilter.new(@mocks.select { |m| !m['request_cookies'] || contains_all(m['request_cookies'], actual)})
+    end
+
+    def contains_all(sub, full)
+      (sub.to_a - full.to_a).empty?
+    end
+
+  end
+end

data/lib/harper/version.rb

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

data/spec/harper_spec.rb

@@ -15,7 +15,7 @@ describe Harper::App do
   let(:content_type) { "text/plain" }
   let(:body) { "fake body" }
   let(:delay) { 0 }
-  
+
   let(:mock_def) do
     { :method => method,
       :url => url,
@@ -71,7 +71,7 @@ describe Harper::App do
       it "should respond with a 201 created" do
         last_response.status.should == 201
       end
-      
+
       it "should point to a newly created mock resource" do
         last_response.headers['Location'].should match(%r{/h/mocks/})
       end
@@ -169,7 +169,7 @@ describe Harper::App do
   end
 
   context "controlling harper" do
-    
+
     it "should exit, abruptly, on demand" do
       host = mock('hosting server')
       host.should_receive(:shutdown)
@@ -294,4 +294,114 @@ describe Harper::App do
     end
   end
 
+  context "support for cookies" do
+
+    after(:each) do
+      delete '/h/mocks'
+    end
+
+    it "should send back cookies registered in the mock" do
+      url = "/someUrl"
+      mock =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body",
+         :cookies => {"UserID" => "JohnDoe","sampleCookie" => "cookieValue"}
+        }.to_json
+
+      post '/h/mocks', mock
+
+      post url
+
+      last_response.headers["Set-Cookie"].should == "UserID=JohnDoe\nsampleCookie=cookieValue"
+    end
+
+    it "should send back response based on match of cookies in the request with those registered in the mock" do
+      url = "/someUrl"
+      mock_with_no_cookie =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body one"
+        }.to_json
+
+      mock_two =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body two",
+         :request_cookies => {"UserID" => "JohnDoe"}
+        }.to_json
+
+      mock_three =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body three",
+         :request_cookies => {"UserID" => "JohnDoe1"}
+        }.to_json
+
+
+      post '/h/mocks', mock_three
+      post '/h/mocks', mock_two
+      post '/h/mocks', mock_with_no_cookie
+
+      post url
+      last_response.body.should == "body one"
+
+      set_cookie "UserID=JohnDoe"
+      set_cookie "Key1=Value1"
+      post url
+      last_response.body.should == "body two"
+
+      set_cookie "UserID=JohnDoe1"
+      post url
+      last_response.body.should == "body three"
+    end
+
+    it "should send back response based on cookies in the request even if request body is the same" do
+      url = "/someUrl"
+
+      request_json = {:param => "request body 1"}.to_json
+      mock_one =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :request_body => request_json,
+         :body => "body one",
+         :request_cookies => {"UserID" => "JohnDoe"}
+        }.to_json
+
+      mock_two =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body two",
+         :request_body => request_json,
+        }.to_json
+
+      mock_three =
+        {:method => "POST",
+         :url => url,
+         :'content-type' => "application/xml",
+         :body => "body three",
+        }.to_json
+
+
+      post '/h/mocks', mock_one
+      post '/h/mocks', mock_two
+      post '/h/mocks', mock_three
+
+      post url
+      last_response.body.should == "body three"
+
+      post url, request_json
+      last_response.body.should == "body two"
+
+      set_cookie "UserID=JohnDoe"
+      post url, request_json
+      last_response.body.should == "body one"
+    end
+  end
 end

data/spec/mock_filter_spec.rb

@@ -0,0 +1,75 @@
+$: << File.dirname(__FILE__) + "/.."
+
+require 'spec/spec_helper'
+require 'harper/mock_filter'
+
+describe Harper::MockFilter do
+
+  subject { Harper::MockFilter.new(starting_set) }
+
+  context "an empty set" do
+    let(:starting_set) { [] }
+
+    it('should be nil') { subject.value.should be_nil }
+  end
+
+  context "a set of one item" do
+    let(:starting_set) { [:a_mock] }
+
+    it('should be the single item') { subject.value.should be :a_mock }
+  end
+
+  context "a set of matching mocks" do
+    let(:starting_set) { [{'id' => 'first'}.merge(attrs), {'id' => 'second'}.merge(attrs)] }
+
+    context "by methods" do
+      let(:attrs) { {'method' => 'matching'} }
+
+      it 'should return the first when filtered by method' do
+        subject.by_method('matching').value['id'].should == 'first'
+      end
+    end
+
+    context "by bodies" do
+      let(:attrs) { {'request_body' => "match"} }
+
+      it 'should return the first when filtered by body' do
+        subject.by_body('matching').value['id'].should == 'first'
+      end
+    end
+
+    context "by cookies" do
+      let(:attrs) { {'request_cookies' => {'c1' => 'v1'} } }
+
+      it 'should return the first when filtered by cookies' do
+        subject.by_cookies('c1' => 'v1', 'c2' => 'v2').value['id'].should == 'first'
+      end
+    end
+  end
+
+  context "a set of five mocks" do
+    let(:put_mock) { {'method' => 'put'} }
+    let(:with_body) { {'method' => 'get', 'request_body' => 'body'} }
+    let(:nothing) { {'method' => 'get'} }
+    let(:with_cookies) { {'method' => 'get', 'request_cookies' => {'c' => 'v'}} }
+    let(:both) { {'method' => 'get', 'request_body' => 'body', 'request_cookies' => {'c' => 'v'}} }
+
+    let(:starting_set) { [put_mock, with_body, nothing, with_cookies, both] }
+
+    context 'filtered by method' do
+      it("should find one mock with method 'put'") { subject.by_method('put').all.should have(1).mocks }
+      it("should find four mocks with method 'get'") { subject.by_method('get').all.should have(4).mocks }
+    end
+
+    context 'filtered by body' do
+      it("should find five mocks with body 'body'") { subject.by_body('body').all.should have(5).mocks }
+      it("should find three mocks with body 'unspecified'") { subject.by_body('unspecified').all.should have(3).mocks }
+    end
+
+    context 'filtered by cookies' do
+      it("should find five mocks with cookie 'c'") { subject.by_cookies('c' => 'v').all.should have(5).mocks }
+      it("should find three mocks with cookie 'c' = 'other'") { subject.by_cookies('c' => 'other').all.should have(3).mocks }
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70183758661480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70183758661480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70183758661020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70183758661020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70183758676260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70183758676260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70183758674400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70183758674400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70183758673380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183758673380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sham_rack
-  requirement: &70183758672900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183758672900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70183758672340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183758672340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70183758671800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70183758671800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: cucumber-sinatra
-  requirement: &70183758670580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183758670580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Dead simple mocking for HTTP services, a Sinatra app
 email:
 - giles.alexander@gmail.com
@@ -136,9 +181,11 @@ files:
 - lib/harper.rb
 - lib/harper/app.rb
 - lib/harper/client.rb
+- lib/harper/mock_filter.rb
 - lib/harper/version.rb
 - spec/client_spec.rb
 - spec/harper_spec.rb
+- spec/mock_filter_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/gga/harper
 licenses: []
@@ -160,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: harper
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Dead simple mocking for HTTP services
@@ -174,4 +221,5 @@ test_files:
 - features/support/paths.rb
 - spec/client_spec.rb
 - spec/harper_spec.rb
+- spec/mock_filter_spec.rb
 - spec/spec_helper.rb