vcr 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07fd7ce84552274d7b4da982cb81c3952f41745280274b236a8f4b2d22f99c14
-  data.tar.gz: 52291714128b6cf2ae583098b0e8c25acb1335826bfbbd6f4db778bf11996533
+  metadata.gz: 79ff7c5f67afb190b63450e117a7dbda6709340fbab8c17680c36b2bb5a8a6f6
+  data.tar.gz: a6a17620c6c63d9a596a39e2700f3f1becddb26bfa63f862e42ef0dfabb783d9
 SHA512:
-  metadata.gz: fdcf18897a729f367411a486747e318c870e92c8eb5c234ed1948123501938ccd7966b129ef99658cca62ec0d6762b2fc339c1064527c6de731eed1bfdf53c72
-  data.tar.gz: 945c7b6cbae5a31ad56d142488dedb69d2554ea2367a157e9693b7771be9fec9e12b74236c3e853b9ab05ffba416bc489055264048b4896efa9030767394a7bb
+  metadata.gz: 9f43f626bae24850a8b5f912203dba5ee7e38ef39ecb3d325382ca2cbfb24ff789c3e630edd628588fdd59b0a8b10919bedd820675a039b5d619f1c779dc186b
+  data.tar.gz: ffc8534bbab227c6f8f4636306644c1c28d1ac8c2d29d47551d1b84c04cd5c37979acfb44803b18c54ee558e961d92826a38e6a75b93d8002af6adde5f2e7d05

data/lib/vcr.rb

@@ -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`.
@@ -197,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

data/lib/vcr/cassette.rb

@@ -176,7 +176,7 @@ module VCR
         :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

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

@@ -496,7 +496,8 @@ module VCR
         :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/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

data/lib/vcr/structs.rb

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

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.1.0'
+      string = '6.0.0'
 
       def string.parts
         split('.').map { |p| p.to_i }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcr
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Myron Marston
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,42 +178,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.12
+        version: 0.14.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.12
+        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
@@ -232,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
@@ -256,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
@@ -376,7 +368,8 @@ files:
 - lib/vcr/version.rb
 homepage: https://relishapp.com/vcr/vcr/docs
 licenses:
-- MIT-Hippocratic-1.2
+- Hippocratic-2.1
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -386,14 +379,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Record your test suite's HTTP interactions and replay them during future