vcr 3.0.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3bd06000e811a9f066f1d73a5d955bbb4ad3733e
-  data.tar.gz: 2784446a0155cfef8d7389208213b5b86aad1b8e
+SHA256:
+  metadata.gz: 79ff7c5f67afb190b63450e117a7dbda6709340fbab8c17680c36b2bb5a8a6f6
+  data.tar.gz: a6a17620c6c63d9a596a39e2700f3f1becddb26bfa63f862e42ef0dfabb783d9
 SHA512:
-  metadata.gz: cb7de4b059e58371b9669c4bf72c3c5f806594e5f9cbd614ed5e41bbbd40d30f38a2bf5e2e079da0b139989aaca57080134d736f8680ff0344191f47a2ceba45
-  data.tar.gz: 1cf77c3a9198f1995721acbabd3470f2735d7e682280f218bdc46385342923beb6956080522e37761132f60ea1d4b67e4a5cfac5bd33d6471df22105a60cb766
+  metadata.gz: 9f43f626bae24850a8b5f912203dba5ee7e38ef39ecb3d325382ca2cbfb24ff789c3e630edd628588fdd59b0a8b10919bedd820675a039b5d619f1c779dc186b
+  data.tar.gz: ffc8534bbab227c6f8f4636306644c1c28d1ac8c2d29d47551d1b84c04cd5c37979acfb44803b18c54ee558e961d92826a38e6a75b93d8002af6adde5f2e7d05

data/lib/vcr.rb

@@ -34,7 +34,6 @@ module VCR
 
   module RSpec
     autoload :Metadata,              'vcr/test_frameworks/rspec'
-    autoload :Macros,                'vcr/deprecations'
   end
 
   module Middleware
@@ -108,6 +107,12 @@ module VCR
   # @option options :persist_with [Symbol] Which cassette persister to
   #  use. Defaults to :file_system. You can also register and use a
   #  custom persister.
+  # @option options :persister_options [Hash] Pass options to the
+  #  persister specified in `persist_with`. Currently available options for the file_system persister:
+  #    - `:downcase_cassette_names`: when `true`, names of cassettes will be
+  #      normalized in lowercase before reading and writing, which can avoid
+  #      confusion when using both case-sensitive and case-insensitive file
+  #      systems.
   # @option options :preserve_exact_body_bytes [Boolean] Whether or not
   #  to base64 encode the bytes of the requests and responses for this cassette
   #  when serializing it. See also `VCR::Configuration#preserve_exact_body_bytes`.
@@ -187,11 +192,35 @@ module VCR
 
     begin
       call_block(block, cassette)
+    rescue StandardError
+      cassette.run_failed!
+      raise
     ensure
       eject_cassette
     end
   end
 
+  # Inserts multiple cassettes the given names
+  #
+  # @example
+  #   cassettes = [
+  #    { name: 'github' },
+  #    { name: 'apple', options: { erb: true } }
+  #   ]
+  #   VCR.use_cassettes(cassettes) do
+  #     # make multiple HTTP requests
+  #   end
+  def use_cassettes(cassettes, &block)
+    cassette = cassettes.pop
+    use_cassette(cassette[:name], cassette[:options] || {}) do
+      if cassettes.empty?
+        block.call
+      else
+        use_cassettes(cassettes, &block)
+      end
+    end
+  end
+
   # Used to configure VCR.
   #
   # @example
@@ -288,6 +317,9 @@ module VCR
   # @see #turn_off!
   # @see #turned_off
   def turned_on?
+    linked_context = current_context[:linked_context]
+    return !linked_context[:turned_off] if linked_context
+
     !context_value(:turned_off)
   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,9 @@ 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 [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 +55,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 +73,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 +173,10 @@ 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
       ]
 
       if invalid_options.size > 0
@@ -155,7 +185,7 @@ module VCR
     end
 
     def extract_options
-      [:erb, :match_requests_on, :re_record_interval,
+      [:record_on_error, :erb, :match_requests_on, :re_record_interval, :clean_outdated_http_interactions,
        :allow_playback_repeats, :allow_unused_http_interactions, :exclusive].each do |name|
         instance_variable_set("@#{name}", @options[name])
       end
@@ -172,7 +202,7 @@ module VCR
     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
@@ -247,7 +277,12 @@ module VCR
         end
       end
 
-      old_interactions + new_recorded_interactions
+      up_to_date_interactions(old_interactions) + new_recorded_interactions
+    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/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,11 +45,6 @@ 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

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,4 +1,4 @@
-require 'multi_json'
+require 'json'
 
 module VCR
   class Cassette
@@ -13,8 +13,8 @@ module VCR
         extend EncodingErrorHandling
 
         # @private
-        ENCODING_ERRORS = [MultiJson::DecodeError, ArgumentError]
-        ENCODING_ERRORS << EncodingError if defined?(EncodingError)
+        ENCODING_ERRORS = [ArgumentError]
+        ENCODING_ERRORS << ::JSON::GeneratorError
 
         # The file extension to use for this serializer.
         #
@@ -23,23 +23,23 @@ 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.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)
+            ::JSON.parse(string)
           end
         end
       end

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

@@ -28,7 +28,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
 

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

@@ -30,7 +30,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
 

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,12 @@ 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,
         :serialize_with    => :yaml,
-        :persist_with      => :file_system
+        :persist_with      => :file_system,
+        :persister_options => {}
       }
 
       self.uri_parser = URI
@@ -502,7 +511,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 +561,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 +586,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