lib/vcr/middleware/faraday.rb

Summary

Maintainability
A
0 mins
Test Coverage
require 'faraday'
require 'vcr/util/version_checker'
require 'vcr/request_handler'

VCR::VersionChecker.new('Faraday', Faraday::VERSION, '0.7.0').check_version!

module VCR
  # Contains middlewares for use with different libraries.
  module Middleware
    # Faraday middleware that VCR uses to record and replay HTTP requests made through
    # Faraday.
    #
    # @note You can either insert this middleware into the Faraday middleware stack
    #  yourself or configure {VCR::Configuration#hook_into} to hook into `:faraday`.
    class Faraday
      include VCR::Deprecations::Middleware::Faraday

      # Constructs a new instance of the Faraday middleware.
      #
      # @param [#call] app the faraday app
      def initialize(app)
        super
        @app = app
      end

      # Handles the HTTP request being made through Faraday
      #
      # @param [Hash] env the Faraday request env hash
      def call(env)
        return @app.call(env) if VCR.library_hooks.disabled?(:faraday)
        RequestHandler.new(@app, env).handle
      end

      # Close any persistent connections.
      def close
        @app.close if @app.respond_to?(:close)
      end

      # @private
      class RequestHandler < ::VCR::RequestHandler
        attr_reader :app, :env
        def initialize(app, env)
          @app, @env = app, env
          @has_on_complete_hook = false
        end

        def handle
          # Faraday must be exlusive here in case another library hook is being used.
          # We don't want double recording/double playback.
          VCR.library_hooks.exclusive_hook = :faraday
          super
        ensure
          response = defined?(@vcr_response) ? @vcr_response : nil
          invoke_after_request_hook(response) unless delay_finishing?
        end

      private

        def delay_finishing?
          !!env[:parallel_manager] && @has_on_complete_hook
        end

        def vcr_request
          @vcr_request ||= VCR::Request.new \
            env[:method],
            env[:url].to_s,
            raw_body_from(env[:body]),
            env[:request_headers]
        end

        def raw_body_from(body)
          return body unless body.respond_to?(:read)

          body.read.tap do |b|
            body.rewind if body.respond_to?(:rewind)
          end
        end

        def response_for(response)
          # reason_phrase is a new addition to Faraday::Response,
          # so maintain backward compatibility
          reason = response.respond_to?(:reason_phrase) ? response.reason_phrase : nil

          VCR::Response.new(
            VCR::ResponseStatus.new(response.status, reason),
            response.headers,
            raw_body_from(response.body),
            nil
          )
        end

        def on_ignored_request
          response = app.call(env)
          @vcr_response = response_for(response)
          response
        end

        def on_stubbed_by_vcr_request
          headers = env[:response_headers] ||= ::Faraday::Utils::Headers.new
          headers.update stubbed_response.headers if stubbed_response.headers
          env.update :status => stubbed_response.status.code, :body => stubbed_response.body

          @vcr_response = stubbed_response

          faraday_response = ::Faraday::Response.new
          faraday_response.finish(env)
          env[:response] = faraday_response
        end

        def on_recordable_request
          @has_on_complete_hook = true
          response = app.call(env)
          response.on_complete do
            @vcr_response = response_for(response)
            VCR.record_http_interaction(VCR::HTTPInteraction.new(vcr_request, @vcr_response))
            invoke_after_request_hook(@vcr_response) if delay_finishing?
          end
        end

        def invoke_after_request_hook(response)
          super
          VCR.library_hooks.exclusive_hook = nil
        end
      end
    end
  end
end