webmock 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 #Changelog
 
+## 1.1.0
+
+* [VCR](http://github.com/myronmarston/vcr/) compatibility. Many thanks to Myron Masteron for all suggestions.
+	
+* Support for stubbing requests and returning responses with multiple headers with the same name. i.e multiple Accept headers.	
+
+		stub_http_request(:get, 'www.example.com').
+		  with(:headers => {'Accept' => ['image/png', 'image/jpeg']}).
+		  to_return(:body => 'abc')
+		RestClient.get('www.example.com',
+		 {"Accept" => ['image/png', 'image/jpeg']}) # ===> "abc\n"	
+
+* When real net connections are disabled and unstubbed request is made, WebMock throws WebMock::NetConnectNotAllowedError instead of assertion error or StandardError.
+
+* Added WebMock.version()
+
+
 ## 1.0.0
 
 * Added support for [Patron](http://toland.github.com/patron/)

data/README.md

@@ -87,6 +87,15 @@ You can also use WebMock without RSpec or Test::Unit support:
       http.request(req, 'abc')
     }    # ===> Success
 
+### Matching multiple headers with the same name
+
+	stub_http_request(:get, 'www.example.com').with(:headers => {'Accept' => ['image/jpeg', 'image/png'] })
+	
+	req = Net::HTTP::Get.new("/")  
+	req['Accept'] = ['image/png']
+	req.add_field('Accept', 'image/jpeg')
+	Net::HTTP.start("www.example.com") {|http|  http.request(req) } # ===> Success
+
 ### Matching requests against provided block
 
 	stub_request(:post, "www.example.com").with { |request| request.body == "abc" }
@@ -384,6 +393,9 @@ i.e the following two sets of headers are equal:
 
 `{ :header1 => "value1",  "Content-Length" => 123, "x-cuSTOM-HeAder" => "value" }`
 
+## Recording real requests and responses and replaying them later
+
+To record your application's real HTTP interactions and replay them later in tests you can use [VCR](http://github.com/myronmarston/vcr) with WebMock.
 
 ## Bugs and Issues
 
@@ -417,6 +429,7 @@ People who submitted patches and new features or suggested improvements. Many th
 * Tekin Suleyman
 * Tom Ward
 * Nadim Bitar
+* Myron Masteron
 
 ## Background
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/webmock/errors.rb

@@ -1,5 +1,9 @@
 module WebMock
   
-  class NetConnectNotAllowedError < StandardError; end;
+  class NetConnectNotAllowedError < StandardError
+    def initialize(request_signature)
+      super("Real HTTP connections are disabled. Unregistered request: #{request_signature}")
+    end
+  end
 
 end

data/lib/webmock/http_lib_adapters/httpclient.rb

@@ -19,15 +19,14 @@ 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?(req.header.request_uri)
+      elsif WebMock.net_connect_allowed?(request_signature.uri)
         if stream
           do_get_stream_without_webmock(req, proxy, conn, &block)
         else
           do_get_block_without_webmock(req, proxy, conn, &block)
         end
       else
-        message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
-        WebMock.assertion_failure(message)
+        raise NetConnectNotAllowedError.new(request_signature)
       end
     end
 
@@ -35,11 +34,10 @@ 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?(uri)
+      if WebMock.registered_request?(request_signature) || WebMock.net_connect_allowed?(request_signature.uri)
         do_request_async_without_webmock(method, uri, query, body, extheader)
       else
-        message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
-        WebMock.assertion_failure(message)
+        raise NetConnectNotAllowedError.new(request_signature)
       end
     end
 
@@ -76,8 +74,12 @@ if defined?(HTTPClient)
 
     auth = www_auth.basic_auth
     auth.challenge(req.header.request_uri, nil)
-
-    headers = Hash[*req.header.all.flatten]
+    
+    headers = req.header.all.inject({}) do |headers, header| 
+      headers[header[0]] ||= [];
+      headers[header[0]] << header[1]
+      headers
+    end
 
     if (auth_cred = auth.get(req)) && auth.scheme == 'Basic'
       userinfo = WebMock::Util::Headers.decode_userinfo_from_header(auth_cred)

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -53,37 +53,7 @@ module Net  #:nodoc: all
     end
 
     def request_with_webmock(request, body = nil, &block)
-      protocol = use_ssl? ? "https" : "http"
-
-      path = request.path
-      path = Addressable::URI.heuristic_parse(request.path).request_uri if request.path =~ /^http/
-
-      if request["authorization"] =~ /^Basic /
-        userinfo = WebMock::Util::Headers.decode_userinfo_from_header(request["authorization"])
-        userinfo = WebMock::Util::URI.encode_unsafe_chars_in_userinfo(userinfo) + "@"
-      else
-        userinfo = ""
-      end
-
-      uri = "#{protocol}://#{userinfo}#{self.address}:#{self.port}#{path}"
-      method = request.method.downcase.to_sym
-
-      headers = Hash[*request.to_hash.map {|k,v| [k, v.flatten]}.flatten]
-       
-      headers.reject! {|k,v| k =~ /[Aa]uthorization/ && v =~ /^Basic / } #we added it to url userinfo
-
-      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)
+      request_signature = WebMock::NetHTTPUtility.request_signature_from_request(self, request, body)
 
       WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
@@ -91,12 +61,11 @@ 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?(uri)
+      elsif WebMock.net_connect_allowed?(request_signature.uri)
         connect_without_webmock
         request_without_webmock(request, nil, &block)
       else
-        message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
-        WebMock.assertion_failure(message)
+        raise WebMock::NetConnectNotAllowedError.new(request_signature)
       end
     end
     alias_method :request_without_webmock, :request
@@ -130,47 +99,70 @@ module Net  #:nodoc: all
 
       response
     end
-    
+
   end
 
 end
 
 module WebMock
   module NetHTTPUtility
-    def self.puts_warning_for_net_http_around_advice_libs_if_needed
-      libs = {"Samuel" => defined?(Samuel)}
-      warnings = libs.select { |_, loaded| loaded }.map do |name, _|
-        <<-TEXT.gsub(/ {10}/, '')
-        \e[1mWarning: WebMock was loaded after #{name}\e[0m
-          * #{name}'s code is being ignored when a request is handled by WebMock,
-          because both libraries work by patching Net::HTTP.
-          * To fix this, just reorder your requires so that WebMock is before #{name}.
-          TEXT
-        end
-        $stderr.puts "\n" + warnings.join("\n") + "\n" if warnings.any?
+
+    def self.request_signature_from_request(net_http, request, body = nil)
+      protocol = net_http.use_ssl? ? "https" : "http"
+
+      path = request.path
+      path = Addressable::URI.heuristic_parse(request.path).request_uri if request.path =~ /^http/
+
+      if request["authorization"] =~ /^Basic /
+        userinfo = WebMock::Util::Headers.decode_userinfo_from_header(request["authorization"])
+        userinfo = WebMock::Util::URI.encode_unsafe_chars_in_userinfo(userinfo) + "@"
+      else
+        userinfo = ""
+      end
+
+      uri = "#{protocol}://#{userinfo}#{net_http.address}:#{net_http.port}#{path}"
+      method = request.method.downcase.to_sym
+
+      headers = Hash[*request.to_hash.map {|k,v| [k, v]}.inject([]) {|r,x| r + x}]
+       
+      headers.reject! {|k,v| k =~ /[Aa]uthorization/ && v.first =~ /^Basic / } #we added it to url userinfo
+
+
+      if request.body_stream
+        body = request.body_stream.read
+        request.body_stream = nil
       end
 
-      def self.record_loaded_net_http_replacement_libs
-        libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
-        @loaded_net_http_replacement_libs = libs.map { |name, loaded| name if loaded }.compact
+      if body != nil && body.respond_to?(:read)
+        request.set_body_internal body.read
+      else
+        request.set_body_internal body
       end
 
-      def self.puts_warning_for_net_http_replacement_libs_if_needed
-        libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
-        warnings = libs.select { |_, loaded| loaded }.
-          reject { |name, _| @loaded_net_http_replacement_libs.include?(name) }.
-          map do |name, _|
-          <<-TEXT.gsub(/ {10}/, '')
-          \e[1mWarning: #{name} was loaded after WebMock\e[0m
-            * WebMock's code is being ignored, because #{name} replaces parts of
-            Net::HTTP without deferring to other libraries. This will break Net::HTTP requests.
-            * To fix this, just reorder your requires so that #{name} is before WebMock.
-            TEXT
-          end
-          $stderr.puts "\n" + warnings.join("\n") + "\n" if warnings.any?
+      WebMock::RequestSignature.new(method, uri, :body => request.body, :headers => headers)
+    end
+
+
+    def self.record_loaded_net_http_replacement_libs
+      libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
+      @loaded_net_http_replacement_libs = libs.map { |name, loaded| name if loaded }.compact
+    end
+
+    def self.puts_warning_for_net_http_replacement_libs_if_needed
+      libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
+      warnings = libs.select { |_, loaded| loaded }.
+        reject { |name, _| @loaded_net_http_replacement_libs.include?(name) }.
+        map do |name, _|
+        <<-TEXT.gsub(/ {10}/, '')
+        \e[1mWarning: #{name} was loaded after WebMock\e[0m
+          * WebMock's code is being ignored, because #{name} replaces parts of
+          Net::HTTP without deferring to other libraries. This will break Net::HTTP requests.
+          * To fix this, just reorder your requires so that #{name} is before WebMock.
+          TEXT
         end
+        $stderr.puts "\n" + warnings.join("\n") + "\n" if warnings.any?
       end
     end
+  end
 
-    WebMock::NetHTTPUtility.record_loaded_net_http_replacement_libs
-    WebMock::NetHTTPUtility.puts_warning_for_net_http_around_advice_libs_if_needed
+  WebMock::NetHTTPUtility.record_loaded_net_http_replacement_libs

data/lib/webmock/http_lib_adapters/patron.rb

@@ -12,11 +12,10 @@ if defined?(Patron)
           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)
+        elsif WebMock.net_connect_allowed?(request_signature.uri)
           handle_request_without_webmock(req)
         else
-          message = "Real HTTP connections are disabled. Unregistered request: #{request_signature}"
-          WebMock.assertion_failure(message)
+          raise WebMock::NetConnectNotAllowedError.new(request_signature)
         end
       end
 

data/lib/webmock/util/headers.rb

@@ -7,14 +7,29 @@ module WebMock
       def self.normalize_headers(headers)
         return nil unless headers
         array = headers.map { |name, value|
-          [name.to_s.split(/_|-/).map { |segment| segment.capitalize }.join("-"), value.is_a?(Regexp) ? value : value.to_s]
+          [name.to_s.split(/_|-/).map { |segment| segment.capitalize }.join("-"),
+           case value
+            when Regexp then value
+            when Array then (value.size == 1) ? value.first : value.map {|v| v.to_s}.sort
+            else value.to_s
+           end
+          ]
         }
-        Hash[*array.flatten]
+        Hash[*array.inject([]) {|r,x| r + x}]
       end
 
       def self.sorted_headers_string(headers)
         headers = WebMock::Util::Headers.normalize_headers(headers)
-        '{' + headers.inspect[1..-2].split(', ').sort.join(', ').gsub("\"","'").gsub("\\","") + '}'
+        str = '{'
+        str << headers.map do |k,v|
+          v = case v
+            when Regexp then v.inspect
+            when Array then "["+v.map{|v| "'#{v.to_s}'"}.join(", ")+"]"
+            else "'#{v.to_s}'"
+          end    
+          "'#{k}'=>#{v}"
+        end.sort.join(", ") 
+        str << '}'
       end
       
       def self.decode_userinfo_from_header(header)

data/lib/webmock/webmock.rb

@@ -1,10 +1,16 @@
 module WebMock
   extend self
 
+  def self.version
+    open(File.join(File.dirname(__FILE__), '../../VERSION')) { |f|
+      f.read.strip
+    }
+  end
+
   def stub_request(method, uri)
     RequestRegistry.instance.register_request_stub(RequestStub.new(method, uri))
   end
-  
+
   alias_method :stub_http_request, :stub_request
 
   def request(method, uri)
@@ -34,10 +40,11 @@ module WebMock
   end
 
   def net_connect_allowed?(uri = nil)
-    if uri.class == String
-      uri = URI::parse(uri)
+    if uri.is_a?(String)
+      uri = WebMock::Util::URI.normalize_uri(uri)
     end
-    Config.instance.allow_net_connect || ( Config.instance.allow_localhost && uri.is_a?(URI) && uri.host == 'localhost' )
+    Config.instance.allow_net_connect || 
+      (Config.instance.allow_localhost && uri.is_a?(Addressable::URI) && uri.host == 'localhost')
   end
 
   def registered_request?(request_signature)
@@ -51,7 +58,7 @@ module WebMock
   def reset_webmock
     WebMock::RequestRegistry.instance.reset_webmock
   end
-  
+
   def assertion_failure(message)
     raise message
   end

data/spec/example_curl_output.txt

@@ -3,6 +3,8 @@ Content-Type: text/html; charset=UTF-8
 Connection: Keep-Alive
 Date: Sat, 23 Jan 2010 01:01:05 GMT
 Content-Length: 438
+Accept: image/jpeg
+Accept: image/png
 
 <HTML>
 <HEAD>

data/spec/httpclient_spec.rb

@@ -22,6 +22,14 @@ describe "Webmock with HTTPClient" do
     response_body.should == "abc"
   end
 
+   it "should match requests if headers are the same  but in different order" do
+     stub_http_request(:get, "www.example.com").with(:headers => {"a" => ["b", "c"]} )
+     http_request(
+       :get, "http://www.example.com/",
+       :headers => {"a" => ["c", "b"]}).status.should == "200"
+   end
+  
+
   describe "async requests" do
 
     before(:each) do

data/spec/httpclient_spec_helper.rb

@@ -17,9 +17,17 @@ module HTTPClientSpecHelper
     else
       response = c.request(*params, &block)
     end
+    headers = response.header.all.inject({}) do |headers, header| 
+      if !headers.has_key?(header[0])
+        headers[header[0]] = header[1]
+      else
+        headers[header[0]] = [headers[header[0]], header[1]].join(', ')
+      end
+      headers
+    end
     OpenStruct.new({
       :body => HTTPClientSpecHelper.async_mode ? response.content.read : response.content,
-      :headers => Hash[*response.header.all.flatten],
+      :headers => headers,
       :status => response.code.to_s,
       :message => response.reason
     })

data/spec/net_http_spec_helper.rb

@@ -7,7 +7,16 @@ module NetHTTPSpecHelper
     end
     response = nil
     clazz = Net::HTTP.const_get("#{method.to_s.capitalize}")
-    req = clazz.new("#{uri.path}#{uri.query ? '?' : ''}#{uri.query}", options[:headers])
+    req = clazz.new("#{uri.path}#{uri.query ? '?' : ''}#{uri.query}", nil)
+    options[:headers].each do |k,v| 
+      if v.is_a?(Array)
+        v.each_with_index do |v,i|
+          i == 0 ? (req[k] = v) : req.add_field(k, v)
+        end
+      else
+        req[k] = v
+      end  
+    end if options[:headers]
 
     req.basic_auth uri.user, uri.password if uri.user
     http = Net::HTTP.new(uri.host, uri.port)

data/spec/other_net_http_libs_spec.rb

@@ -14,16 +14,6 @@ describe "loading other Net::HTTP based libraries" do
     `ruby #{load_path_opts} -e "#{requires}; #{additional_code}" 2>&1 | cat`
   end
 
-  it "should requiring samuel before webmock prints warning" do
-    output = capture_output_from_requiring %w(samuel webmock)
-    output.should match(%r(Warning: WebMock was loaded after Samuel))
-  end
-
-  it "should requiring samuel after webmock does not print warning" do
-    output = capture_output_from_requiring %w(webmock samuel)
-    output.should be_empty
-  end
-
   it "should requiring right http connection before webmock and then connecting does not print warning" do
     additional_code = "Net::HTTP.start('example.com')"
     output = capture_output_from_requiring %w(right_http_connection webmock), additional_code