webmock 1.21.0 → 1.22.1

data/.travis.yml

@@ -5,14 +5,22 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.1
+  - 2.2.3
+  - rbx-2
   - ruby-head
   - ree
+  - jruby-9.0.0.0
+  - jruby-9.0.1.0
   - jruby-18mode
   - jruby-19mode
   - jruby
   - jruby-head
 matrix:
   allow_failures:
+    - rvm: jruby-9.0.0.0
+    - rvm: jruby-9.0.1.0
     - rvm: jruby-18mode
     - rvm: jruby-head
     - rvm: ruby-head
+    - rvm: rbx-2
+sudo: false

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+## 1.22.1
+
+  * Adds Rack as a development dependency and removes require rack/utils in main lib.
+
+    Thanks to [Keenan Brock](https://github.com/kbrock)
+
+## 1.22.0
+
+  All the credit for preparing this release go to [David Begin](https://github.com/davidbegin)!
+
+  * Adds [Manticore](https://github.com/cheald/manticore) support.
+
+      Thanks to [Mike Knepper](https://github.com/mikeknep), [David Abdemoulaie](https://github.com/hobodave)
+
+  * Update to Show a hash diff for requests that have stubs with a body.
+
+      Thanks to [yurivm](https://github.com/yurivm)
+
+  * Update to mirror Net::HTTP handling of headers as symbols
+
+  * Update to ignore non-comparable-values error when sorting
+    query values, because sorting is just a convience.
+
+      Thanks to [Magne Land](https://github.com/magneland)
+
+  * Covert Boolean values to Strings when using them to define
+    the body of a request.
+
+      Thanks to [Krzysztof Rygielski](https://github.com/riggy)
+
+  * Fixes WebMock's parsing Multibyte characters
+
+      Thanks to [Zhao Wen](https://github.com/VincentZhao)
+
+  * Updates to be compatible with httpclient 2.6.0
+
+  * Converts keys from symbols to strings when for QueryMapper.to_query
+
+      Thanks to [Ramon Tayag](https://github.com/ramontayag)
+
+  * Restricts http.rb version to 0.7.3 for Ruby 1.8.7
+
+  * Fixes issue emulating em-http-request's handling of multiple requests.
+
+      Thanks to [Matt Palmer](https://github.com/mpalmer)
+
+  * WebMock requires only the necessary parts of crack to avoid pulling in safe_yaml
+
+      Thanks to [Johannes Schlumberger](https://github.com/spjsschl)
+
 ## 1.21.0
 
   * Support for http.rb >= 0.8.0
@@ -10,7 +60,7 @@
 
       Thanks to [Mattias Putman](https://github.com/challengee)
 
-  * Added support for RSpec3-like `and_return`, `and_raise`, `and_timeout` sytnax.
+  * Added support for RSpec3-like `and_return`, `and_raise`, `and_timeout` syntax.
 
       Thanks to [Franky Wahl](https://github.com/frankywahl)
 

data/Gemfile

@@ -10,7 +10,6 @@ group :development do
 end
 
 group :test do
-  gem 'rack'
   gem 'minitest_tu_shim', '1.3.2'
 end
 

data/README.md

@@ -1,5 +1,6 @@
-WebMock [![Build Status](https://secure.travis-ci.org/bblimke/webmock.png?branch=master)](http://travis-ci.org/bblimke/webmock) [![Dependency Status](https://gemnasium.com/bblimke/webmock.png)](http://gemnasium.com/bblimke/webmock)
+WebMock
 =======
+[![Gem Version](https://badge.fury.io/rb/webmock.svg)](http://badge.fury.io/rb/webmock) [![Build Status](https://secure.travis-ci.org/bblimke/webmock.svg?branch=master)](http://travis-ci.org/bblimke/webmock) [![Dependency Status](https://gemnasium.com/bblimke/webmock.svg)](http://gemnasium.com/bblimke/webmock) [![Code Climate](https://codeclimate.com/github/bblimke/webmock/badges/gpa.svg)](https://codeclimate.com/github/bblimke/webmock) [![Inline docs](http://inch-ci.org/github/bblimke/webmock.svg?branch=master)](http://inch-ci.org/github/bblimke/webmock)
 
 Library for stubbing and setting expectations on HTTP requests in Ruby.
 
@@ -26,6 +27,7 @@ Supported HTTP libraries
 * Typhoeus (currently only Typhoeus::Hydra)
 * Excon
 * HTTP Gem
+* Manticore
 
 Supported Ruby Interpreters
 ---------------------------
@@ -736,13 +738,13 @@ If you use any of the WebMock methods for matching query params, then Addressabl
 WebMock will match request headers against stubbed request headers in the following situations:
 
 1. Stubbed request has headers specified and request headers are the same as stubbed headers <br/>
-i.e stubbed headers: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+i.e stubbed headers: `{ 'Header1' => 'Value1', 'Header2' => 'Value2' }`, requested: `{ 'Header1' => 'Value1', 'Header2' => 'Value2' }`
 
 2. Stubbed request has headers specified and stubbed request headers are a subset of request headers <br/>
-i.e stubbed headers: `{ 'Header1' => 'Value1'  }`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+i.e stubbed headers: `{ 'Header1' => 'Value1'  }`, requested: `{ 'Header1' => 'Value1', 'Header2' => 'Value2' }`
 
 3. Stubbed request has no headers <br/>
-i.e stubbed headers: `nil`, requested: `{ 'Header1' => 'Value1', 'Header1' => 'Value1' }`
+i.e stubbed headers: `nil`, requested: `{ 'Header1' => 'Value1', 'Header2' => 'Value2' }`
 
 WebMock normalises headers and treats all forms of same headers as equal:
 i.e the following two sets of headers are equal:
@@ -827,7 +829,7 @@ all version with just one command.
 
 This command is wrapped up in to a rake task and can be invoked like so:
 
-    rake spec:rubies
+  rake rvm:specs
 
 ## Credits
 
@@ -972,7 +974,16 @@ People who submitted patches and new features or suggested improvements. Many th
 * Steve Mitchell
 * Mattias Putman
 * Zachary Anker
-
+* Emmanuel Sambo
+* Ramon Tayag
+* Johannes Schlumberger
+* Siôn Le Roux
+* Matt Palmer
+* Zhao Wen
+* Krzysztof Rygielski
+* Magne Land
+* yurivm
+* Mike Knepper
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock.rb

@@ -2,7 +2,7 @@ require 'singleton'
 
 require 'addressable/uri'
 require 'addressable/template'
-require 'crack'
+require 'crack/xml'
 
 require 'webmock/deprecation'
 require 'webmock/version'
@@ -28,6 +28,8 @@ require 'webmock/response'
 require 'webmock/rack_response'
 
 require 'webmock/stub_request_snippet'
+require 'webmock/request_signature_snippet'
+require 'webmock/request_body_diff'
 
 require 'webmock/assertion_failure'
 require 'webmock/request_execution_verifier'
@@ -47,6 +49,7 @@ require 'webmock/http_lib_adapters/curb_adapter'
 require 'webmock/http_lib_adapters/em_http_request_adapter'
 require 'webmock/http_lib_adapters/typhoeus_hydra_adapter'
 require 'webmock/http_lib_adapters/excon_adapter'
+require 'webmock/http_lib_adapters/manticore_adapter'
 
 require 'webmock/webmock'
 

data/lib/webmock/config.rb

@@ -4,6 +4,7 @@ module WebMock
 
     def initialize
       @show_stubbing_instructions = true
+      @show_body_diff = true
     end
 
     attr_accessor :allow_net_connect
@@ -12,5 +13,6 @@ module WebMock
     attr_accessor :net_http_connect_on_start
     attr_accessor :show_stubbing_instructions
     attr_accessor :query_values_notation
+    attr_accessor :show_body_diff
   end
 end

data/lib/webmock/errors.rb

@@ -2,34 +2,16 @@ module WebMock
 
   class NetConnectNotAllowedError < Exception
     def initialize(request_signature)
+      request_signature_snippet = RequestSignatureSnippet.new(request_signature)
       text = [
         "Real HTTP connections are disabled. Unregistered request: #{request_signature}",
-        stubbing_instructions(request_signature),
-        request_stubs,
+        request_signature_snippet.stubbing_instructions,
+        request_signature_snippet.request_stubs,
         "="*60
       ].compact.join("\n\n")
       super(text)
     end
 
-    private
-
-    def request_stubs
-      return if WebMock::StubRegistry.instance.request_stubs.empty?
-      text = "registered request stubs:\n"
-      WebMock::StubRegistry.instance.request_stubs.each do |stub|
-        text << "\n#{WebMock::StubRequestSnippet.new(stub).to_s(false)}"
-      end
-      text
-    end
-
-    def stubbing_instructions(request_signature)
-      return unless WebMock.show_stubbing_instructions?
-      text = ""
-      request_stub = RequestStub.from_request_signature(request_signature)
-      text << "You can stub this request with the following snippet:\n\n"
-      text << WebMock::StubRequestSnippet.new(request_stub).to_s
-      text
-    end
   end
 
 end

data/lib/webmock/http_lib_adapters/em_http_request/em_http_request_1_x.rb

@@ -70,6 +70,10 @@ if defined?(EventMachine::HttpClient)
           raise WebMock::NetConnectNotAllowedError.new(request_signature)
         end
       end
+
+      def drop_client
+        @clients.shift
+      end
     end
 
     class WebMockHttpClient < EventMachine::HttpClient
@@ -83,6 +87,7 @@ if defined?(EventMachine::HttpClient)
         @last_effective_url = @uri = uri
         if error
           on_error(error)
+          @conn.drop_client
           fail(self)
         else
           @conn.receive_data(response)

data/lib/webmock/http_lib_adapters/manticore_adapter.rb

@@ -0,0 +1,123 @@
+begin
+  require 'manticore'
+rescue LoadError
+  # manticore not found
+end
+
+if defined?(Manticore)
+  module WebMock
+    module HttpLibAdapters
+      class ManticoreAdapter < HttpLibAdapter
+        adapter_for :manticore
+
+        OriginalManticoreClient = Manticore::Client
+
+        def self.enable!
+          Manticore.send(:remove_const, :Client)
+          Manticore.send(:const_set, :Client, WebMockManticoreClient)
+          Manticore.instance_variable_set(:@manticore_facade, WebMockManticoreClient.new)
+        end
+
+        def self.disable!
+          Manticore.send(:remove_const, :Client)
+          Manticore.send(:const_set, :Client, OriginalManticoreClient)
+          Manticore.instance_variable_set(:@manticore_facade, OriginalManticoreClient.new)
+        end
+
+        class WebMockManticoreClient < Manticore::Client
+          def request(klass, url, options={}, &block)
+            super(klass, WebMock::Util::URI.normalize_uri(url).to_s, format_options(options))
+          end
+
+          private
+
+          def format_options(options)
+            return options unless headers = options[:headers]
+
+            options.merge(:headers => join_array_values(headers))
+          end
+
+          def join_array_values(headers)
+            headers.reduce({}) do |h, (k,v)|
+              v = v.join(', ') if v.is_a?(Array)
+              h.merge(k => v)
+            end
+          end
+
+          def response_object_for(request, context, &block)
+            request_signature = generate_webmock_request_signature(request)
+            WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+
+            if webmock_response = registered_response_for(request_signature)
+              webmock_response.raise_error_if_any
+              manticore_response = generate_manticore_response(webmock_response).call
+              real_request = false
+
+            elsif real_request_allowed?(request_signature.uri)
+              manticore_response = Manticore::Response.new(self, request, context, &block).call
+              webmock_response = generate_webmock_response(manticore_response)
+              real_request = true
+
+            else
+              raise WebMock::NetConnectNotAllowedError.new(request_signature)
+            end
+
+            WebMock::CallbackRegistry.invoke_callbacks({:lib => :manticore, :real_request => real_request}, request_signature, webmock_response)
+            manticore_response
+          end
+
+          def registered_response_for(request_signature)
+            WebMock::StubRegistry.instance.response_for_request(request_signature)
+          end
+
+          def real_request_allowed?(uri)
+            WebMock.net_connect_allowed?(uri)
+          end
+
+          def generate_webmock_request_signature(request)
+            method = request.method.downcase
+            uri = request.uri.to_s
+            body = read_body(request)
+            headers = split_array_values(request.headers)
+
+            WebMock::RequestSignature.new(method, uri, {:body => body, :headers => headers})
+          end
+
+          def read_body(request)
+            if request.respond_to?(:entity) && !request.entity.nil?
+              Manticore::EntityConverter.new.read_entity(request.entity)
+            end
+          end
+
+          def split_array_values(headers = [])
+            headers.each_with_object({}) do |(k, v), h|
+              h[k] = case v
+                     when /,/ then v.split(',').map(&:strip)
+                     else v
+                     end
+            end
+          end
+
+          def generate_manticore_response(webmock_response)
+            raise Manticore::ConnectTimeout if webmock_response.should_timeout
+
+            Manticore::StubbedResponse.stub(
+              :code => webmock_response.status[0],
+              :body => webmock_response.body,
+              :headers => webmock_response.headers,
+              :cookies => {}
+            )
+          end
+
+          def generate_webmock_response(manticore_response)
+            webmock_response = WebMock::Response.new
+            webmock_response.status = [manticore_response.code, manticore_response.message]
+            webmock_response.body = manticore_response.body
+            webmock_response.headers = manticore_response.headers
+            webmock_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -272,10 +272,9 @@ module WebMock
       method = request.method.downcase.to_sym
 
       headers = Hash[*request.to_hash.map {|k,v| [k, v]}.inject([]) {|r,x| r + x}]
-
+      validate_headers(headers)
       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
@@ -290,6 +289,21 @@ module WebMock
       WebMock::RequestSignature.new(method, uri, :body => request.body, :headers => headers)
     end
 
+    def self.validate_headers(headers)
+      # If you make a request with headers that are symbols Net::HTTP raises a NoMethodError
+      #
+      # WebMock normalizes headers when creating a RequestSignature,
+      # and will update all headers from symbols to strings.
+      #
+      # This could create a false positive in a test suite with WebMock.
+      #
+      # So before this point, WebMock raises an ArgumentError if any of the headers are symbols
+      # instead of the cryptic NoMethodError "undefined method `split' ...` from Net::HTTP
+      header_as_symbol = headers.keys.find {|header| header.is_a? Symbol}
+      if header_as_symbol
+        raise ArgumentError.new("Net:HTTP does not accept headers as symbols")
+      end
+    end
 
     def self.check_right_http_connection
       @was_right_http_connection_loaded = defined?(RightHttpConnection)

data/lib/webmock/request_body_diff.rb

@@ -0,0 +1,63 @@
+require "hashdiff"
+require "json"
+
+module WebMock
+  class RequestBodyDiff
+
+    def initialize(request_signature, request_stub)
+      @request_signature = request_signature
+      @request_stub      = request_stub
+    end
+
+    def body_diff
+      return {} unless request_signature_diffable? && request_stub_diffable?
+
+      HashDiff.diff(request_signature_body_hash, request_stub_body_hash)
+    end
+
+    private
+
+    attr_reader :request_signature, :request_stub
+
+    def request_signature_diffable?
+      request_signature.json_headers? && request_signature_parseable_json?
+    end
+
+    def request_stub_diffable?
+      request_stub_body.is_a?(Hash) || request_stub_parseable_json?
+    end
+
+    def request_signature_body_hash
+      JSON.parse(request_signature.body)
+    end
+
+    def request_stub_body_hash
+      return request_stub_body if request_stub_body.is_a?(Hash)
+
+      JSON.parse(request_stub_body)
+    end
+
+    def request_stub_body
+      request_stub.request_pattern &&
+        request_stub.request_pattern.body_pattern &&
+        request_stub.request_pattern.body_pattern.pattern
+    end
+
+    def request_signature_parseable_json?
+      parseable_json?(request_signature.body)
+    end
+
+    def request_stub_parseable_json?
+      parseable_json?(request_stub_body)
+    end
+
+    def parseable_json?(body_pattern)
+      return false unless body_pattern.is_a?(String)
+
+      JSON.parse(body_pattern)
+      true
+    rescue JSON::ParserError
+      false
+    end
+  end
+end