vcr 2.5.0 → 2.6.0

data/lib/vcr/cassette/http_interaction_list.rb

@@ -2,7 +2,7 @@ module VCR
   class Cassette
     # @private
     class HTTPInteractionList
-      include Logger
+      include Logger::Mixin
 
       # @private
       module NullList
@@ -59,9 +59,10 @@ module VCR
       # @raise [VCR::Errors::UnusedHTTPInteractionError] if not all interactions were played back.
       def assert_no_unused_interactions!
         return unless has_unused_interactions?
+        logger = Logger.new(nil)
 
         descriptions = @interactions.map do |i|
-          "  - #{request_summary(i.request)} => #{response_summary(i.response)}"
+          "  - #{logger.request_summary(i.request, @request_matchers)} => #{logger.response_summary(i.response)}"
         end.join("\n")
 
         raise Errors::UnusedHTTPInteractionError, "There are unused HTTP interactions left in the cassette:\n#{descriptions}"

data/lib/vcr/cassette/migrator.rb

@@ -30,6 +30,7 @@ module VCR
         end
 
         http_interactions.map! do |interaction|
+          interaction.response.adapter_metadata = {}
           interaction.recorded_at = File.mtime(cassette)
           remove_unnecessary_standard_port(interaction)
           denormalize_http_header_keys(interaction.request)

data/lib/vcr/cassette/serializers/json.rb

@@ -13,7 +13,7 @@ module VCR
         extend EncodingErrorHandling
 
         # @private
-        ENCODING_ERRORS = [MultiJson::DecodeError]
+        ENCODING_ERRORS = [MultiJson::DecodeError, ArgumentError]
         ENCODING_ERRORS << EncodingError if defined?(EncodingError)
 
         # The file extension to use for this serializer.

data/lib/vcr/configuration.rb

@@ -7,7 +7,7 @@ module VCR
   class Configuration
     include Hooks
     include VariableArgsBlockCaller
-    include Logger
+    include Logger::Mixin
 
     # Gets the directory to read cassettes from and write cassettes to.
     #
@@ -430,7 +430,21 @@ module VCR
     #   VCR.configure do |c|
     #     c.debug_logger = File.open('vcr.log', 'w')
     #   end
-    attr_accessor :debug_logger
+    attr_reader :debug_logger
+    # @private (documented above)
+    def debug_logger=(value)
+      @debug_logger = value
+
+      if value
+        @logger = Logger.new(value)
+      else
+        @logger = Logger::Null
+      end
+    end
+
+    # @private
+    # Logger object that provides logging APIs and helper methods.
+    attr_reader :logger
 
     # Sets a callback that determines whether or not to base64 encode
     # the bytes of a request or response body during serialization in
@@ -479,7 +493,7 @@ module VCR
 
       self.uri_parser = URI
       self.query_parser = CGI.method(:parse)
-      self.debug_logger = NullDebugLogger
+      self.debug_logger = nil
 
       register_built_in_hooks
     end
@@ -537,11 +551,5 @@ module VCR
     # @private
     define_hook :after_library_hooks_loaded
   end
-
-  # @private
-  module NullDebugLogger
-    extend self
-    def puts(*); end
-  end
 end
 

data/lib/vcr/library_hooks/typhoeus.rb

@@ -50,7 +50,7 @@ else
               :status_message => stubbed_response.status.message,
               :headers        => stubbed_response_headers,
               :body           => stubbed_response.body,
-              :effective_url  => request.url,
+              :effective_url  => stubbed_response.adapter_metadata.fetch('effective_url', request.url),
               :mock           => true
           end
 
@@ -69,7 +69,8 @@ else
             VCR::ResponseStatus.new(response.code, response.status_message),
             response.headers,
             response.body,
-            response.http_version
+            response.http_version,
+            { "effective_url" => response.effective_url }
         end
 
         ::Typhoeus.on_complete do |response|

data/lib/vcr/library_hooks/webmock.rb

@@ -2,7 +2,7 @@ require 'vcr/util/version_checker'
 require 'vcr/request_handler'
 require 'webmock'
 
-VCR::VersionChecker.new('WebMock', WebMock.version, '1.8.0', '1.11').check_version!
+VCR::VersionChecker.new('WebMock', WebMock.version, '1.8.0', '1.13').check_version!
 
 module VCR
   class LibraryHooks

data/lib/vcr/middleware/excon.rb

@@ -2,7 +2,7 @@ require 'excon'
 require 'vcr/request_handler'
 require 'vcr/util/version_checker'
 
-VCR::VersionChecker.new('Excon', Excon::VERSION, '0.22.0', '0.22').check_version!
+VCR::VersionChecker.new('Excon', Excon::VERSION, '0.22.0', '0.26').check_version!
 
 module VCR
   # Contains middlewares for use with different libraries.
@@ -39,6 +39,7 @@ module VCR
 
       # @private
       def error_call(params)
+        @request_handler.ensure_response_body_can_be_read_for_error_case
         @request_handler.after_request(params)
         super
       end
@@ -84,10 +85,21 @@ module VCR
           invoke_after_request_hook(vcr_response)
         end
 
+        def ensure_response_body_can_be_read_for_error_case
+          # Excon does not invoke the `:response_block` when an error
+          # has occurred, so we need to be sure to use the non-streaming
+          # body reader.
+          @response_body_reader = NonStreamingResponseBodyReader
+        end
+
         attr_reader :request_params, :response_params, :response_body_reader
 
       private
 
+        def externally_stubbed?
+          !!::Excon.stub_for(request_params)
+        end
+
         def should_record?
           @should_record
         end

data/lib/vcr/middleware/faraday.rb

@@ -27,6 +27,7 @@ module VCR
       #
       # @param [Hash] env the Faraday request env hash
       def call(env)
+        return if VCR.library_hooks.disabled?(:faraday)
         RequestHandler.new(@app, env).handle
       end
 

data/lib/vcr/request_handler.rb

@@ -1,7 +1,7 @@
 module VCR
   # @private
   class RequestHandler
-    include Logger
+    include Logger::Mixin
 
     def handle
       log "Handling request: #{request_summary} (disabled: #{disabled?})"

data/lib/vcr/structs.rb

@@ -76,6 +76,11 @@ module VCR
     private
 
       def serializable_body
+        # Ensure it's just a string, and not a string with some
+        # extra state, as such strings serialize to YAML with
+        # all the extra state.
+        body = String.new(self.body.to_s)
+
         if VCR.configuration.preserve_exact_body_bytes_for?(self)
           base_body_hash(body).merge('base64_string' => Base64.encode64(body))
         else
@@ -166,7 +171,7 @@ module VCR
   module OrderedHashSerializer
     def each
       @ordered_keys.each do |key|
-        yield key, self[key]
+        yield key, self[key] if has_key?(key)
       end
     end
 
@@ -341,10 +346,16 @@ module VCR
   # @attr [Hash{String => Array<String>}] headers the response headers
   # @attr [String] body the response body
   # @attr [nil, String] http_version the HTTP version
-  class Response < Struct.new(:status, :headers, :body, :http_version)
+  # @attr [Hash] adapter_metadata Additional metadata used by a specific VCR adapter.
+  class Response < Struct.new(:status, :headers, :body, :http_version, :adapter_metadata)
     include Normalizers::Header
     include Normalizers::Body
 
+    def initialize(*args)
+      super(*args)
+      self.adapter_metadata ||= {}
+    end
+
     # Builds a serializable hash from the response data.
     #
     # @return [Hash] hash that represents this response
@@ -356,7 +367,10 @@ module VCR
         'headers'      => headers,
         'body'         => serializable_body,
         'http_version' => http_version
-      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+      }.tap do |hash|
+        hash['adapter_metadata'] = adapter_metadata unless adapter_metadata.empty?
+        OrderedHashSerializer.apply_to(hash, members)
+      end
     end
 
     # Constructs a new instance from a hash.
@@ -367,7 +381,8 @@ module VCR
       new ResponseStatus.from_hash(hash.fetch('status', {})),
           hash['headers'],
           body_from(hash['body']),
-          hash['http_version']
+          hash['http_version'],
+          hash['adapter_metadata']
     end
 
     # Updates the Content-Length response header so that it is

data/lib/vcr/test_frameworks/cucumber.rb

@@ -52,8 +52,8 @@ module VCR
           VCR.insert_cassette(cassette_name, options)
         end
 
-        @main_object.After(tag_name) do
-          VCR.eject_cassette
+        @main_object.After(tag_name) do |scenario|
+          VCR.eject_cassette(:skip_no_unused_interactions_assertion => scenario.failed?)
         end
 
         self.class.add_tag(tag_name)

data/lib/vcr/test_frameworks/rspec.rb

@@ -17,14 +17,22 @@ module VCR
             end
           end
 
-          config.around(:each, :vcr => lambda { |v| !!v }) do |example|
+          when_tagged_with_vcr = { :vcr => lambda { |v| !!v } }
+
+          config.before(:each, when_tagged_with_vcr) do |ex|
+            example = respond_to?(:example) ? self.example : ex
+
             options = example.metadata[:vcr]
             options = options.is_a?(Hash) ? options.dup : {} # in case it's just :vcr => true
 
             cassette_name = options.delete(:cassette_name) ||
                             vcr_cassette_name_for[example.metadata]
+            VCR.insert_cassette(cassette_name, options)
+          end
 
-            VCR.use_cassette(cassette_name, options, &example)
+          config.after(:each, when_tagged_with_vcr) do |ex|
+            example = respond_to?(:example) ? self.example : ex
+            VCR.eject_cassette(:skip_no_unused_interactions_assertion => !!example.exception)
           end
         end
       end

data/lib/vcr/util/logger.rb

@@ -1,14 +1,15 @@
 module VCR
   # @private
-  module Logger
-    def log(message, indentation_level = 0)
-      indentation = '  ' * indentation_level
-      log_message = indentation + log_prefix + message
-      VCR.configuration.debug_logger.puts log_message
+  # Provides log message formatting helper methods.
+  class Logger
+    def initialize(stream)
+      @stream = stream
     end
 
-    def log_prefix
-      ''
+    def log(message, log_prefix, indentation_level = 0)
+      indentation = '  ' * indentation_level
+      log_message = indentation + log_prefix + message
+      @stream.puts log_message
     end
 
     def request_summary(request, request_matchers)
@@ -21,5 +22,38 @@ module VCR
     def response_summary(response)
       "[#{response.status.code} #{response.body[0, 80].inspect}]"
     end
+
+    # @private
+    # A null-object version of the Logger. Used when
+    # a `debug_logger` has not been set.
+    #
+    # @note We used to use a null object for the `debug_logger` itself,
+    #       but some users noticed a negative perf impact from having the
+    #       logger formatting logic still executing in that case, so we
+    #       moved the null object interface up a layer to here.
+    module Null
+      module_function
+
+      def log(*); end
+      def request_summary(*); end
+      def response_summary(*); end
+    end
+
+    # @private
+    # Provides common logger helper methods that simply delegate to
+    # the underlying logger object.
+    module Mixin
+      def log(message, indentation_level = 0)
+        VCR.configuration.logger.log(message, log_prefix, indentation_level)
+      end
+
+      def request_summary(*args)
+        VCR.configuration.logger.request_summary(*args)
+      end
+
+      def response_summary(*args)
+        VCR.configuration.logger.response_summary(*args)
+      end
+    end
   end
 end

data/lib/vcr/version.rb

@@ -10,7 +10,7 @@ module VCR
   #   * `parts` [Array<Integer>] List of the version parts.
   def version
     @version ||= begin
-      string = '2.5.0'
+      string = '2.6.0'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/script/ci.sh

@@ -1,6 +1,13 @@
 # Kill the whole script on error
 set -e -x
 
+# idea taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
+export JRUBY_OPTS='-X-C' # disable JIT since these processes are so short lived
+
+# force jRuby to use client mode JVM or a compilation mode thats as close as possible,
+# idea taken from https://github.com/jruby/jruby/wiki/Improving-startup-time
+export JAVA_OPTS='-client -XX:+TieredCompilation -XX:TieredStopAtLevel=1'
+
 echo "-------- Running Typhoeus 0.4 Specs ---------"
 bundle install --gemfile=gemfiles/typhoeus_old.gemfile --without extras
 BUNDLE_GEMFILE=gemfiles/typhoeus_old.gemfile bundle exec rspec spec/vcr/library_hooks/typhoeus_0.4_spec.rb --format progress --backtrace
@@ -10,7 +17,7 @@ git submodule init
 git submodule update
 
 echo "-------- Running Specs ---------"
-bundle exec ruby -w -I./spec -r./spec/capture_warnings -rspec_helper -S rspec spec --format progress --backtrace
+bundle exec ruby -I./spec -r./spec/capture_warnings -rspec_helper -S rspec spec --format progress --backtrace
 
 echo "-------- Running Cukes ---------"
 bundle exec cucumber

data/spec/acceptance/threading_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 describe VCR do
   context 'when used in a multithreaded environment', :with_monkey_patches => :excon do
+    def preload_yaml_serializer_to_avoid_circular_require_warning_race_condition
+      VCR.cassette_serializers[:yaml]
+    end
+
+    before { preload_yaml_serializer_to_avoid_circular_require_warning_race_condition }
+
     def recorded_content_for(name)
       VCR.cassette_persisters[:file_system]["#{name}.yml"].to_s
     end

data/spec/capture_warnings.rb

@@ -1,17 +1,25 @@
 require 'rubygems' if RUBY_VERSION =~ /^1\.8/
+require 'bundler/setup'
 require 'rspec/core'
 require 'rspec/expectations'
 require 'tempfile'
+
 stderr_file = Tempfile.new("vcr.stderr")
-$stderr.reopen(stderr_file.path)
 current_dir = Dir.pwd
 
 RSpec.configure do |config|
+  config.before(:suite) do
+    $stderr.reopen(stderr_file.path)
+    $VERBOSE = true
+  end
+
   config.after(:suite) do
     stderr_file.rewind
     lines = stderr_file.read.split("\n").uniq
     stderr_file.close!
 
+    $stderr.reopen(STDERR)
+
     vcr_warnings, other_warnings = lines.partition { |line| line.include?(current_dir) }
 
     # After upgrading to curb 0.8.1, I started to get a circular require

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 using_git = File.exist?(File.expand_path('../../.git/', __FILE__))
 require 'bundler/setup' if using_git
 
-if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE == 'ruby'
+if RUBY_VERSION.to_f >= 1.9 && RUBY_ENGINE == 'ruby'
   require 'simplecov'
 
   SimpleCov.start do
@@ -41,7 +41,7 @@ require 'monkey_patches'
 require "support/http_library_adapters"
 
 module VCR
-  SPEC_ROOT = File.dirname(__FILE__)
+  SPEC_ROOT = File.dirname(File.expand_path('.', __FILE__))
 
   def reset!(hook = :fakeweb)
     instance_variables.each do |ivar|
@@ -60,6 +60,10 @@ RSpec.configure do |config|
     expectations.syntax = :expect
   end
 
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+
   tmp_dir = File.expand_path('../../tmp/cassette_library_dir', __FILE__)
   config.before(:each) do
     unless example.metadata[:skip_vcr_reset]

data/spec/support/configuration_stubbing.rb

@@ -0,0 +1,8 @@
+shared_context "configuration stubbing" do
+  let(:config) { double("VCR::Configuration") }
+
+  before do
+    allow(VCR).to receive(:configuration) { config }
+  end
+end
+