vcr 3.0.3 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1b4d30cbef974c49ed29dee25cb2d8024049148a
-  data.tar.gz: 32d2c73128d06279593abf6ba8c5168028eeec2a
+SHA256:
+  metadata.gz: 902881c25780fa44253365c8f5fd0bb260510d7f754287d74a70275abc2dabce
+  data.tar.gz: fe52ddaa831a711b7415c350205a2662e833de2c4a6d58b8b6539170645bd218
 SHA512:
-  metadata.gz: 07428a8f9ad5ffa5a0fa63617c9ca8f285fbe5ddf8a6d6bdee9eeebf972cce481b17c1036abee539dd7d255ee4e877d2dc4152f7f6aae6d9849281c16d3e13bc
-  data.tar.gz: 95438bbea501e8ee6003f65a8bc1cbf9d3b991d44dbac7db038b7a4317f05956450ff0b438e19fc194c53609807dcc6a88cb176d4fb5cdb7a1a20a59a98b189b
+  metadata.gz: f79ffb02f15e691a1266c3421043a5ee95f3bd35715687137f139b291c490ee87a93351e0526faa0f29c73deba80ba41740f87d0fc9d50793a6b6d4101c7b116
+  data.tar.gz: 3e9276ffc9e2a2ae07f4a11054dcb484a324dc18e28a4badaa06df7454db36cfdbfbf38b95aec40c01a15a40cde56fb6cd9868780e50994fc2f554caf86e209a

data/lib/vcr/cassette/erb_renderer.rb

@@ -32,7 +32,7 @@ module VCR
       end
 
       def erb_variables
-        @erb if @erb.is_a?(Hash)
+        @erb if @erb.is_a?(Hash) && !@erb.empty?
       end
 
       def template
@@ -40,7 +40,9 @@ module VCR
       end
 
       @@struct_cache = Hash.new do |hash, attributes|
-        hash[attributes] = Struct.new(*attributes)
+        attributes = attributes.map(&:to_sym)
+        hash[attributes] = Struct.new(*attributes) unless hash.key?(attributes)
+        hash[attributes]
       end
 
       def variables_object

data/lib/vcr/cassette/http_interaction_list.rb

@@ -22,21 +22,26 @@ module VCR
         @parent_list            = parent_list
         @used_interactions      = []
         @log_prefix             = log_prefix
+        @mutex                  = Mutex.new
 
         interaction_summaries = interactions.map { |i| "#{request_summary(i.request)} => #{response_summary(i.response)}" }
         log "Initialized HTTPInteractionList with request matchers #{request_matchers.inspect} and #{interactions.size} interaction(s): { #{interaction_summaries.join(', ')} }", 1
       end
 
       def response_for(request)
-        if index = matching_interaction_index_for(request)
-          interaction = @interactions.delete_at(index)
-          @used_interactions.unshift interaction
-          log "Found matching interaction for #{request_summary(request)} at index #{index}: #{response_summary(interaction.response)}", 1
-          interaction.response
-        elsif interaction = matching_used_interaction_for(request)
-          interaction.response
-        else
-          @parent_list.response_for(request)
+        # Without this mutex, under threaded access, the wrong response may be removed
+        # out of the (remaining) interactions list (and other problems).
+        @mutex.synchronize do
+          if index = matching_interaction_index_for(request)
+            interaction = @interactions.delete_at(index)
+            @used_interactions.unshift interaction
+            log "Found matching interaction for #{request_summary(request)} at index #{index}: #{response_summary(interaction.response)}", 1
+            interaction.response
+          elsif interaction = matching_used_interaction_for(request)
+            interaction.response
+          else
+            @parent_list.response_for(request)
+          end
         end
       end
 

data/lib/vcr/cassette/migrator.rb

@@ -45,17 +45,16 @@ module VCR
           "recorded_with"     => "VCR #{VCR.version}"
         }
 
-        def hash.each
-          yield 'http_interactions', self['http_interactions']
-          yield 'recorded_with', self['recorded_with']
-        end
-
         File.open(cassette, 'w') { |f| f.write ::YAML.dump(hash) }
         @out.puts "  - Migrated #{relative_casssette_name(cassette)}"
       end
 
       def load_yaml(cassette)
-        ::YAML.load_file(cassette)
+        if ::YAML.respond_to?(:unsafe_load_file)
+          ::YAML.unsafe_load_file(cassette)
+        else
+          ::YAML.load_file(cassette)
+        end
       rescue *@yaml_load_errors
         return nil
       end

data/lib/vcr/cassette/persisters/file_system.rb

@@ -55,7 +55,15 @@ module VCR
             file_extension = '.' + parts.pop
           end
 
-          parts.join('.').gsub(/[^\w\-\/]+/, '_') + file_extension.to_s
+          file_name = parts.join('.').gsub(/[^[:word:]\-\/]+/, '_') + file_extension.to_s
+          file_name.downcase! if downcase_cassette_names?
+          file_name
+        end
+
+        def downcase_cassette_names?
+          !!VCR.configuration
+            .default_cassette_options
+            .dig(:persister_options, :downcase_cassette_names)
         end
       end
     end

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

@@ -17,9 +17,9 @@ module VCR
 
         # The file extension to use for this serializer.
         #
-        # @return [String] "gz"
+        # @return [String] "zz"
         def file_extension
-          'gz'
+          'zz'
         end
 
         # Serializes the given hash using YAML and Zlib.

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

@@ -1,9 +1,9 @@
-require 'multi_json'
+require 'json'
 
 module VCR
   class Cassette
     class Serializers
-      # The JSON serializer. Uses `MultiJson` under the covers.
+      # The JSON serializer.
       #
       # @see Psych
       # @see Syck
@@ -11,10 +11,14 @@ module VCR
       module JSON
         extend self
         extend EncodingErrorHandling
+        extend SyntaxErrorHandling
 
         # @private
-        ENCODING_ERRORS = [MultiJson::DecodeError, ArgumentError]
-        ENCODING_ERRORS << EncodingError if defined?(EncodingError)
+        ENCODING_ERRORS = [ArgumentError]
+        ENCODING_ERRORS << ::JSON::GeneratorError
+
+        # @private
+        SYNTAX_ERRORS = [::JSON::ParserError]
 
         # The file extension to use for this serializer.
         #
@@ -23,23 +27,25 @@ module VCR
           "json"
         end
 
-        # Serializes the given hash using `MultiJson`.
+        # Serializes the given hash using `JSON`.
         #
         # @param [Hash] hash the object to serialize
         # @return [String] the JSON string
         def serialize(hash)
           handle_encoding_errors do
-            MultiJson.encode(hash)
+            ::JSON.pretty_generate(hash)
           end
         end
 
-        # Deserializes the given string using `MultiJson`.
+        # Deserializes the given string using `JSON`.
         #
         # @param [String] string the JSON string
         # @return [Hash] the deserialized object
         def deserialize(string)
           handle_encoding_errors do
-            MultiJson.decode(string)
+            handle_syntax_errors do
+              ::JSON.parse(string)
+            end
           end
         end
       end

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

@@ -11,10 +11,14 @@ module VCR
       module Psych
         extend self
         extend EncodingErrorHandling
+        extend SyntaxErrorHandling
 
         # @private
         ENCODING_ERRORS = [ArgumentError]
 
+        # @private
+        SYNTAX_ERRORS = [::Psych::SyntaxError]
+
         # The file extension to use for this serializer.
         #
         # @return [String] "yml"
@@ -28,7 +32,9 @@ module VCR
         # @return [String] the YAML string
         def serialize(hash)
           handle_encoding_errors do
-            ::Psych.dump(hash)
+            result = ::Psych.dump(hash)
+            result.gsub!(": \n", ": null\n") # set canonical null value in order to avoid trailing whitespaces
+            result
           end
         end
 
@@ -38,7 +44,9 @@ module VCR
         # @return [Hash] the deserialized object
         def deserialize(string)
           handle_encoding_errors do
-            ::Psych.load(string)
+            handle_syntax_errors do
+              ::Psych.load(string)
+            end
           end
         end
       end

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

@@ -11,10 +11,14 @@ module VCR
       module Syck
         extend self
         extend EncodingErrorHandling
+        extend SyntaxErrorHandling
 
         # @private
         ENCODING_ERRORS = [ArgumentError]
 
+        # @private
+        SYNTAX_ERRORS = [::Psych::SyntaxError]
+
         # The file extension to use for this serializer.
         #
         # @return [String] "yml"
@@ -38,7 +42,9 @@ module VCR
         # @return [Hash] the deserialized object
         def deserialize(string)
           handle_encoding_errors do
-            using_syck { ::YAML.load(string) }
+            handle_syntax_errors do
+              using_syck { ::YAML.load(string) }
+            end
           end
         end
 

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

@@ -13,10 +13,14 @@ module VCR
       module YAML
         extend self
         extend EncodingErrorHandling
+        extend SyntaxErrorHandling
 
         # @private
         ENCODING_ERRORS = [ArgumentError]
 
+        # @private
+        SYNTAX_ERRORS = [::Psych::SyntaxError]
+
         # The file extension to use for this serializer.
         #
         # @return [String] "yml"
@@ -30,7 +34,9 @@ module VCR
         # @return [String] the YAML string
         def serialize(hash)
           handle_encoding_errors do
-            ::YAML.dump(hash)
+            result = ::YAML.dump(hash)
+            result.gsub!(": \n", ": null\n") # set canonical null value in order to avoid trailing whitespaces
+            result
           end
         end
 
@@ -40,7 +46,13 @@ module VCR
         # @return [Hash] the deserialized object
         def deserialize(string)
           handle_encoding_errors do
-            ::YAML.load(string)
+            handle_syntax_errors do
+              if ::YAML.respond_to?(:unsafe_load)
+                ::YAML.unsafe_load(string)
+              else
+                ::YAML.load(string)
+              end
+            end
           end
         end
       end

data/lib/vcr/cassette/serializers.rb

@@ -54,6 +54,16 @@ module VCR
         raise
       end
     end
+
+    # @private
+    module SyntaxErrorHandling
+      def handle_syntax_errors
+        yield
+      rescue *self::SYNTAX_ERRORS => e
+        e.message << "\nNote: This is a VCR cassette. If it is using ERB, you may have forgotten to pass the `:erb` option to `use_cassette`."
+        raise
+      end
+    end
   end
 end
 

data/lib/vcr/cassette.rb

@@ -24,6 +24,13 @@ module VCR
     #  plays them back, or does both.
     attr_reader :record_mode
 
+    # @return [Boolean] The cassette's record_on_error mode. When the code that uses the cassette
+    #  raises an error (for example a test failure) and record_on_error is set to false, no
+    #  cassette will be recorded. This is useful when you are TDD'ing an API integration: when
+    #  an error is raised that often means your request is invalid, so you don't want the cassette
+    #  to be recorded.
+    attr_reader :record_on_error
+
     # @return [Array<Symbol, #call>] List of request matchers. Used to find a response from an
     #  existing HTTP interaction to play back.
     attr_reader :match_requests_on
@@ -36,6 +43,12 @@ module VCR
     # @return [Integer, nil] How frequently (in seconds) the cassette should be re-recorded.
     attr_reader :re_record_interval
 
+    # @return [Boolean, nil] Should outdated interactions be recorded back to file
+    attr_reader :clean_outdated_http_interactions
+
+    # @return [Boolean] Should unused requests be dropped from the cassette?
+    attr_reader :drop_unused_requests
+
     # @return [Array<Symbol>] If set, {VCR::Configuration#before_record} and
     #  {VCR::Configuration#before_playback} hooks with a corresponding tag will apply.
     attr_reader :tags
@@ -45,6 +58,7 @@ module VCR
     def initialize(name, options = {})
       @name    = name
       @options = VCR.configuration.default_cassette_options.merge(options)
+      @mutex   = Mutex.new
 
       assert_valid_options!
       extract_options
@@ -62,21 +76,40 @@ module VCR
     # @param (see VCR#eject_casssette)
     # @see VCR#eject_cassette
     def eject(options = {})
-      write_recorded_interactions_to_disk
+      write_recorded_interactions_to_disk if should_write_recorded_interactions_to_disk?
 
       if should_assert_no_unused_interactions? && !options[:skip_no_unused_interactions_assertion]
         http_interactions.assert_no_unused_interactions!
       end
     end
 
+    # @private
+    def run_failed!
+      @run_failed = true
+    end
+
+    # @private
+    def run_failed?
+      @run_failed = false unless defined?(@run_failed)
+      @run_failed
+    end
+
+    def should_write_recorded_interactions_to_disk?
+      !run_failed? || record_on_error
+    end
+
     # @private
     def http_interactions
-      @http_interactions ||= HTTPInteractionList.new \
-        should_stub_requests? ? previously_recorded_interactions : [],
-        match_requests_on,
-        @allow_playback_repeats,
-        @parent_list,
-        log_prefix
+      # Without this mutex, under threaded access, an HTTPInteractionList will overwrite
+      # the first.
+      @mutex.synchronize do
+        @http_interactions ||= HTTPInteractionList.new \
+          should_stub_requests? ? previously_recorded_interactions : [],
+          match_requests_on,
+          @allow_playback_repeats,
+          @parent_list,
+          log_prefix
+      end
     end
 
     # @private
@@ -143,10 +176,11 @@ module VCR
 
     def assert_valid_options!
       invalid_options = @options.keys - [
-        :record, :erb, :match_requests_on, :re_record_interval, :tag, :tags,
+        :record, :record_on_error, :erb, :match_requests_on, :re_record_interval, :tag, :tags,
         :update_content_length_header, :allow_playback_repeats, :allow_unused_http_interactions,
         :exclusive, :serialize_with, :preserve_exact_body_bytes, :decode_compressed_response,
-        :persist_with
+        :recompress_response, :persist_with, :persister_options, :clean_outdated_http_interactions,
+        :drop_unused_requests
       ]
 
       if invalid_options.size > 0
@@ -155,24 +189,23 @@ module VCR
     end
 
     def extract_options
-      [:erb, :match_requests_on, :re_record_interval,
-       :allow_playback_repeats, :allow_unused_http_interactions, :exclusive].each do |name|
+      [:record_on_error, :erb, :match_requests_on, :re_record_interval, :clean_outdated_http_interactions,
+       :allow_playback_repeats, :allow_unused_http_interactions, :exclusive, :drop_unused_requests].each do |name|
         instance_variable_set("@#{name}", @options[name])
       end
 
       assign_tags
 
-      @record_mode = @options[:record]
       @serializer  = VCR.cassette_serializers[@options[:serialize_with]]
       @persister   = VCR.cassette_persisters[@options[:persist_with]]
-      @record_mode = :all if should_re_record?
+      @record_mode = should_re_record?(@options[:record]) ? :all : @options[:record]
       @parent_list = @exclusive ? HTTPInteractionList::NullList : VCR.http_interactions
     end
 
     def assign_tags
       @tags = Array(@options.fetch(:tags) { @options[:tag] })
 
-      [:update_content_length_header, :preserve_exact_body_bytes, :decode_compressed_response].each do |tag|
+      [:update_content_length_header, :preserve_exact_body_bytes, :decode_compressed_response, :recompress_response].each do |tag|
         @tags << tag if @options[tag]
       end
     end
@@ -201,9 +234,10 @@ module VCR
       end
     end
 
-    def should_re_record?
+    def should_re_record?(record_mode)
       return false unless @re_record_interval
       return false unless originally_recorded_at
+      return false if record_mode == :none
 
       now = Time.now
 
@@ -229,6 +263,10 @@ module VCR
       record_mode == :all
     end
 
+    def should_remove_unused_interactions?
+      @drop_unused_requests
+    end
+
     def should_assert_no_unused_interactions?
       !(@allow_unused_http_interactions || $!)
     end
@@ -247,7 +285,16 @@ module VCR
         end
       end
 
-      old_interactions + new_recorded_interactions
+        if should_remove_unused_interactions?
+          new_recorded_interactions
+        else
+          up_to_date_interactions(old_interactions) + new_recorded_interactions
+        end
+    end
+
+    def up_to_date_interactions(interactions)
+      return interactions unless clean_outdated_http_interactions && re_record_interval
+      interactions.take_while { |x| x[:recorded_at] > Time.now - re_record_interval }
     end
 
     def interactions_to_record

data/lib/vcr/configuration.rb

@@ -54,16 +54,14 @@ module VCR
     #
     # @example
     #   VCR.configure do |c|
-    #     c.hook_into :fakeweb, :typhoeus
+    #     c.hook_into :webmock, :typhoeus
     #   end
     #
     # @param hooks [Array<Symbol>] List of libraries. Valid values are
-    #  `:fakeweb`, `:webmock`, `:typhoeus`, `:excon` and `:faraday`.
+    #  `:webmock`, `:typhoeus`, `:excon` and `:faraday`.
     # @raise [ArgumentError] when given an unsupported library name.
     # @raise [VCR::Errors::LibraryVersionTooLowError] when the version
     #  of a library you are using is too low for VCR to support.
-    # @note `:fakeweb` and `:webmock` cannot both be used since they both monkey patch
-    #  `Net::HTTP`. Otherwise, you can use any combination of these.
     def hook_into(*hooks)
       hooks.each { |a| load_library_hook(a) }
       invoke_hook(:after_library_hooks_loaded)
@@ -79,6 +77,15 @@ module VCR
     end
     alias ignore_host ignore_hosts
 
+    # Specifies host(s) that VCR should stop ignoring.
+    #
+    # @param hosts [Array<String>] List of hosts to unignore
+    # @see #ignore_hosts
+    def unignore_hosts(*hosts)
+      VCR.request_ignorer.unignore_hosts(*hosts)
+    end
+    alias unignore_host unignore_hosts
+
     # Sets whether or not VCR should ignore localhost requests.
     #
     # @param value [Boolean] the value to set
@@ -224,7 +231,7 @@ module VCR
 
       before_playback(tag) do |interaction|
         orig_text = call_block(block, interaction)
-        log "before_playback: replacing #{placeholder.inspect} with #{orig_text.inspect}"
+        log "before_playback: replacing #{orig_text.inspect} with #{placeholder.inspect}"
         interaction.filter!(placeholder, orig_text)
       end
     end
@@ -485,10 +492,13 @@ module VCR
       @rspec_metadata_configured = false
       @default_cassette_options = {
         :record            => :once,
+        :record_on_error   => true,
         :match_requests_on => RequestMatcherRegistry::DEFAULT_MATCHERS,
         :allow_unused_http_interactions => true,
+        :drop_unused_requests => false,
         :serialize_with    => :yaml,
-        :persist_with      => :file_system
+        :persist_with      => :file_system,
+        :persister_options => {}
       }
 
       self.uri_parser = URI
@@ -502,7 +512,7 @@ module VCR
       file = "vcr/library_hooks/#{hook}"
       require file
     rescue LoadError => e
-      raise e unless e.message.include?(file) # in case FakeWeb/WebMock/etc itself is not available
+      raise e unless e.message.include?(file) # in case WebMock itself is not available
       raise ArgumentError.new("#{hook.inspect} is not a supported VCR HTTP library hook.")
     end
 
@@ -552,6 +562,10 @@ module VCR
     end
 
     def register_built_in_hooks
+      before_playback(:recompress_response) do |interaction|
+        interaction.response.recompress if interaction.response.vcr_decompressed?
+      end
+
       before_playback(:update_content_length_header) do |interaction|
         interaction.response.update_content_length_header
       end
@@ -573,4 +587,3 @@ module VCR
     define_hook :after_library_hooks_loaded
   end
 end
-

data/lib/vcr/deprecations.rb

@@ -43,67 +43,5 @@ module VCR
       end
     end
   end
-
-  module RSpec
-    # Contains macro methods to assist with VCR usage. These methods are
-    # intended to be used directly in an RSpec example group. To make these
-    # available in your RSpec example groups, extend the module in an individual
-    # example group, or configure RSpec to extend the module in all example groups.
-    #
-    # @example
-    #   RSpec.configure do |c|
-    #     c.extend VCR::RSpec::Macros
-    #   end
-    #
-    module Macros
-      def self.extended(base)
-        Kernel.warn "WARNING: VCR::RSpec::Macros is deprecated. Use RSpec metadata options instead `:vcr => vcr_options`"
-      end
-
-      # Sets up a `before` and `after` hook that will insert and eject a
-      # cassette, respectively.
-      #
-      # @example
-      #   describe "Some API Client" do
-      #     use_vcr_cassette "some_api", :record => :new_episodes
-      #   end
-      #
-      # @param [(optional) String] name the cassette name; it will be inferred by the example
-      #  group descriptions if not given.
-      # @param [(optional) Hash] options the cassette options
-      # @deprecated Use RSpec metadata options
-      def use_vcr_cassette(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        name    = args.first || infer_cassette_name
-
-        before(:each) do
-          VCR.insert_cassette(name, options)
-        end
-
-        after(:each) do
-          VCR.eject_cassette
-        end
-      end
-
-      private
-
-      def infer_cassette_name
-        # RSpec 1 exposes #description_parts; use that if its available
-        return description_parts.join("/") if respond_to?(:description_parts)
-
-        # Otherwise use RSpec 2/3 metadata...
-        group_descriptions = []
-        klass = self
-
-        while klass.respond_to?(:metadata) && klass.metadata
-          group_descriptions << klass.metadata[:description] ||
-                                klass.metadata[:example_group][:description]
-          klass = klass.superclass
-        end
-
-        group_descriptions.compact.reverse.join('/')
-      end
-    end
-  end
 end
 

data/lib/vcr/errors.rb

@@ -88,18 +88,7 @@ module VCR
       end
 
       def current_cassettes
-        @cassettes ||= begin
-          cassettes = VCR.cassettes.to_a.reverse
-
-          begin
-            loop do
-              break unless VCR.eject_cassette
-            end
-          rescue EjectLinkedCassetteError
-          end
-
-          cassettes
-        end
+        @cassettes ||= VCR.cassettes.to_a.reverse
       end
 
       def request_description
@@ -107,6 +96,10 @@ module VCR
 
         lines << "  #{request.method.to_s.upcase} #{request.uri}"
 
+        if match_request_on_headers?
+          lines << "  Headers:\n#{formatted_headers}"
+        end
+
         if match_request_on_body?
           lines << "  Body: #{request.body}"
         end
@@ -114,6 +107,10 @@ module VCR
         lines.join("\n")
       end
 
+      def match_request_on_headers?
+        current_matchers.include?(:headers)
+      end
+
       def match_request_on_body?
         current_matchers.include?(:body)
       end
@@ -128,6 +125,14 @@ module VCR
         end
       end
 
+      def formatted_headers
+        request.headers.flat_map do |header, values|
+          values.map do |val|
+            "    #{header}: #{val.inspect}"
+          end
+        end.join("\n")
+      end
+
       def cassettes_description
         if current_cassettes.size > 0
           [cassettes_list << "\n",