vcr 3.0.2 → 6.0.0

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",

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/library_hooks/typhoeus.rb

@@ -44,7 +44,7 @@ else
           end
 
           def on_stubbed_by_vcr_request
-            ::Typhoeus::Response.new \
+            response = ::Typhoeus::Response.new \
               :http_version   => stubbed_response.http_version,
               :code           => stubbed_response.status.code,
               :status_message => stubbed_response.status.message,
@@ -52,6 +52,13 @@ else
               :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 stubbed_response_headers
@@ -74,17 +81,36 @@ else
         end
 
         # @private
-        def self.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 }
+        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 collect_chunks(request)
+            chunks = ''
+            request.on_body.unshift(
+              Proc.new do |body, response|
+                chunks += body
+                request.instance_variable_set(:@chunked_body, chunks)
+              end
+            )
+          end
+
+          def restore_body_from_chunks(response, request)
+            response.options[:response_body] = request.instance_variable_get(:@chunked_body)
+          end
         end
 
         ::Typhoeus.on_complete do |response|
           request = response.request
+
+          restore_body_from_chunks(response, request) if request.streaming?
+
           unless VCR.library_hooks.disabled?(:typhoeus)
             vcr_response = vcr_response_from(response)
             typed_vcr_request = request.send(:remove_instance_variable, :@__typed_vcr_request)
@@ -99,7 +125,10 @@ else
         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

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/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
@@ -72,8 +77,12 @@ module VCR
         end
 
         def response_for(response)
+          # reason_phrase is a new addition to Faraday::Response,
+          # so maintain backward compatibility
+          reason = response.respond_to?(:reason_phrase) ? response.reason_phrase : nil
+
           VCR::Response.new(
-            VCR::ResponseStatus.new(response.status, nil),
+            VCR::ResponseStatus.new(response.status, reason),
             response.headers,
             raw_body_from(response.body),
             nil

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

@@ -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
@@ -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.
@@ -274,7 +255,7 @@ module VCR
       end
 
       # @return [Boolean] whether or not this request is being stubbed by an
-      #  external library (such as WebMock or FakeWeb).
+      #  external library (such as WebMock).
       # @see #stubbed_by_vcr?
       # @see #stubbed?
       def externally_stubbed?
@@ -365,11 +346,10 @@ 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?
-        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'
@@ -437,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
@@ -463,7 +481,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 +514,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/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|

data/lib/vcr/test_frameworks/rspec.rb

@@ -32,10 +32,19 @@ module VCR
           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
-
-            cassette_name = options.delete(:cassette_name) ||
+            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]
             VCR.insert_cassette(cassette_name, options)
           end

data/lib/vcr/util/hooks.rb

@@ -5,6 +5,7 @@ module VCR
   module Hooks
     include VariableArgsBlockCaller
 
+    # @private
     FilteredHook = Struct.new(:hook, :filters) do
       include VariableArgsBlockCaller
 

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