webmock 1.24.6 → 2.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff6dc7d940f08ae334e0220100267ab6a41a58e4
+  data.tar.gz: 35dd3369af56b08b38fdf59f943c56b9552eb31e
+SHA512:
+  metadata.gz: f8448b8a8a176d912a448912133bc68b0edfa37c136235821f938153a7ef421ac2a2218996de115676469c781668a1b70abf0740140b2a3751419b7b267762b0
+  data.tar.gz: 389edffa68682edbf92649d0346073193abf5dd9d918249a3c6d381eecb5ae2954b01a739d803b467bbc65bf1438a82b30bb322c9796a93010b881ec28322dd1

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.0
@@ -14,16 +13,8 @@ rvm:
   - jruby
   - jruby-head
 matrix:
-  include:
-    - rvm: 1.8.7
-      gemfile: gemfiles/ruby_1_8.gemfile
-    - rvm: ree
-      gemfile: gemfiles/ruby_1_8.gemfile
-    - rvm: jruby-18mode
-      gemfile: gemfiles/ruby_1_8.gemfile
   allow_failures:
     - rvm: jruby-9.0.0.0
-    - rvm: jruby-18mode
     - rvm: jruby-head
     - rvm: ruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -1,19 +1,43 @@
 # Changelog
 
-## 1.24.6
+## 2.0.0
 
-  * Fixed issue with RUBY_VERSION comparison using old RubyGems.
+  * require 'webmock' does not enable WebMock anymore. `gem 'webmock'` can be now safely added to the Gemfile without modifying http clients. Call `WebMock.enable!` to enable it.
 
-    Thanks to [Chris Griego](https://github.com/cgriego).
+    Please note that `require 'webmock/rspec'`, `require 'webmock/test_unit'`, `require 'webmock/minitest'` and `require 'webmock/cucumber'` still do enable WebMock.
 
-  * Support for http.rb >= 2.0.0
+  * Dropped support for Ruby < 1.9.3
 
-## 1.24.4
+  * Dropped support for em-http-request < 1.0.0
 
-  * Fixed the issue with parsing query to a hash with nested array i.e. `a[][b][]=one&a[][c][]=two`
+  * WebMock 2.0 does not match basic auth credentials in the userinfo part of the url, with credentials passed in `Authorization: Basic ...` header.
+  It now treats the Authorization header and credentials in userinfo in the url as completely separate attributes of the request.
+
+  The following stub declaration, which used to work in WebMock 1.x, is not going to work anymore
+
+        stub_request(:get, "user:pass@www.example.com")
+
+        Net::HTTP.start('www.example.com') do |http|
+          req = Net::HTTP::Get.new('/')
+          req.basic_auth 'user', 'pass'
+          http.request(req)
+        end    # ===> Failure
+
+  In order to stub a request with basic authentication credentials provided in the Authorization header, please use the following code:
+
+        stub_request(:get, "www.example.com").with(basic_auth: ['user', 'pass'])
+
+  or
+
+        stub_request(:get, "www.example.com").
+          with(headers: 'Authorization' => "Basic #{ Base64.encode64('user:pass').chomp}")
+
+  In order to stub a request with basic authentication credentials provided in the url please use the following code:
+
+        stub_request(:get, "user:pass@www.example.com")
+
+        RestClient.get('user:pass@www.example.com')    # ===> Success
 
-    Thanks to [Tim Diggins](https://github.com/timdiggins) for reporting the issue.
-    Thanks to [Cedric Pimenta](https://github.com/cedricpim) for finding the solution.
 
 ## 1.24.3
 
@@ -21,6 +45,11 @@
 
     Thanks to [Alex Kestner](https://github.com/akestner)
 
+  * Fixed the issue with parsing query to a hash with nested array i.e. `a[][b][]=one&a[][c][]=two`
+
+    Thanks to [Tim Diggins](https://github.com/timdiggins) for reporting the issue.
+    Thanks to [Cedric Pimenta](https://github.com/cedricpim) for finding the solution.
+
   * Added a clear message on an attept to match a multipart encoded request body.
     WebMock does't support requests with multipart body... yet.
 

data/Gemfile

@@ -1,13 +1,9 @@
 source 'http://rubygems.org/'
 
 gemspec
-if ENV["EM_HTTP_REQUEST_0_X"]
-  gem 'em-http-request', '~> 0.3.0'
-end
 
 group :development do
-  gem 'rake', '~> 10.5.0' if RUBY_VERSION < '1.9.3'
-  gem 'rake' if RUBY_VERSION >= '1.9.3'
+  gem 'rake'
 end
 
 group :test do

data/README.md

@@ -32,15 +32,11 @@ Supported HTTP libraries
 Supported Ruby Interpreters
 ---------------------------
 
-* MRI 1.8.7
-* MRI 1.9.1
-* MRI 1.9.2
 * MRI 1.9.3
 * MRI 2.0.0
 * MRI 2.1
 * MRI 2.2
 * MRI 2.3
-* REE 1.8.7
 * JRuby
 * Rubinius
 
@@ -54,6 +50,10 @@ Supported Ruby Interpreters
     cd webmock
     rake install
 
+## Upgrading from v1.x to v2.x
+
+WebMock 2.x has changed somewhat since version 1.x. Changes are listed in [CHANGELOG.md](CHANGELOG.md)
+
 ### Test::Unit
 
 Add the following code to `test/test_helper.rb`
@@ -93,11 +93,9 @@ You can also use WebMock outside a test framework:
 ```ruby
 require 'webmock'
 include WebMock::API
-```
-
-### Automatically enabled
 
-`require 'webmock'` loads the library AND enables `WebMock`.  Add `WebMock.disable!` after loading the gem to disable this behavior.
+WebMock.enable!
+```
 
 ## Examples
 
@@ -205,10 +203,13 @@ stub_request(:post, "www.example.com").with { |request| request.body == "abc" }
 RestClient.post('www.example.com', 'abc')    # ===> Success
 ```
 
-### Request with basic authentication
+### Request with basic authentication header
 
 ```ruby
-stub_request(:get, "user:pass@www.example.com")
+stub_request(:get, "www.example.com").with(basic_auth: ['user', 'pass'])
+# or
+# stub_request(:get, "www.example.com").
+#   with(headers: 'Authorization' => "Basic #{ Base64.encode64('user:pass').chomp}")
 
 Net::HTTP.start('www.example.com') do |http|
   req = Net::HTTP::Get.new('/')
@@ -217,6 +218,16 @@ Net::HTTP.start('www.example.com') do |http|
 end    # ===> Success
 ```
 
+##### Important! Since version 2.0.0, WebMock does not match credentials provided in Authorization header and credentials provided in the userinfo of a url. I.e. `stub_request(:get, "user:pass@www.example.com")` does not match a request with credentials provided in the Athoriation header.
+
+### Request with basic authentication in the url
+
+```ruby
+stub_request(:get, "user:pass@www.example.com")
+
+RestClient.get('user:pass@www.example.com')    # ===> Success
+```
+
 ### Matching uris using regular expressions
 
 ```ruby
@@ -739,7 +750,7 @@ I.e all the following representations of the URI are equal:
 "http://www.example.com:80/"
 ```
 
-The following URIs with basic authentication are also equal for WebMock
+The following URIs with userinfo are also equal for WebMock
 
 ```ruby
 "a b:pass@www.example.com"
@@ -842,45 +853,6 @@ In order to work on Webmock you first need to fork and clone the repo.
 Please do any work on a dedicated branch and rebase against master
 before sending a pull request.
 
-#### Running Tests
-
-We use RVM in order to test WebMock against 1.8.6, REE, 1.8.7, 1.9.2 and
-jRuby.  You can get RVM setup for WebMock development using the
-following commands (if you don't have these version of Ruby installed
-use `rvm install` to install each of them).
-
-    rvm use --create 1.8.6@webmock
-    gem install jeweler bundler
-    bundle install
-
-    rvm use --create ree@webmock
-    gem install jeweler bundler
-    bundle install
-
-    rvm use --create 1.8.7@webmock
-    gem install jeweler bundler
-    bundle install
-
-    rvm use --create 1.9.2@webmock
-    gem install jeweler bundler
-    bundle install
-
-    rvm use --create jruby@webmock
-    gem install jeweler bundler
-    bundle install
-
-These commands will create a gemset named WebMock for each of the
-supported versions of Ruby and `bundle install` all dependencies.
-
-With the supported versions of Ruby installed RVM will run specs across
-all version with just one command.
-
-    bundle exec rvm 1.8.6@webmock,ree@webmock,1.8.7@webmock,1.9.2@webmock,jruby@webmock rspec spec/**/*_spec.rb
-
-This command is wrapped up in to a rake task and can be invoked like so:
-
-  rake rvm:specs
-
 ## 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)
@@ -1043,7 +1015,6 @@ People who submitted patches and new features or suggested improvements. Many th
 * Manfred Stienstra
 * Tim Diggins
 * Gabriel Chaney
-* Chris Griego
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/Rakefile

@@ -3,17 +3,6 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-namespace :rvm do
-  desc 'Run specs against 1.8.6, REE, 1.8.7, 1.9.2 and jRuby'
-  task :specs do
-    # JCF: I'd love to be able to use RVM's `rvm {rubies} specs` command but
-    # the require tests in spec/other_net_http_libs_spec.rb break when doing
-    # so.
-    spec_files = Dir[File.dirname(__FILE__) + '/spec/**/*_spec.rb'].join(' ')
-    sh "rvm 1.8.6@webmock,ree@webmock,1.8.7@webmock,1.9.2@webmock,jruby@webmock exec rspec #{spec_files}"
-  end
-end
-
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
@@ -25,11 +14,6 @@ RSpec::Core::RakeTask.new(:spec_http_without_webmock) do |t|
   t.pattern = 'spec/acceptance/net_http/real_net_http_spec.rb'
 end
 
-
-task :em_http_request_0_x_spec do
-  sh "EM_HTTP_REQUEST_0_X=true bundle install && EM_HTTP_REQUEST_0_X=true bundle exec rspec spec/acceptance/em_http_request/em_http_request_spec.rb" if RUBY_VERSION <= "1.8.7"
-end
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb")
@@ -43,11 +27,4 @@ Rake::TestTask.new(:minitest) do |test|
   test.warning = false
 end
 
-
 task :default => [:spec, :spec_http_without_webmock, :test, :minitest]
-
-task :require_ruby_18 do
-  raise "This must be run on Ruby 1.8" unless RUBY_VERSION =~ /^1\.8/
-end
-
-task :release => [:require_ruby_18]

data/lib/webmock.rb

@@ -52,15 +52,3 @@ require 'webmock/http_lib_adapters/excon_adapter'
 require 'webmock/http_lib_adapters/manticore_adapter'
 
 require 'webmock/webmock'
-
-if RUBY_VERSION <= "1.8.7" && Addressable::VERSION::STRING >= "2.4.0"
-  raise StandardError,
-    <<-ERR
-    \n\e[31m
-    Addressable dropped support for Ruby 1.8.7 on version 2.4.0,
-
-    please add the following to your Gemfile to be able to use WebMock:
-
-    gem 'addressable', '< 2.4.0'\e[0m\n
-  ERR
-end

data/lib/webmock/cucumber.rb

@@ -1,6 +1,8 @@
 require 'webmock'
 require 'webmock/rspec/matchers'
 
+WebMock.enable!
+
 World(WebMock::API, WebMock::Matchers)
 
 After do

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -84,8 +84,6 @@ if defined?(Curl)
 
         uri = WebMock::Util::URI.heuristic_parse(self.url)
         uri.path = uri.normalized_path.gsub("[^:]//","/")
-        uri.user = self.username
-        uri.password = self.password
 
         request_body = case method
         when :post
@@ -100,11 +98,19 @@ if defined?(Curl)
           method,
           uri.to_s,
           :body => request_body,
-          :headers => self.headers
+          :headers => self.headers.merge(basic_auth_headers)
         )
         request_signature
       end
 
+      def basic_auth_headers
+        if self.username
+          {'Authorization' => WebMock::Util::Headers.basic_auth_header(self.username, self.password)}
+        else
+          {}
+        end
+      end
+
       def build_curb_response(webmock_response)
         raise Curl::Err::TimeoutError if webmock_response.should_timeout
         webmock_response.raise_error_if_any

data/lib/webmock/http_lib_adapters/em_http_request_adapter.rb

@@ -1,11 +1,222 @@
-begin
-  require 'em-http-request'
-rescue LoadError
-  # em-http-request not found
-end
+if defined?(EventMachine::HttpClient)
+  module WebMock
+    module HttpLibAdapters
+      class EmHttpRequestAdapter < HttpLibAdapter
+        adapter_for :em_http_request
+
+        OriginalHttpClient = EventMachine::HttpClient unless const_defined?(:OriginalHttpClient)
+        OriginalHttpConnection = EventMachine::HttpConnection unless const_defined?(:OriginalHttpConnection)
+
+        def self.enable!
+          EventMachine.send(:remove_const, :HttpConnection)
+          EventMachine.send(:const_set, :HttpConnection, EventMachine::WebMockHttpConnection)
+          EventMachine.send(:remove_const, :HttpClient)
+          EventMachine.send(:const_set, :HttpClient, EventMachine::WebMockHttpClient)
+        end
+
+        def self.disable!
+          EventMachine.send(:remove_const, :HttpConnection)
+          EventMachine.send(:const_set, :HttpConnection, OriginalHttpConnection)
+          EventMachine.send(:remove_const, :HttpClient)
+          EventMachine.send(:const_set, :HttpClient, OriginalHttpClient)
+        end
+      end
+    end
+  end
+
+  module EventMachine
+    if defined?(Synchrony) && HTTPMethods.instance_methods.include?(:aget)
+      # have to make the callbacks fire on the next tick in order
+      # to avoid the dreaded "double resume" exception
+      module HTTPMethods
+        %w[get head post delete put].each do |type|
+          class_eval %[
+            def #{type}(options = {}, &blk)
+              f = Fiber.current
+
+               conn = setup_request(:#{type}, options, &blk)
+               conn.callback { EM.next_tick { f.resume(conn) } }
+               conn.errback  { EM.next_tick { f.resume(conn) } }
+
+               Fiber.yield
+            end
+          ]
+        end
+      end
+    end
+
+    class WebMockHttpConnection < HttpConnection
+      def activate_connection(client)
+        request_signature = client.request_signature
+
+        if client.stubbed_webmock_response
+          conn = HttpStubConnection.new rand(10000)
+          post_init
+
+          @deferred = false
+          @conn = conn
+
+          conn.parent = self
+          conn.pending_connect_timeout = @connopts.connect_timeout
+          conn.comm_inactivity_timeout = @connopts.inactivity_timeout
+
+          finalize_request(client)
+          @conn.set_deferred_status :succeeded
+        elsif WebMock.net_connect_allowed?(request_signature.uri)
+          super
+        else
+          raise WebMock::NetConnectNotAllowedError.new(request_signature)
+        end
+      end
+
+      def drop_client
+        @clients.shift
+      end
+    end
+
+    class WebMockHttpClient < EventMachine::HttpClient
+      include HttpEncoding
+
+      def uri
+        @req.uri
+      end
+
+      def setup(response, uri, error = nil)
+        @last_effective_url = @uri = uri
+        if error
+          on_error(error)
+          @conn.drop_client
+          fail(self)
+        else
+          @conn.receive_data(response)
+          succeed(self)
+        end
+      end
+
+      def send_request(head, body)
+        WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+
+        if stubbed_webmock_response
+          WebMock::CallbackRegistry.invoke_callbacks({:lib => :em_http_request}, request_signature, stubbed_webmock_response)
+          @uri ||= nil
+          EM.next_tick {
+            setup(make_raw_response(stubbed_webmock_response), @uri,
+                  stubbed_webmock_response.should_timeout ? "WebMock timeout error" : nil)
+          }
+          self
+        elsif WebMock.net_connect_allowed?(request_signature.uri)
+          super
+        else
+          raise WebMock::NetConnectNotAllowedError.new(request_signature)
+        end
+      end
+
+      def unbind(reason = nil)
+        if !stubbed_webmock_response && WebMock::CallbackRegistry.any_callbacks?
+          webmock_response = build_webmock_response
+          WebMock::CallbackRegistry.invoke_callbacks(
+            {:lib => :em_http_request, :real_request => true},
+            request_signature,
+            webmock_response)
+        end
+        @request_signature = nil
+        remove_instance_variable(:@stubbed_webmock_response)
+
+        super
+      end
+
+      def request_signature
+        @request_signature ||= build_request_signature
+      end
+
+      def stubbed_webmock_response
+        unless defined?(@stubbed_webmock_response)
+          @stubbed_webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
+        end
+
+        @stubbed_webmock_response
+      end
+
+      def get_response_cookie(name)
+        name = name.to_s
+
+        raw_cookie = response_header.cookie
+        raw_cookie = [raw_cookie] if raw_cookie.is_a? String
+
+        cookie = raw_cookie.select { |c| c.start_with? name }.first
+        cookie and cookie.split('=', 2)[1]
+      end
+
+      private
+
+      def build_webmock_response
+        webmock_response = WebMock::Response.new
+        webmock_response.status = [response_header.status, response_header.http_reason]
+        webmock_response.headers = response_header
+        webmock_response.body = response
+        webmock_response
+      end
+
+      def build_request_signature
+        headers, body = @req.headers, @req.body
+
+        @conn.middleware.select {|m| m.respond_to?(:request) }.each do |m|
+          headers, body = m.request(self, headers, body)
+        end
+
+        method = @req.method
+        uri = @req.uri.clone
+        query = @req.query
+
+        uri.query = encode_query(@req.uri, query).slice(/\?(.*)/, 1)
+
+        body = form_encode_body(body) if body.is_a?(Hash)
+
+        headers = @req.headers
+
+        if headers['authorization']
+          headers['Authorization'] = WebMock::Util::Headers.basic_auth_header(headers.delete('authorization'))
+        end
+
+        WebMock::RequestSignature.new(
+          method.downcase.to_sym,
+          uri.to_s,
+          :body => body || (@req.file && File.read(@req.file)),
+          :headers => headers
+        )
+      end
+
+      def make_raw_response(response)
+        response.raise_error_if_any
+
+        status, headers, body = response.status, response.headers, response.body
+        headers ||= {}
+
+        response_string = []
+        response_string << "HTTP/1.1 #{status[0]} #{status[1]}"
+
+        headers["Content-Length"] = body.bytesize unless headers["Content-Length"]
+        headers.each do |header, value|
+          if header =~ /set-cookie/i
+            [value].flatten.each do |cookie|
+              response_string << "#{header}: #{cookie}"
+            end
+          else
+            value = value.join(", ") if value.is_a?(Array)
+
+            # WebMock's internal processing will not handle the body
+            # correctly if the header indicates that it is chunked, unless
+            # we also create all the chunks.
+            # It's far easier just to remove the header.
+            next if header =~ /transfer-encoding/i && value =~/chunked/i
+
+            response_string << "#{header}: #{value}"
+          end
+        end if headers
 
-if defined?(EventMachine::HttpConnection)
-  require File.expand_path(File.dirname(__FILE__) + '/em_http_request/em_http_request_1_x')
-else
-  require File.expand_path(File.dirname(__FILE__) + '/em_http_request/em_http_request_0_x')
+        response_string << "" << body
+        response_string.join("\n")
+      end
+    end
+  end
 end