vcr 3.0.3 → 4.0.0

data/features/configuration/preserve_exact_body_bytes.feature

@@ -1,108 +0,0 @@
-@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?}"
-
-      $server = start_sinatra_app do
-        get('/') { string }
-      end
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.cassette_library_dir = 'cassettes'
-        c.hook_into :webmock
-        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('localhost', '/', $server.port).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
-      $server = start_sinatra_app do
-        get('/') { "Hello World" }
-      end
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.cassette_library_dir = 'cassettes'
-        c.hook_into :webmock
-        c.default_cassette_options = { :serialize_with => :json }
-
-        c.before_record do |i|
-          # otherwise Ruby 2.0 will default to UTF-8:
-          i.response.body.force_encoding('US-ASCII')
-        end
-      end
-
-      VCR.use_cassette('preserve_bytes', :preserve_exact_body_bytes => true) do
-        Net::HTTP.get_response('localhost', '/', $server.port)
-      end
-
-      VCR.use_cassette('dont_preserve_bytes') do
-        Net::HTTP.get_response('localhost', '/', $server.port)
-      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/configuration/query_parser.feature

@@ -1,84 +0,0 @@
-Feature: query_parser
-
-  By default, VCR will parse query strings using `CGI.parse` from the Ruby
-  standard library. This may not be the most optimal or performant library
-  available.  You can set the `query_parser` configuration option to use a
-  different parser (such as `Rack::Utils.method(:parse_query)`) to decode,
-  normalize, and/or provide a comparison object for query strings.
-
-  The configured query parser needs to expose a `.call` method that returns an
-  object which is comparable. This instance needs to implement the following
-  API:
-
-    * `#==`     => boolean
-
-  Background:
-    Given a file named "cassettes/example.yml" with:
-      """
-      ---
-      http_interactions:
-      - request:
-          method: get
-          uri: http://url.example.com/?bravo=2&alpha=1
-          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, 25 Sep 2012 04:58:44 GMT
-      recorded_with: VCR 2.2.5
-      """
-
-  Scenario: the VCR query parser gets its value from `query_parser`
-    Given a file named "query_parser.rb" with:
-      """ruby
-      require 'vcr'
-      require 'rack'
-
-      VCR.configure do |c|
-        c.query_parser = lambda { |query| raise query.inspect }
-        c.default_cassette_options = {:match_requests_on => [:query]}
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      uri = URI.parse('http://other-url.example.com/?bravo=2&alpha=1')
-      VCR.use_cassette('example') do
-        puts Net::HTTP.get_response(uri).body
-      end
-      """
-     When I run `ruby query_parser.rb`
-     Then it should fail with an error like:
-     """
-     "alpha=1&bravo=2"
-     """
-
-
-  Scenario: the `query_parser` defaults to the standard library's `CGI.parse`
-    Given a file named "query_parser_default.rb" with:
-      """ruby
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.default_cassette_options = {:match_requests_on => [:query]}
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      uri = URI.parse('http://other-url.example.com/?bravo=2&alpha=1')
-      VCR.use_cassette('example') do
-        puts Net::HTTP.get_response(uri).body
-      end
-      """
-     When I run `ruby query_parser_default.rb`
-     Then it should pass with "Hello"

data/features/configuration/uri_parser.feature

@@ -1,93 +0,0 @@
-Feature: uri_parser
-
-  By default, VCR will parse URIs using `URI` from the Ruby standard
-  library. There are some URIs seen out in the wild that `URI` cannot
-  parse properly. You can set the `uri_parser` configuration option
-  to use a different parser (such as `Addressable::URI`) to work with
-  these URIs.
-
-  The configured URI parser needs to expose a `.parse` class method
-  that returns an instance of the uri. This uri instance needs to
-  implement the following API:
-
-    * `#scheme` => a string
-    * `#host`   => a string
-    * `#port`   => a fixnum
-    * `#path`   => a string
-    * `#query`  => a string
-    * `#to_s`   => a string
-    * `#port=`
-    * `#query=`
-    * `#==`     => boolean
-
-  Background:
-    Given a file named "cassettes/example.yml" with:
-      """
-      ---
-      http_interactions:
-      - request:
-          method: get
-          uri: http://example.com/hello
-          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, 25 Sep 2012 04:58:44 GMT
-      recorded_with: VCR 2.2.5
-      """
-
-  Scenario: the VCR uri parser gets its value from `uri_parser`
-    Given a file named "uri_parser.rb" with:
-      """ruby
-      require 'vcr'
-      require 'uri'
-
-      module MyURI
-        def self.parse(url)
-          uri = URI.parse(url)
-          uri.host = 'example.com'
-          uri.path = '/hello'
-          uri
-        end
-      end
-
-      VCR.configure do |c|
-        c.uri_parser = MyURI
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      VCR.use_cassette('example') do
-        puts Net::HTTP.get_response('evil.org', '/projects').body
-      end
-      """
-     When I run `ruby uri_parser.rb`
-     Then it should pass with "Hello"
-
-  Scenario: the `uri_parser` defaults to the standard library's `URI`
-    Given a file named "uri_parser_default.rb" with:
-      """ruby
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.hook_into :webmock
-        c.cassette_library_dir = 'cassettes'
-      end
-
-      VCR.use_cassette('example') do
-        puts Net::HTTP.get_response('example.com', '/hello').body
-      end
-      """
-     When I run `ruby uri_parser_default.rb`
-     Then it should pass with "Hello"

data/features/getting_started.md

@@ -1,82 +0,0 @@
-### Install it
-
-    [sudo] gem install vcr
-    [sudo] gem install webmock
-
-### Configure it
-
-Create a file named `vcr_setup.rb` with content like:
-
-    require 'vcr'
-
-    VCR.configure do |c|
-      c.cassette_library_dir = 'vcr_cassettes'
-      c.hook_into :webmock
-    end
-
-Ensure this file is required by your test suite before any
-of the tests are run.
-
-### Use it
-
-Run your tests.  Any tests that make HTTP requests using Net::HTTP will
-raise errors like:
-
-    ================================================================================
-    An HTTP request has been made that VCR does not know how to handle:
-      GET http://example.com/
-
-    There is currently no cassette in use. There are a few ways
-    you can configure VCR to handle this request:
-
-      * If you want VCR to record this request and play it back during future test
-        runs, you should wrap your test (or this portion of your test) in a
-        `VCR.use_cassette` block [1].
-      * If you only want VCR to handle requests made while a cassette is in use,
-        configure `allow_http_connections_when_no_cassette = true`. VCR will
-        ignore this request since it is made when there is no cassette [2].
-      * If you want VCR to ignore this request (and others like it), you can
-        set an `ignore_request` callback [3].
-
-    [1] https://www.relishapp.com/myronmarston/vcr/v/2-0-0/docs/getting-started
-    [2] https://www.relishapp.com/myronmarston/vcr/v/2-0-0/docs/configuration/allow-http-connections-when-no-cassette
-    [3] https://www.relishapp.com/myronmarston/vcr/v/2-0-0/docs/configuration/ignore-request
-    ================================================================================
-
-Find one of these tests (preferably one that uses the same HTTP method and
-request URL every time--if not, you'll have to configure the request matcher).
-Wrap the body of it (or at least the code that makes the HTTP request) in a
-`VCR.use_cassette` block:
-
-    VCR.use_cassette('whatever cassette name you want') do
-       # the body of the test would go here...
-    end
-
-Run this test.  It will record the HTTP request to disk as a cassette (a
-test fixture), with content like:
-
-    ---
-    http_interactions:
-    - request:
-        method: get
-        uri: http://example.com/
-        body: ''
-        headers: {}
-      response:
-        status:
-          code: 200
-          message: OK
-        headers:
-          Content-Type:
-          - text/html;charset=utf-8
-          Content-Length:
-          - '26'
-        body: This is the response body
-        http_version: '1.1'
-      recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
-    recorded_with: VCR 2.0.0
-
-Disconnect your computer from the internet.  Run the test again.
-It should pass since VCR is automatically replaying the recorded
-response when the request is made.
-

data/features/hooks/after_http_request.feature

@@ -1,58 +0,0 @@
-Feature: after_http_request hook
-
-  The `after_http_request` hook gets called with each request and response
-  just after a request has completed. It can be used for many things:
-
-    * globally logging requests and responses
-    * 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>")
-
-      $server = start_sinatra_app do
-        get('/foo') { "Hello World (foo)" }
-        get('/bar') { "Hello World (bar)" }
-      end
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        <configuration>
-        c.cassette_library_dir = 'cassettes'
-        c.ignore_localhost = true
-        c.after_http_request(:ignored?, lambda { |req| req.uri =~ /foo/ }) do |request, response|
-          uri = request.uri.sub(/:\d+/, ":7777")
-          puts "Response for #{request.method} #{uri}: #{response.body}"
-        end
-      end
-
-      make_http_request(:get, "http://localhost:#{$server.port}/foo")
-      make_http_request(:get, "http://localhost:#{$server.port}/bar")
-      """
-    When I run `ruby after_http_request.rb`
-    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              |
-      | c.hook_into :fakeweb  | net/http              |
-      | c.hook_into :webmock  | net/http              |
-      | c.hook_into :webmock  | httpclient            |
-      | c.hook_into :webmock  | curb                  |
-      | c.hook_into :typhoeus | typhoeus              |
-      | c.hook_into :excon    | excon                 |
-      | c.hook_into :faraday  | faraday (w/ net_http) |
-

data/features/hooks/around_http_request.feature

@@ -1,57 +0,0 @@
-@exclude-1.9.3p327
-Feature: around_http_request hook
-
-  The `around_http_request` hook wraps each HTTP request. It can be used
-  rather than separate `before_http_request` and `after_http_request` hooks
-  to simplify wrapping/transactional logic (such as using a VCR cassette).
-
-  In your block, call `#proceed` on the yielded request to cause it to continue.
-  Alternately, you can treat the request as a proc and pass it on to a method that
-  expects a block by prefixing it with an ampersand (`&request`).
-
-  Note that `around_http_request` will not work on Ruby 1.8.  It uses a fiber
-  under the covers and thus is only available on interpreters that support fibers.
-  On 1.8, you can use separate `before_http_request` and `after_http_request` hooks.
-
-  Scenario Outline: globally handle requests using an around_http_request hook
-    Given a file named "globally_handle_requests.rb" with:
-      """ruby
-      include_http_adapter_for("<http_lib>")
-
-      request_count = 0
-      $server = start_sinatra_app do
-        get('/') { "Response #{request_count += 1 }" }
-      end
-
-      require 'vcr'
-
-      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
-      end
-
-      puts "Response for request 1: " + response_body_for(:get, "http://localhost:#{$server.port}/")
-      puts "Response for request 2: " + response_body_for(:get, "http://localhost:#{$server.port}/")
-      """
-    When I run `ruby globally_handle_requests.rb`
-    Then it should pass with:
-      """
-      Response for request 1: Response 1
-      Response for request 2: Response 1
-      """
-    And the file "cassettes/global.yml" should contain "Response 1"
-
-   Examples:
-      | configuration         | http_lib              |
-      | c.hook_into :fakeweb  | net/http              |
-      | c.hook_into :webmock  | net/http              |
-      | c.hook_into :webmock  | httpclient            |
-      | c.hook_into :webmock  | curb                  |
-      | c.hook_into :typhoeus | typhoeus              |
-      | c.hook_into :excon    | excon                 |
-      | c.hook_into :faraday  | faraday (w/ net_http) |
-