webmock 0.9.1 → 1.0.0

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 #Changelog
 
+## 1.0.0
+
+* Added support for [Patron](http://toland.github.com/patron/)
+
+* Responses dynamically evaluated from block (idea and implementation by Tom Ward)
+
+		stub_request(:any, 'www.example.net').
+		     to_return { |request| {:body => request.body} }
+
+		RestClient.post('www.example.net', 'abc')    # ===> "abc\n"
+
+* Responses dynamically evaluated from lambda (idea and implementation by Tom Ward)
+
+    	stub_request(:any, 'www.example.net').
+	      to_return(lambda { |request| {:body => request.body} })
+
+	    RestClient.post('www.example.net', 'abc')    # ===> "abc\n"	       
+
+* Response with custom status message 
+
+		stub_request(:any, "www.example.com").to_return(:status => [500, "Internal Server Error"])
+
+		req = Net::HTTP::Get.new("/")
+		Net::HTTP.start("www.example.com") { |http| http.request(req) }.message # ===> "Internal Server Error"
+
+* Raising timeout errors (suggested by Jeffrey Jones) (compatibility with Ruby 1.8.6 by Mack Earnhardt)
+
+		stub_request(:any, 'www.example.net').to_timeout
+
+		RestClient.post('www.example.net', 'abc')    # ===> RestClient::RequestTimeout
+
+* External requests can be disabled while allowing localhost (idea and implementation by Mack Earnhardt)
+
+		WebMock.disable_net_connect!(:allow_localhost => true)
+
+		Net::HTTP.get('www.something.com', '/')   # ===> Failure
+
+		Net::HTTP.get('localhost:9887', '/')      # ===> Allowed. Perhaps to Selenium?
+
+
+### Bug fixes
+
+* Fixed issue where Net::HTTP adapter didn't work for requests with body responding to read (reported by Tekin Suleyman)
+* Fixed issue where request stub with headers declared as nil was matching requests with non empty headers
+
 ## 0.9.1
 
 * Fixed issue where response status code was not read from raw (curl -is) responses
@@ -14,12 +59,12 @@
 		#or 
 		assert_requested(:post, "www.example.com") { |req| req.body == "abc" }
 
-* Matching request body against regular expressions
+* Matching request body against regular expressions (suggested by Ben Pickles)
 
 		stub_request(:post, "www.example.com").with(:body => /^.*world$/).to_return(:body => "abc")
 		RestClient.post('www.example.com', 'hello world')    # ===> "abc\n"
 	
-* Matching request headers against regular expressions
+* Matching request headers against regular expressions (suggested by Ben Pickles)
 
 		stub_request(:post, "www.example.com").with(:headers => {"Content-Type" => /image\/.+/}).to_return(:body => "abc")
 		RestClient.post('www.example.com', '', {'Content-Type' => 'image/png'})    # ===> "abc\n"

data/README.md

@@ -14,6 +14,7 @@ Features
 * Support for Test::Unit and RSpec (and can be easily extended to other frameworks)
 * Support for Net::HTTP and other http libraries based on Net::HTTP (i.e RightHttpConnection, rest-client, HTTParty)
 * Support for HTTPClient library (both sync and async requests)
+* Support for Patron library
 * Easy to extend to other HTTP libraries
 
 Installation
@@ -113,7 +114,7 @@ You can also use WebMock without RSpec or Test::Unit support:
 	
 	Net::HTTP.get("www.example.com", '/')    # ===> "abc"
 
-### Custom response with body specified as IO object
+### Response with body specified as IO object
 
 	File.open('/tmp/response_body.txt', 'w') { |f| f.puts 'abc' }
 
@@ -121,6 +122,13 @@ You can also use WebMock without RSpec or Test::Unit support:
 
 	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
 	
+### Response with custom status message
+
+	stub_request(:any, "www.example.com").to_return(:status => [500, "Internal Server Error"])
+
+	req = Net::HTTP::Get.new("/")
+	Net::HTTP.start("www.example.com") { |http| http.request(req) }.message # ===> "Internal Server Error"
+		
 ### Replaying raw responses recorded with `curl -is`
 
 	`curl -is www.example.com > /tmp/example_curl_-is_output.txt`
@@ -134,13 +142,39 @@ You can also use WebMock without RSpec or Test::Unit support:
 
 	stub_request(:get, "www.example.com").to_return(raw_response_file.read)
 
-### Custom response with dynamically evaluated response
-	
+### Responses dynamically evaluated from block
+
+    stub_request(:any, 'www.example.net').
+      to_return { |request| {:body => request.body} }
+
+    RestClient.post('www.example.net', 'abc')    # ===> "abc\n"
+    
+### Responses dynamically evaluated from lambda
+    
+    stub_request(:any, 'www.example.net').
+      to_return(lambda { |request| {:body => request.body} })
+
+    RestClient.post('www.example.net', 'abc')    # ===> "abc\n"	       
+
+### Responses with dynamically evaluated parts
+
     stub_request(:any, 'www.example.net').
       to_return(:body => lambda { |request| request.body })
 
     RestClient.post('www.example.net', 'abc')    # ===> "abc\n"	
 
+### Raising errors
+
+	stub_request(:any, 'www.example.net').to_raise(StandardError)
+
+    RestClient.post('www.example.net', 'abc')    # ===> StandardError
+
+### Raising timeout errors
+
+	stub_request(:any, 'www.example.net').to_timeout
+
+	RestClient.post('www.example.net', 'abc')    # ===> RestClient::RequestTimeout	
+
 ### Multiple responses for repeated requests
 
 	stub_request(:get, "www.example.com").to_return({:body => "abc"}, {:body => "def"})
@@ -151,10 +185,10 @@ You can also use WebMock without RSpec or Test::Unit support:
 	
 	Net::HTTP.get('www.example.com', '/')    # ===> "def\n" 
 
-### Multiple responses using chained `to_return()` or `to_raise()` declarations
+### Multiple responses using chained `to_return()`, `to_raise()` or `to_timeout` declarations
 
 	stub_request(:get, "www.example.com").
-		to_return({:body => "abc"}).then.  #then() just is a syntactic sugar
+		to_return({:body => "abc"}).then.  #then() is just a syntactic sugar
 		to_return({:body => "def"}).then.
 		to_raise(MyException)
 	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
@@ -186,6 +220,13 @@ You can also use WebMock without RSpec or Test::Unit support:
 	
 	Net::HTTP.get('www.something.com', '/')    # ===> Failure
 
+### External requests can be disabled while allowing localhost
+	
+	WebMock.disable_net_connect!(:allow_localhost => true)
+	
+	Net::HTTP.get('www.something.com', '/')   # ===> Failure
+	
+	Net::HTTP.get('localhost:9887', '/')      # ===> Allowed. Perhaps to Selenium?
 
 ## Setting Expectations
 
@@ -356,10 +397,31 @@ I'm particularly interested in how the DSL could be improved.
 
 ## Credits
 
+The initial lines of this project were written during New Bamboo [Hack Day](http://blog.new-bamboo.co.uk/2009/11/13/hackday-results)
 Thanks to my fellow [Bambinos](http://new-bamboo.co.uk/) for all the great suggestions!
 
+People who submitted patches and new features or suggested improvements. Many thanks to these people:
+
+* Ben Pickles
+* Mark Evans
+* Ivan Vega
+* Piotr Usewicz
+* Nick Plante
+* Nick Quaranto
+* Diego E. "Flameeyes" Pettenò
+* Niels Meersschaert
+* Mack Earnhardt
+* Arvicco
+* Sergio Gil
+* Jeffrey Jones
+* Tekin Suleyman
+* Tom Ward
+* Nadim Bitar
+
+## Background
+
 Thank you Fakeweb! This library was inspired by [FakeWeb](fakeweb.rubyforge.org).
-I took couple of solutions from that project. I also copied some code i.e Net:HTTP adapter. 
+I imported some solutions from that project to WebMock. I also copied some code i.e Net:HTTP adapter. 
 Fakeweb architecture unfortunately didn't allow me to extend it easily with the features I needed.
 I also preferred some things to work differently i.e request stub precedence.
 

data/Rakefile

@@ -13,7 +13,7 @@ begin
     gem.add_dependency "addressable", ">= 2.1.1"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "httpclient", ">= 2.1.5.2"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_development_dependency "patron", ">= 0.4.5" unless RUBY_PLATFORM =~ /java/
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.9.1
+1.0.0

data/lib/webmock.rb

@@ -4,6 +4,7 @@ require 'addressable/uri'
 
 require 'webmock/http_lib_adapters/net_http'
 require 'webmock/http_lib_adapters/httpclient'
+require 'webmock/http_lib_adapters/patron'
 
 require 'webmock/errors'
 
@@ -11,8 +12,7 @@ require 'webmock/util/uri'
 require 'webmock/util/headers'
 require 'webmock/util/hash_counter'
 
-require 'webmock/request'
-require 'webmock/request_profile'
+require 'webmock/request_pattern'
 require 'webmock/request_signature'
 require 'webmock/responses_sequence'
 require 'webmock/request_stub'

data/lib/webmock/adapters/rspec.rb

@@ -1,6 +1,6 @@
 require 'webmock'
 require 'spec'
-require 'webmock/adapters/rspec/request_profile_matcher'
+require 'webmock/adapters/rspec/request_pattern_matcher'
 require 'webmock/adapters/rspec/webmock_matcher'
 require 'webmock/adapters/rspec/matchers'
 

data/lib/webmock/adapters/rspec/matchers.rb

@@ -1,11 +1,11 @@
 module WebMock
   module Matchers
     def have_been_made
-      WebMock::RequestProfileMatcher.new
+      WebMock::RequestPatternMatcher.new
     end
     
     def have_not_been_made
-      WebMock::RequestProfileMatcher.new.times(0)
+      WebMock::RequestPatternMatcher.new.times(0)
     end
     
     def have_requested(method, uri)

data/lib/webmock/adapters/rspec/{request_profile_matcher.rb → request_pattern_matcher.rb}

@@ -1,5 +1,5 @@
 module WebMock
-  class RequestProfileMatcher
+  class RequestPatternMatcher
 
     def initialize
       @request_execution_verifier = RequestExecutionVerifier.new
@@ -20,13 +20,13 @@ module WebMock
       self
     end
 
-    def matches?(request_profile)
-      @request_execution_verifier.request_profile = request_profile
+    def matches?(request_pattern)
+      @request_execution_verifier.request_pattern = request_pattern
       @request_execution_verifier.matches?
     end
 
-    def does_not_match?(request_profile)
-      @request_execution_verifier.request_profile = request_profile
+    def does_not_match?(request_pattern)
+      @request_execution_verifier.request_pattern = request_pattern
       @request_execution_verifier.does_not_match?
     end
 

data/lib/webmock/adapters/rspec/webmock_matcher.rb

@@ -3,7 +3,7 @@ module WebMock
 
     def initialize(method, uri)
       @request_execution_verifier = RequestExecutionVerifier.new
-      @request_execution_verifier.request_profile = RequestProfile.new(method, uri)
+      @request_execution_verifier.request_pattern = RequestPattern.new(method, uri)
     end
 
     def once
@@ -17,7 +17,7 @@ module WebMock
     end
 
     def with(options = {}, &block)
-      @request_execution_verifier.request_profile.with(options, &block)
+      @request_execution_verifier.request_pattern.with(options, &block)
       self
     end
 

data/lib/webmock/config.rb

@@ -3,5 +3,6 @@ module WebMock
     include Singleton
     
     attr_accessor :allow_net_connect
+    attr_accessor :allow_localhost
   end
-end
+end

data/lib/webmock/http_lib_adapters/httpclient.rb

@@ -19,7 +19,7 @@ if defined?(HTTPClient)
         webmock_response = WebMock.response_for_request(request_signature)
         response = build_httpclient_response(webmock_response, stream, &block)
         conn.push(response)
-      elsif WebMock.net_connect_allowed?
+      elsif WebMock.net_connect_allowed?(req.header.request_uri)
         if stream
           do_get_stream_without_webmock(req, proxy, conn, &block)
         else
@@ -35,7 +35,7 @@ if defined?(HTTPClient)
       req = create_request(method, uri, query, body, extheader)
       request_signature = build_request_signature(req)
       
-      if WebMock.registered_request?(request_signature) || WebMock.net_connect_allowed?
+      if WebMock.registered_request?(request_signature) || WebMock.net_connect_allowed?(uri)
         do_request_async_without_webmock(method, uri, query, body, extheader)
       else
         message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
@@ -55,10 +55,11 @@ if defined?(HTTPClient)
     def build_httpclient_response(webmock_response, stream = false, &block)
       body = stream ? StringIO.new(webmock_response.body) : webmock_response.body
       response = HTTP::Message.new_response(body)
-      response.header.init_response(webmock_response.status)
-
+      response.header.init_response(webmock_response.status[0])
+      response.reason=webmock_response.status[1]
       webmock_response.headers.to_a.each { |name, value| response.header.set(name, value) }
 
+      raise HTTPClient::TimeoutError if webmock_response.should_timeout              
       webmock_response.raise_error_if_any
 
       block.call(nil, body) if block

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -91,9 +91,9 @@ module Net  #:nodoc: all
         @socket = Net::HTTP.socket_type.new
         webmock_response = WebMock.response_for_request(request_signature)
         build_net_http_response(webmock_response, &block)
-      elsif WebMock.net_connect_allowed?
+      elsif WebMock.net_connect_allowed?(uri)
         connect_without_webmock
-        request_without_webmock(request, body, &block)
+        request_without_webmock(request, nil, &block)
       else
         message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
         WebMock.assertion_failure(message)
@@ -114,7 +114,7 @@ module Net  #:nodoc: all
     alias_method :connect, :connect_with_webmock
 
     def build_net_http_response(webmock_response, &block)
-      response = Net::HTTPResponse.send(:response_class, webmock_response.status.to_s).new("1.0", webmock_response.status.to_s, "")
+      response = Net::HTTPResponse.send(:response_class, webmock_response.status[0].to_s).new("1.0", webmock_response.status[0].to_s, webmock_response.status[1])
       response.instance_variable_set(:@body, webmock_response.body)
       webmock_response.headers.to_a.each { |name, value| response[name] = value }
 
@@ -122,6 +122,8 @@ module Net  #:nodoc: all
 
       response.extend StubResponse
 
+      raise Timeout::Error, "execution expired" if webmock_response.should_timeout
+
       webmock_response.raise_error_if_any
 
       yield response if block_given?

data/lib/webmock/http_lib_adapters/patron.rb

@@ -0,0 +1,82 @@
+if defined?(Patron)
+
+  module Patron
+    class Session
+
+      def handle_request_with_webmock(req)
+        request_signature = build_request_signature(req)
+
+        WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+
+        if WebMock.registered_request?(request_signature)
+          webmock_response = WebMock.response_for_request(request_signature)
+          handle_file_name(req, webmock_response)
+          build_patron_response(webmock_response)
+        elsif WebMock.net_connect_allowed?(req.url)
+          handle_request_without_webmock(req)
+        else
+          message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
+          WebMock.assertion_failure(message)
+        end
+      end
+
+      alias_method :handle_request_without_webmock, :handle_request
+      alias_method :handle_request, :handle_request_with_webmock
+
+
+
+      def handle_file_name(req, webmock_response)
+        if req.action == :get && req.file_name
+          begin
+            File.open(req.file_name, "w") do |f|
+              f.write webmock_response.body
+            end
+          rescue Errno::EACCES
+            raise ArgumentError.new("Unable to open specified file.")
+          end
+        end
+      end
+
+      def build_request_signature(req)
+        uri = Addressable::URI.heuristic_parse(req.url)
+        uri.path = uri.normalized_path.gsub("[^:]//","/")
+        uri.user = req.username
+        uri.password = req.password
+
+        if [:put, :post].include?(req.action)
+          if req.file_name
+            if !File.exist?(req.file_name) || !File.readable?(req.file_name)
+              raise ArgumentError.new("Unable to open specified file.")
+            end
+            request_body = File.read(req.file_name)
+          elsif req.upload_data
+            request_body = req.upload_data
+          else
+            raise ArgumentError.new("Must provide either data or a filename when doing a PUT or POST")
+          end
+        end
+
+        request_signature = WebMock::RequestSignature.new(
+          req.action,
+          uri.to_s,
+          :body => request_body,
+          :headers => req.headers
+        )
+        request_signature
+      end
+
+      def build_patron_response(webmock_response)
+        raise Patron::TimeoutError if webmock_response.should_timeout        
+        webmock_response.raise_error_if_any
+        res = Patron::Response.new
+        res.instance_variable_set(:@body, webmock_response.body)
+        res.instance_variable_set(:@status, webmock_response.status[0])
+        res.instance_variable_set(:@status_line, webmock_response.status[1])
+        res.instance_variable_set(:@headers, webmock_response.headers)
+        res
+      end
+
+    end
+  end
+
+end