webmock 0.8.2 → 0.9.0

data/CHANGELOG.md

@@ -0,0 +1,113 @@
+#Changelog
+
+## 0.9.0
+  
+* Matching requests against provided block (by Sergio Gil)
+
+		stub_request(:post, "www.example.com").with { |request| request.body == "abc" }.to_return(:body => "def")
+		RestClient.post('www.example.com', 'abc')    # ===> "def\n"
+		request(:post, "www.example.com").with { |req| req.body == "abc" }.should have_been_made	
+		#or 
+		assert_requested(:post, "www.example.com") { |req| req.body == "abc" }
+
+* Matching request body against regular expressions
+
+		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
+
+		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"
+
+* Replaying raw responses recorded with `curl -is`
+
+		`curl -is www.example.com > /tmp/example_curl_-is_output.txt`
+		raw_response_file = File.new("/tmp/example_curl_-is_output.txt")
+	
+	from file
+	
+		stub_request(:get, "www.example.com").to_return(raw_response_file)
+
+	or string
+	
+		stub_request(:get, "www.example.com").to_return(raw_response_file.read)
+
+* Multiple responses for repeated requests
+
+		stub_request(:get, "www.example.com").to_return({:body => "abc"}, {:body => "def"})
+		Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+		Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
+
+* Multiple responses using chained `to_return()` or `to_raise()` declarations
+
+		stub_request(:get, "www.example.com").
+			to_return({:body => "abc"}).then.  #then() just is a syntactic sugar
+			to_return({:body => "def"}).then.
+			to_raise(MyException)
+		Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+		Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
+		Net::HTTP.get('www.example.com', '/')    # ===> MyException raised
+	
+* Specifying number of times given response should be returned
+
+		stub_request(:get, "www.example.com").
+			to_return({:body => "abc"}).times(2).then.
+			to_return({:body => "def"})
+	
+		Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+		Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+		Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
+	
+* Added support for `Net::HTTP::Post#body_stream`
+
+	This fixes compatibility with new versions of RestClient
+	
+* WebMock doesn't suppress default request headers added by http clients anymore.
+
+	i.e. Net::HTTP adds `'Accept'=>'*/*'` to all requests by default
+	
+	
+	
+## 0.8.2
+  
+  * Fixed issue where WebMock was not closing IO object passed as response body after reading it.
+  * Ruby 1.9.2 compat: Use `File#expand_path` for require path because "." is not be included in LOAD_PATH since Ruby 1.9.2
+
+
+## 0.8.1
+  
+  * Fixed HTTPClient adapter compatibility with Ruby 1.8.6 (reported by Piotr Usewicz)
+  * Net:HTTP adapter now handles request body assigned as Net::HTTP::Post#body attribute (fixed by Mack Earnhardt)
+  * Fixed issue where requests were not matching stubs with Accept header set.(reported by Piotr Usewicz)
+  * Fixed compatibility with Ruby 1.9.1, 1.9.2 and JRuby 1.3.1 (reported by Diego E. “Flameeyes” Pettenò)
+  * Fixed issue with response body declared as IO object and multiple requests (reported by Niels Meersschaert)
+  * Fixed "undefined method `assertion_failure'" error (reported by Nick Plante)
+
+
+## 0.8.0
+
+  * Support for HTTPClient (sync and async requests)
+  * Support for dynamic responses. Response body and headers can be now declared as lambda. 
+	(Thanks to Ivan Vega ( @ivanyv ) for suggesting this feature)
+  * Support for stubbing and expecting requests with empty body
+  * Executing non-stubbed request leads to failed expectation instead of error
+
+
+### Bug fixes
+
+  * Basic authentication now works correctly
+  * Fixed problem where WebMock didn't call a block with the response when block was provided
+  * Fixed problem where uris with single slash were not matching uris without path provided
+
+
+## 0.7.3
+
+  * Clarified documentation
+  * Fixed some issues with loading of Webmock classes
+  * Test::Unit and RSpec adapters have to be required separately
+
+
+## 0.7.2
+
+  * Added support for matching escaped and non escaped URLs

data/README.md

@@ -1,12 +1,12 @@
 WebMock
 =======
 
-Library for stubbing HTTP requests and setting expectations on HTTP requests in Ruby.
+Library for stubbing and setting expectations on HTTP requests in Ruby.
 
 Features
 --------
 
-* Stubbing HTTP requests at low Net::HTTP level (no need to change tests when you change HTTP lib interface)
+* Stubbing HTTP requests at low http client lib level (no need to change tests when you change HTTP library)
 * Setting and verifying expectations on HTTP requests
 * Matching requests based on method, URI, headers and body
 * Smart matching of the same URIs in different representations (also encoded and non encoded forms)
@@ -14,7 +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)
-* Easy to extend to other HTTP libraries except Net::HTTP
+* Easy to extend to other HTTP libraries
 
 Installation
 ------------
@@ -63,10 +63,21 @@ You can also use WebMock without RSpec or Test::Unit support:
       http.request(req, "abc")
     }    # ===> Success
 
+### Matching request body and headers against regular expressions
+
+	stub_request(:post, "www.example.com").
+	  with(:body => /^.*world$/, :headers => {"Content-Type" => /image\/.+/}).to_return(:body => "abc")
+
+	uri = URI.parse('http://www.example.com/')
+    req = Net::HTTP::Post.new(uri.path)
+	req['Content-Type'] = 'image/png'
+    res = Net::HTTP.start(uri.host, uri.port) {|http|
+      http.request(req, 'hello world')
+    }    # ===> Success
+
 ### Matching custom request headers
 
-    stub_request(:any, "www.example.com").
-	  with( :headers=>{ 'Header-Name' => 'Header-Value' } ).to_return(:body => "abc", :status => 200)
+    stub_request(:any, "www.example.com").with(:headers=>{ 'Header-Name' => 'Header-Value' })
 
 	uri = URI.parse('http://www.example.com/')
     req = Net::HTTP::Post.new(uri.path)
@@ -75,6 +86,27 @@ You can also use WebMock without RSpec or Test::Unit support:
       http.request(req, 'abc')
     }    # ===> Success
 
+### Matching requests against provided block
+
+	stub_request(:post, "www.example.com").with { |request| request.body == "abc" }
+	RestClient.post('www.example.com', 'abc')    # ===> Success
+	
+### Request with basic authentication
+
+    stub_request(:get, "user:pass@www.example.com")
+
+    Net::HTTP.start('www.example.com') {|http|
+      req = Net::HTTP::Get.new('/')
+      req.basic_auth 'user', 'pass'
+      http.request(req)
+    }  # ===> Success
+
+### Matching uris using regular expressions
+
+	 stub_request(:any, /.*example.*/)
+
+	 Net::HTTP.get('www.example.com', '/') # ===> Success	
+
 ### Stubbing with custom response
 
 	stub_request(:any, "www.example.com").to_return(:body => "abc", :status => 200,  :headers => { 'Content-Length' => 3 } )
@@ -88,6 +120,19 @@ You can also use WebMock without RSpec or Test::Unit support:
 	stub_request(:any, "www.example.com").to_return(:body => File.new('/tmp/response_body.txt'), :status => 200)
 
 	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+	
+### Replaying raw responses recorded with `curl -is`
+
+	`curl -is www.example.com > /tmp/example_curl_-is_output.txt`
+	raw_response_file = File.new("/tmp/example_curl_-is_output.txt")
+
+   from file
+
+	stub_request(:get, "www.example.com").to_return(raw_response_file)
+
+   or string
+
+	stub_request(:get, "www.example.com").to_return(raw_response_file.read)
 
 ### Custom response with dynamically evaluated response
 	
@@ -96,21 +141,36 @@ You can also use WebMock without RSpec or Test::Unit support:
 
     RestClient.post('www.example.net', 'abc')    # ===> "abc\n"	
 
-### Request with basic authentication
+### Multiple responses for repeated requests
 
-    stub_request(:get, "user:pass@www.example.com")
+	stub_request(:get, "www.example.com").to_return({:body => "abc"}, {:body => "def"})
+	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+	Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
+	
+	#after all responses are used the last response will be returned infinitely
+	
+	Net::HTTP.get('www.example.com', '/')    # ===> "def\n" 
 
-    Net::HTTP.start('www.example.com') {|http|
-      req = Net::HTTP::Get.new('/')
-      req.basic_auth 'user', 'pass'
-      http.request(req)
-    }  # ===> Success
+### Multiple responses using chained `to_return()` or `to_raise()` declarations
 
-### Matching uris using regular expressions
+	stub_request(:get, "www.example.com").
+		to_return({:body => "abc"}).then.  #then() just is a syntactic sugar
+		to_return({:body => "def"}).then.
+		to_raise(MyException)
+	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+	Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
+	Net::HTTP.get('www.example.com', '/')    # ===> MyException raised
 
-	 stub_request(:any, /.*example.*/)
+### Specifying number of times given response should be returned
+
+	stub_request(:get, "www.example.com").
+		to_return({:body => "abc"}).times(2).then.
+		to_return({:body => "def"})
+
+	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+	Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
+	Net::HTTP.get('www.example.com', '/')    # ===> "def\n"
 
-	 Net::HTTP.get('www.example.com', '/') # ===> Success
 
 ### Real requests to network can be allowed or disabled
 
@@ -146,6 +206,8 @@ You can also use WebMock without RSpec or Test::Unit support:
 	
 	assert_not_requested :get, "http://www.something.com"    # ===> Success
 
+	assert_requested(:post, "http://www.example.com", :times => 1) { |req| req.body == "abc" }
+
 ### Expecting real (not stubbed) requests
 
 	WebMock.allow_net_connect!
@@ -163,6 +225,8 @@ You can also use WebMock without RSpec or Test::Unit support:
 	WebMock.should have_requested(:get, "www.example.com").with(:body => "abc", :headers => {'Content-Length' => 3}).twice
 	
 	WebMock.should_not have_requested(:get, "www.something.com")
+	
+	WebMock.should have_requested(:post, "www.example.com").with { |req| req.body == "abc" }
 
 ### Different way of setting expectations in RSpec
 
@@ -172,7 +236,8 @@ You can also use WebMock without RSpec or Test::Unit support:
 
 	request(:any, "www.example.com").should_not have_been_made
 
-
+	request(:post, "www.example.com").with { |req| req.body == "abc" }.should have_been_made
+	
 ## Clearing stubs and request history
 
 If you want to reset all current stubs and history of requests use `WebMock.reset_webmock`
@@ -195,7 +260,8 @@ An executed request matches stubbed request if it passes following criteria:
   When request URI matches stubbed request URI string or Regexp pattern<br/>
   And request method is the same as stubbed request method or stubbed request method is :any<br/>
   And request body is the same as stubbed request body or stubbed request body is not specified<br/>
-  And request headers match stubbed request headers, or stubbed request headers match a subset of request headers, or stubbed request headers are not specified
+  And request headers match stubbed request headers, or stubbed request headers match a subset of request headers, or stubbed request headers are not specified<br/>
+  And request matches provided block or block is not provided
 
 ## Precedence of stubs
 
@@ -299,4 +365,4 @@ I also preferred some things to work differently i.e request stub precedence.
 
 ## Copyright
 
-Copyright 2009 Bartosz Blimke. See LICENSE for details.
+Copyright 2009-2010 Bartosz Blimke. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.9.0

data/lib/webmock.rb

@@ -14,6 +14,7 @@ require 'webmock/util/hash_counter'
 require 'webmock/request'
 require 'webmock/request_profile'
 require 'webmock/request_signature'
+require 'webmock/responses_sequence'
 require 'webmock/request_stub'
 require 'webmock/response'
 

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

@@ -16,8 +16,8 @@ module WebMock
       self
     end
 
-    def with(options)
-      @request_execution_verifier.request_profile.with(options)
+    def with(options = {}, &block)
+      @request_execution_verifier.request_profile.with(options, &block)
       self
     end
 

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -69,12 +69,19 @@ module Net  #:nodoc: all
       method = request.method.downcase.to_sym
 
       headers = Hash[*request.to_hash.map {|k,v| [k, v.flatten]}.flatten]
-      
-      remove_default_net_http_headers!(headers)
-      
+       
       headers.reject! {|k,v| k =~ /[Aa]uthorization/ && v =~ /^Basic / } #we added it to url userinfo
 
-      request.set_body_internal body
+      if request.body_stream
+        body = request.body_stream.read
+        request.body_stream = nil
+      end
+
+      if body != nil && body.respond_to?(:read)
+        request.set_body_internal body.read
+      else
+        request.set_body_internal body
+      end
 
       request_signature = WebMock::RequestSignature.new(method, uri, :body => request.body, :headers => headers)
 
@@ -122,15 +129,6 @@ module Net  #:nodoc: all
       response
     end
     
-    def remove_default_net_http_headers!(headers)
-      default_request = Net::HTTPGenericRequest.new('','','','/')
-      default_net_http_headers = Hash[*default_request.to_hash.map {|k,v|
-         [k, v.flatten]
-      }.flatten]
-      headers.reject! {|k,v| default_request[k] == v}
-      headers
-    end
-    
   end
 
 end

data/lib/webmock/request.rb

@@ -14,7 +14,7 @@ module WebMock
       string << " with body '#{body.to_s}'" if body && body.to_s != ''
       if headers && !headers.empty?
         string << " with headers #{WebMock::Util::Headers.normalize_headers(headers).inspect.gsub("\"","'")}"
-      end
+      end      
       string
     end
 

data/lib/webmock/request_profile.rb

@@ -1,15 +1,24 @@
 module WebMock
 
   class RequestProfile < Request
+    
+    attr_reader :with_block
 
-    def with(options)
+    def with(options = {}, &block)
       assign_options(options)
+      @with_block = block
       self
     end
     
     def body=(body)
       @body = Body.new(body)
     end
+    
+    def to_s
+      string = super
+      string << " with given block" if @with_block
+      string
+    end
 
     class Body
 
@@ -22,7 +31,7 @@ module WebMock
       def ==(other)
         other = Body.new(other) unless other.is_a?(Body)
         other.is_a?(Body) &&
-          (other.is_empty? && self.is_empty? || other.data == self.data)        
+          (other.is_empty? && self.is_empty? || other.data == self.data || self.data === other.data )        
       end
 
       def is_empty?

data/lib/webmock/request_signature.rb

@@ -7,7 +7,8 @@ module WebMock
       match_method(request_profile) &&
         match_body(request_profile) &&
         match_headers(request_profile) &&
-        match_uri(request_profile)
+        match_uri(request_profile) &&
+        match_with_block(request_profile)
     end
 
     private
@@ -26,7 +27,7 @@ module WebMock
       return false if self.headers && !self.headers.empty? && request_profile.headers && request_profile.headers.empty?
       if request_profile.headers && !request_profile.headers.empty?
         request_profile.headers.each do | key, value |
-          return false unless (self.headers && self.headers.has_key?(key) && value == self.headers[key])
+          return false unless (self.headers && self.headers.has_key?(key) && value === self.headers[key])
         end
       end
       return true
@@ -39,6 +40,11 @@ module WebMock
     def match_method(request_profile)
       request_profile.method == self.method || request_profile.method == :any
     end
+    
+    def match_with_block(request_profile)
+      return true unless request_profile.with_block
+      request_profile.with_block.call(self)
+    end
   end
 
 

data/lib/webmock/request_stub.rb

@@ -1,25 +1,53 @@
 module WebMock
   class RequestStub
-    attr_accessor :request_profile, :response
-    
+
+    attr_accessor :request_profile, :responses
+
     def initialize(method, uri)
       @request_profile = RequestProfile.new(method, uri)
-      @response = WebMock::Response.new
+      @responses_sequences = []
+      self
+    end
+
+    def with(params = {}, &block)
+      @request_profile.with(params, &block)
+      self
+    end
+
+    def to_return(*response_hashes)
+      @responses_sequences << ResponsesSequence.new([*response_hashes].flatten.map {|r| WebMock::Response.new(r)})
       self
     end
 
-    def with(params)
-      @request_profile.with(params)
+    def to_raise(*exceptions)
+      @responses_sequences << ResponsesSequence.new([*exceptions].flatten.map {|e| WebMock::Response.new(:exception => e)})
       self
     end
 
-    def to_return(response_hash)
-      @response = WebMock::Response.new(response_hash)
+    def response
+      if @responses_sequences.empty?
+        WebMock::Response.new
+      elsif @responses_sequences.length > 1
+        @responses_sequences.shift if @responses_sequences.first.end?
+        @responses_sequences.first.next_response
+      else
+        @responses_sequences[0].next_response
+      end
     end
-    
-    def to_raise(exception)
-      @response = WebMock::Response.new({:exception => exception})
+
+    def then
+      self
     end
-    
+
+    def times(number)
+      raise "times(N) accepts integers >= 1 only" if !number.is_a?(Fixnum) || number < 1
+      if @responses_sequences.empty?
+        raise "Invalid WebMock stub declaration." +
+          " times(N) can be declared only after response declaration."
+      end
+      @responses_sequences.last.times_to_repeat += number-1
+      self
+    end
+
   end
 end