webmock 1.5.0 → 1.6.0

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 #Changelog
 
+## 1.6.0
+
+* Simplified integration with Test::Unit, RSpec and Cucumber. Now only a single file has to be required i.e.
+
+		require 'webmock/test_unit'
+		require 'webmock/rspec'
+		require 'webmock/cucumber'
+
+* The error message on unstubbed request now contains code snippet which can be used to stub this request. Thanks to Martyn Loughran for suggesting this feature.
+
+* The expectation failure message now contains a list of made requests. Thanks to Martyn Loughran for suggesting this feature.
+
+* Added `WebMock.print_executed_requests` method which can be useful to find out what requests were made until a given point.
+
+* em-http-request adapter is now activated by replacing EventMachine::HttpRequest constant, instead of monkeypatching the original class.
+
+ This technique is borrowed from em-http-request native mocking module. It allows switching WebMock adapter on an off, and using it interchangeably with em-http-request native mocking i.e:
+
+		EventMachine::WebMockHttpRequest.activate!
+		EventMachine::WebMockHttpRequest.deactivate!
+
+	Thanks to Martyn Loughran for suggesting this feature.
+	
+* `WebMock.reset_webmock` is deprecated in favour of new `WebMock.reset!`	
+
+* Fixed integration with Cucumber. Previously documented example didn't work with new versions of Cucumber.
+
+* Fixed stubbing requests with body declared as a hash. Thanks to Erik Michaels-Ober for reporting the issue.
+
+* Fixed issue with em-http-request adapter which didn't work when :query option value was passed as a string, not a hash. Thanks to Chee Yeo for reporting the issue.
+
+* Fixed problem with assert_requested which didn't work if used outside rspec or test/unit
+
+* Removed dependency on json gem
+
 ## 1.5.0
 
 * Support for dynamically evaluated raw responses recorded with `curl -is` <br/>

data/README.md

@@ -25,17 +25,19 @@ Supported HTTP libraries
 
 ##Installation
 
-    gem install webmock --source http://gemcutter.org
+	gem install webmock --source http://gemcutter.org
+
+### or to install the latest development version from github master
+
+	git clone http://github.com/bblimke/webmock.git
+	cd webmock
+	rake install
 
 ### Test::Unit 
 
 Add the following code to `test/test_helper.rb`
 
 	require 'webmock/test_unit'
-	
-	class Test::Unit::TestCase
-	  include WebMock::API
-	end
 
 ### RSpec
 	
@@ -43,32 +45,16 @@ Add the following code to `spec/spec_helper`:
 
 	require 'webmock/rspec'
 
-	Spec::Runner.configure do |config|
-	  config.include WebMock::API
-	end
-
-### RSpec 2
-
-Add the following code to `spec/spec_helper`:
-
-	require 'webmock/rspec'
-	
-	RSpec.configure do |config|
-	  config.include WebMock::API
-	end
-
 ### Cucumber
 
 Add the following code to `features/support/env.rb`
 
-	require 'webmock/rspec'
-	World(WebMock::API, WebMock::Matchers)
+	require 'webmock/cucumber'
 
 You can also use WebMock outside a test framework:
 
 	require 'webmock'
 	include WebMock::API
-	include WebMock::Matchers
 
 ## Examples
 
@@ -392,13 +378,13 @@ This forces WebMock Net::HTTP adapter to always connect on `Net::HTTP.start`.
 
 ## Clearing stubs and request history
 
-If you want to reset all current stubs and history of requests use `WebMock.reset_webmock`
+If you want to reset all current stubs and history of requests use `WebMock.reset!`
 
 	stub_request(:any, "www.example.com")
 
 	Net::HTTP.get('www.example.com', '/')    # ===> Success
 
-	reset_webmock
+	WebMock.reset!
 
 	Net::HTTP.get('www.example.com', '/')    # ===> Failure
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/lib/webmock.rb

@@ -16,6 +16,7 @@ require 'webmock/errors'
 require 'webmock/util/uri'
 require 'webmock/util/headers'
 require 'webmock/util/hash_counter'
+require 'webmock/util/hash_keys_stringifier'
 
 require 'webmock/request_pattern'
 require 'webmock/request_signature'
@@ -23,10 +24,13 @@ require 'webmock/responses_sequence'
 require 'webmock/request_stub'
 require 'webmock/response'
 
+require 'webmock/stub_request_snippet'
+
 require 'webmock/assertion_failure'
 require 'webmock/request_execution_verifier'
 require 'webmock/config'
 require 'webmock/callback_registry'
 require 'webmock/request_registry'
+require 'webmock/stub_registry'
 require 'webmock/api'
 require 'webmock/webmock'

data/lib/webmock/api.rb

@@ -3,7 +3,7 @@ module WebMock
     extend self
     
     def stub_request(method, uri)
-      WebMock::RequestRegistry.instance.register_request_stub(WebMock::RequestStub.new(method, uri))
+      WebMock::StubRegistry.instance.register_request_stub(WebMock::RequestStub.new(method, uri))
     end
 
     alias_method :stub_http_request, :stub_request

data/lib/webmock/assertion_failure.rb

@@ -1,13 +1,11 @@
 module WebMock
   class AssertionFailure
+    @error_class = RuntimeError
     class << self
-      attr_writer :error_class
-      @error_class = RuntimeError
-    
+      attr_accessor :error_class
       def failure(message)
         raise @error_class.new(message)
       end
-    
     end
   end
 end

data/lib/webmock/cucumber.rb

@@ -0,0 +1,8 @@
+require 'webmock'
+require 'webmock/rspec/matchers'
+
+World(WebMock::API, WebMock::Matchers)
+
+After do
+  WebMock.reset!
+end

data/lib/webmock/errors.rb

@@ -2,7 +2,19 @@ module WebMock
   
   class NetConnectNotAllowedError < StandardError
     def initialize(request_signature)
-      super("Real HTTP connections are disabled. Unregistered request: #{request_signature}")
+      text = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
+      text << stubbing_instructions(request_signature)
+      super(text)
+    end
+
+    private
+
+    def stubbing_instructions(request_signature)
+      text = "\n\n"
+      text << "You can stub this request with the following snippet:\n\n"
+      text << WebMock::StubRequestSnippet.new(request_signature).to_s
+      text << "\n\n" + "="*60
+      text
     end
   end
 

data/lib/webmock/http_lib_adapters/curb.rb

@@ -6,8 +6,8 @@ if defined?(Curl)
         request_signature = build_request_signature
         WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
-        if WebMock::RequestRegistry.instance.registered_request?(request_signature)
-          webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+        if WebMock::StubRegistry.instance.registered_request?(request_signature)
+          webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
           build_curb_response(webmock_response)
           WebMock::CallbackRegistry.invoke_callbacks(
             {:lib => :curb}, request_signature, webmock_response)

data/lib/webmock/http_lib_adapters/em_http_request.rb

@@ -1,9 +1,13 @@
 if defined?(EventMachine::HttpRequest)
 
   module EventMachine
-    class HttpRequest
+    OriginalHttpRequest = HttpRequest unless const_defined?(:OriginalHttpRequest)
 
-      class WebMockFakeHttpClient < EventMachine::HttpClient
+    class WebMockHttpRequest < EventMachine::HttpRequest
+
+      include HttpEncoding
+
+      class WebMockHttpClient < EventMachine::HttpClient
 
         def setup(response, uri, error = nil)
           @uri = uri
@@ -17,7 +21,7 @@ if defined?(EventMachine::HttpRequest)
             end
           end
         end
-        
+
         def unbind
         end
 
@@ -30,11 +34,11 @@ if defined?(EventMachine::HttpRequest)
 
         WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
-        if WebMock::RequestRegistry.instance.registered_request?(request_signature)
-          webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+        if WebMock::StubRegistry.instance.registered_request?(request_signature)
+          webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
           WebMock::CallbackRegistry.invoke_callbacks(
-            {:lib => :em_http_request}, request_signature, webmock_response)
-          client = WebMockFakeHttpClient.new(nil)
+          {:lib => :em_http_request}, request_signature, webmock_response)
+          client = WebMockHttpClient.new(nil)
           client.on_error("WebMock timeout error") if webmock_response.should_timeout
           client.setup(make_raw_response(webmock_response), @uri,
             webmock_response.should_timeout ? "WebMock timeout error" : nil)
@@ -54,13 +58,13 @@ if defined?(EventMachine::HttpRequest)
           raise WebMock::NetConnectNotAllowedError.new(request_signature)
         end
       end
-      
+
       alias_method :send_request_without_webmock, :send_request
       alias_method :send_request, :send_request_with_webmock
-      
+
 
       private
-      
+
       def build_webmock_response(http)
         webmock_response = WebMock::Response.new
         webmock_response.status = [http.response_header.status, http.response_header.http_reason]
@@ -78,7 +82,7 @@ if defined?(EventMachine::HttpRequest)
           options = @options
           method = @method
           uri = @uri
-        end  
+        end
 
         if options[:authorization] || options['authorization']
           auth = (options[:authorization] || options['authorization'])
@@ -87,9 +91,9 @@ if defined?(EventMachine::HttpRequest)
           options.reject! {|k,v| k.to_s == 'authorization' } #we added it to url userinfo
           uri.userinfo = userinfo
         end
-        
-       uri.query_values = (uri.query_values || {}).merge(options[:query]) if options[:query]
-        
+
+        uri.query = encode_query(@req.uri, options[:query]).slice(/\?(.*)/, 1)
+
         WebMock::RequestSignature.new(
           method.downcase.to_sym,
           uri.to_s,
@@ -99,11 +103,11 @@ if defined?(EventMachine::HttpRequest)
       end
 
 
-      def make_raw_response(response)            
+      def make_raw_response(response)
         response.raise_error_if_any
-        
+
         status, headers, body = response.status, response.headers, response.body
-        
+
         response_string = []
         response_string << "HTTP/1.1 #{status[0]} #{status[1]}"
 
@@ -116,8 +120,18 @@ if defined?(EventMachine::HttpRequest)
         response_string.join("\n")
       end
 
+      def self.activate!
+        EventMachine.send(:remove_const, :HttpRequest)
+        EventMachine.send(:const_set, :HttpRequest, WebMockHttpRequest)
+      end
 
+      def self.deactivate!
+        EventMachine.send(:remove_const, :HttpRequest)
+        EventMachine.send(:const_set, :HttpRequest, OriginalHttpRequest)
+      end
     end
   end
 
+  EventMachine::WebMockHttpRequest.activate!
+
 end

data/lib/webmock/http_lib_adapters/httpclient.rb

@@ -15,8 +15,8 @@ if defined?(::HTTPClient)
 
       WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
-      if WebMock::RequestRegistry.instance.registered_request?(request_signature)
-        webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+      if WebMock::StubRegistry.instance.registered_request?(request_signature)
+        webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
         response = build_httpclient_response(webmock_response, stream, &block)
         res = conn.push(response)
         WebMock::CallbackRegistry.invoke_callbacks(
@@ -46,7 +46,7 @@ if defined?(::HTTPClient)
       req = create_request(method, uri, query, body, extheader)
       request_signature = build_request_signature(req)
       
-      if WebMock::RequestRegistry.instance.registered_request?(request_signature) ||
+      if WebMock::StubRegistry.instance.registered_request?(request_signature) ||
          WebMock.net_connect_allowed?(request_signature.uri)
         do_request_async_without_webmock(method, uri, query, body, extheader)
       else

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -51,9 +51,9 @@ module Net  #:nodoc: all
 
       WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
-      if WebMock::RequestRegistry.instance.registered_request?(request_signature)
+      if WebMock::StubRegistry.instance.registered_request?(request_signature)
         @socket = Net::HTTP.socket_type.new
-        webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+        webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
         WebMock::CallbackRegistry.invoke_callbacks(
           {:lib => :net_http}, request_signature, webmock_response)
         build_net_http_response(webmock_response, &block)

data/lib/webmock/http_lib_adapters/patron.rb

@@ -8,8 +8,8 @@ if defined?(Patron)
 
         WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
-        if WebMock::RequestRegistry.instance.registered_request?(request_signature)
-          webmock_response = WebMock::RequestRegistry.instance.response_for_request(request_signature)
+        if WebMock::StubRegistry.instance.registered_request?(request_signature)
+          webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
           handle_file_name(req, webmock_response)
           res = build_patron_response(webmock_response)
           WebMock::CallbackRegistry.invoke_callbacks(

data/lib/webmock/request_execution_verifier.rb

@@ -27,15 +27,29 @@ module WebMock
 
     def failure_message
       expected_times_executed = @expected_times_executed || 1
-      %Q(The request #{request_pattern.to_s} was expected to execute #{expected_times_executed} time#{ (expected_times_executed == 1) ? '' : 's'} but it executed #{times_executed} time#{ (times_executed == 1) ? '' : 's'})
+      text = %Q(The request #{request_pattern.to_s} was expected to execute #{times(expected_times_executed)} but it executed #{times(times_executed)})
+      text << self.class.executed_requests_message
+      text
     end
 
     def negative_failure_message
-      if @expected_times_executed
-        %Q(The request #{request_pattern.to_s} was not expected to execute #{expected_times_executed} time#{ (expected_times_executed == 1) ? '' : 's'} but it executed #{times_executed} time#{ (times_executed == 1) ? '' : 's'})
+      text = if @expected_times_executed
+        %Q(The request #{request_pattern.to_s} was not expected to execute #{times(expected_times_executed)} but it executed #{times(times_executed)})
       else
-        %Q(The request #{request_pattern.to_s} was expected to execute 0 times but it executed #{times_executed} time#{ (times_executed == 1) ? '' : 's'})
+        %Q(The request #{request_pattern.to_s} was expected to execute 0 times but it executed #{times(times_executed)})
       end
+      text << self.class.executed_requests_message
+      text
+    end
+
+    def self.executed_requests_message
+      "\n\nThe following requests were made:\n\n#{RequestRegistry.instance.to_s}\n" + "="*60
+    end
+
+    private
+
+    def times(times)
+      "#{times} time#{ (times == 1) ? '' : 's'}"
     end
 
   end

data/lib/webmock/request_pattern.rb

@@ -167,7 +167,7 @@ module WebMock
     end
 
     def normalize_hash(hash)
-      JSON.parse(JSON.generate(hash))
+      WebMock::Util::HashKeysStringifier.stringify_keys!(hash)
     end
 
   end

data/lib/webmock/request_registry.rb

@@ -3,47 +3,32 @@ module WebMock
   class RequestRegistry
     include Singleton
 
-    attr_accessor :request_stubs, :requested_signatures
+    attr_accessor :requested_signatures
 
     def initialize
-      reset_webmock
+      reset!
     end
 
-    def reset_webmock
-      self.request_stubs = []
+    def reset!
       self.requested_signatures = Util::HashCounter.new
     end
 
-    def register_request_stub(stub)
-      request_stubs.insert(0, stub)
-      stub
-    end
-
-    def registered_request?(request_signature)
-      request_stub_for(request_signature)
-    end
-
-    def response_for_request(request_signature)
-      stub = request_stub_for(request_signature)
-      stub ? evaluate_response_for_request(stub.response, request_signature) : nil
-    end
-
     def times_executed(request_pattern)
       self.requested_signatures.hash.select { |request_signature, times_executed|
         request_pattern.matches?(request_signature)
       }.inject(0) {|sum, (_, times_executed)| sum + times_executed }
     end
 
-    private
-
-    def request_stub_for(request_signature)
-      request_stubs.detect { |registered_request_stub|
-        registered_request_stub.request_pattern.matches?(request_signature)
-      }
-    end
-
-    def evaluate_response_for_request(response, request_signature)
-      response.evaluate(request_signature)
+    def to_s
+      if requested_signatures.hash.empty?
+        "No requests were made."
+      else
+        text = ""
+        self.requested_signatures.each do |request_signature, times_executed|
+          text << "#{request_signature} was made #{times_executed} time#{times_executed == 1 ? '' : 's' }\n"
+        end
+        text
+      end
     end
 
   end