vcr 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0121a881f4d4b1ac0f68b5078f5674f137e07a4a0580b70a438f920c5953db
-  data.tar.gz: 551623fd6fd0317c2510e1a02c36f6a8c3cac4bba72752ffd31907de0e1bfef9
+  metadata.gz: 07fd7ce84552274d7b4da982cb81c3952f41745280274b236a8f4b2d22f99c14
+  data.tar.gz: 52291714128b6cf2ae583098b0e8c25acb1335826bfbbd6f4db778bf11996533
 SHA512:
-  metadata.gz: d6ad287e1f993836c3adac326228312596935313d65313fb60b07b16a962b0b5b9cff3f74db5200ce21e2c5ba5b6e32da0fd445d73fe7024c35308fecfcdc688
-  data.tar.gz: bcf77106091efc49ae8ee789f076b162eb28491349a2e04ef0a1220ae5b1cfb3501de2e3106d8aa14459c7577207775650232ebf11235fe110c28dfa16614149
+  metadata.gz: fdcf18897a729f367411a486747e318c870e92c8eb5c234ed1948123501938ccd7966b129ef99658cca62ec0d6762b2fc339c1064527c6de731eed1bfdf53c72
+  data.tar.gz: 945c7b6cbae5a31ad56d142488dedb69d2554ea2367a157e9693b7771be9fec9e12b74236c3e853b9ab05ffba416bc489055264048b4896efa9030767394a7bb

data/lib/vcr.rb

@@ -186,6 +186,9 @@ module VCR
 
     begin
       call_block(block, cassette)
+    rescue StandardError
+      cassette.run_failed!
+      raise
     ensure
       eject_cassette
     end
@@ -308,6 +311,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
@@ -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,7 +173,7 @@ 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
@@ -163,7 +185,7 @@ 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

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

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

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

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

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vcr
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Myron Marston
+- Kurtis Rainbolt-Greene
+- Olle Jonsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +152,26 @@ 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
@@ -170,14 +192,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.14.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.14.12
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -307,7 +329,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: []
@@ -354,7 +376,7 @@ files:
 - lib/vcr/version.rb
 homepage: https://relishapp.com/vcr/vcr/docs
 licenses:
-- MIT
+- MIT-Hippocratic-1.2
 metadata: {}
 post_install_message: 
 rdoc_options: []