vcr 3.0.3 → 6.1.0

data/features/Upgrade.md

@@ -1,289 +0,0 @@
-See the [Changelog](changelog) for a complete list of changes from VCR
-1.x to 2.0. This file simply lists the most pertinent ones to upgrading.
-
-## Supported Rubies
-
-Ruby 1.8.6 and 1.9.1 are no longer supported.
-
-## Configuration Changes
-
-In VCR 1.x, your configuration block would be something like this:
-
-``` ruby
-VCR.config do |c|
-  c.cassette_library_dir = 'cassettes'
-  c.stub_with :fakeweb, :typhoeus
-end
-```
-
-This will continue to work in VCR 2.0 but will generate deprecation
-warnings. Instead, you should change this to:
-
-``` ruby
-VCR.configure do |c|
-  c.cassette_library_dir = 'cassettes'
-  c.hook_into :fakeweb, :typhoeus
-end
-```
-
-## New Cassette Format
-
-The cassette format has changed between VCR 1.x and VCR 2.0.
-VCR 1.x cassettes cannot be used with VCR 2.0.
-
-The easiest way to upgrade is to simply delete your cassettes and
-re-record all of them. VCR also provides a rake task that attempts
-to upgrade your 1.x cassettes to the new 2.0 format. To use it, add
-the following line to your Rakefile:
-
-``` ruby
-load 'vcr/tasks/vcr.rake'
-```
-
-Then run `rake vcr:migrate_cassettes DIR=path/to/your/cassettes/directory` to
-upgrade your cassettes. Note that this rake task may be unable to
-upgrade some cassettes that make extensive use of ERB. In addition, now
-that VCR 2.0 does less normalization then before, it may not be able to
-migrate the cassette perfectly. It's recommended that you delete and
-re-record your cassettes if you are able.
-
-## Custom Request Matchers
-
-VCR 2.0 allows you to register custom request matchers:
-
-``` ruby
-VCR.configure do |c|
-  c.register_request_matcher :port do |request_1, request_2|
-    URI(request_1.uri).port == URI(request_2.uri).port
-  end
-end
-```
-
-You can also pass any callable (an object that responds to #call, such as a lambda)
-to the `:match_requests_on` option:
-
-``` ruby
-port_matcher = lambda do |request_1, request_2|
-  URI(request_1.uri).port == URI(request_2.uri).port
-end
-
-VCR.use_cassette("example", :match_requests_on => [:host, port_matcher, :method]) do
-  # make an HTTP request
-end
-```
-
-In addition, a helper method is provided for generating a custom
-matcher that ignores one or more query parameters:
-
-``` ruby
-uri_without_timestamp = VCR.request_matchers.uri_without_param(:timestamp)
-VCR.configure do |c|
-  c.register_request_matcher(:uri_without_timestamp, &uri_without_timestamp)
-end
-```
-
-## Custom Serializers
-
-VCR 2.0 supports multiple serializers. `:yaml`, `:json`, `:psych` and
-`:syck` are supported out of the box, and it's easy to implement your
-own. Custom serializers must implement `#file_extension`, `#serialize`
-and `#deserialize`:
-
-``` ruby
-VCR.use_cassette("example", :serialize_with => :json) do
-  # make an HTTP request
-end
-
-marshal_serializer = Object.new
-marshal_serializer.instance_eval do
-  def file_extension
-    "marsh"
-  end
-
-  def serialize(hash)
-    Marshal.dump(hash)
-  end
-
-  def deserialize(string)
-    Marshal.load(string)
-  end
-end
-
-VCR.configure do |c|
-  c.cassette_serializers[:marshal] = marshal_serializer
-  c.default_cassette_options = { :serialize_with => :marshal }
-end
-```
-
-## Request Hooks
-
-VCR 2.0 has new request hooks, allowing you to inject custom logic
-before an HTTP request, after an HTTP request, or around an HTTP
-request:
-
-``` ruby
-VCR.configure do |c|
-  c.before_http_request do |request|
-    # do something with the request
-  end
-
-  c.after_http_request do |request, response|
-    # do something with the request or response
-  end
-
-  # around_http_request only works on ruby 1.9
-  c.around_http_request do |request|
-    uri = URI(request.uri)
-    if uri.host == 'api.geocoder.com'
-      # extract an address like "1700 E Pine St, Seattle, WA"
-      # from a query like "address=1700+E+Pine+St%2C+Seattle%2C+WA"
-      address = CGI.unescape(uri.query.split('=').last)
-      VCR.use_cassette("geocoding/#{address}", &request)
-    else
-      request.proceed
-    end
-  end
-end
-```
-
-## Ignore a Request Based on Anything
-
-You can now define what requests get ignored using a block. This
-gives you the flexibility to ignore a requets based on anything.
-
-``` ruby
-VCR.configure do |c|
-  c.ignore_request do |request|
-    uri = URI(request.uri)
-    uri.host == 'localhost' && uri.port == 7500
-  end
-end
-```
-
-## Integration with RSpec 2 Metadata
-
-VCR can integrate directly with RSpec metadata:
-
-``` ruby
-VCR.configure do |c|
-  c.configure_rspec_metadata!
-end
-
-RSpec.configure do |c|
-  # so we can use `:vcr` rather than `:vcr => true`;
-  # in RSpec 3 this will no longer be necessary.
-  c.treat_symbols_as_metadata_keys_with_true_values = true
-end
-
-# apply it to an example group
-describe MyAPIWrapper, :vcr do
-end
-
-describe MyAPIWrapper do
-  # apply it to an individual example
-  it "does something", :vcr do
-  end
-
-  # set some cassette options
-  it "does something", :vcr => { :record => :new_episodes } do
-  end
-
-  # override the cassette name
-  it "does something", :vcr => { :cassette_name => "something" } do
-  end
-end
-```
-
-## Improved Faraday Integration
-
-VCR 1.x integrated with Faraday but required that you insert
-`VCR::Middleware::Faraday` into your middleware stack and configure
-`stub_with :faraday`. VCR 2 now takes care of inserting itself
-into the Faraday middleware stack if you configure `hook_into :faraday`.
-
-## Improved Unhandled Error Messages
-
-When VCR is unsure how to handle a request, the error message now contains
-suggestions for how you can configure VCR or your test so it can handle
-the request.
-
-## Debug Logger
-
-VCR 2.0 has a new configuration option that will turn on a logging mode
-so you can get more insight into what VCR is doing, for troubleshooting
-purposes:
-
-``` ruby
-VCR.configure do |c|
-  c.debug_logger = File.open('log/vcr.log')
-  # or...
-  c.debug_logger = $stderr
-end
-```
-
-## Playback Changes
-
-In VCR 1.x, a single HTTP interaction could be played back multiple
-times. This was mostly due to how VCR was implemented using FakeWeb
-and WebMock, and was not really by design. It's more in keeping with
-the philosophy of VCR to record the entire sequence of HTTP interactions
-(including the duplicate requests). In VCR 2, each recorded HTTP
-interaction can only be played back once unless you use the new
-`:allow_playback_repeats` option.
-
-In VCR 1.x, request matching was delegated to the HTTP stubbing library
-(typically FakeWeb or WebMock). They contain some normalization logic
-that can treat some URIs that are different strings as equivalent.
-For example, WebMock ignores the ordering of query parameters:
-
-``` ruby
-> require 'webmock'
- => true
-> uri1 = "http://foo.com/bar?a=1&b=2"
- => "http://foo.com/bar?a=1&b=2"
-> uri2 = "http://foo.com/bar?b=2&a=1"
- => "http://foo.com/bar?b=2&a=1"
-> uri1 == uri2
- => false
-> WebMock::Util::URI.normalize_uri(uri1) == WebMock::Util::URI.normalize_uri(uri2)
- => true
-```
-
-VCR 2, the `:uri` matcher simply [uses string
-equality](https://github.com/myronmarston/vcr/blob/v2.0.0/lib/vcr/request_matcher_registry.rb#L111).
-This means that there are some cases of non-deterministic URIs that VCR
-1.x matched but VCR 2.0 will not match. If you need the `:uri` matcher
-to be tolerant of slight variations like these, you can easily override
-it:
-
-``` ruby
-VCR.configure do |c|
-  c.register_request_matcher(:uri) do |r1, r2|
-    WebMock::Util::URI.normalize_uri(r1.uri) == WebMock::Util::URI.normalize_uri(r2.uri)
-  end
-end
-```
-
-## Preserve Exact Body Bytes
-
-Sometimes the request or response body of an HTTP interaction cannot
-be serialized and deserialized properly. Usually this is due to the body
-having invalid UTF-8 bytes. This new option configures VCR to base64
-encode the body in order to preserve the bytes exactly. It can either
-be configured globally with a block, or set on individual cassettes:
-
-``` ruby
-VCR.configure do |c|
-  c.preserve_exact_body_bytes do |http_message|
-    http_message.body.encoding.name == 'ASCII-8BIT' ||
-    !http_message.body.valid_encoding?
-  end
-end
-
-# or....
-
-VCR.use_cassette("my_cassette", :preserve_exact_body_bytes => true) do
-  # ...
-end
-```
-

data/features/about_these_examples.md

@@ -1,18 +0,0 @@
-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 `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
-  examples re-run the script without the sinatra server to demonstrate
-  the replaying of a recorded HTTP response.
-* `include_http_adapter_for`: includes a module that implements a common
-  HTTP interface for the given HTTP library.  The `response_body_for`
-  method will make an HTTP request using the given library.  This
-  allows scenarios to be run against each different supported HTTP
-  library.
-
-If you have ideas to clarify or improve any of these cucumber features,
-please submit an [issue](https://github.com/vcr/vcr/issues) or pull request.

data/features/cassettes/allow_unused_http_interactions.feature

@@ -1,100 +0,0 @@
-Feature: Allow Unused HTTP Interactions
-
-  If set to false, this cassette option will cause VCR to raise an error
-  when a cassette is ejected and there are unused HTTP interactions remaining,
-  unless there is already an exception unwinding the callstack.
-
-  It verifies that all requests included in the cassette were made, and allows
-  VCR to function a bit like a mock object at the HTTP layer.
-
-  The option defaults to true (mostly for backwards compatibility).
-
-  Background:
-    Given a file named "vcr_config.rb" with:
-      """ruby
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-      """
-    And a previously recorded cassette file "cassettes/example.yml" with:
-      """
-      --- 
-      http_interactions: 
-      - request: 
-          method: get
-          uri: http://example.com/foo
-          body: 
-            encoding: UTF-8
-            string: ""
-          headers: {}
-        response: 
-          status: 
-            code: 200
-            message: OK
-          headers: 
-            Content-Length: 
-            - "5"
-          body: 
-            encoding: UTF-8
-            string: Hello
-          http_version: "1.1"
-        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
-      recorded_with: VCR 2.0.0
-      """
-
-  Scenario: Unused HTTP interactions are allowed by default
-    Given a file named "allowed_by_default.rb" with:
-      """ruby
-      require 'vcr_config'
-
-      VCR.use_cassette("example") do
-        # no requests
-      end
-      """
-    When I run `ruby allowed_by_default.rb`
-    Then it should pass
-
-  Scenario: Error raised if option is false and there are unused interactions
-    Given a file named "disallowed_with_no_requests.rb" with:
-      """ruby
-      require 'vcr_config'
-
-      VCR.use_cassette("example", :allow_unused_http_interactions => false) do
-        # no requests
-      end
-      """
-    When I run `ruby disallowed_with_no_requests.rb`
-    Then it should fail with an error like:
-      """
-      There are unused HTTP interactions left in the cassette:
-        - [get http://example.com/foo] => [200 "Hello"]
-      """
-
-  Scenario: No error raised if option is false and all interactions are used
-    Given a file named "disallowed_with_all_requests.rb" with:
-      """ruby
-      require 'vcr_config'
-
-      VCR.use_cassette("example", :allow_unused_http_interactions => false) do
-        Net::HTTP.get_response(URI("http://example.com/foo"))
-      end
-      """
-    When I run `ruby disallowed_with_all_requests.rb`
-    Then it should pass
-
-  Scenario: Does not silence other errors raised in `use_cassette` block
-    Given a file named "does_not_silence_other_errors.rb" with:
-      """ruby
-      require 'vcr_config'
-
-      VCR.use_cassette("example", :allow_unused_http_interactions => false) do
-        raise "boom"
-      end
-      """
-    When I run `ruby does_not_silence_other_errors.rb`
-    Then it should fail with "boom"
-     And the output should not contain "There are unused HTTP interactions"
-

data/features/cassettes/automatic_re_recording.feature

@@ -1,72 +0,0 @@
-Feature: Automatic Re-recording
-
-  Over time, your cassettes may get out-of-date. APIs change and sites you
-  scrape get updated. VCR provides a facility to automatically re-record your
-  cassettes. Enable re-recording using the `:re_record_interval` option.
-
-  The value provided should be an interval (expressed in seconds) that
-  determines how often VCR will re-record the cassette.  When a cassette
-  is used, VCR checks the earliest `recorded_at` timestamp in the cassette;
-  if more time than the interval has passed since that timestamp,
-  VCR will use the `:all` record mode to cause it be re-recorded.
-
-  Background:
-    Given a previously recorded cassette file "cassettes/example.yml" with:
-      """
-      --- 
-      http_interactions: 
-      - request: 
-          method: get
-          uri: http://localhost/
-          body: 
-            encoding: UTF-8
-            string: ""
-          headers: {}
-        response: 
-          status: 
-            code: 200
-            message: OK
-          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
-      """
-    And a file named "re_record.rb" with:
-      """ruby
-      $server = start_sinatra_app do
-        get('/') { 'New Response' }
-      end
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      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
-      """
-
-  Scenario: Cassette is not re-recorded when not enough time has passed
-    Given it is Tue, 07 Nov 2011
-    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 "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 "New Response"
-    But the file "cassettes/example.yml" should not contain "Old Response"
-

data/features/cassettes/decompress.feature

@@ -1,74 +0,0 @@
-Feature: Decode compressed response
-
-  When the `:decode_compressed_response` option is set to a truthy value, VCR
-  will decompress "gzip" and "deflate" response bodies before recording.  This
-  ensures that these interactions become readable and editable after being
-  serialized.
-
-  This option should be avoided if the actual decompression of response bodies
-  is part of the functionality of the library or app being tested.
-
-  Background:
-    Given a file named "decompress.rb" with:
-      """ruby
-      require 'zlib'
-      require 'stringio'
-
-      $server = start_sinatra_app do
-        get('/') {
-          content = 'The quick brown fox jumps over the lazy dog'
-          io = StringIO.new
-
-          writer = Zlib::GzipWriter.new(io)
-          writer << content
-          writer.close
-
-          headers['Content-Encoding'] = 'gzip'
-          io.string
-        }
-      end
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.cassette_library_dir = 'cassettes'
-        c.hook_into :webmock
-        c.default_cassette_options = { :serialize_with => :syck }
-      end
-      """
-
-  Scenario: The option is not set by default
-    When I append to file "decompress.rb":
-      """ruby
-      VCR.use_cassette(:decompress) do
-        Net::HTTP.start('localhost', $server.port) do |http|
-          http.get('/', 'accept-encoding' => 'identity')
-        end
-      end
-      """
-    And I run `ruby decompress.rb`
-    Then the file "cassettes/decompress.yml" should contain a YAML fragment like:
-      """
-      Content-Encoding:
-      - gzip
-      """
-
-  Scenario: The option is enabled
-    When I append to file "decompress.rb":
-      """ruby
-      VCR.use_cassette(:decompress, :decode_compressed_response => true) do
-        Net::HTTP.start('localhost', $server.port) do |http|
-          http.get('/', 'accept-encoding' => 'identity')
-        end
-      end
-      """
-    And I run `ruby decompress.rb`
-    Then the file "cassettes/decompress.yml" should contain a YAML fragment like:
-      """
-      Content-Length:
-      - '43'
-      """
-    And the file "cassettes/decompress.yml" should contain:
-      """
-      string: The quick brown fox jumps over the lazy dog
-      """

data/features/cassettes/dynamic_erb.feature

@@ -1,100 +0,0 @@
-Feature: Dynamic ERB cassettes
-
-  By default, cassettes are static: the exact response that was received
-  when the cassette was recorded will be replayed for all future requests.
-  Usually, this is fine, but in some cases you need something more dynamic.
-  You can use ERB for this.
-
-  To enable ERB evaluation of a cassette, pass the `:erb => true` option
-  to a cassette.  If you want to pass variables to the cassette, you can
-  pass the names and values of the variables in a hash (`:erb => { ... }`).
-
-  Scenario: Enable dynamic ERB cassette evalutation using :erb => true
-    Given a previously recorded cassette file "cassettes/dynamic.yml" with:
-      """
-      ---
-      http_interactions:
-      - request:
-          method: get
-          uri: http://example.com/foo?a=<%= 'b' * 3 %>
-          body:
-            encoding: UTF-8
-            string: ''
-          headers: {}
-        response:
-          status:
-            code: 200
-            message: OK
-          headers:
-            Content-Type:
-            - text/html;charset=utf-8
-            Content-Length:
-            - '9'
-          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
-      """
-    And a file named "dynamic_erb_example.rb" with:
-      """ruby
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      VCR.use_cassette('dynamic', :erb => true) do
-        response = Net::HTTP.get_response('example.com', '/foo?a=bbb')
-        puts "Response: #{response.body}"
-      end
-      """
-    When I run `ruby dynamic_erb_example.rb`
-    Then it should pass with "Response: Hello bas"
-
-  Scenario: Pass arguments to the ERB using :erb => { ... }
-    Given a previously recorded cassette file "cassettes/dynamic.yml" with:
-      """
-      ---
-      http_interactions:
-      - request:
-          method: get
-          uri: http://example.com/foo?a=<%= arg1 %>
-          body:
-            encoding: UTF-8
-            string: ''
-          headers: {}
-        response:
-          status:
-            code: 200
-            message: OK
-          headers:
-            Content-Type:
-            - text/html;charset=utf-8
-            Content-Length:
-            - '9'
-          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
-      """
-    And a file named "dynamic_erb_example.rb" with:
-      """ruby
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      VCR.use_cassette('dynamic', :erb => { :arg1 => 7, :arg2 => 'baz' }) do
-        response = Net::HTTP.get_response('example.com', '/foo?a=7')
-        puts "Response: #{response.body}"
-      end
-      """
-    When I run `ruby dynamic_erb_example.rb`
-    Then it should pass with "Response: Hello baz"