webmock 1.16.1 → 1.17.0

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.17.0
+
+* HTTP gem support!
+
+  Thanks to [Aleksey V. Zapparov](https://github.com/ixti)
+
+* Limited Excon gem requirement to version < 0.30 until the compatibility with version > 0.30.0 is fixed.
+
+  Thanks to [Aleksey V. Zapparov](https://github.com/ixti)
+
+* Fixed issue where empty query key caused a `TypeError`
+
+  Thanks to [Jon Rowe](https://github.com/JonRowe)
+
+* Handling Typhoeus `on_headers` and `on_body` params.
+
+  Thanks to [Matt Burke](https://github.com/spraints)
+
 ## 1.16.1
 
 * Fixed "NameError: uninitialized constant WebMock::Response::Pathname" issue.

data/README.md

@@ -25,6 +25,7 @@ Supported HTTP libraries
 * Curb (currently only Curb::Easy)
 * Typhoeus (currently only Typhoeus::Hydra)
 * Excon
+* HTTP Gem
 
 Supported Ruby Interpreters
 ---------------------------
@@ -874,6 +875,9 @@ People who submitted patches and new features or suggested improvements. Many th
 * Stefano Uliari
 * Alex Stupakov
 * Karen Wang
+* Matt Burke
+* Jon Rowe
+* Aleksey V. Zapparov
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock.rb

@@ -38,6 +38,7 @@ require 'webmock/api'
 require 'webmock/http_lib_adapters/http_lib_adapter_registry'
 require 'webmock/http_lib_adapters/http_lib_adapter'
 require 'webmock/http_lib_adapters/net_http'
+require 'webmock/http_lib_adapters/http_gem_adapter'
 require 'webmock/http_lib_adapters/httpclient_adapter'
 require 'webmock/http_lib_adapters/patron_adapter'
 require 'webmock/http_lib_adapters/curb_adapter'

data/lib/webmock/http_lib_adapters/http_gem_adapter.rb

@@ -0,0 +1,170 @@
+begin
+  require "http"
+rescue LoadError
+  # HTTP gem not found
+end
+
+
+if defined?(HTTP::Client)
+  module WebMock
+    module HttpLibAdapters
+      class HttpGemAdapter < HttpLibAdapter
+
+        adapter_for :http_gem
+
+
+        def self.enable!
+          ::HTTP.enable_webmock!
+        end
+
+
+        def self.disable!
+          ::HTTP.disable_webmock!
+        end
+
+      end
+    end
+  end
+
+
+  module HTTP
+    class Request
+
+      def webmock_signature
+        ::WebMock::RequestSignature.new(method, uri.to_s, {
+          :headers  => headers,
+          :body     => body
+        })
+      end
+
+    end
+
+
+    class Response
+
+      def to_webmock
+        webmock_response = ::WebMock::Response.new
+
+        webmock_response.status  = [status, reason]
+        webmock_response.body    = body
+        webmock_response.headers = headers
+
+        webmock_response
+      end
+
+
+      def self.from_webmock(webmock_response)
+        status  = webmock_response.status.first
+        headers = webmock_response.headers || {}
+        body    = webmock_response.body
+
+        new(status, "1.1", headers, body)
+      end
+
+    end
+
+
+    class WebMockPerform
+
+      def initialize request, &perform
+        @request = request
+        @perform = perform
+      end
+
+
+      def exec
+        replay || perform || halt
+      end
+
+
+      def request_signature
+        unless @request_signature
+          @request_signature = @request.webmock_signature
+          register_request(@request_signature)
+        end
+
+        @request_signature
+      end
+
+
+      protected
+
+
+      def response_for_request(signature)
+        ::WebMock::StubRegistry.instance.response_for_request(signature)
+      end
+
+
+      def register_request(signature)
+        ::WebMock::RequestRegistry.instance.requested_signatures.put(signature)
+      end
+
+
+      def replay
+        webmock_response = response_for_request(request_signature)
+
+        return unless webmock_response
+
+        raise Errno::ETIMEDOUT if webmock_response.should_timeout
+        webmock_response.raise_error_if_any
+
+        invoke_callbacks(webmock_response, :real_request => false)
+        ::HTTP::Response.from_webmock webmock_response
+      end
+
+
+      def perform
+        return unless ::WebMock.net_connect_allowed?(request_signature.uri)
+        response = @perform.call
+        invoke_callbacks(response.to_webmock, :real_request => true)
+        response
+      end
+
+
+      def halt
+        raise ::WebMock::NetConnectNotAllowedError.new request_signature
+      end
+
+
+      def invoke_callbacks webmock_response, options = {}
+        ::WebMock::CallbackRegistry.invoke_callbacks(
+          options.merge({ :lib => :http_gem }),
+          request_signature,
+          webmock_response
+        )
+      end
+
+    end
+
+
+    class Client
+
+      alias :__perform__ :perform
+
+      def perform request, options
+        return __perform__(request, options) unless ::HTTP.webmock_enabled?
+        WebMockPerform.new(request) { __perform__(request, options) }.exec
+      end
+
+    end
+
+
+    class << self
+
+      def enable_webmock!
+        @webmock_enabled = true
+      end
+
+
+      def disable_webmock!
+        @webmock_enabled = false
+      end
+
+
+      def webmock_enabled?
+        @webmock_enabled
+      end
+
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb

@@ -143,6 +143,13 @@ if defined?(Typhoeus)
             if webmock_response = ::WebMock::StubRegistry.instance.response_for_request(request_signature)
               # ::WebMock::HttpLibAdapters::TyphoeusAdapter.stub_typhoeus(request_signature, webmock_response, self)
               response = ::WebMock::HttpLibAdapters::TyphoeusAdapter.generate_typhoeus_response(request_signature, webmock_response)
+              if request.respond_to?(:on_headers)
+                request.execute_headers_callbacks(response)
+              end
+              if request.respond_to?(:streaming?) && request.streaming?
+                response.options[:response_body] = ""
+                request.on_body.each { |callback| callback.call(webmock_response.body, response) }
+              end
               request.finish(response)
               webmock_response.raise_error_if_any
               res = false

data/lib/webmock/util/query_mapper.rb

@@ -131,8 +131,8 @@ module WebMock::Util
         end
         new_query_values = new_query_values.to_hash
         new_query_values = new_query_values.map do |key, value|
-          key = key.to_s if key.kind_of?(Symbol)
-          [key, value]
+          key = key.to_s if key.kind_of?(Symbol) || key.nil?
+          [key.to_s, value]
         end
         # Useful default for OAuth and caching.
         # Only to be used for non-Array inputs. Arrays should preserve order.

data/lib/webmock/version.rb

@@ -1,3 +1,3 @@
 module WebMock
-  VERSION = '1.16.1' unless defined?(::WebMock::VERSION)
+  VERSION = '1.17.0' unless defined?(::WebMock::VERSION)
 end

data/spec/acceptance/excon/excon_spec_helper.rb

@@ -7,8 +7,13 @@ module ExconSpecHelper
     uri      = Addressable::URI.heuristic_parse(uri)
     uri      = uri.omit(:userinfo).to_s.gsub(' ', '%20')
 
-    options  = options.merge(:method => method, :nonblock => false) # Dup and merge
-    response = Excon.new(uri).request(options, &block)
+    if Gem::Version.new(Excon::VERSION) < Gem::Version.new("0.29.0")
+      options  = options.merge(:method => method, :nonblock => false) # Dup and merge
+      response = Excon.new(uri).request(options, &block)
+    else
+      options  = options.merge(:method => method) # Dup and merge
+      response = Excon.new(uri, :nonblock => false).request(options, &block)
+    end
 
     headers  = WebMock::Util::Headers.normalize_headers(response.headers)
     headers  = headers.inject({}) do |res, (name, value)|

data/spec/acceptance/http_gem/http_gem_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require "spec_helper"
+require "acceptance/webmock_shared"
+require "acceptance/http_gem/http_gem_spec_helper"
+
+describe "HTTP Gem" do
+
+  include HttpGemSpecHelper
+
+
+  include_examples "with WebMock", :no_status_message
+
+
+  context "when not following redirects" do
+
+    let(:response) { http_request(:get, "http://example.com") }
+    let(:headers)  { response.headers }
+
+    it "stops on first request" do
+      stub_simple_request("example.com", 302, "Location" => "www.example.com")
+      stub_simple_request("www.example.com")
+
+      expect(headers).to include "Host" => "example.com"
+    end
+
+  end
+
+
+  context "when following redirects" do
+
+    let(:response) { http_request(:get, "http://example.com", :follow => true) }
+    let(:headers)  { response.headers }
+
+
+    it "returns response of destination" do
+      stub_simple_request("example.com", 302, "Location" => "www.example.com")
+      stub_simple_request("www.example.com")
+
+      expect(headers).to include "Host" => "www.example.com"
+    end
+
+
+    it "works with more than one redirect" do
+      stub_simple_request("example.com", 302, "Location" => "www.example.com")
+      stub_simple_request("www.example.com", 302, "Location" => "blog.example.com")
+      stub_simple_request("blog.example.com")
+
+      expect(headers).to include "Host" => "blog.example.com"
+    end
+
+  end
+
+end

data/spec/acceptance/http_gem/http_gem_spec_helper.rb

@@ -0,0 +1,52 @@
+require "ostruct"
+
+
+module HttpGemSpecHelper
+
+  def http_request(method, uri, options = {}, &block)
+    response = HTTP.request(method, normalize_uri(uri), options).response
+
+    OpenStruct.new({
+      :body       => response.body,
+      :headers    => normalize_headers(response.headers),
+      :status     => response.status.to_s,
+      :message    => response.reason
+    })
+  end
+
+
+  def normalize_uri(uri)
+    Addressable::URI.heuristic_parse(uri).normalize.to_s
+  end
+
+
+  def normalize_headers headers
+    WebMock::Util::Headers.normalize_headers(Hash[headers.map { |k, v|
+      [k, v.is_a?(Array) ? v.join(", ") : v]
+    }])
+  end
+
+
+  def stub_simple_request host, status = 200, headers = {}
+    stub_request(:any, host).to_return({
+      :status   => status,
+      :headers  => headers.merge({ "Host" => host })
+    })
+  end
+
+
+  def client_timeout_exception_class
+    Errno::ETIMEDOUT
+  end
+
+
+  def connection_refused_exception_class
+    Errno::ECONNREFUSED
+  end
+
+
+  def http_library
+    :http_gem
+  end
+
+end

data/spec/acceptance/typhoeus/typhoeus_hydra_spec.rb

@@ -78,6 +78,39 @@ unless RUBY_PLATFORM =~ /java/
           hydra.run
           test.should == response_code
         end
+
+        it "should call on_body with 2xx response" do
+          body = "on_body fired"
+          stub_request(:any, "example.com").to_return(:body => body)
+
+          test_body = nil
+          test_complete = nil
+          pending("This test requires a newer version of Typhoeus") unless @request.respond_to?(:on_body)
+          @request.on_body do |body, response|
+            test_body = body
+          end
+          @request.on_complete do |response|
+            test_complete = response.body
+          end
+          hydra.queue @request
+          hydra.run
+          test_body.should == body
+          test_complete.should == ""
+        end
+
+        it "should call on_headers with 2xx response" do
+          body = "on_headers fired"
+          stub_request(:any, "example.com").to_return(:body => body, :headers => {'X-Test' => '1'})
+
+          test_headers = nil
+          pending("This test requires a newer version of Typhoeus") unless @request.respond_to?(:on_headers)
+          @request.on_headers do |response|
+            test_headers = response.headers
+          end
+          hydra.queue @request
+          hydra.run
+          test_headers.should include('X-Test' => '1')
+        end
       end
     end
   end

data/spec/unit/util/query_mapper_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe WebMock::Util::QueryMapper do
+  let(:query_mapper) { described_class }
+
+  it "converts query to values" do
+    query = "key=value&other_key=other_value"
+    values = { 'key' => 'value', 'other_key' => 'other_value' }
+    expect(query_mapper.query_to_values query).to eq values
+  end
+
+  it 'converts values to a query string' do
+    query = "key=value&other_key=other_value"
+    values = [['key','value'],['other_key','other_value']]
+    expect(query_mapper.values_to_query values).to eq query
+  end
+
+  it 'converts values with missing keys to a query string' do
+    query = "=value"
+    values = { '' => 'value' }
+    expect(query_mapper.values_to_query values).to eq query
+  end
+
+  it 'converts values with nil keys to a query string' do
+    query = "=value"
+    values = { nil => 'value' }
+    expect(query_mapper.values_to_query values).to eq query
+  end
+
+end

data/webmock.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
   s.add_dependency 'crack', '>=0.3.2'
 
   s.add_development_dependency 'rspec',           '~> 2.10'
+  s.add_development_dependency 'http',            '>= 0.5.0'
   s.add_development_dependency 'httpclient',      '>= 2.2.4'
   s.add_development_dependency 'patron',          '>= 0.4.18' unless RUBY_PLATFORM =~ /java/
   s.add_development_dependency 'em-http-request', '>= 1.0.2'
   s.add_development_dependency 'em-synchrony',    '>= 1.0.0' if RUBY_VERSION >= "1.9"
   s.add_development_dependency 'curb',            '>= 0.8.0' unless RUBY_PLATFORM =~ /java/
   s.add_development_dependency 'typhoeus',        '>= 0.5.0' unless RUBY_PLATFORM =~ /java/
-  s.add_development_dependency 'excon',           '>= 0.22.0'
+  s.add_development_dependency 'excon',           '>= 0.27.5', '< 0.30.0'
   s.add_development_dependency 'minitest',        '~> 5.0.0'
   s.add_development_dependency 'rdoc',            ((RUBY_VERSION == '1.8.6') ? '<= 3.5.0' : '>3.5.0')
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webmock
 version: !ruby/object:Gem::Version 
-  hash: 85
+  hash: 83
   prerelease: 
   segments: 
   - 1
-  - 16
-  - 1
-  version: 1.16.1
+  - 17
+  - 0
+  version: 1.17.0
 platform: ruby
 authors: 
 - Bartosz Blimke
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-12-15 00:00:00 Z
+date: 2014-01-16 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: addressable
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +31,11 @@ dependencies:
         - 2
         - 7
         version: 2.2.7
-  type: :runtime
   prerelease: false
   requirement: *id001
+  name: addressable
 - !ruby/object:Gem::Dependency 
-  name: crack
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,11 +47,11 @@ dependencies:
         - 3
         - 2
         version: 0.3.2
-  type: :runtime
   prerelease: false
   requirement: *id002
+  name: crack
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,12 +62,28 @@ dependencies:
         - 2
         - 10
         version: "2.10"
-  type: :development
   prerelease: false
   requirement: *id003
+  name: rspec
 - !ruby/object:Gem::Dependency 
-  name: httpclient
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  prerelease: false
+  requirement: *id004
+  name: http
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,12 +94,12 @@ dependencies:
         - 2
         - 4
         version: 2.2.4
-  type: :development
   prerelease: false
-  requirement: *id004
+  requirement: *id005
+  name: httpclient
 - !ruby/object:Gem::Dependency 
-  name: patron
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,12 +110,12 @@ dependencies:
         - 4
         - 18
         version: 0.4.18
-  type: :development
   prerelease: false
-  requirement: *id005
+  requirement: *id006
+  name: patron
 - !ruby/object:Gem::Dependency 
-  name: em-http-request
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -109,12 +126,12 @@ dependencies:
         - 0
         - 2
         version: 1.0.2
-  type: :development
   prerelease: false
-  requirement: *id006
+  requirement: *id007
+  name: em-http-request
 - !ruby/object:Gem::Dependency 
-  name: curb
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -125,12 +142,12 @@ dependencies:
         - 8
         - 0
         version: 0.8.0
-  type: :development
   prerelease: false
-  requirement: *id007
+  requirement: *id008
+  name: curb
 - !ruby/object:Gem::Dependency 
-  name: typhoeus
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -141,28 +158,36 @@ dependencies:
         - 5
         - 0
         version: 0.5.0
-  type: :development
   prerelease: false
-  requirement: *id008
+  requirement: *id009
+  name: typhoeus
 - !ruby/object:Gem::Dependency 
-  name: excon
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 71
+        hash: 121
+        segments: 
+        - 0
+        - 27
+        - 5
+        version: 0.27.5
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 103
         segments: 
         - 0
-        - 22
+        - 30
         - 0
-        version: 0.22.0
-  type: :development
+        version: 0.30.0
   prerelease: false
-  requirement: *id009
+  requirement: *id010
+  name: excon
 - !ruby/object:Gem::Dependency 
-  name: minitest
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -173,12 +198,12 @@ dependencies:
         - 0
         - 0
         version: 5.0.0
-  type: :development
   prerelease: false
-  requirement: *id010
+  requirement: *id011
+  name: minitest
 - !ruby/object:Gem::Dependency 
-  name: rdoc
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
@@ -189,9 +214,9 @@ dependencies:
         - 5
         - 0
         version: 3.5.0
-  type: :development
   prerelease: false
-  requirement: *id011
+  requirement: *id012
+  name: rdoc
 description: WebMock allows stubbing HTTP requests and setting expectations on HTTP requests.
 email: 
 - bartosz.blimke@gmail.com
@@ -224,6 +249,7 @@ files:
 - lib/webmock/http_lib_adapters/em_http_request/em_http_request_1_x.rb
 - lib/webmock/http_lib_adapters/em_http_request_adapter.rb
 - lib/webmock/http_lib_adapters/excon_adapter.rb
+- lib/webmock/http_lib_adapters/http_gem_adapter.rb
 - lib/webmock/http_lib_adapters/http_lib_adapter.rb
 - lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb
 - lib/webmock/http_lib_adapters/httpclient_adapter.rb
@@ -266,6 +292,8 @@ files:
 - spec/acceptance/em_http_request/em_http_request_spec_helper.rb
 - spec/acceptance/excon/excon_spec.rb
 - spec/acceptance/excon/excon_spec_helper.rb
+- spec/acceptance/http_gem/http_gem_spec.rb
+- spec/acceptance/http_gem/http_gem_spec_helper.rb
 - spec/acceptance/httpclient/httpclient_spec.rb
 - spec/acceptance/httpclient/httpclient_spec_helper.rb
 - spec/acceptance/net_http/net_http_shared.rb
@@ -309,6 +337,7 @@ files:
 - spec/unit/util/hash_keys_stringifier_spec.rb
 - spec/unit/util/headers_spec.rb
 - spec/unit/util/json_spec.rb
+- spec/unit/util/query_mapper_spec.rb
 - spec/unit/util/uri_spec.rb
 - spec/unit/util/version_checker_spec.rb
 - spec/unit/webmock_spec.rb
@@ -317,6 +346,7 @@ files:
 - test/test_helper.rb
 - test/test_webmock.rb
 - webmock.gemspec
+has_rdoc: true
 homepage: http://github.com/bblimke/webmock
 licenses: 
 - MIT
@@ -346,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: webmock
-rubygems_version: 1.8.19
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Library for stubbing HTTP requests in Ruby.
@@ -357,6 +387,8 @@ test_files:
 - spec/acceptance/em_http_request/em_http_request_spec_helper.rb
 - spec/acceptance/excon/excon_spec.rb
 - spec/acceptance/excon/excon_spec_helper.rb
+- spec/acceptance/http_gem/http_gem_spec.rb
+- spec/acceptance/http_gem/http_gem_spec_helper.rb
 - spec/acceptance/httpclient/httpclient_spec.rb
 - spec/acceptance/httpclient/httpclient_spec_helper.rb
 - spec/acceptance/net_http/net_http_shared.rb
@@ -400,6 +432,7 @@ test_files:
 - spec/unit/util/hash_keys_stringifier_spec.rb
 - spec/unit/util/headers_spec.rb
 - spec/unit/util/json_spec.rb
+- spec/unit/util/query_mapper_spec.rb
 - spec/unit/util/uri_spec.rb
 - spec/unit/util/version_checker_spec.rb
 - spec/unit/webmock_spec.rb