vcr 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 806e6d86ccbe7132de58cc1313e0aef6ab0c2d8d
-  data.tar.gz: e86dd3056697f943fe96721fd2e58163fa900c1e
+SHA256:
+  metadata.gz: fb0121a881f4d4b1ac0f68b5078f5674f137e07a4a0580b70a438f920c5953db
+  data.tar.gz: 551623fd6fd0317c2510e1a02c36f6a8c3cac4bba72752ffd31907de0e1bfef9
 SHA512:
-  metadata.gz: 7549fff407299870a1d989c3627a371b1a77d5054ba42b9a3ee52abd1e579acccbe282a1e7077f3f7bf14eceef2ed6a04d8a7a7578895061d6f858436c07be01
-  data.tar.gz: 427619bde2eb934e06da74ba0888544efc574f437387cd6e00b7e8e3736f760bb5461626e697e4d9725c3d53103d22d9c589f1d809c3aa062550ab9c6fe3d746
+  metadata.gz: d6ad287e1f993836c3adac326228312596935313d65313fb60b07b16a962b0b5b9cff3f74db5200ce21e2c5ba5b6e32da0fd445d73fe7024c35308fecfcdc688
+  data.tar.gz: bcf77106091efc49ae8ee789f076b162eb28491349a2e04ef0a1220ae5b1cfb3501de2e3106d8aa14459c7577207775650232ebf11235fe110c28dfa16614149

data/lib/vcr.rb

@@ -202,10 +202,13 @@ module VCR
   #   # make multiple HTTP requests
   # end
   def use_cassettes(cassettes, &block)
-    return use_cassette(cassettes.last[:name]) { block.call } if cassettes.length == 1
     cassette = cassettes.pop
-    use_cassette(cassette[:name], cassette[:options]) do
-      use_cassettes(cassettes, &block)
+    use_cassette(cassette[:name], cassette[:options] || {}) do
+      if cassettes.empty?
+        block.call
+      else
+        use_cassettes(cassettes, &block)
+      end
     end
   end
 

data/lib/vcr/cassette.rb

@@ -48,6 +48,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
@@ -74,12 +75,16 @@ module VCR
 
     # @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
@@ -149,7 +154,7 @@ module VCR
         :record, :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, :clean_outdated_http_interactions
+        :recompress_response, :persist_with, :clean_outdated_http_interactions
       ]
 
       if invalid_options.size > 0
@@ -175,7 +180,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

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

@@ -77,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
@@ -222,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
@@ -550,6 +559,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
@@ -571,4 +584,3 @@ module VCR
     define_hook :after_library_hooks_loaded
   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

data/lib/vcr/library_hooks/excon.rb

@@ -22,6 +22,14 @@ VCR.configuration.after_library_hooks_loaded do
   # (i.e. to double record requests or whatever).
   if defined?(WebMock::HttpLibAdapters::ExconAdapter)
     WebMock::HttpLibAdapters::ExconAdapter.disable!
+
+    if defined?(::RSpec)
+      ::RSpec.configure do |config|
+        config.before(:suite) do
+          WebMock::HttpLibAdapters::ExconAdapter.disable!
+        end
+      end
+    end
   end
 end
 

data/lib/vcr/request_ignorer.rb

@@ -29,6 +29,10 @@ module VCR
       ignored_hosts.merge(hosts)
     end
 
+    def unignore_hosts(*hosts)
+      ignored_hosts.subtract(hosts)
+    end
+
     def ignore?(request)
       invoke_hook(:ignore_request, request).any?
     end
@@ -40,4 +44,3 @@ module VCR
     end
   end
 end
-

data/lib/vcr/request_matcher_registry.rb

@@ -138,7 +138,7 @@ module VCR
 
       register(:body_as_json) do |r1, r2|
         begin
-          JSON.parse(r1.body) == JSON.parse(r2.body)
+          r1.body == r2.body || JSON.parse(r1.body) == JSON.parse(r2.body)
         rescue JSON::ParserError
           false
         end

data/lib/vcr/structs.rb

@@ -167,25 +167,6 @@ module VCR
     end
   end
 
-  # @private
-  module OrderedHashSerializer
-    def each
-      @ordered_keys.each do |key|
-        yield key, self[key] if has_key?(key)
-      end
-    end
-
-    if RUBY_VERSION.to_f > 1.8
-      # 1.9+ hashes are already ordered.
-      def self.apply_to(*args); end
-    else
-      def self.apply_to(hash, keys)
-        hash.instance_variable_set(:@ordered_keys, keys)
-        hash.extend self
-      end
-    end
-  end
-
   # The request of an {HTTPInteraction}.
   #
   # @attr [Symbol] method the HTTP method (i.e. :head, :options, :get, :post, :put, :patch or :delete)
@@ -219,7 +200,7 @@ module VCR
         'uri'     => uri,
         'body'    => serializable_body,
         'headers' => headers
-      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+      }
     end
 
     # Constructs a new instance from a hash.
@@ -369,7 +350,6 @@ module VCR
         'http_version' => http_version
       }.tap do |hash|
         hash['adapter_metadata'] = adapter_metadata unless adapter_metadata.empty?
-        OrderedHashSerializer.apply_to(hash, members)
       end
     end
 
@@ -403,6 +383,11 @@ module VCR
       %w[ gzip deflate ].include? content_encoding
     end
 
+    # Checks if VCR decompressed the response body
+    def vcr_decompressed?
+      adapter_metadata['vcr_decompressed']
+    end
+
     # Decodes the compressed body and deletes evidence that it was ever compressed.
     #
     # @return self
@@ -412,11 +397,43 @@ module VCR
       self.class.decompress(body, content_encoding) { |new_body|
         self.body = new_body
         update_content_length_header
+        adapter_metadata['vcr_decompressed'] = content_encoding
         delete_header('Content-Encoding')
       }
       return self
     end
 
+    # Recompresses the decompressed body according to adapter metadata.
+    #
+    # @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
+    #  stored in the adapter metadata is unknown
+    def recompress
+      type = adapter_metadata['vcr_decompressed']
+      new_body = begin
+        case type
+        when 'gzip'
+          body_str = ''
+          args = [StringIO.new(body_str)]
+          args << { :encoding => 'ASCII-8BIT' } if ''.respond_to?(:encoding)
+          writer = Zlib::GzipWriter.new(*args)
+          writer.write(body)
+          writer.close
+          body_str
+        when 'deflate'
+          Zlib::Deflate.inflate(body)
+        when 'identity', NilClass
+          nil
+        else
+          raise Errors::UnknownContentEncodingError, "unknown content encoding: #{type}"
+        end
+      end
+      if new_body
+        self.body = new_body
+        update_content_length_header
+        headers['Content-Encoding'] = type
+      end
+    end
+
     begin
       require 'zlib'
       require 'stringio'
@@ -463,7 +480,7 @@ module VCR
     def to_hash
       {
         'code' => code, 'message' => message
-      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+      }
     end
 
     # Constructs a new instance from a hash.
@@ -496,9 +513,7 @@ module VCR
         'request'     => request.to_hash,
         'response'    => response.to_hash,
         'recorded_at' => recorded_at.httpdate
-      }.tap do |hash|
-        OrderedHashSerializer.apply_to(hash, members)
-      end
+      }
     end
 
     # Constructs a new instance from a hash.

data/lib/vcr/util/internet_connection.rb

@@ -1,31 +1,25 @@
 module VCR
   # Ruby 1.8 provides Ping.pingecho, but it was removed in 1.9.
-  # So we try requiring it, and if that fails, define it ourselves.
-  begin
-    require 'ping'
-    Ping = ::Ping
-  rescue LoadError
-    # This is copied, verbatim, from Ruby 1.8.7's ping.rb.
-    require 'timeout'
-    require "socket"
+  # This is copied, verbatim, from Ruby 1.8.7's ping.rb.
+  require 'timeout'
+  require "socket"
 
-    # @private
-    module Ping
-      def pingecho(host, timeout=5, service="echo")
-        begin
-          Timeout.timeout(timeout) do
-            s = TCPSocket.new(host, service)
-            s.close
-          end
-        rescue Errno::ECONNREFUSED
-          return true
-        rescue Timeout::Error, StandardError
-          return false
+  # @private
+  module Ping
+    def pingecho(host, timeout=5, service="echo")
+      begin
+        Timeout.timeout(timeout) do
+          s = TCPSocket.new(host, service)
+          s.close
         end
+      rescue Errno::ECONNREFUSED
         return true
+      rescue Timeout::Error, StandardError
+        return false
       end
-      module_function :pingecho
+      return true
     end
+    module_function :pingecho
   end
 
   # @private

data/lib/vcr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vcr
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Myron Marston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -210,16 +210,16 @@ dependencies:
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.62.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -371,8 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Record your test suite's HTTP interactions and replay them during future