vcr 2.0.0.rc1 → 2.0.0.rc2

data/features/configuration/filter_sensitive_data.feature

@@ -51,7 +51,7 @@ Feature: Filter sensitive data
       """
     When I run `ruby filtering.rb --with-server`
     Then the output should contain "Response: Hello World"
-     And the file "cassettes/filtering.yml" should contain "body: <GREETING> <LOCATION>"
+     And the file "cassettes/filtering.yml" should contain "<GREETING> <LOCATION>"
      And the file "cassettes/filtering.yml" should not contain "Hello"
      And the file "cassettes/filtering.yml" should not contain "World"
 
@@ -90,8 +90,8 @@ Feature: Filter sensitive data
     Then the output should contain each of the following:
       | Tagged Response: Hello World 1   |
       | Untagged Response: Hello World 2 |
-     And the file "cassettes/tagged.yml" should contain "body: Hello <LOCATION> 1"
-     And the file "cassettes/untagged.yml" should contain "body: Hello World 2"
+     And the file "cassettes/tagged.yml" should contain "Hello <LOCATION> 1"
+     And the file "cassettes/untagged.yml" should contain "Hello World 2"
 
     When I run `ruby tagged_filtering.rb`
     Then the output should contain each of the following:
@@ -141,7 +141,7 @@ Feature: Filter sensitive data
       """
     When I run `ruby dynamic_filtering.rb --with-server`
     Then the output should contain "john.doe/monkey"
-    And the file "cassettes/example.yml" should contain "body: john.doe/<PASSWORD>"
+    And the file "cassettes/example.yml" should contain "john.doe/<PASSWORD>"
     And the file "cassettes/example.yml" should contain a YAML fragment like:
       """
       X-Http-Password:

data/features/configuration/hook_into.feature

@@ -12,6 +12,7 @@ Feature: hook_into
       - Curb (Curl::Easy, but not Curl::Multi)
       - EM HTTP Request
       - Typhoeus (Typhoeus::Hydra, but not Typhoeus::Easy or Typhoeus::Multi)
+      - Excon
     - :typhoeus can be used to hook into itself (as long as you use Typhoeus::Hydra,
       but not Typhoeus::Easy or Typhoeus::Multi).
     - :excon can be used to hook into itself.
@@ -53,6 +54,7 @@ Feature: hook_into
         <configuration>
         c.cassette_library_dir = 'vcr_cassettes'
         c.ignore_localhost = false
+        c.default_cassette_options = { :serialize_with => :syck }
       end
 
       VCR.use_cassette('example') do
@@ -63,13 +65,13 @@ Feature: hook_into
     Then the output should contain each of the following:
       | The response for request 1 was: Hello World |
       | The response for request 2 was: Hello World |
-     And the file "vcr_cassettes/example.yml" should contain "body: Hello World"
+     And the file "vcr_cassettes/example.yml" should contain "Hello World"
 
     When I run `ruby hook_into_http_lib_combo.rb 'Goodbye World'`
     Then the output should contain each of the following:
       | The response for request 1 was: Goodbye World |
       | The response for request 2 was: Hello World   |
-     And the file "vcr_cassettes/example.yml" should contain "body: Hello World"
+     And the file "vcr_cassettes/example.yml" should contain "Hello World"
 
    Examples:
       | configuration         | http_lib              |
@@ -80,6 +82,7 @@ Feature: hook_into
       | c.hook_into :webmock  | patron                |
       | c.hook_into :webmock  | em-http-request       |
       | c.hook_into :webmock  | typhoeus              |
+      | c.hook_into :webmock  | excon                 |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
       | c.hook_into :faraday  | faraday (w/ net_http) |

data/features/configuration/ignore_request.feature

@@ -48,6 +48,7 @@ Feature: Ignore Request
           URI(request.uri).port == 7777
         end
 
+        c.default_cassette_options = { :serialize_with => :syck }
         c.cassette_library_dir = 'cassettes'
         <configuration>
       end
@@ -75,8 +76,8 @@ Feature: Ignore Request
       Port 7777 Response 1
       Port 7777 Response 2
       """
-    And the file "cassettes/example.yml" should contain "body: Port 8888"
-    And the file "cassettes/example.yml" should not contain "body: Port 7777"
+    And the file "cassettes/example.yml" should contain "Port 8888"
+    And the file "cassettes/example.yml" should not contain "Port 7777"
 
     Examples:
       | configuration         | http_lib              |
@@ -132,6 +133,7 @@ Feature: Ignore Request
 
       VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = { :serialize_with => :syck }
         <configuration>
       end
 
@@ -143,7 +145,7 @@ Feature: Ignore Request
       """
     When I run `ruby localhost_not_ignored.rb`
     Then it should fail with "An HTTP request has been made that VCR does not know how to handle"
-     And the file "cassettes/localhost.yml" should contain "body: Port 7777 Response 1"
+     And the file "cassettes/localhost.yml" should contain "Port 7777 Response 1"
 
     Examples:
       | configuration         | http_lib              |

data/features/configuration/preserve_exact_body_bytes.feature

@@ -0,0 +1,103 @@
+@exclude-18
+Feature: Preserve Exact Body Bytes
+
+  Some HTTP servers are not well-behaved and respond with invalid data: the response body may
+  not be encoded according to the encoding specified in the HTTP headers, or there may be bytes
+  that are invalid for the given encoding. The YAML and JSON serializers are not generally
+  designed to handle these cases gracefully, and you may get errors when the cassette is serialized
+  or deserialized. Also, the encoding may not be preserved when round-tripped through the
+  serializer.
+
+  VCR provides a configuration option to deal with cases like these. The `preserve_exact_body_bytes`
+  method accepts a block that VCR will use to determine if the body of the given request or response object
+  should be base64 encoded in order to preserve the bytes exactly as-is. VCR does not do this by
+  default, since base64-encoding the string removes the human readibility of the cassette.
+
+  Alternately, if you want to force an entire cassette to preserve the exact body bytes,
+  you can pass the `:preserve_exact_body_bytes => true` cassette option when inserting your
+  cassette.
+
+  Scenario: Preserve exact bytes for response body with invalid encoding
+    Given a file named "preserve.rb" with:
+      """ruby
+      # encoding: utf-8
+      string = "abc \xFA"
+      puts "Valid encoding: #{string.valid_encoding?}"
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { string }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.cassette_library_dir = 'cassettes'
+        c.hook_into :fakeweb
+        c.preserve_exact_body_bytes do |http_message|
+          http_message.body.encoding.name == 'ASCII-8BIT' ||
+          !http_message.body.valid_encoding?
+        end
+      end
+
+      def make_request(label)
+        puts
+        puts label
+        VCR.use_cassette('example', :serialize_with => :json) do
+          body = Net::HTTP.get_response(URI("http://localhost:7777/")).body
+          puts "Body: #{body.inspect}"
+        end
+      end
+
+      make_request("Recording:")
+      make_request("Playback:")
+      """
+    When I run `ruby preserve.rb`
+    Then the output should contain exactly:
+      """
+      Valid encoding: false
+
+      Recording:
+      Body: "abc \xFA"
+
+      Playback:
+      Body: "abc \xFA"
+
+      """
+    And the file "cassettes/example.json" should contain:
+      """
+      "body":{"encoding":"ASCII-8BIT","base64_string":"YWJjIPo=\n"}
+      """
+
+  Scenario: Preserve exact bytes for cassette with `:preserve_exact_body_bytes` option
+    Given a file named "preserve.rb" with:
+      """ruby
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello World" }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.cassette_library_dir = 'cassettes'
+        c.hook_into :fakeweb
+        c.default_cassette_options = { :serialize_with => :json }
+      end
+
+      VCR.use_cassette('preserve_bytes', :preserve_exact_body_bytes => true) do
+        Net::HTTP.get_response(URI("http://localhost:7777/"))
+      end
+
+      VCR.use_cassette('dont_preserve_bytes') do
+        Net::HTTP.get_response(URI("http://localhost:7777/"))
+      end
+      """
+    When I run `ruby preserve.rb`
+    Then the file "cassettes/preserve_bytes.json" should contain:
+      """
+      "body":{"encoding":"US-ASCII","base64_string":"SGVsbG8gV29ybGQ=\n"}
+      """
+     And the file "cassettes/dont_preserve_bytes.json" should contain:
+      """
+      "body":{"encoding":"US-ASCII","string":"Hello World"}
+      """
+

data/features/hooks/after_http_request.feature

@@ -7,13 +7,24 @@ Feature: after_http_request hook
     * ejecting the current cassette (i.e. if you inserted it in a
       `before_http_request` hook)
 
+  You can also pass one or more "filters" to `after_http_request`, to make
+  the hook only be called for some requests. Any object that responds to `#to_proc`
+  can be a filter.  Here are some simple examples:
+
+    * `:real?` -- only real requests
+    * `:stubbed?` -- only stubbed requests
+    * `:ignored?` -- only ignored requests
+    * `:recordable?` -- only requests that are being recorded
+    * `lambda { |req| URI(req.uri).host == 'amazon.com' }` -- only requests to amazon.com.
+
   Scenario Outline: log all requests and responses using after_http_request hook
     Given a file named "after_http_request.rb" with:
       """ruby
       include_http_adapter_for("<http_lib>")
 
       start_sinatra_app(:port => 7777) do
-        get('/') { "Hello World" }
+        get('/foo') { "Hello World (foo)" }
+        get('/bar') { "Hello World (bar)" }
       end
 
       require 'vcr'
@@ -22,15 +33,17 @@ Feature: after_http_request hook
         <configuration>
         c.cassette_library_dir = 'cassettes'
         c.ignore_localhost = true
-        c.after_http_request do |request, response|
+        c.after_http_request(lambda { |req| req.uri =~ /foo/ }) do |request, response|
           puts "Response for #{request.method} #{request.uri}: #{response.body}"
         end
       end
 
-      make_http_request(:get, "http://localhost:7777/")
+      make_http_request(:get, "http://localhost:7777/foo")
+      make_http_request(:get, "http://localhost:7777/bar")
       """
     When I run `ruby after_http_request.rb`
-    Then it should pass with "Response for get http://localhost:7777/: Hello World"
+    Then the output should contain "Response for get http://localhost:7777/foo: Hello World (foo)"
+     But the output should not contain "bar"
 
    Examples:
       | configuration         | http_lib              |

data/features/hooks/around_http_request.feature

@@ -28,6 +28,7 @@ Feature: around_http_request hook
       VCR.configure do |c|
         <configuration>
         c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = { :serialize_with => :syck }
         c.around_http_request do |request|
           VCR.use_cassette('global', :record => :new_episodes, &request)
         end
@@ -42,7 +43,7 @@ Feature: around_http_request hook
       Response for request 1: Response 1
       Response for request 2: Response 1
       """
-    And the file "cassettes/global.yml" should contain "body: Response 1"
+    And the file "cassettes/global.yml" should contain "Response 1"
 
    Examples:
       | configuration         | http_lib              |

data/features/hooks/before_http_request.feature

@@ -7,13 +7,25 @@ Feature: before_http_request hook
     * inserting a particular cassette based on the request URI host
     * raising a timeout error
 
+  You can also pass one or more "filters" to `before_http_request`, to make
+  the hook only be called for some requests. Any object that responds to `#to_proc`
+  can be a filter.  Here are some simple examples:
+
+    * `:real?` -- only real requests
+    * `:stubbed?` -- only stubbed requests
+    * `:ignored?` -- only ignored requests
+    * `:recordable?` -- only requests that are being recorded
+    * `lambda { |r| URI(r.uri).host == 'amazon.com' }` -- only requests to amazon.com.
+
   Scenario Outline: log all requests using a before_http_request hook
     Given a file named "before_http_request.rb" with:
       """ruby
       include_http_adapter_for("<http_lib>")
 
-      start_sinatra_app(:port => 7777) do
-        get('/') { "Hello World" }
+      if ARGV.include?('--with-server')
+        start_sinatra_app(:port => 7777) do
+          get('/') { "Hello World" }
+        end
       end
 
       require 'vcr'
@@ -21,16 +33,21 @@ Feature: before_http_request hook
       VCR.configure do |c|
         <configuration>
         c.cassette_library_dir = 'cassettes'
-        c.ignore_localhost = true
-        c.before_http_request do |request|
-          puts "before request: #{request.method} #{request.uri}"
+        c.before_http_request(:real?) do |request|
+          File.open(ARGV.first, 'w') do |f|
+            f.write("before real request: #{request.method} #{request.uri}")
+          end
         end
       end
 
-      make_http_request(:get, "http://localhost:7777/")
+      VCR.use_cassette('hook_example') do
+        make_http_request(:get, "http://localhost:7777/")
+      end
       """
-    When I run `ruby before_http_request.rb`
-    Then it should pass with "before request: get http://localhost:7777/"
+    When I run `ruby before_http_request.rb run1.log --with-server`
+    Then the file "run1.log" should contain "before real request: get http://localhost:7777/"
+    When I run `ruby before_http_request.rb run2.log`
+    Then the file "run2.log" should not exist
 
    Examples:
       | configuration         | http_lib              |

data/features/hooks/before_playback.feature

@@ -26,24 +26,28 @@ Feature: before_playback hook
   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-Type:
+          headers: 
+            Content-Type: 
             - text/html;charset=utf-8
-            Content-Length:
-            - '20'
-          body: previously recorded response
-          http_version: '1.1'
+            Content-Length: 
+            - "20"
+          body: 
+            encoding: UTF-8
+            string: previously recorded response
+          http_version: "1.1"
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
       """

data/features/hooks/before_record.feature

@@ -46,7 +46,7 @@ Feature: before_record hook
       end
       """
     When I run `ruby before_record_example.rb`
-    Then the file "cassettes/recording_example.yml" should contain "body: Hello World"
+    Then the file "cassettes/recording_example.yml" should contain "Hello World"
      And the file "cassettes/recording_example.yml" should not contain "Earth"
 
   Scenario: Modify recorded response based on the cassette
@@ -72,7 +72,7 @@ Feature: before_record hook
       end
       """
     When I run `ruby before_record_example.rb`
-    Then the file "cassettes/recording_example.yml" should contain "body: Hello Earth (recording_example)"
+    Then the file "cassettes/recording_example.yml" should contain "Hello Earth (recording_example)"
 
   Scenario: Prevent recording by ignoring interaction in before_record hook
     Given a file named "before_record_ignore.rb" with:

data/features/http_libraries/em_http_request.feature

@@ -59,57 +59,69 @@ Feature: EM HTTP Request
       """
     And the file "cassettes/em_http.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
+            Content-Length: 
+            - "9"
+          body: 
+            encoding: UTF-8
+            string: Hello foo
           http_version: 
         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
+            Content-Length: 
+            - "9"
+          body: 
+            encoding: UTF-8
+            string: Hello bar
           http_version: 
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
-      - request:
+      - request: 
           method: get
           uri: http://localhost:7777/bazz
-          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:
-            - '10'
-          body: Hello bazz
+            Content-Length: 
+            - "10"
+          body: 
+            encoding: UTF-8
+            string: Hello bazz
           http_version: 
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0
@@ -154,57 +166,69 @@ Feature: EM HTTP Request
       """
     And the file "cassettes/em_http.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
+            Content-Length: 
+            - "9"
+          body: 
+            encoding: UTF-8
+            string: Hello foo
           http_version: 
         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
+            Content-Length: 
+            - "9"
+          body: 
+            encoding: UTF-8
+            string: Hello bar
           http_version: 
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
-      - request:
+      - request: 
           method: get
           uri: http://localhost:7777/bazz
-          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:
-            - '10'
-          body: Hello bazz
+            Content-Length: 
+            - "10"
+          body: 
+            encoding: UTF-8
+            string: Hello bazz
           http_version: 
         recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
       recorded_with: VCR 2.0.0