webmock 1.8.6 → 3.14.0

data/lib/webmock/http_lib_adapters/excon_adapter.rb

@@ -5,27 +5,94 @@ rescue LoadError
 end
 
 if defined?(Excon)
-  WebMock::VersionChecker.new('Excon', Excon::VERSION, '0.9.6').check_version!
+  WebMock::VersionChecker.new('Excon', Excon::VERSION, '0.27.5').check_version!
 
   module WebMock
     module HttpLibAdapters
 
       class ExconAdapter < HttpLibAdapter
+        PARAMS_TO_DELETE = [:expects, :idempotent,
+                            :instrumentor_name, :instrumentor,
+                            :response_block,
+                            :__construction_args, :stack,
+                            :connection, :response]
+
         adapter_for :excon
 
+        instance_exec do
+          @original_excon_mock_default = nil
+          @stub = nil
+        end
+
         def self.enable!
-          Excon.send(:remove_const, :Connection)
-          Excon.send(:const_set, :Connection, ExconConnection)
+          self.add_excon_stub
         end
 
         def self.disable!
-          Excon.send(:remove_const, :Connection)
-          Excon.send(:const_set, :Connection, ExconConnection.superclass)
+          self.remove_excon_stub
+        end
+
+        def self.add_excon_stub
+          if not @stub
+            @original_excon_mock_default = ::Excon.defaults[:mock]
+            ::Excon.defaults[:mock] = true
+            @stub = ::Excon.stub({}) do |params|
+              self.handle_request(params)
+            end
+          end
+        end
+
+        def self.remove_excon_stub
+          ::Excon.defaults[:mock] = @original_excon_mock_default
+          @original_excon_mock_default = nil
+          Excon.stubs.delete(@stub)
+          @stub = nil
+        end
+
+        def self.handle_request(params)
+          mock_request  = self.build_request params.dup
+          WebMock::RequestRegistry.instance.requested_signatures.put(mock_request)
+
+          if mock_response = WebMock::StubRegistry.instance.response_for_request(mock_request)
+            self.perform_callbacks(mock_request, mock_response, real_request: false)
+            response = self.real_response(mock_response)
+            response
+          elsif WebMock.net_connect_allowed?(mock_request.uri)
+            conn = new_excon_connection(params)
+            real_response = conn.request(request_params_from(params.merge(mock: false)))
+
+            ExconAdapter.perform_callbacks(mock_request, ExconAdapter.mock_response(real_response), real_request: true)
+
+            real_response.data
+          else
+            raise WebMock::NetConnectNotAllowedError.new(mock_request)
+          end
+        end
+
+        def self.new_excon_connection(params)
+          # Ensure the connection is constructed with the exact same args
+          # that the orginal connection was constructed with.
+          args = params.fetch(:__construction_args)
+          ::Excon::Connection.new(connection_params_from args.merge(mock: false))
+        end
+
+        def self.connection_params_from(hash)
+          hash = hash.dup
+          PARAMS_TO_DELETE.each { |key| hash.delete(key) }
+          hash
         end
 
+        def self.request_params_from(hash)
+          hash = hash.dup
+          if defined?(Excon::VALID_REQUEST_KEYS)
+            hash.reject! {|key,_| !Excon::VALID_REQUEST_KEYS.include?(key) }
+          end
+          PARAMS_TO_DELETE.each { |key| hash.delete(key) }
+          hash
+        end
 
         def self.to_query(hash)
-          string = ""
+          string = "".dup
           for key, values in hash
             if values.nil?
               string << key.to_s << '&'
@@ -40,56 +107,59 @@ if defined?(Excon)
 
         def self.build_request(params)
           params = params.dup
+          params.delete(:user)
+          params.delete(:password)
           method  = (params.delete(:method) || :get).to_s.downcase.to_sym
           params[:query] = to_query(params[:query]) if params[:query].is_a?(Hash)
-          uri     = Addressable::URI.new(params).to_s
-          WebMock::RequestSignature.new method, uri, :body => params[:body], :headers => params[:headers]
+          uri = Addressable::URI.new(params).to_s
+          WebMock::RequestSignature.new method, uri, body: body_from(params), headers: params[:headers]
+        end
+
+        def self.body_from(params)
+          body = params[:body]
+          return body unless body.respond_to?(:read)
+
+          contents = body.read
+          body.rewind if body.respond_to?(:rewind)
+          contents
         end
 
         def self.real_response(mock)
           raise Excon::Errors::Timeout if mock.should_timeout
           mock.raise_error_if_any
-          Excon::Response.new \
-            :body    => mock.body,
-            :status  => mock.status[0].to_i,
-            :headers => mock.headers
+          {
+            body: mock.body,
+            status: mock.status[0].to_i,
+            reason_phrase: mock.status[1],
+            headers: mock.headers || {}
+          }
         end
 
         def self.mock_response(real)
           mock = WebMock::Response.new
-          mock.status  = real.status
+          mock.status  = [real.status, real.reason_phrase]
           mock.headers = real.headers
-          mock.body    = real.body
+          mock.body    = real.body.dup
           mock
         end
 
         def self.perform_callbacks(request, response, options = {})
           return unless WebMock::CallbackRegistry.any_callbacks?
-          WebMock::CallbackRegistry.invoke_callbacks(options.merge(:lib => :excon), request, response)
+          WebMock::CallbackRegistry.invoke_callbacks(options.merge(lib: :excon), request, response)
         end
-
       end
+    end
+  end
 
-      class ExconConnection < ::Excon::Connection
-
-        def request_kernel(params, &block)
-          mock_request  = ExconAdapter.build_request params.dup
-          WebMock::RequestRegistry.instance.requested_signatures.put(mock_request)
-
-          if mock_response = WebMock::StubRegistry.instance.response_for_request(mock_request)
-            ExconAdapter.perform_callbacks(mock_request, mock_response, :real_request => false)
-            ExconAdapter.real_response(mock_response)
-          elsif WebMock.net_connect_allowed?(mock_request.uri)
-            real_response = super
-            ExconAdapter.perform_callbacks(mock_request, ExconAdapter.mock_response(real_response), :real_request => true)
-            real_response
-          else
-            raise WebMock::NetConnectNotAllowedError.new(mock_request)
-          end
-        end
-
+  Excon::Connection.class_eval do
+    def self.new(args = {})
+      args.delete(:__construction_args)
+      super(args).tap do |instance|
+        instance.data[:__construction_args] = args
       end
     end
   end
 
+  # Suppresses Excon connection argument validation warning
+  Excon::VALID_CONNECTION_KEYS << :__construction_args
 end

data/lib/webmock/http_lib_adapters/http_rb/client.rb

@@ -0,0 +1,17 @@
+module HTTP
+  class Client
+    alias_method :__perform__, :perform
+
+    def perform(request, options)
+      return __perform__(request, options) unless webmock_enabled?
+
+      response = WebMockPerform.new(request) { __perform__(request, options) }.exec
+      options.features.each { |_name, feature| response = feature.wrap_response(response) }
+      response
+    end
+
+    def webmock_enabled?
+      ::WebMock::HttpLibAdapters::HttpRbAdapter.enabled?
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/http_rb/request.rb

@@ -0,0 +1,16 @@
+module HTTP
+  class Request
+    def webmock_signature
+      request_body = if defined?(HTTP::Request::Body)
+                       ''.tap { |string| body.each { |part| string << part } }
+                     else
+                       body
+                     end
+
+      ::WebMock::RequestSignature.new(verb, uri.to_s, {
+        headers: headers.to_h,
+        body: request_body
+      })
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/http_rb/response.rb

@@ -0,0 +1,64 @@
+module HTTP
+  class Response
+    def to_webmock
+      webmock_response = ::WebMock::Response.new
+
+      webmock_response.status  = [status.to_i, reason]
+      webmock_response.body    = body.to_s
+      webmock_response.headers = headers.to_h
+
+      webmock_response
+    end
+
+    class << self
+      def from_webmock(request, webmock_response, request_signature = nil)
+        status  = Status.new(webmock_response.status.first)
+        headers = webmock_response.headers || {}
+        uri     = normalize_uri(request_signature && request_signature.uri)
+
+        # HTTP.rb 3.0+ uses a keyword argument to pass the encoding, but 1.x
+        # and 2.x use a positional argument, and 0.x don't support supplying
+        # the encoding.
+        body = if HTTP::VERSION < "1.0.0"
+          Body.new(Streamer.new(webmock_response.body))
+        elsif HTTP::VERSION < "3.0.0"
+          Body.new(Streamer.new(webmock_response.body), webmock_response.body.encoding)
+        else
+          Body.new(Streamer.new(webmock_response.body), encoding: webmock_response.body.encoding)
+        end
+
+        return new(status, "1.1", headers, body, uri) if HTTP::VERSION < "1.0.0"
+
+        # 5.0.0 had a breaking change to require request instead of uri.
+        if HTTP::VERSION < '5.0.0'
+          return new({
+            status: status,
+            version: "1.1",
+            headers: headers,
+            body: body,
+            uri: uri
+          })
+        end
+
+        new({
+          status: status,
+          version: "1.1",
+          headers: headers,
+          body: body,
+          request: request,
+        })
+      end
+
+      private
+
+      def normalize_uri(uri)
+        return unless uri
+
+        uri = Addressable::URI.parse uri
+        uri.port = nil if uri.default_port && uri.port == uri.default_port
+
+        uri
+      end
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/http_rb/streamer.rb

@@ -0,0 +1,29 @@
+module HTTP
+  class Response
+    class Streamer
+      def initialize(str)
+        @io = StringIO.new str
+      end
+
+      def readpartial(size = nil, outbuf = nil)
+        unless size
+          if defined?(HTTP::Client::BUFFER_SIZE)
+            size = HTTP::Client::BUFFER_SIZE
+          elsif defined?(HTTP::Connection::BUFFER_SIZE)
+            size = HTTP::Connection::BUFFER_SIZE
+          end
+        end
+
+        @io.read size, outbuf
+      end
+
+      def close
+        @io.close
+      end
+
+      def sequence_id
+        -1
+      end
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/http_rb/webmock.rb

@@ -0,0 +1,68 @@
+module HTTP
+  class WebMockPerform
+    def initialize(request, &perform)
+      @request = request
+      @perform = perform
+      @request_signature = nil
+    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_timeout_error if webmock_response.should_timeout
+      webmock_response.raise_error_if_any
+
+      invoke_callbacks(webmock_response, real_request: false)
+      ::HTTP::Response.from_webmock @request, webmock_response, request_signature
+    end
+
+    def raise_timeout_error
+      raise Errno::ETIMEDOUT if HTTP::VERSION < "1.0.0"
+      raise HTTP::TimeoutError, "connection error: #{Errno::ETIMEDOUT.new}"
+    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_rb }),
+        request_signature,
+        webmock_response
+      )
+    end
+  end
+end

data/lib/webmock/http_lib_adapters/http_rb_adapter.rb

@@ -0,0 +1,37 @@
+begin
+  require "http"
+rescue LoadError
+  # HTTP gem not found
+end
+
+if defined?(HTTP) && defined?(HTTP::VERSION)
+  WebMock::VersionChecker.new("HTTP Gem", HTTP::VERSION, "0.6.0").check_version!
+
+  module WebMock
+    module HttpLibAdapters
+      class HttpRbAdapter < HttpLibAdapter
+        adapter_for :http_rb
+
+        class << self
+          def enable!
+            @enabled = true
+          end
+
+          def disable!
+            @enabled = false
+          end
+
+          def enabled?
+            @enabled
+          end
+        end
+      end
+    end
+  end
+
+  require "webmock/http_lib_adapters/http_rb/client"
+  require "webmock/http_lib_adapters/http_rb/request"
+  require "webmock/http_lib_adapters/http_rb/response"
+  require "webmock/http_lib_adapters/http_rb/streamer"
+  require "webmock/http_lib_adapters/http_rb/webmock"
+end