vcr 5.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0121a881f4d4b1ac0f68b5078f5674f137e07a4a0580b70a438f920c5953db
-  data.tar.gz: 551623fd6fd0317c2510e1a02c36f6a8c3cac4bba72752ffd31907de0e1bfef9
+  metadata.gz: 0230f475b5c666e17c97d0b81695860d18a54c40d07dccfb82ab63098fc60084
+  data.tar.gz: b79ad4ff6425ef66da8810b75f9cdc787d656c97cb5d60acf31c9ba09a4b6a5d
 SHA512:
-  metadata.gz: d6ad287e1f993836c3adac326228312596935313d65313fb60b07b16a962b0b5b9cff3f74db5200ce21e2c5ba5b6e32da0fd445d73fe7024c35308fecfcdc688
-  data.tar.gz: bcf77106091efc49ae8ee789f076b162eb28491349a2e04ef0a1220ae5b1cfb3501de2e3106d8aa14459c7577207775650232ebf11235fe110c28dfa16614149
+  metadata.gz: 22d462bea8b4048575d82db89ecc36327be825267d76f69fa366ca98894b691210b6e859f4ab7d7acaf5fef537749b010ea166dcb09af642677bf402d6aaf855
+  data.tar.gz: 9f2a224345cabd78d03c0ac5f687b6261c7e1e34fe64c24dca7c4c46057de6122ec74d58c11ff3e3aefb8cc848efda899441c65c3d7dd0bdad86fbcccda9163d

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/migrator.rb

@@ -50,7 +50,11 @@ module VCR
       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(/[^[:word:]\-\/]+/, '_') + 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/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
@@ -66,13 +73,28 @@ 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
       # Without this mutex, under threaded access, an HTTPInteractionList will overwrite
@@ -151,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,
-        :recompress_response, :persist_with, :clean_outdated_http_interactions
+        :recompress_response, :persist_with, :persister_options, :clean_outdated_http_interactions
       ]
 
       if invalid_options.size > 0
@@ -163,17 +185,16 @@ module VCR
     end
 
     def extract_options
-      [:erb, :match_requests_on, :re_record_interval, :clean_outdated_http_interactions,
+      [: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
 
       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
 
@@ -209,9 +230,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
 

data/lib/vcr/configuration.rb

@@ -492,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

data/lib/vcr/library_hooks/typhoeus.rb

@@ -2,137 +2,121 @@ 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
+module VCR
+  class LibraryHooks
+    # @private
+    module Typhoeus
       # @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
+      class RequestHandler < ::VCR::RequestHandler
+        attr_reader :request
+        def initialize(request)
+          @request = request
+          request.block_connection = false if VCR.turned_on?
+        end
 
-          def externally_stubbed?
-            ::Typhoeus::Expectation.find_by(request)
-          end
+        def vcr_request
+          @vcr_request ||= VCR::Request.new \
+            request.options.fetch(:method, :get),
+            request.url,
+            request.encoded_body,
+            request.options.fetch(:headers, {})
+        end
 
-          def set_typed_request_for_after_hook(*args)
-            super
-            request.instance_variable_set(:@__typed_vcr_request, @after_hook_typed_request)
-          end
+      private
 
-          def on_unhandled_request
-            invoke_after_request_hook(nil)
-            super
-          end
+        def externally_stubbed?
+          ::Typhoeus::Expectation.find_by(request)
+        end
 
-          def on_stubbed_by_vcr_request
-            response = ::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
-
-            first_header_line = "HTTP/#{stubbed_response.http_version} #{response.code} #{response.status_message}\r\n"
-            response.instance_variable_set(:@first_header_line, first_header_line)
-            response.instance_variable_get(:@options)[:response_headers] =
-              first_header_line + response.headers.map { |k,v| "#{k}: #{v}"}.join("\r\n")
-
-            response
-          end
+        def set_typed_request_for_after_hook(*args)
+          super
+          request.instance_variable_set(:@__typed_vcr_request, @after_hook_typed_request)
+        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
+        def on_unhandled_request
+          invoke_after_request_hook(nil)
+          super
+        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
+        def on_stubbed_by_vcr_request
+          response = ::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
+
+          first_header_line = "HTTP/#{stubbed_response.http_version} #{response.code} #{response.status_message}\r\n"
+          response.instance_variable_set(:@first_header_line, first_header_line)
+          response.instance_variable_get(:@options)[:response_headers] =
+            first_header_line + response.headers.map { |k,v| "#{k}: #{v}"}.join("\r\n")
+
+          response
         end
 
-        # @private
-        class << self
-          def 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 }
+        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
 
-          def collect_chunks(request)
-            chunks = ''
-            request.on_body.unshift(
-              Proc.new do |body, response|
-                chunks += body
-                request.instance_variable_set(:@chunked_body, chunks)
-              end
-            )
-          end
+      # @private
+      class << self
+        def 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
 
-          def restore_body_from_chunks(response, request)
-            response.options[:response_body] = request.instance_variable_get(:@chunked_body)
-          end
+        def collect_chunks(request)
+          chunks = ''
+          request.on_body.unshift(
+            Proc.new do |body, response|
+              chunks += body
+              request.instance_variable_set(:@chunked_body, chunks)
+            end
+          )
         end
 
-        ::Typhoeus.on_complete do |response|
-          request = response.request
+        def restore_body_from_chunks(response, request)
+          response.options[:response_body] = request.instance_variable_get(:@chunked_body)
+        end
+      end
 
-          restore_body_from_chunks(response, request) if request.streaming?
+      ::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)
+        restore_body_from_chunks(response, request) if request.streaming?
 
-            unless request.response.mock
-              http_interaction = VCR::HTTPInteraction.new(typed_vcr_request, vcr_response)
-              VCR.record_http_interaction(http_interaction)
-            end
+        unless VCR.library_hooks.disabled?(:typhoeus)
+          vcr_response = vcr_response_from(response)
+          typed_vcr_request = request.send(:remove_instance_variable, :@__typed_vcr_request)
 
-            VCR.configuration.invoke_hook(:after_http_request, typed_vcr_request, vcr_response)
+          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|
-          collect_chunks(request) if request.streaming?
-          if response = VCR::LibraryHooks::Typhoeus::RequestHandler.new(request).handle
-            request.on_headers.each { |cb| cb.call(response) }
-            request.on_body.each { |cb| cb.call(response.body, response) }
-            request.finish(response)
-          else
-            true
-          end
+      ::Typhoeus.before do |request|
+        collect_chunks(request) if request.streaming?
+        if response = VCR::LibraryHooks::Typhoeus::RequestHandler.new(request).handle
+          request.on_headers.each { |cb| cb.call(response) }
+          request.on_body.each { |cb| cb.call(response.body, response) }
+          request.finish(response)
+        else
+          true
         end
       end
     end
@@ -146,4 +130,3 @@ VCR.configuration.after_library_hooks_loaded do
     WebMock::HttpLibAdapters::TyphoeusAdapter.disable!
   end
 end
-

data/lib/vcr/library_hooks/webmock.rb

@@ -12,8 +12,6 @@ module VCR
     module WebMock
       extend self
 
-      @global_hook_disabled_requests = {}
-
       def with_global_hook_disabled(request)
         global_hook_disabled_requests << request
 
@@ -25,19 +23,12 @@ module VCR
       end
 
       def global_hook_disabled?(request)
-        requests = @global_hook_disabled_requests[Thread.current.object_id]
+        requests = Thread.current[:_vcr_webmock_disabled_requests]
         requests && requests.include?(request)
       end
 
       def global_hook_disabled_requests
-        requests = @global_hook_disabled_requests[Thread.current.object_id]
-        return requests if requests
-
-        ObjectSpace.define_finalizer(Thread.current, lambda {
-          @global_hook_disabled_requests.delete(Thread.current.object_id)
-        })
-
-        @global_hook_disabled_requests[Thread.current.object_id] = []
+        Thread.current[:_vcr_webmock_disabled_requests] ||= []
       end
 
       # @private

data/lib/vcr/linked_cassette.rb

@@ -9,8 +9,8 @@ module VCR
       include Enumerable
 
       # Creates a new list of context-owned cassettes and linked cassettes
-      # @param [Array] context-owned cassettes
-      # @param [Array] context-unowned (linked) cassettes
+      # @param cassettes [Array] context-owned cassettes
+      # @param linked_cassettes [Array] context-unowned (linked) cassettes
       def initialize(cassettes, linked_cassettes)
         @cassettes = cassettes
         @linked_cassettes = linked_cassettes
@@ -52,8 +52,8 @@ module VCR
     end
 
     # Create a new CassetteList
-    # @param [Array] context-owned cassettes
-    # @param [Array] context-unowned (linked) cassettes
+    # @param cassettes [Array] context-owned cassettes
+    # @param linked_cassettes [Array] context-unowned (linked) cassettes
     def self.list(cassettes, linked_cassettes)
       CassetteList.new(cassettes, linked_cassettes)
     end

data/lib/vcr/middleware/excon.rb

@@ -74,7 +74,7 @@ module VCR
         def after_request(response)
           vcr_response = vcr_response_for(response)
 
-          if should_record?
+          if vcr_response && should_record?
             VCR.record_http_interaction(VCR::HTTPInteraction.new(vcr_request, vcr_response))
           end
 

data/lib/vcr/middleware/faraday.rb

@@ -31,6 +31,11 @@ module VCR
         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

data/lib/vcr/request_ignorer.rb

@@ -25,6 +25,10 @@ module VCR
       end
     end
 
+    def localhost_ignored?
+      (LOCALHOST_ALIASES & ignore_hosts.to_a).any?
+    end
+
     def ignore_hosts(*hosts)
       ignored_hosts.merge(hosts)
     end

data/lib/vcr/request_matcher_registry.rb

@@ -110,12 +110,12 @@ module VCR
 
     def register_built_ins
       register(:method)  { |r1, r2| r1.method == r2.method }
-      register(:uri)     { |r1, r2| r1.uri == r2.uri }
+      register(:uri)     { |r1, r2| r1.parsed_uri == r2.parsed_uri }
       register(:body)    { |r1, r2| r1.body == r2.body }
       register(:headers) { |r1, r2| r1.headers == r2.headers }
 
       register(:host) do |r1, r2|
-        r1.parsed_uri.host == r2.parsed_uri.host
+        r1.parsed_uri.host.chomp('.') == r2.parsed_uri.host.chomp('.')
       end
       register(:path) do |r1, r2|
         r1.parsed_uri.path == r2.parsed_uri.path

data/lib/vcr/structs.rb

@@ -62,7 +62,7 @@ module VCR
         super
 
         if body && !body.is_a?(String)
-          raise ArgumentError, "#{self.class} initialized with an invalid body: #{body.inspect}."
+          raise ArgumentError, "#{self.class} initialized with an invalid (non-String) body of class #{body.class}: #{body.inspect}."
         end
 
         # Ensure that the body is a raw string, in case the string instance
@@ -346,9 +346,9 @@ module VCR
       {
         'status'       => status.to_hash,
         'headers'      => headers,
-        'body'         => serializable_body,
-        'http_version' => http_version
+        'body'         => serializable_body
       }.tap do |hash|
+        hash['http_version']     = http_version if http_version
         hash['adapter_metadata'] = adapter_metadata unless adapter_metadata.empty?
       end
     end
@@ -454,9 +454,10 @@ module VCR
 
       case type
       when 'gzip'
-        args = [StringIO.new(body)]
-        args << { :encoding => 'ASCII-8BIT' } if ''.respond_to?(:encoding)
-        yield Zlib::GzipReader.new(*args).read
+        gzip_reader_options = {}
+        gzip_reader_options[:encoding] = 'ASCII-8BIT' if ''.respond_to?(:encoding)
+        yield Zlib::GzipReader.new(StringIO.new(body),
+                                   **gzip_reader_options).read
       when 'deflate'
         yield Zlib::Inflate.inflate(body)
       when 'identity', NilClass

data/lib/vcr/test_frameworks/cucumber.rb

@@ -23,10 +23,10 @@ module VCR
     # Adds `Before` and `After` cucumber hooks for the named tags that
     # will cause a VCR cassette to be used for scenarios with matching tags.
     #
-    # @param [Array<String>] tag_names the cucumber scenario tags
-    # @param [(optional) Hash] options the cassette options. Specify
-    #   `:use_scenario_name => true` to automatically name the
-    #   cassette according to the scenario name.
+    # @param tag_names [Array<String,Hash>] the cucumber scenario tags. If
+    #  the last argument is a hash it is treated as cassette options.
+    #   - `:use_scenario_name => true` to automatically name the
+    #     cassette according to the scenario name.
     def tags(*tag_names)
       original_options = tag_names.last.is_a?(::Hash) ? tag_names.pop : {}
       tag_names.each do |tag_name|
@@ -47,10 +47,21 @@ module VCR
                 scenario.scenario_outline.name,
                 scenario.name.split("\n").first
               ].join("/")
-            else
+            elsif scenario.respond_to?(:feature)
               [ scenario.feature.name.split("\n").first,
                 scenario.name.split("\n").first
               ].join("/")
+            elsif scenario.location.lines.min == scenario.location.lines.max
+              # test case from a regular scenario in cucumber version 4
+              [ scenario.location.file.split("/").last.split(".").first,
+                scenario.name.split("\n").first
+              ].join("/")
+            else
+              # test case from a scenario with examples ("scenario outline") in cucumber version 4
+              [ scenario.location.file.split("/").last.split(".").first,
+                scenario.name.split("\n").first,
+                "Example at line #{scenario.location.lines.max}"
+              ].join("/")
             end
           else
             "cucumber_tags/#{tag_name.gsub(/\A@/, '')}"

data/lib/vcr/test_frameworks/rspec.rb

@@ -5,38 +5,50 @@ module VCR
     module Metadata
       extend self
 
+      def vcr_cassette_name_for(metadata)
+        description = 
+          if metadata[:description].empty?
+            # we have an "it { is_expected.to be something }" block
+            metadata[:scoped_id]
+          else
+            metadata[:description]
+          end
+        example_group = 
+          if metadata.key?(:example_group)
+            metadata[:example_group]
+          else
+            metadata[:parent_example_group]
+          end
+
+        if example_group
+          [vcr_cassette_name_for(example_group), description].join('/')
+        else
+          description
+        end
+      end
+
       def configure!
         ::RSpec.configure do |config|
-          vcr_cassette_name_for = lambda do |metadata|
-            description = if metadata[:description].empty?
-                            # we have an "it { is_expected.to be something }" block
-                            metadata[:scoped_id]
-                          else
-                            metadata[:description]
-                          end
-            example_group = if metadata.key?(:example_group)
-                              metadata[:example_group]
-                            else
-                              metadata[:parent_example_group]
-                            end
-
-            if example_group
-              [vcr_cassette_name_for[example_group], description].join('/')
-            else
-              description
-            end
-          end
 
           when_tagged_with_vcr = { :vcr => lambda { |v| !!v } }
 
           config.before(:each, when_tagged_with_vcr) do |ex|
             example = ex.respond_to?(:metadata) ? ex : ex.example
 
+            cassette_name = nil
             options = example.metadata[:vcr]
-            options = options.is_a?(Hash) ? options.dup : {} # in case it's just :vcr => true
+            options = case options
+                      when Hash #=> vcr: { cassette_name: 'foo' }
+                        options.dup
+                      when String #=> vcr: 'bar'
+                        cassette_name = options.dup
+                        {}
+                      else #=> :vcr or vcr: true
+                        {}
+                      end
 
-            cassette_name = options.delete(:cassette_name) ||
-                            vcr_cassette_name_for[example.metadata]
+            cassette_name ||= options.delete(:cassette_name) ||
+                              VCR::RSpec::Metadata.vcr_cassette_name_for(example.metadata)
             VCR.insert_cassette(cassette_name, options)
           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 = '5.0.0'
+      string = +'6.1.0'
 
       def string.parts
         split('.').map { |p| p.to_i }
@@ -28,7 +28,7 @@ module VCR
         parts[2]
       end
 
-      string
+      string.freeze
     end
   end
 end

data/lib/vcr.rb

@@ -52,7 +52,7 @@ module VCR
   # Inserts the named cassette using the given cassette options.
   # New HTTP interactions, if allowed by the cassette's `:record` option, will
   # be recorded to the cassette. The cassette's existing HTTP interactions
-  # will be used to stub requests, unless prevented by the cassete's
+  # will be used to stub requests, unless prevented by the cassette's
   # `:record` option.
   #
   # @example
@@ -107,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`.
@@ -186,6 +192,9 @@ module VCR
 
     begin
       call_block(block, cassette)
+    rescue StandardError
+      cassette.run_failed!
+      raise
     ensure
       eject_cassette
     end
@@ -194,13 +203,13 @@ module VCR
   # Inserts multiple cassettes the given names
   #
   # @example
-  # cassettes = [
-  #  { name: 'github' },
-  #  { name: 'apple', options: { erb: true } }
-  # ]
-  # VCR.use_cassettes() do
-  #   # make multiple HTTP requests
-  # end
+  #   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
@@ -257,6 +266,7 @@ module VCR
   # @see #turn_off!
   # @see #turn_on!
   # @see #turned_on?
+  # @see #turned_on
   def turned_off(options = {})
     turn_off!(options)
 
@@ -292,11 +302,28 @@ module VCR
     set_context_value(:turned_off, true)
   end
 
+  # Turns on VCR, for the duration of a block.
+  # @param (see #turn_off!)
+  # @return [void]
+  # @see #turn_off!
+  # @see #turned_off
+  # @see #turned_on?
+  def turned_on(options = {})
+    turn_on!
+
+    begin
+      yield
+    ensure
+      turn_off!(options)
+    end
+  end
+
   # Turns on VCR, if it has previously been turned off.
   # @return [void]
   # @see #turn_off!
   # @see #turned_off
   # @see #turned_on?
+  # @see #turned_on
   def turn_on!
     set_context_value(:turned_off, false)
   end
@@ -308,6 +335,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
 

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vcr
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Myron Marston
-autorequire: 
+- Kurtis Rainbolt-Greene
+- Olle Jonsson
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +46,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: 3.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: 3.4.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -150,48 +152,74 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.14.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.14.14
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -210,14 +238,14 @@ dependencies:
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.62.0
 - !ruby/object:Gem::Dependency
@@ -234,20 +262,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -307,7 +321,7 @@ dependencies:
 description: Record your test suite's HTTP interactions and replay them during future
   test runs for fast, deterministic, accurate tests.
 email:
-- myron.marston@gmail.com
+- kurtis@rainbolt-greene.online
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -332,7 +346,6 @@ files:
 - lib/vcr/library_hooks/excon.rb
 - lib/vcr/library_hooks/faraday.rb
 - lib/vcr/library_hooks/typhoeus.rb
-- lib/vcr/library_hooks/typhoeus_0.4.rb
 - lib/vcr/library_hooks/webmock.rb
 - lib/vcr/linked_cassette.rb
 - lib/vcr/middleware/excon.rb
@@ -354,9 +367,10 @@ files:
 - lib/vcr/version.rb
 homepage: https://relishapp.com/vcr/vcr/docs
 licenses:
+- Hippocratic-2.1
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -364,15 +378,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Record your test suite's HTTP interactions and replay them during future
   test runs for fast, deterministic, accurate tests.

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

@@ -1,103 +0,0 @@
-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
-