vcr 2.3.0 → 2.4.0

data/features/request_matching/README.md

@@ -14,6 +14,8 @@ Specify an array of attributes to match on.  Supported attributes are:
   - `:path` - The path of the URI. You can use this (alone, or in combination
     with `:host`) as an alternative to `:uri` to cause VCR to match using a regex
     that matches the path.
+  - `:query` - The query string values of the URI. The query string ordering does
+    not affect matching results (it's order-agnostic).
   - `:body` - The body of the request.
   - `:headers` - The request headers.
 

data/features/request_matching/query.feature

@@ -0,0 +1,97 @@
+Feature: Matching on Query string
+
+  Use the `:query` request matcher to match requests on the query string
+  portion of the request URI.
+
+  You can use this (alone, or in combination with others) as an
+  alternative to `:uri` so that non-deterministic portions of the URI
+  are not considered as part of the request matching.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      ---
+      http_interactions:
+      - request:
+          method: post
+          uri: http://host1.com/query?date=2011-09-01
+          body:
+            encoding: UTF-8
+            string: ""
+          headers: {}
+        response:
+          status:
+            code: 200
+            message: OK
+          headers:
+            Content-Length:
+            - "19"
+          body:
+            encoding: UTF-8
+            string: 2011-09-01 response
+          http_version: "1.1"
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      - request:
+          method: post
+          uri: http://host1.com/query?date=2011-09-02
+          body:
+            encoding: UTF-8
+            string: ""
+          headers: {}
+        response:
+          status:
+            code: 200
+            message: OK
+          headers:
+            Content-Length:
+            - "19"
+          body:
+            encoding: UTF-8
+            string: 2011-09-02 response
+          http_version: "1.1"
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
+      """
+
+  Scenario Outline: Replay interaction that matches the query string
+    And a file named "query_matching.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        <configuration>
+        c.default_cassette_options = { :match_requests_on => [:query] }
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:query]) do
+        puts "Response for 2011-09-01 /query: " + response_body_for(:get, "http://example.com/query?date=2011-09-01")
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:query]) do
+        puts "Response for 2011-09-02 /query: " + response_body_for(:get,  "http://example.com/query?date=2011-09-02")
+      end
+      """
+    When I run `ruby query_matching.rb`
+    Then it should pass with:
+      """
+      Response for 2011-09-01 /query: 2011-09-01 response
+      Response for 2011-09-02 /query: 2011-09-02 response
+      """
+
+    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 :webmock  | patron                |
+      | c.hook_into :webmock  | em-http-request       |
+      | c.hook_into :webmock  | typhoeus              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :excon    | excon                 |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
+

data/gemfiles/{typhoeus-old.gemfile → typhoeus_old.gemfile}

@@ -8,10 +8,8 @@ gem "yard"
 gem "relish", "~> 0.6"
 gem "fuubar"
 gem "fuubar-cucumber"
-gem "redcarpet", "~> 1.17.2"
+gem "redcarpet", "~> 1.17.2", :platforms=>:ruby
 gem "github-markup"
-gem "ruby-debug", :platforms=>[:mri_18, :jruby]
-gem "debugger", :platforms=>:mri_19
 gem "typhoeus", "~> 0.4.2"
 gem "webmock", "1.8.11"
 

data/gemfiles/{typhoeus-old.gemfile.lock → typhoeus_old.gemfile.lock}

@@ -1,13 +1,13 @@
 PATH
-  remote: /Users/myron/code/vcr
+  remote: /Users/hungerandthirst/Code/Ruby/vcr
   specs:
-    vcr (2.2.5)
+    vcr (2.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.2)
-    appraisal (0.4.1)
+    appraisal (0.5.1)
       bundler
       rake
     archive-tar-minitar (0.5.2)
@@ -19,6 +19,7 @@ GEM
     builder (3.1.4)
     childprocess (0.3.6)
       ffi (~> 1.0, >= 1.0.6)
+    coderay (1.0.8)
     columnize (0.3.6)
     cookiejar (0.3.0)
     crack (0.3.1)
@@ -28,14 +29,14 @@ GEM
       gherkin (~> 2.9.0)
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
-    curb (0.8.1)
-    debugger (1.2.1)
+    curb (0.8.3)
+    debugger (1.2.2)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.4)
+      debugger-ruby_core_source (~> 1.1.5)
     debugger-linecache (1.1.2)
       debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.4)
+    debugger-ruby_core_source (1.1.5)
     diff-lcs (1.1.3)
     em-http-request (1.0.3)
       addressable (>= 2.2.3)
@@ -46,11 +47,11 @@ GEM
     em-socksify (0.2.1)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.0.0)
-    excon (0.16.7)
+    excon (0.16.10)
     fakeweb (1.3.0)
     faraday (0.8.4)
       multipart-post (~> 1.1)
-    ffi (1.1.5)
+    ffi (1.2.0)
     fuubar (1.0.0)
       rspec (~> 2.0)
       rspec-instafail (~> 0.2.0)
@@ -66,14 +67,19 @@ GEM
     json (1.6.7)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
+    method_source (0.8.1)
     mime-types (1.19)
     multi_json (1.0.4)
     multipart-post (1.1.5)
     patron (0.4.18)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
     rack (1.3.6)
     rack-protection (1.2.0)
       rack
-    rake (0.9.2.2)
+    rake (0.9.5)
     rbx-require-relative (0.0.9)
     redcarpet (1.17.2)
     redis (2.2.2)
@@ -83,15 +89,15 @@ GEM
       rest-client (>= 1.6.1)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-instafail (0.2.4)
-    rspec-mocks (2.11.3)
+    rspec-mocks (2.12.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -107,6 +113,7 @@ GEM
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
+    slop (3.3.3)
     term-ansicolor (1.0.7)
     tilt (1.3.3)
     timecop (0.3.5)
@@ -141,6 +148,7 @@ DEPENDENCIES
   json (~> 1.6.5)
   multi_json (~> 1.0.3)
   patron (~> 0.4.15)
+  pry
   rack (~> 1.3.6)
   rake (~> 0.9.2)
   redcarpet (~> 1.17.2)

data/lib/vcr.rb

@@ -24,7 +24,11 @@ module VCR
 
   autoload :CucumberTags,       'vcr/test_frameworks/cucumber'
   autoload :InternetConnection, 'vcr/util/internet_connection'
-  autoload :RSpec,              'vcr/test_frameworks/rspec'
+
+  module RSpec
+    autoload :Metadata,              'vcr/test_frameworks/rspec'
+    autoload :Macros,                'vcr/deprecations'
+  end
 
   module Middleware
     autoload :Faraday,           'vcr/middleware/faraday'

data/lib/vcr/configuration.rb

@@ -1,5 +1,6 @@
 require 'vcr/util/hooks'
 require 'uri'
+require 'cgi'
 
 module VCR
   # Stores the VCR configuration.
@@ -124,6 +125,24 @@ module VCR
       !!@allow_http_connections_when_no_cassette
     end
 
+    # Sets a parser for VCR to use when parsing query strings for request
+    # comparisons.  The new parser must implement a method `call` that returns
+    # an object which is both equalivant and consistent when given an HTTP
+    # query string of possibly differing value ordering.
+    #
+    # * `#==    # => Boolean`
+    #
+    # The `#==` method must return true if both objects represent the
+    # same query string.
+    #
+    # This defaults to `CGI.parse` from the ruby standard library.
+    #
+    # @overload query_parser
+    #  @return [#call] the current query string parser object
+    # @overload query_parser=
+    #  @param value [#call] sets the query_parser
+    attr_accessor :query_parser
+
     # Sets a parser for VCR to use when parsing URIs. The new parser
     # must implement a method `parse` that returns an instance of the
     # URI object. This URI object must implement the following
@@ -452,6 +471,7 @@ module VCR
       }
 
       self.uri_parser = URI
+      self.query_parser = CGI.method(:parse)
       self.debug_logger = NullDebugLogger
 
       register_built_in_hooks

data/lib/vcr/deprecations.rb

@@ -24,7 +24,7 @@ module VCR
     # @deprecated Use #hook_into instead.
     # @see #hook_into
     def stub_with(*adapters)
-      warn "WARNING: `VCR.config { |c| c.stub_with ... }` is deprecated. Use `VCR.configure { |c| c.hook_into ... }` instead."
+      warn "WARNING: `VCR.configure { |c| c.stub_with ... }` is deprecated. Use `VCR.configure { |c| c.hook_into ... }` instead."
       hook_into(*adapters)
     end
   end
@@ -43,5 +43,66 @@ module VCR
       end
     end
   end
+
+  module RSpec
+    # Contains macro methods to assist with VCR usage. These methods are
+    # intended to be used directly in an RSpec example group. To make these
+    # available in your RSpec example groups, extend the module in an individual
+    # example group, or configure RSpec to extend the module in all example groups.
+    #
+    # @example
+    #   RSpec.configure do |c|
+    #     c.extend VCR::RSpec::Macros
+    #   end
+    #
+    module Macros
+      def self.extended(base)
+        Kernel.warn "WARNING: VCR::RSpec::Macros is deprecated. Use RSpec metadata options instead `:vcr => vcr_options`"
+      end
+
+      # Sets up a `before` and `after` hook that will insert and eject a
+      # cassette, respectively.
+      #
+      # @example
+      #   describe "Some API Client" do
+      #     use_vcr_cassette "some_api", :record => :new_episodes
+      #   end
+      #
+      # @param [(optional) String] name the cassette name; it will be inferred by the example
+      #  group descriptions if not given.
+      # @param [(optional) Hash] options the cassette options
+      # @deprecated Use RSpec metadata options
+      def use_vcr_cassette(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        name    = args.first || infer_cassette_name
+
+        before(:each) do
+          VCR.insert_cassette(name, options)
+        end
+
+        after(:each) do
+          VCR.eject_cassette
+        end
+      end
+
+      private
+
+      def infer_cassette_name
+        # RSpec 1 exposes #description_parts; use that if its available
+        return description_parts.join("/") if respond_to?(:description_parts)
+
+        # Otherwise use RSpec 2 metadata...
+        group_descriptions = []
+        klass = self
+
+        while klass.respond_to?(:metadata) && klass.metadata
+          group_descriptions << klass.metadata[:example_group][:description]
+          klass = klass.superclass
+        end
+
+        group_descriptions.compact.reverse.join('/')
+      end
+    end
+  end
 end
 

data/lib/vcr/errors.rb

@@ -132,41 +132,41 @@ module VCR
         :use_new_episodes => [
           ["You can use the :new_episodes record mode to allow VCR to",
            "record this new request to the existing cassette"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/record-modes/new-episodes"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/record-modes/new-episodes"
         ],
 
         :delete_cassette_for_once => [
           ["The current record mode (:once) does not allow new requests to be recorded",
            "to a previously recorded cassette. You can delete the cassette file and re-run",
            "your tests to allow the cassette to be recorded with this request"],
-           "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/record-modes/once"
+           "https://www.relishapp.com/vcr/vcr/v/%s/docs/record-modes/once"
         ],
 
         :deal_with_none => [
           ["The current record mode (:none) does not allow requests to be recorded. You",
            "can temporarily change the record mode to :once, delete the cassette file ",
            "and re-run your tests to allow the cassette to be recorded with this request"],
-           "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/record-modes/none"
+           "https://www.relishapp.com/vcr/vcr/v/%s/docs/record-modes/none"
         ],
 
         :use_a_cassette => [
           ["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"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/getting-started"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/getting-started"
         ],
 
         :allow_http_connections_when_no_cassette => [
           ["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"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/configuration/allow-http-connections-when-no-cassette"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/configuration/allow-http-connections-when-no-cassette"
         ],
 
         :ignore_request => [
           ["If you want VCR to ignore this request (and others like it), you can",
            "set an `ignore_request` callback"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/configuration/ignore-request"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/configuration/ignore-request"
         ],
 
         :allow_playback_repeats => [
@@ -174,7 +174,7 @@ module VCR
            "but it has already been played back. If you wish to allow a single HTTP",
            "interaction to be played back multiple times, set the `:allow_playback_repeats`",
            "cassette option"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/request-matching/playback-repeats"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/request-matching/playback-repeats"
         ],
 
         :match_requests_on => [
@@ -182,14 +182,14 @@ module VCR
            "played back. If your request is non-deterministic, you may need to",
            "change your :match_requests_on cassette option to be more lenient",
            "or use a custom request matcher to allow it to match"],
-           "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/request-matching"
+           "https://www.relishapp.com/vcr/vcr/v/%s/docs/request-matching"
         ],
 
         :try_debug_logger => [
           ["If you're surprised VCR is raising this error",
            "and want insight about how VCR attempted to handle the request,",
            "you can use the debug_logger configuration option to log more details"],
-          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/configuration/debug-logging"
+          "https://www.relishapp.com/vcr/vcr/v/%s/docs/configuration/debug-logging"
         ]
       }
 

data/lib/vcr/library_hooks/fakeweb.rb

@@ -191,5 +191,6 @@ VCR.configuration.after_library_hooks_loaded do
   if defined?(WebMock)
     raise ArgumentError.new("You have configured VCR to hook into both :fakeweb and :webmock. You cannot use both.")
   end
+  ::Kernel.warn "WARNING: VCR's FakeWeb integration is deprecated and will be removed in VCR 3.0."
 end
 

data/lib/vcr/library_hooks/typhoeus.rb

@@ -50,6 +50,7 @@ else
               :status_message => stubbed_response.status.message,
               :headers        => stubbed_response_headers,
               :body           => stubbed_response.body,
+              :effective_url  => request.url,
               :mock           => true
           end