vcr 2.0.0 → 2.0.1

data/.travis.yml

@@ -17,6 +17,7 @@ branches:
     - master
     - 1-x-stable
     - travis-testing
+    - 2-0-stable
 matrix:
   allow_failures:
     - rvm: jruby-19mode

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0...2-0-stable)
+
+* Fix encoding logic to not attempt to encode the request or response
+  body on deserialization if there is no encoding specified. This should
+  allow cassettes recorded on 1.8 to work on 1.9. Thanks to
+  [Kevin Menard](https://github.com/nirvdrum) for reporting the bug.
+* Fix Excon adapter to fix a bug with Excon 0.11 and greater. When you
+  passed a block to an excon request, the response body would not be
+  recorded.
+* Fix Faraday middleware so that it plays back parallel requests
+  properly. Thanks to [Dave Weiser](https://github.com/davidann) for
+  reporting this bug.
 
 ## 2.0.0 (March 2, 2012)
 

data/README.md

@@ -155,17 +155,21 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Sathya Sekaran](https://github.com/sfsekaran)
 * [Wesley Beary](https://github.com/geemus)
 
-## Similar Libraries
+## Ports in other languages
 
 * [Betamax](https://github.com/robfletcher/betamax) (Groovy)
 * [VCR.js](https://github.com/elcuervo/vcr.js) (JavaScript)
 * [TapeDeck.js](https://github.com/EndangeredMassa/TapeDeck.js) (JavaScript)
 * [Mimic](https://github.com/acoulton/mimic) (PHP/Kohana)
-* [Ephemeral Response](https://github.com/sandro/ephemeral_response) (Ruby)
-* [Net::HTTP Spy](http://github.com/martinbtt/net-http-spy) (Ruby)
-* [NetRecorder](https://github.com/chrisyoung/netrecorder) (Ruby)
-* [Stale Fish](https://github.com/jsmestad/stale_fish) (Ruby)
-* [WebFixtures](http://github.com/trydionel/web_fixtures) (Ruby)
+
+## Similar Libraries in Ruby
+
+* [Ephemeral Response](https://github.com/sandro/ephemeral_response)
+* [Net::HTTP Spy](http://github.com/martinbtt/net-http-spy)
+* [NetRecorder](https://github.com/chrisyoung/netrecorder)
+* [Stale Fish](https://github.com/jsmestad/stale_fish)
+* [WebFixtures](http://github.com/trydionel/web_fixtures)
+* [REST-assured](https://github.com/BBC/REST-assured)
 
 ## Copyright
 

data/Upgrade.md

@@ -49,8 +49,7 @@ re-record your cassettes if you are able.
 
 ## Custom Request Matchers
 
-VCR 2.0 allows any callable (an object that responds to #call, such as a lambda)
-to be used as a request matcher:
+VCR 2.0 allows you to register custom request matchers:
 
 ``` ruby
 VCR.configure do |c|
@@ -60,6 +59,19 @@ VCR.configure do |c|
 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:
 
@@ -74,7 +86,8 @@ end
 
 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:
+own. Custom serializers must implement `#file_extension`, `#serialize`
+and `#deserialize`:
 
 ``` ruby
 VCR.use_cassette("example", :serialize_with => :json) do
@@ -119,17 +132,15 @@ VCR.configure do |c|
   end
 
   # around_http_request only works on ruby 1.9
-  VCR.configure do |c|
-    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
+  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

data/features/support/env.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler'
 Bundler.setup
-require 'limited_red/plugins/cucumber' unless ENV['CI']
+require 'limited_red/plugins/cucumber'
 
 require 'ruby-debug' if !defined?(RUBY_ENGINE) && RUBY_VERSION != '1.9.3' && !ENV['CI']
 

data/lib/vcr/library_hooks/excon.rb

@@ -2,7 +2,7 @@ require 'vcr/util/version_checker'
 require 'vcr/request_handler'
 require 'excon'
 
-VCR::VersionChecker.new('Excon', Excon::VERSION, '0.9.6', '0.10').check_version!
+VCR::VersionChecker.new('Excon', Excon::VERSION, '0.9.6', '0.13').check_version!
 
 module VCR
   class LibraryHooks
@@ -52,7 +52,7 @@ module VCR
           # a raw response, and then the main request (with :mock => true) can
           # handle failure/retry on its own with its set options.
           params.merge(:mock => false, :retry_limit => 0).tap do |p|
-            [:expects, :idempotent, :instrumentor_name, :instrumentor].each do |key|
+            [:expects, :idempotent, :instrumentor_name, :instrumentor, :response_block, :request_block].each do |key|
               p.delete(key)
             end
           end

data/lib/vcr/middleware/faraday.rb

@@ -83,7 +83,7 @@ module VCR
           env.update :status => stubbed_response.status.code, :body => stubbed_response.body
 
           faraday_response = ::Faraday::Response.new
-          faraday_response.finish(env) unless env[:parallel_manager]
+          faraday_response.finish(env)
           env[:response] = faraday_response
         end
 

data/lib/vcr/structs.rb

@@ -32,7 +32,13 @@ module VCR
           end
 
           def try_encode_string(string, encoding)
-            return string if string.encoding.name == encoding
+            return string if encoding.nil? || string.encoding.name == encoding
+
+            # ASCII-8BIT just means binary, so encoding to it is nonsensical
+            # and yet "\u00f6".encode("ASCII-8BIT") raises an error.
+            # Instead, we'll force encode it (essentially just tagging it as binary)
+            return string.force_encoding(encoding) if encoding == "ASCII-8BIT"
+
             string.encode(encoding)
           rescue EncodingError => e
             struct_type = name.split('::').last.downcase

data/lib/vcr/version.rb

@@ -10,7 +10,7 @@ module VCR
   #   * `parts` [Array<Integer>] List of the version parts.
   def version
     @version ||= begin
-      string = '2.0.0'
+      string = '2.0.1'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/spec/spec_helper.rb

@@ -48,9 +48,11 @@ RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
 
   tmp_dir = File.expand_path('../../tmp/cassette_library_dir', __FILE__)
-  config.before(:each, :skip_vcr_reset => lambda { |v| v != true }) do
-    VCR.reset!
-    VCR.configuration.cassette_library_dir = tmp_dir
+  config.before(:each) do
+    unless example.metadata[:skip_vcr_reset]
+      VCR.reset!
+      VCR.configuration.cassette_library_dir = tmp_dir
+    end
   end
 
   config.after(:each) do

data/spec/vcr/library_hooks/excon_spec.rb

@@ -32,9 +32,9 @@ describe "Excon hook", :with_monkey_patches => :excon do
         chunks = []
 
         VCR.use_cassette('excon_streaming', :record => :once) do
-          Excon.get("http://localhost:#{VCR::SinatraApp.port}/foo") do |chunk, remaining_bytes, total_bytes|
+          Excon.get "http://localhost:#{VCR::SinatraApp.port}/foo", :response_block => lambda { |chunk, remaining_bytes, total_bytes|
             chunks << chunk
-          end
+          }
         end
 
         chunks.join

data/spec/vcr/middleware/faraday_spec.rb

@@ -13,10 +13,28 @@ describe VCR::Middleware::Faraday do
     include VCRStubHelpers
     let(:parallel_manager)   { ::Faraday::Adapter::Typhoeus.setup_parallel_manager }
     let(:connection)         { ::Faraday.new { |b| b.adapter :typhoeus } }
+    let(:request_url) { "http://localhost:#{VCR::SinatraApp.port}/" }
 
-    shared_examples_for "exclusive library hook" do
-      let(:request_url) { "http://localhost:#{VCR::SinatraApp.port}/" }
+    it 'works correctly with multiple parallel requests' do
+      recorded, played_back = [1, 2].map do
+        responses = []
+
+        VCR.use_cassette("multiple_parallel") do
+          connection.in_parallel(parallel_manager) do
+            responses << connection.get(request_url)
+            responses << connection.get(request_url)
+          end
+        end
+
+        responses.map(&:body)
+      end
+
+      # there should be no blanks
+      recorded.select { |r| r.to_s == '' }.should eq([])
+      played_back.should eq(recorded)
+    end
 
+    shared_examples_for "exclusive library hook" do
       def make_request
         connection.in_parallel(parallel_manager) { connection.get(request_url) }
       end

data/spec/vcr/structs_spec.rb

@@ -162,6 +162,29 @@ module VCR
           i.response.body.encoding.name.should eq("ISO-8859-1")
         end
 
+        it 'does not attempt to encode the string when there is no encoding given (i.e. if the cassette was recorded on ruby 1.8)' do
+          string = 'foo'
+          string.force_encoding("ISO-8859-1")
+          hash['request']['body']  = { 'string' => string }
+
+          i = HTTPInteraction.from_hash(hash)
+          i.request.body.should eq('foo')
+          i.request.body.encoding.name.should eq("ISO-8859-1")
+        end
+
+        it 'force encodes to ASCII-8BIT (since it just means "no encoding" or binary)' do
+          string = "\u00f6"
+          string.encode("UTF-8")
+          string.should be_valid_encoding
+          hash['request']['body']  = { 'string' => string, 'encoding' => 'ASCII-8BIT' }
+
+          Request.should_not_receive(:warn)
+          i = HTTPInteraction.from_hash(hash)
+          i.request.body.should eq(string)
+          i.request.body.bytes.to_a.should eq(string.bytes.to_a)
+          i.request.body.encoding.name.should eq("ASCII-8BIT")
+        end
+
         context 'when the string cannot be encoded as the original encoding' do
           before do
             Request.stub(:warn)

data/vcr.gemspec

@@ -17,33 +17,33 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8.7'
   s.required_rubygems_version = '>= 1.3.5'
 
-  s.add_development_dependency 'bundler', '~> 1.0.7'
+  s.add_development_dependency 'bundler', '>= 1.0.7'
   s.add_development_dependency 'rake', '~> 0.9.2'
 
   s.add_development_dependency 'cucumber', '~> 1.1.4'
   s.add_development_dependency 'aruba', '~> 0.4.11'
 
-  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'rspec', '~> 2.9.0'
   s.add_development_dependency 'shoulda', '~> 2.9.2'
 
   s.add_development_dependency 'fakeweb', '~> 1.3.0'
-  s.add_development_dependency 'webmock', '~> 1.8.0'
+  s.add_development_dependency 'webmock', '~> 1.8.3'
 
   s.add_development_dependency 'faraday', '~> 0.8.0.rc2'
   s.add_development_dependency 'httpclient', '~> 2.1.5.2'
-  s.add_development_dependency 'excon', '>= 0.9.6', '< 1.0'
+  s.add_development_dependency 'excon', '>= 0.11.0', '< 1.0'
 
   s.add_development_dependency 'timecop', '~> 0.3.5'
   s.add_development_dependency 'rack', '~> 1.3.6'
   s.add_development_dependency 'sinatra', '~> 1.3.2'
   s.add_development_dependency 'multi_json', '~> 1.0.3'
   s.add_development_dependency 'json', '~> 1.6.5'
-  s.add_development_dependency 'limited_red', '~> 0.3.7'
+  s.add_development_dependency 'limited_red', '~> 0.3.8'
   s.add_development_dependency 'simplecov', '~> 0.5.3'
 
   unless RUBY_PLATFORM == 'java'
     s.add_development_dependency 'patron', '~> 0.4.15'
-    s.add_development_dependency 'em-http-request', '~> 1.0.1'
+    s.add_development_dependency 'em-http-request', '~> 1.0.2'
     s.add_development_dependency 'curb', '~> 0.8.0'
     s.add_development_dependency 'typhoeus', '~> 0.3.3'
     s.add_development_dependency 'yajl-ruby', '~> 1.1.0'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vcr
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 0
-  - 0
-  version: 2.0.0
+  - 1
+  version: 2.0.1
 platform: ruby
 authors: 
 - Myron Marston
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-02 00:00:00 Z
+date: 2012-03-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 25
         segments: 
@@ -87,12 +87,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 47
+        hash: 43
         segments: 
         - 2
-        - 8
+        - 9
         - 0
-        version: 2.8.0
+        version: 2.9.0
   name: rspec
   type: :development
   prerelease: false
@@ -135,12 +135,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 55
+        hash: 49
         segments: 
         - 1
         - 8
-        - 0
-        version: 1.8.0
+        - 3
+        version: 1.8.3
   name: webmock
   type: :development
   prerelease: false
@@ -186,12 +186,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 55
+        hash: 51
         segments: 
         - 0
-        - 9
-        - 6
-        version: 0.9.6
+        - 11
+        - 0
+        version: 0.11.0
     - - <
       - !ruby/object:Gem::Version 
         hash: 15
@@ -289,12 +289,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 3
         segments: 
         - 0
         - 3
-        - 7
-        version: 0.3.7
+        - 8
+        version: 0.3.8
   name: limited_red
   type: :development
   prerelease: false
@@ -337,12 +337,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 19
         segments: 
         - 1
         - 0
-        - 1
-        version: 1.0.1
+        - 2
+        version: 1.0.2
   name: em-http-request
   type: :development
   prerelease: false