vcr 2.9.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e6983e0b541695c90b220f62fe9a67357d061c7
-  data.tar.gz: dae97ef043b1c5fcc7589dd0f591ce7bb751e3db
+  metadata.gz: 4220b7228aef7b898a3c0caaac694cde250bf8c2
+  data.tar.gz: 1dc6b739ec86f670219754076cd749edb295c47b
 SHA512:
-  metadata.gz: 16981e6236478ed88aa82d859e1cfeed50d9d16a44d536a0606c0408c4f17d74147e1ed855a2273a1f0c7aa8521713fdc741333382e181641edf8a30fbbd5d07
-  data.tar.gz: de2dd8e386e31e46d500e2faa5daa993df951a2adec43163f325f6bc9d530bce519fe16739c71a8f989daa2015b62cfde4d2369260f2bc50a92630990e509b84
+  metadata.gz: 758f773b6832d30b190aaaba9c24ed7d345c1d31a1216cc8b9ff4bac4175e17f01d9355be38ba2e7bb752c6ab10e8f98c2fa31ddfcac8dbfbe7649d27c279768
+  data.tar.gz: a29dff72f5ed9facdda4038866b2c761905e42ae3c51756406ab965bae03e9b398d3219ebea0963ae85235f84e90492a66e44a61def80412d298ecac56e73c5d

data/features/about_these_examples.md

@@ -2,7 +2,7 @@ The cucumber features provided here demonstrate all of the major features of
 VCR.  These features are executable documentation for VCR.
 
 Many of the examples use one (or both) of these helper functions
-provided by `vcr_cucumber_helpers.rb`:
+provided by `spec/support/cucumber_helpers.rb`:
 
 * `start_sinatra_app`: starts a sinatra application on the given port.
   The server automatically shuts down when the ruby script ends.  Many

data/features/cassettes/automatic_re_recording.feature

@@ -17,7 +17,7 @@ Feature: Automatic Re-recording
       http_interactions: 
       - request: 
           method: get
-          uri: http://localhost:7777/
+          uri: http://localhost/
           body: 
             encoding: UTF-8
             string: ""
@@ -38,7 +38,7 @@ Feature: Automatic Re-recording
       """
     And a file named "re_record.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { 'New Response' }
       end
 
@@ -49,8 +49,8 @@ Feature: Automatic Re-recording
         c.cassette_library_dir = 'cassettes'
       end
 
-      VCR.use_cassette('example', :re_record_interval => 7.days) do
-        puts Net::HTTP.get_response('localhost', '/', 7777).body
+      VCR.use_cassette('example', :re_record_interval => 7.days, :match_requests_on => [:method, :host, :path]) do
+        puts Net::HTTP.get_response('localhost', '/', $server.port).body
       end
       """
 

data/features/cassettes/decompress.feature

@@ -14,7 +14,7 @@ Feature: Decode compressed response
       require 'zlib'
       require 'stringio'
 
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') {
           content = 'The quick brown fox jumps over the lazy dog'
           io = StringIO.new
@@ -41,7 +41,7 @@ Feature: Decode compressed response
     When I append to file "decompress.rb":
       """ruby
       VCR.use_cassette(:decompress) do
-        Net::HTTP.start('localhost', 7777) do |http|
+        Net::HTTP.start('localhost', $server.port) do |http|
           http.get('/', 'accept-encoding' => 'identity')
         end
       end
@@ -57,7 +57,7 @@ Feature: Decode compressed response
     When I append to file "decompress.rb":
       """ruby
       VCR.use_cassette(:decompress, :decode_compressed_response => true) do
-        Net::HTTP.start('localhost', 7777) do |http|
+        Net::HTTP.start('localhost', $server.port) do |http|
           http.get('/', 'accept-encoding' => 'identity')
         end
       end

data/features/cassettes/exclusive.feature

@@ -21,7 +21,7 @@ Feature: exclusive cassette
       http_interactions: 
       - request: 
           method: get
-          uri: http://localhost:7777/outer
+          uri: http://localhost/outer
           body: 
             encoding: UTF-8
             string: ""
@@ -46,7 +46,7 @@ Feature: exclusive cassette
       http_interactions: 
       - request: 
           method: get
-          uri: http://localhost:7777/inner
+          uri: http://localhost/inner
           body: 
             encoding: UTF-8
             string: ""
@@ -69,7 +69,7 @@ Feature: exclusive cassette
       """ruby
       include_http_adapter_for("net/http")
 
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/:path') { "New #{params[:path]} response" }
       end
 
@@ -78,7 +78,10 @@ Feature: exclusive cassette
       VCR.configure do |c|
         c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
-        c.default_cassette_options = { :record => :new_episodes }
+        c.default_cassette_options = {
+          :record => :new_episodes,
+          :match_requests_on => [:method, :host, :path]
+        }
       end
       """
 
@@ -89,8 +92,8 @@ Feature: exclusive cassette
 
       VCR.use_cassette('outer') do
         VCR.use_cassette('inner') do
-          puts response_body_for(:get, "http://localhost:7777/outer")
-          puts response_body_for(:get, "http://localhost:7777/inner")
+          puts response_body_for(:get, "http://localhost:#{$server.port}/outer")
+          puts response_body_for(:get, "http://localhost:#{$server.port}/inner")
         end
       end
       """
@@ -108,8 +111,8 @@ Feature: exclusive cassette
 
       VCR.use_cassette('outer') do
         VCR.use_cassette('inner', :exclusive => true) do
-          puts response_body_for(:get, "http://localhost:7777/outer")
-          puts response_body_for(:get, "http://localhost:7777/inner")
+          puts response_body_for(:get, "http://localhost:#{$server.port}/outer")
+          puts response_body_for(:get, "http://localhost:#{$server.port}/inner")
         end
       end
       """

data/features/cassettes/format.feature

@@ -37,6 +37,8 @@ Feature: Cassette format
       you want to ensure that psych is always used.
     - `:json`--Uses [multi_json](https://github.com/intridea/multi_json)
       to serialize the cassette data as JSON.
+    - `:compressed`--Wraps the default YAML serializer with Zlib, writing
+      compressed cassettes to disk.
 
   You can also register a custom serializer using:
 
@@ -56,7 +58,7 @@ Feature: Cassette format
       include_http_adapter_for("<http_lib>")
 
       if ARGV.any?
-        start_sinatra_app(:port => 7777) do
+        $server = start_sinatra_app do
           get('/:path') { ARGV[0] + ' ' + params[:path] }
         end
       end
@@ -66,60 +68,63 @@ Feature: Cassette format
       VCR.configure do |c|
         <configuration>
         c.cassette_library_dir = 'cassettes'
+        c.before_record do |i|
+          i.request.uri.sub!(/:\d+/, ':7777')
+        end
       end
 
       VCR.use_cassette('example') do
-        make_http_request(:get, "http://localhost:7777/foo", nil, 'Accept-Encoding' => 'identity')
-        make_http_request(:get, "http://localhost:7777/bar", nil, 'Accept-Encoding' => 'identity')
+        make_http_request(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
+        make_http_request(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
       end
       """
-    When I run `ruby cassette_yaml.rb 'Hello'`
+    When I successfully run `ruby cassette_yaml.rb 'Hello'`
     Then the file "cassettes/example.yml" should contain YAML like:
       """
-      --- 
-      http_interactions: 
-      - request: 
+      ---
+      http_interactions:
+      - request:
           method: get
           uri: http://localhost:7777/foo
-          body: 
+          body:
             encoding: UTF-8
             string: ""
-          headers: 
-            Accept-Encoding: 
+          headers:
+            Accept-Encoding:
             - identity
-        response: 
-          status: 
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            Content-Type: 
+          headers:
+            Content-Type:
             - text/html;charset=utf-8
-            Content-Length: 
+            Content-Length:
             - "9"
-          body: 
+          body:
             encoding: UTF-8
             string: Hello foo
           http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
-      - request: 
+      - request:
           method: get
           uri: http://localhost:7777/bar
-          body: 
+          body:
             encoding: UTF-8
             string: ""
-          headers: 
-            Accept-Encoding: 
+          headers:
+            Accept-Encoding:
             - identity
-        response: 
-          status: 
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            Content-Type: 
+          headers:
+            Content-Type:
             - text/html;charset=utf-8
-            Content-Length: 
+            Content-Length:
             - "9"
-          body: 
+          body:
             encoding: UTF-8
             string: Hello bar
           http_version: "1.1"
@@ -145,7 +150,7 @@ Feature: Cassette format
       """ruby
       include_http_adapter_for("net/http")
 
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/:path') { ARGV[0] + ' ' + params[:path] }
       end
 
@@ -154,11 +159,17 @@ Feature: Cassette format
       VCR.configure do |c|
         c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
+        c.before_record do |i|
+          i.request.uri.sub!(/:\d+/, ':7777')
+        end
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
       end
 
       VCR.use_cassette('example', :serialize_with => :json) do
-        puts response_body_for(:get, "http://localhost:7777/foo", nil, 'Accept-Encoding' => 'identity')
-        puts response_body_for(:get, "http://localhost:7777/bar", nil, 'Accept-Encoding' => 'identity')
+        puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
+        puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
       end
       """
     When I run `ruby cassette_json.rb 'Hello'`
@@ -235,12 +246,98 @@ Feature: Cassette format
       Hello bar
       """
 
+  Scenario: Request/Response data can be saved as compressed YAML
+    Given a file named "cassette_compressed.rb" with:
+      """ruby
+      include_http_adapter_for("net/http")
+
+      $server = start_sinatra_app do
+        get('/:path') { ARGV[0] + ' ' + params[:path] }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :webmock
+        c.cassette_library_dir = 'cassettes'
+        c.before_record do |i|
+          i.request.uri.sub!(/:\d+/, ':7777')
+        end
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
+      end
+
+      VCR.use_cassette('example', :serialize_with => :compressed) do
+        puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
+        puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
+      end
+
+      """
+    When I run `ruby cassette_compressed.rb 'Hello'`
+    Then the file "cassettes/example.gz" should contain compressed YAML like:
+      """
+      ---
+      http_interactions:
+      - request:
+          method: get
+          uri: http://localhost:7777/foo
+          body:
+            encoding: UTF-8
+            string: ""
+          headers:
+            Accept-Encoding:
+            - identity
+        response:
+          status:
+            code: 200
+            message: OK
+          headers:
+            Content-Type:
+            - text/html;charset=utf-8
+            Content-Length:
+            - "9"
+          body:
+            encoding: UTF-8
+            string: Hello foo
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      - request:
+          method: get
+          uri: http://localhost:7777/bar
+          body:
+            encoding: UTF-8
+            string: ""
+          headers:
+            Accept-Encoding:
+            - identity
+        response:
+          status:
+            code: 200
+            message: OK
+          headers:
+            Content-Type:
+            - text/html;charset=utf-8
+            Content-Length:
+            - "9"
+          body:
+            encoding: UTF-8
+            string: Hello bar
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
+      """
+    When I run `ruby cassette_compressed.rb`
+    Then it should pass with:
+      """
+      Hello foo
+      Hello bar
+      """
+
   Scenario: Request/Response data can be saved using a custom serializer
     Given a file named "cassette_ruby.rb" with:
       """ruby
       include_http_adapter_for("net/http")
 
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/:path') { ARGV[0] + ' ' + params[:path] }
       end
 
@@ -259,11 +356,17 @@ Feature: Cassette format
         c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
         c.cassette_serializers[:ruby] = ruby_serializer
+        c.before_record do |i|
+          i.request.uri.sub!(/:\d+/, ':7777')
+        end
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
       end
 
       VCR.use_cassette('example', :serialize_with => :ruby) do
-        puts response_body_for(:get, "http://localhost:7777/foo", nil, 'Accept-Encoding' => 'identity')
-        puts response_body_for(:get, "http://localhost:7777/bar", nil, 'Accept-Encoding' => 'identity')
+        puts response_body_for(:get, "http://localhost:#{$server.port}/foo", nil, 'Accept-Encoding' => 'identity')
+        puts response_body_for(:get, "http://localhost:#{$server.port}/bar", nil, 'Accept-Encoding' => 'identity')
       end
       """
     When I run `ruby cassette_ruby.rb 'Hello'`

data/features/cassettes/naming.feature

@@ -8,7 +8,7 @@ Feature: Naming
   Scenario: Name sanitizing
     Given a file named "name_sanitizing.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { "Hello" }
       end
 
@@ -20,7 +20,7 @@ Feature: Naming
       end
 
       VCR.use_cassette('Fee, Fi Fo Fum') do
-        Net::HTTP.get_response('localhost', '/', 7777)
+        Net::HTTP.get_response('localhost', '/', $server.port)
       end
       """
      And the directory "cassettes" does not exist

data/features/cassettes/no_cassette.feature

@@ -56,7 +56,7 @@ Feature: Error for HTTP request made when no cassette is in use
   Scenario: Temporarily turn VCR off to allow HTTP requests to procede as normal
     Given a file named "turn_off_vcr.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { 'Hello' }
       end
 
@@ -69,7 +69,7 @@ Feature: Error for HTTP request made when no cassette is in use
 
       def make_request(context)
         puts context
-        puts Net::HTTP.get_response('localhost', '/', 7777).body
+        puts Net::HTTP.get_response('localhost', '/', $server.port).body
       rescue => e
         puts "Error: #{e.class}"
       end
@@ -127,7 +127,7 @@ Feature: Error for HTTP request made when no cassette is in use
   Scenario: Turning VCR off with `:ignore_cassettes => true` ignores cassettes
     Given a file named "turn_off_vcr_and_insert_cassette.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { 'Hello' }
       end
 
@@ -142,7 +142,7 @@ Feature: Error for HTTP request made when no cassette is in use
       VCR.turn_off!(:ignore_cassettes => true)
 
       VCR.use_cassette('example') do
-        response = Net::HTTP.get_response('localhost', '/', 7777).body
+        response = Net::HTTP.get_response('localhost', '/', $server.port).body
         puts "Response: #{response}"
       end
       """

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -9,7 +9,7 @@ Feature: Allow HTTP connections when no cassette
     Given a file named "vcr_setup.rb" with:
       """ruby
       if ARGV.include?('--with-server')
-        start_sinatra_app(:port => 7777) do
+        $server = start_sinatra_app do
           get('/') { "Hello" }
         end
       end
@@ -20,6 +20,9 @@ Feature: Allow HTTP connections when no cassette
         c.allow_http_connections_when_no_cassette = true
         c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
       end
       """
     And the directory "vcr/cassettes" does not exist
@@ -29,7 +32,7 @@ Feature: Allow HTTP connections when no cassette
       """ruby
       require 'vcr_setup.rb'
 
-      puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
+      puts "Response: " + Net::HTTP.get_response('localhost', '/', $server ? $server.port : 0).body
       """
     When I run `ruby no_cassette.rb --with-server`
     Then the output should contain "Response: Hello"
@@ -40,7 +43,7 @@ Feature: Allow HTTP connections when no cassette
       require 'vcr_setup.rb'
 
       VCR.use_cassette('localhost') do
-        puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
+        puts "Response: " + Net::HTTP.get_response('localhost', '/', $server ? $server.port : 0).body
       end
       """
     When I run `ruby record_replay_cassette.rb --with-server`