vcr 2.0.0.rc1 → 2.0.0.rc2

data/features/.nav

@@ -24,6 +24,8 @@
   - ignore_request.feature
   - filter_sensitive_data.feature
   - allow_http_connections_when_no_cassette.feature
+  - debug_logging.feature
+  - preserve_exact_body_bytes.feature
 - hooks:
   - before_record.feature
   - before_playback.feature

data/features/cassettes/automatic_re_recording.feature

@@ -13,22 +13,26 @@ Feature: Automatic Re-recording
   Background:
     Given a previously recorded cassette file "cassettes/example.yml" with:
       """
-      ---
-      http_interactions:
-      - request:
+      --- 
+      http_interactions: 
+      - request: 
           method: get
           uri: http://localhost:7777/
-          body: ''
+          body: 
+            encoding: UTF-8
+            string: ""
           headers: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Length:
-            - '12'
-          body: Old Response
-          http_version: '1.1'
+          headers: 
+            Content-Length: 
+            - "12"
+          body: 
+            encoding: UTF-8
+            string: Old Response
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """
@@ -55,14 +59,14 @@ Feature: Automatic Re-recording
     When I run `ruby re_record.rb`
     Then the output should contain "Old Response"
     But the output should not contain "New Response"
-    And the file "cassettes/example.yml" should contain "body: Old Response"
-    But the file "cassettes/example.yml" should not contain "body: New Response"
+    And the file "cassettes/example.yml" should contain "Old Response"
+    But the file "cassettes/example.yml" should not contain "New Response"
 
   Scenario: Cassette is re-recorded when enough time has passed
     Given it is Tue, 09 Nov 2011
     When I run `ruby re_record.rb`
     Then the output should contain "New Response"
     But the output should not contain "Old Response"
-    And the file "cassettes/example.yml" should contain "body: New Response"
-    But the file "cassettes/example.yml" should not contain "body: Old Response"
+    And the file "cassettes/example.yml" should contain "New Response"
+    But the file "cassettes/example.yml" should not contain "Old Response"
 

data/features/cassettes/dynamic_erb.feature

@@ -17,7 +17,9 @@ Feature: Dynamic ERB cassettes
       - request:
           method: get
           uri: http://example.com/foo?a=<%= 'b' * 3 %>
-          body: ''
+          body:
+            encoding: UTF-8
+            string: ''
           headers: {}
         response:
           status:
@@ -28,7 +30,9 @@ Feature: Dynamic ERB cassettes
             - text/html;charset=utf-8
             Content-Length:
             - '9'
-          body: Hello <%= 'bar'.next %>
+          body:
+            encoding: UTF-8
+            string: Hello <%= 'bar'.next %>
           http_version: '1.1'
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
@@ -58,7 +62,9 @@ Feature: Dynamic ERB cassettes
       - request:
           method: get
           uri: http://example.com/foo?a=<%= arg1 %>
-          body: ''
+          body:
+            encoding: UTF-8
+            string: ''
           headers: {}
         response:
           status:
@@ -69,7 +75,9 @@ Feature: Dynamic ERB cassettes
             - text/html;charset=utf-8
             Content-Length:
             - '9'
-          body: Hello <%= arg2 %>
+          body:
+            encoding: UTF-8
+            string: Hello <%= arg2 %>
           http_version: '1.1'
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0

data/features/cassettes/exclusive.feature

@@ -17,43 +17,51 @@ Feature: exclusive cassette
   Background:
     Given a previously recorded cassette file "cassettes/outer.yml" with:
       """
-      ---
-      http_interactions:
-      - request:
+      --- 
+      http_interactions: 
+      - request: 
           method: get
           uri: http://localhost:7777/outer
-          body: ''
+          body: 
+            encoding: UTF-8
+            string: ""
           headers: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Length:
-            - '18'
-          body: Old outer response
-          http_version: '1.1'
+          headers: 
+            Content-Length: 
+            - "18"
+          body: 
+            encoding: UTF-8
+            string: Old outer response
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """
     And a previously recorded cassette file "cassettes/inner.yml" with:
       """
-      ---
-      http_interactions:
-      - request:
+      --- 
+      http_interactions: 
+      - request: 
           method: get
           uri: http://localhost:7777/inner
-          body: ''
+          body: 
+            encoding: UTF-8
+            string: ""
           headers: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Length:
-            - '18'
-          body: Old inner response
-          http_version: '1.1'
+          headers: 
+            Content-Length: 
+            - "18"
+          body: 
+            encoding: UTF-8
+            string: Old inner response
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """
@@ -111,5 +119,5 @@ Feature: exclusive cassette
       New outer response
       Old inner response
       """
-    And the file "cassettes/inner.yml" should contain "body: New outer response"
+    And the file "cassettes/inner.yml" should contain "New outer response"
 

data/features/cassettes/format.feature

@@ -9,6 +9,8 @@ Feature: Cassette format
       - method
       - uri
       - body
+        - encoding
+        - string
       - headers
     - response
       - status
@@ -16,6 +18,8 @@ Feature: Cassette format
         - message
       - headers
       - body
+        - encoding
+        - string
       - http version
 
   By default, VCR uses YAML to serialize this data.  You can configure
@@ -72,41 +76,49 @@ Feature: Cassette format
     When I 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: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Type:
+          headers: 
+            Content-Type: 
             - text/html;charset=utf-8
-            Content-Length:
-            - '9'
-          body: Hello foo
-          http_version: '1.1'
+            Content-Length: 
+            - "9"
+          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: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Type:
+          headers: 
+            Content-Type: 
             - text/html;charset=utf-8
-            Content-Length:
-            - '9'
-          body: Hello bar
-          http_version: '1.1'
+            Content-Length: 
+            - "9"
+          body: 
+            encoding: UTF-8
+            string: Hello bar
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """
@@ -152,7 +164,10 @@ Feature: Cassette format
         "http_interactions": [
           {
             "response": {
-              "body": "Hello foo",
+              "body": {
+                "encoding": "UTF-8",
+                "string": "Hello foo"
+              },
               "http_version": null,
               "status": { "code": 200, "message": "OK" },
               "headers": {
@@ -165,7 +180,10 @@ Feature: Cassette format
             },
             "request": {
               "uri": "http://localhost:7777/foo",
-              "body": "",
+              "body": {
+                "encoding": "UTF-8",
+                "string": ""
+              },
               "method": "get",
               "headers": { }
             },
@@ -173,7 +191,10 @@ Feature: Cassette format
           },
           {
             "response": {
-              "body": "Hello bar",
+              "body": {
+                "encoding": "UTF-8",
+                "string": "Hello bar"
+              },
               "http_version": null,
               "status": { "code": 200, "message": "OK" },
               "headers": {
@@ -186,7 +207,10 @@ Feature: Cassette format
             },
             "request": {
               "uri": "http://localhost:7777/bar",
-              "body": "",
+              "body": {
+                "encoding": "UTF-8",
+                "string": ""
+              },
               "method": "get",
               "headers": { }
             },
@@ -241,7 +265,7 @@ Feature: Cassette format
         [{"request"=>
            {"method"=>"get",
             "uri"=>"http://localhost:7777/foo",
-            "body"=>"",
+            "body"=>{"encoding"=>"UTF-8", "string"=>""},
             "headers"=>{"Accept"=>["*/*"], "User-Agent"=>["Ruby"]}},
           "response"=>
            {"status"=>{"code"=>200, "message"=>"OK "},
@@ -249,13 +273,13 @@ Feature: Cassette format
              {"Content-Type"=>["text/html;charset=utf-8"],
               "Content-Length"=>["9"],
               "Connection"=>["Keep-Alive"]},
-            "body"=>"Hello foo",
+            "body"=>{"encoding"=>"UTF-8", "string"=>"Hello foo"},
             "http_version"=>nil},
           "recorded_at"=>"Tue, 01 Nov 2011 04:58:44 GMT"},
          {"request"=>
            {"method"=>"get",
             "uri"=>"http://localhost:7777/bar",
-            "body"=>"",
+            "body"=>{"encoding"=>"UTF-8", "string"=>""},
             "headers"=>{"Accept"=>["*/*"], "User-Agent"=>["Ruby"]}},
           "response"=>
            {"status"=>{"code"=>200, "message"=>"OK "},
@@ -263,7 +287,7 @@ Feature: Cassette format
              {"Content-Type"=>["text/html;charset=utf-8"],
               "Content-Length"=>["9"],
               "Connection"=>["Keep-Alive"]},
-            "body"=>"Hello bar",
+            "body"=>{"encoding"=>"UTF-8", "string"=>"Hello bar"},
             "http_version"=>nil},
           "recorded_at"=>"Tue, 01 Nov 2011 04:58:44 GMT"}],
        "recorded_with"=>"VCR 2.0.0"}

data/features/cassettes/naming.feature

@@ -24,4 +24,4 @@ Feature: Naming
       """
      And the directory "cassettes" does not exist
     When I run `ruby name_sanitizing.rb`
-    Then the file "cassettes/Fee_Fi_Fo_Fum.yml" should contain "body: Hello"
+    Then the file "cassettes/Fee_Fi_Fo_Fum.yml" should contain "Hello"

data/features/cassettes/update_content_length_header.feature

@@ -21,24 +21,28 @@ Feature: Update content_length header
   Background:
     Given a previously recorded cassette file "cassettes/example.yml" with:
       """
-      ---
-      http_interactions:
-      - request:
+      --- 
+      http_interactions: 
+      - request: 
           method: get
           uri: http://example.com/
-          body: ''
+          body: 
+            encoding: UTF-8
+            string: ""
           headers: {}
-        response:
-          status:
+        response: 
+          status: 
             code: 200
             message: OK
-          headers:
-            Content-Type:
+          headers: 
+            Content-Type: 
             - text/html;charset=utf-8
-            Content-Length:
-            - '11'
-          body: Hello <modified>
-          http_version: '1.1'
+            Content-Length: 
+            - "11"
+          body: 
+            encoding: UTF-8
+            string: Hello <modified>
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -45,7 +45,7 @@ Feature: Allow HTTP connections when no cassette
       """
     When I run `ruby record_replay_cassette.rb --with-server`
     Then the output should contain "Response: Hello"
-    And the file "cassettes/localhost.yml" should contain "body: Hello"
+    And the file "cassettes/localhost.yml" should contain "Hello"
 
     When I run `ruby record_replay_cassette.rb`
     Then the output should contain "Response: Hello"

data/features/configuration/debug_logging.feature

@@ -0,0 +1,52 @@
+@exclude-18
+Feature: Debug Logging
+
+  Use the `debug_logger` option to set an IO-like object that VCR will log
+  debug output to. This is a useful way to troubleshoot what VCR is doing.
+
+  The debug logger must respond to `#puts`.
+
+  Scenario: Use the debug logger for troubleshooting
+    Given a file named "debug_logger.rb" with:
+      """ruby
+      if ARGV.include?('--with-server')
+        start_sinatra_app(:port => 7777) do
+          get('/') { "Hello World" }
+        end
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.debug_logger = File.open(ARGV.first, 'w')
+      end
+
+      VCR.use_cassette('example') do
+        Net::HTTP.get_response(URI("http://localhost:7777/"))
+      end
+      """
+    When I run `ruby debug_logger.rb record.log --with-server`
+    Then the file "record.log" should contain exactly:
+      """
+      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :serialize_with=>:yaml}
+      [fakeweb] Handling request: [get http://localhost:7777/] (disabled: false)
+        [Cassette: 'example'] Initialized HTTPInteractionList with request matchers [:method, :uri] and 0 interaction(s): {  }
+      [fakeweb] Identified request type (recordable) for [get http://localhost:7777/]
+      [Cassette: 'example'] Recorded HTTP interaction [get http://localhost:7777/] => [200 "Hello World"]
+
+      """
+    When I run `ruby debug_logger.rb playback.log`
+    Then the file "playback.log" should contain exactly:
+      """
+      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :serialize_with=>:yaml}
+      [fakeweb] Handling request: [get http://localhost:7777/] (disabled: false)
+        [Cassette: 'example'] Initialized HTTPInteractionList with request matchers [:method, :uri] and 1 interaction(s): { [get http://localhost:7777/] => [200 "Hello World"] }
+        [Cassette: 'example'] Checking if [get http://localhost:7777/] matches [get http://localhost:7777/] using [:method, :uri]
+          [Cassette: 'example'] method (matched): current request [get http://localhost:7777/] vs [get http://localhost:7777/]
+          [Cassette: 'example'] uri (matched): current request [get http://localhost:7777/] vs [get http://localhost:7777/]
+        [Cassette: 'example'] Found matching interaction for [get http://localhost:7777/] at index 0: [200 "Hello World"]
+      [fakeweb] Identified request type (stubbed) for [get http://localhost:7777/]
+
+      """