mustwin-vcr 2.9.3

data/lib/vcr/library_hooks/fakeweb.rb

@@ -0,0 +1,196 @@
+require 'vcr/util/version_checker'
+require 'fakeweb'
+require 'net/http'
+require 'vcr/extensions/net_http_response'
+require 'vcr/request_handler'
+require 'set'
+
+VCR::VersionChecker.new('FakeWeb', FakeWeb::VERSION, '1.3.0').check_version!
+
+module VCR
+  class LibraryHooks
+    # @private
+    module FakeWeb
+      # @private
+      class RequestHandler < ::VCR::RequestHandler
+        attr_reader :net_http, :request, :request_body, :response_block
+        def initialize(net_http, request, request_body = nil, &response_block)
+          @net_http, @request, @request_body, @response_block =
+           net_http,  request,  request_body,  response_block
+          @stubbed_response, @vcr_response, @recursing = nil, nil, false
+        end
+
+        def handle
+          super
+        ensure
+          invoke_after_request_hook(@vcr_response) unless @recursing
+        end
+
+      private
+
+        def externally_stubbed?
+          ::FakeWeb.registered_uri?(request_method, uri)
+        end
+
+        def on_externally_stubbed_request
+          # just perform the request--FakeWeb will handle it
+          perform_request(:started)
+        end
+
+        def on_recordable_request
+          perform_request(net_http.started?, :record_interaction)
+        end
+
+        def on_stubbed_by_vcr_request
+          with_exclusive_fakeweb_stub(stubbed_response) do
+            # force it to be considered started since it doesn't
+            # recurse in this case like the others.
+            perform_request(:started)
+          end
+        end
+
+        def on_ignored_request
+          perform_request(net_http.started?)
+        end
+
+        def perform_request(started, record_interaction = false)
+          # Net::HTTP calls #request recursively in certain circumstances.
+          # We only want to record the request when the request is started, as
+          # that is the final time through #request.
+          unless started
+            @recursing = true
+            request.instance_variable_set(:@__vcr_request_handler, recursive_request_handler)
+            return net_http.request_without_vcr(request, request_body, &response_block)
+          end
+
+          net_http.request_without_vcr(request, request_body) do |response|
+            @vcr_response = vcr_response_from(response)
+
+            if record_interaction
+              VCR.record_http_interaction VCR::HTTPInteraction.new(vcr_request, @vcr_response)
+            end
+
+            response.extend VCR::Net::HTTPResponse # "unwind" the response
+            response_block.call(response) if response_block
+          end
+        end
+
+        def uri
+          @uri ||= ::FakeWeb::Utility.request_uri_as_string(net_http, request)
+        end
+
+        def response_hash(response)
+          (response.headers || {}).merge(
+            :body   => response.body,
+            :status => [response.status.code.to_s, response.status.message]
+          )
+        end
+
+        def with_exclusive_fakeweb_stub(response)
+          original_map = ::FakeWeb::Registry.instance.uri_map.dup
+          ::FakeWeb.clean_registry
+          ::FakeWeb.register_uri(:any, /.*/, response_hash(response))
+
+          begin
+            return yield
+          ensure
+            ::FakeWeb::Registry.instance.uri_map = original_map
+          end
+        end
+
+        def request_method
+          request.method.downcase.to_sym
+        end
+
+        def vcr_request
+          @vcr_request ||= VCR::Request.new \
+            request_method,
+            uri,
+            (request_body || request.body),
+            request.to_hash
+        end
+
+        def vcr_response_from(response)
+          VCR::Response.new \
+            VCR::ResponseStatus.new(response.code.to_i, response.message),
+            response.to_hash,
+            response.body,
+            response.http_version
+        end
+
+        def recursive_request_handler
+          @recursive_request_handler ||= RecursiveRequestHandler.new(
+            @after_hook_typed_request.type, @stubbed_response, @vcr_request,
+            @net_http, @request, @request_body, &@response_block
+          )
+        end
+      end
+
+      class RecursiveRequestHandler < RequestHandler
+        attr_reader :stubbed_response
+
+        def initialize(request_type, stubbed_response, vcr_request, *args, &response_block)
+          @request_type, @stubbed_response, @vcr_request =
+           request_type,  stubbed_response,  vcr_request
+          super(*args)
+        end
+
+        def handle
+          set_typed_request_for_after_hook(@request_type)
+          send "on_#{@request_type}_request"
+        ensure
+          invoke_after_request_hook(@vcr_response)
+        end
+
+        def request_type(*args)
+          @request_type
+        end
+      end
+    end
+  end
+end
+
+# @private
+module Net
+  # @private
+  class HTTP
+    unless method_defined?(:request_with_vcr)
+      def request_with_vcr(request, *args, &block)
+        if VCR.turned_on?
+          handler = request.instance_eval do
+            remove_instance_variable(:@__vcr_request_handler) if defined?(@__vcr_request_handler)
+          end || VCR::LibraryHooks::FakeWeb::RequestHandler.new(self, request, *args, &block)
+
+          handler.handle
+        else
+          request_without_vcr(request, *args, &block)
+        end
+      end
+
+      alias request_without_vcr request
+      alias request request_with_vcr
+    end
+  end
+end
+
+# @private
+module FakeWeb
+  class << self
+    # ensure HTTP requests are always allowed; VCR takes care of disallowing
+    # them at the appropriate times in its hook
+    def allow_net_connect_with_vcr?(*args)
+      VCR.turned_on? ? true : allow_net_connect_without_vcr?(*args)
+    end
+
+    alias allow_net_connect_without_vcr? allow_net_connect?
+    alias allow_net_connect? allow_net_connect_with_vcr?
+  end unless respond_to?(:allow_net_connect_with_vcr?)
+end
+
+VCR.configuration.after_library_hooks_loaded do
+  if defined?(WebMock)
+    raise ArgumentError.new("You have configured VCR to hook into both :fakeweb and :webmock. You cannot use both.")
+  end
+  ::Kernel.warn "WARNING: VCR's FakeWeb integration is deprecated and will be removed in VCR 3.0."
+end
+

data/lib/vcr/library_hooks/faraday.rb

@@ -0,0 +1,51 @@
+require 'vcr/middleware/faraday'
+
+module VCR
+  class LibraryHooks
+    # @private
+    module Faraday
+      # @private
+      module BuilderClassExtension
+        def new(*args)
+          super.extend BuilderInstanceExtension
+        end
+
+        if defined?(::Faraday::RackBuilder)
+          ::Faraday::RackBuilder.extend self
+        else
+          ::Faraday::Builder.extend self
+        end
+      end
+
+      # @private
+      module BuilderInstanceExtension
+        def lock!(*args)
+          insert_vcr_middleware
+          super
+        end
+
+      private
+
+        def insert_vcr_middleware
+          return if handlers.any? { |h| h.klass == VCR::Middleware::Faraday }
+          adapter_index = handlers.index { |h| h.klass < ::Faraday::Adapter }
+          adapter_index ||= handlers.size
+          warn_about_after_adapter_middleware(adapter_index)
+          insert_before(adapter_index, VCR::Middleware::Faraday)
+        end
+
+        def warn_about_after_adapter_middleware(adapter_index)
+          after_adapter_middleware_count = (handlers.size - adapter_index - 1)
+          return if after_adapter_middleware_count < 1
+
+          after_adapter_middlewares = handlers.last(after_adapter_middleware_count)
+          warn "WARNING: The Faraday connection stack contains middleware after " +
+               "the HTTP adapter (#{after_adapter_middlewares.map(&:inspect).join(', ')}). " +
+               "This is a non-standard configuration and VCR may not be able to " +
+               "record the HTTP requests made through this Faraday connection."
+        end
+      end
+    end
+  end
+end
+

data/lib/vcr/library_hooks/typhoeus.rb

@@ -0,0 +1,120 @@
+require 'vcr/util/version_checker'
+require 'vcr/request_handler'
+require 'typhoeus'
+
+if Float(Typhoeus::VERSION[/^\d+\.\d+/]) < 0.5
+  require 'vcr/library_hooks/typhoeus_0.4'
+else
+  VCR::VersionChecker.new('Typhoeus', Typhoeus::VERSION, '0.5.0').check_version!
+
+  module VCR
+    class LibraryHooks
+      # @private
+      module Typhoeus
+        # @private
+        class RequestHandler < ::VCR::RequestHandler
+          attr_reader :request
+          def initialize(request)
+            @request = request
+            request.block_connection = false if VCR.turned_on?
+          end
+
+          def vcr_request
+            @vcr_request ||= VCR::Request.new \
+              request.options.fetch(:method, :get),
+              request.url,
+              request_body,
+              request.options.fetch(:headers, {})
+          end
+
+        private
+
+          def externally_stubbed?
+            ::Typhoeus::Expectation.find_by(request)
+          end
+
+          def set_typed_request_for_after_hook(*args)
+            super
+            request.instance_variable_set(:@__typed_vcr_request, @after_hook_typed_request)
+          end
+
+          def on_unhandled_request
+            invoke_after_request_hook(nil)
+            super
+          end
+
+          def on_stubbed_by_vcr_request
+            ::Typhoeus::Response.new \
+              :http_version   => stubbed_response.http_version,
+              :code           => stubbed_response.status.code,
+              :status_message => stubbed_response.status.message,
+              :headers        => stubbed_response_headers,
+              :body           => stubbed_response.body,
+              :effective_url  => stubbed_response.adapter_metadata.fetch('effective_url', request.url),
+              :mock           => true
+          end
+
+          def stubbed_response_headers
+            @stubbed_response_headers ||= {}.tap do |hash|
+              stubbed_response.headers.each do |key, values|
+                hash[key] = values.size == 1 ? values.first : values
+              end if stubbed_response.headers
+            end
+          end
+
+          if ::Typhoeus::Request.method_defined?(:encoded_body)
+            def request_body
+              request.encoded_body
+            end
+          else
+            def request_body
+              request.options.fetch(:body, "")
+            end
+          end
+        end
+
+        # @private
+        def self.vcr_response_from(response)
+          VCR::Response.new \
+            VCR::ResponseStatus.new(response.code, response.status_message),
+            response.headers,
+            response.body,
+            response.http_version,
+            { "effective_url" => response.effective_url }
+        end
+
+        ::Typhoeus.on_complete do |response|
+          request = response.request
+          unless VCR.library_hooks.disabled?(:typhoeus)
+            vcr_response = vcr_response_from(response)
+            typed_vcr_request = request.send(:remove_instance_variable, :@__typed_vcr_request)
+
+            unless request.response.mock
+              http_interaction = VCR::HTTPInteraction.new(typed_vcr_request, vcr_response)
+              VCR.record_http_interaction(http_interaction)
+            end
+
+            VCR.configuration.invoke_hook(:after_http_request, typed_vcr_request, vcr_response)
+          end
+        end
+
+        ::Typhoeus.before do |request|
+          if response = VCR::LibraryHooks::Typhoeus::RequestHandler.new(request).handle
+            request.finish(response)
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end
+
+VCR.configuration.after_library_hooks_loaded do
+  # ensure WebMock's Typhoeus adapter does not conflict with us here
+  # (i.e. to double record requests or whatever).
+  if defined?(WebMock::HttpLibAdapters::TyphoeusAdapter)
+    WebMock::HttpLibAdapters::TyphoeusAdapter.disable!
+  end
+end
+

data/lib/vcr/library_hooks/typhoeus_0.4.rb

@@ -0,0 +1,103 @@
+VCR::VersionChecker.new('Typhoeus', Typhoeus::VERSION, '0.3.2').check_version!
+
+module VCR
+  class LibraryHooks
+    # @private
+    module Typhoeus
+      # @private
+      class RequestHandler < ::VCR::RequestHandler
+        attr_reader :request
+        def initialize(request)
+          @request = request
+        end
+
+        def vcr_request
+          @vcr_request ||= VCR::Request.new \
+            request.method,
+            request.url,
+            request.body,
+            request.headers
+        end
+
+      private
+
+        def externally_stubbed?
+          ::Typhoeus::Hydra.stubs.detect { |stub| stub.matches?(request) }
+        end
+
+        def set_typed_request_for_after_hook(*args)
+          super
+          request.instance_variable_set(:@__typed_vcr_request, @after_hook_typed_request)
+        end
+
+        def on_unhandled_request
+          invoke_after_request_hook(nil)
+          super
+        end
+
+        def on_stubbed_by_vcr_request
+          ::Typhoeus::Response.new \
+            :http_version   => stubbed_response.http_version,
+            :code           => stubbed_response.status.code,
+            :status_message => stubbed_response.status.message,
+            :headers_hash   => stubbed_response_headers,
+            :body           => stubbed_response.body
+        end
+
+        def stubbed_response_headers
+          @stubbed_response_headers ||= {}.tap do |hash|
+            stubbed_response.headers.each do |key, values|
+              hash[key] = values.size == 1 ? values.first : values
+            end if stubbed_response.headers
+          end
+        end
+      end
+
+      # @private
+      def self.vcr_response_from(response)
+        VCR::Response.new \
+          VCR::ResponseStatus.new(response.code, response.status_message),
+          response.headers_hash,
+          response.body,
+          response.http_version
+      end
+
+      ::Typhoeus::Hydra.after_request_before_on_complete do |request|
+        unless VCR.library_hooks.disabled?(:typhoeus)
+          vcr_response = vcr_response_from(request.response)
+          typed_vcr_request = request.send(:remove_instance_variable, :@__typed_vcr_request)
+
+          unless request.response.mock?
+            http_interaction = VCR::HTTPInteraction.new(typed_vcr_request, vcr_response)
+            VCR.record_http_interaction(http_interaction)
+          end
+
+          VCR.configuration.invoke_hook(:after_http_request, typed_vcr_request, vcr_response)
+        end
+      end
+
+      ::Typhoeus::Hydra.register_stub_finder do |request|
+        VCR::LibraryHooks::Typhoeus::RequestHandler.new(request).handle
+      end
+    end
+  end
+end
+
+# @private
+module Typhoeus
+  class << Hydra
+    # ensure HTTP requests are always allowed; VCR takes care of disallowing
+    # them at the appropriate times in its hook
+    def allow_net_connect_with_vcr?(*args)
+      VCR.turned_on? ? true : allow_net_connect_without_vcr?
+    end
+
+    alias allow_net_connect_without_vcr? allow_net_connect?
+    alias allow_net_connect? allow_net_connect_with_vcr?
+  end unless Hydra.respond_to?(:allow_net_connect_with_vcr?)
+end
+
+VCR.configuration.after_library_hooks_loaded do
+  ::Kernel.warn "WARNING: VCR's Typhoeus 0.4 integration is deprecated and will be removed in VCR 3.0."
+end
+