vcr 2.0.0.beta1 → 2.0.0.beta2

data/spec/monkey_patches.rb

@@ -1,4 +1,4 @@
-require 'typhoeus' if RUBY_INTERPRETER == :mri
+require 'typhoeus' unless RUBY_INTERPRETER == :jruby
 
 module MonkeyPatches
   extend self
@@ -14,7 +14,7 @@ module MonkeyPatches
 
   ALL_MONKEY_PATCHES = NET_HTTP_MONKEY_PATCHES.dup
 
-  ALL_MONKEY_PATCHES << [Typhoeus::Hydra::Stubbing::SharedMethods, :find_stub_from_request] if RUBY_INTERPRETER == :mri
+  ALL_MONKEY_PATCHES << [Typhoeus::Hydra::Stubbing::SharedMethods, :find_stub_from_request] if defined?(::Typhoeus)
 
   def enable!(scope)
     case scope
@@ -24,7 +24,7 @@ module MonkeyPatches
       when :webmock
         ::WebMock.reset!
         ::WebMock::HttpLibAdapters::NetHttpAdapter.enable!
-        ::WebMock::HttpLibAdapters::TyphoeusAdapter.enable! if RUBY_INTERPRETER == :mri
+        ::WebMock::HttpLibAdapters::TyphoeusAdapter.enable! if defined?(::Typhoeus)
         $original_webmock_callbacks.each do |cb|
           ::WebMock::CallbackRegistry.add_callback(cb[:options], cb[:block])
         end
@@ -42,7 +42,7 @@ module MonkeyPatches
 
     if defined?(::WebMock)
       ::WebMock::HttpLibAdapters::NetHttpAdapter.disable!
-      ::WebMock::HttpLibAdapters::TyphoeusAdapter.disable! unless RUBY_INTERPRETER == :jruby
+      ::WebMock::HttpLibAdapters::TyphoeusAdapter.disable! if defined?(::Typhoeus)
       ::WebMock::CallbackRegistry.reset
       ::WebMock::StubRegistry.instance.request_stubs = []
     end
@@ -112,7 +112,7 @@ end
 # for WebMock to work with them.
 require 'httpclient'
 
-if RUBY_INTERPRETER == :mri
+unless RUBY_INTERPRETER == :jruby
   require 'patron'
   require 'em-http-request'
   require 'curb'

data/spec/support/http_library_adapters.rb

@@ -1,6 +1,18 @@
+module HeaderDowncaser
+  def downcase_headers(headers)
+    {}.tap do |downcased|
+      headers.each do |k, v|
+        downcased[k.downcase] = v
+      end
+    end
+  end
+end
+
 HTTP_LIBRARY_ADAPTERS = {}
 
 HTTP_LIBRARY_ADAPTERS['net/http'] = Module.new do
+  include HeaderDowncaser
+
   def self.http_library_name; 'Net::HTTP'; end
 
   def get_body_string(response); response.body; end
@@ -20,6 +32,14 @@ HTTP_LIBRARY_ADAPTERS['net/http'] = Module.new do
 
     http.send_request(method.to_s.upcase, uri.request_uri, body, headers)
   end
+
+  DEFAULT_REQUEST_HEADERS = { "Accept"=>["*/*"] }
+  DEFAULT_REQUEST_HEADERS['User-Agent'] = ["Ruby"] if RUBY_VERSION =~ /1.9/
+
+  def normalize_request_headers(headers)
+    defined?(super) ? super :
+    downcase_headers(headers.merge(DEFAULT_REQUEST_HEADERS))
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['patron'] = Module.new do
@@ -34,6 +54,10 @@ HTTP_LIBRARY_ADAPTERS['patron'] = Module.new do
   def make_http_request(method, url, body = nil, headers = {})
     Patron::Session.new.request(method, url, headers, :data => body || '')
   end
+
+  def normalize_request_headers(headers)
+    headers.merge('Expect' => [''])
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['httpclient'] = Module.new do
@@ -52,6 +76,10 @@ HTTP_LIBRARY_ADAPTERS['httpclient'] = Module.new do
   def make_http_request(method, url, body = nil, headers = {})
     HTTPClient.new.request(method, url, nil, body, headers)
   end
+
+  def normalize_request_headers(headers)
+    headers
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['em-http-request'] = Module.new do
@@ -73,6 +101,10 @@ HTTP_LIBRARY_ADAPTERS['em-http-request'] = Module.new do
     end
     http
   end
+
+  def normalize_request_headers(headers)
+    headers
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['curb'] = Module.new do
@@ -102,6 +134,10 @@ HTTP_LIBRARY_ADAPTERS['curb'] = Module.new do
       end
     end
   end
+
+  def normalize_request_headers(headers)
+    headers
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['typhoeus'] = Module.new do
@@ -118,6 +154,10 @@ HTTP_LIBRARY_ADAPTERS['typhoeus'] = Module.new do
   def make_http_request(method, url, body = nil, headers = {})
     Typhoeus::Request.send(method, url, :body => body, :headers => headers)
   end
+
+  def normalize_request_headers(headers)
+    headers.merge("User-Agent" => ["Typhoeus - http://github.com/dbalatero/typhoeus/tree/master"])
+  end
 end
 
 HTTP_LIBRARY_ADAPTERS['excon'] = Module.new do
@@ -134,6 +174,10 @@ HTTP_LIBRARY_ADAPTERS['excon'] = Module.new do
   def make_http_request(method, url, body = nil, headers = {})
     Excon.send(method, url, :body => body, :headers => headers)
   end
+
+  def normalize_request_headers(headers)
+    headers
+  end
 end
 
 %w[ net_http typhoeus patron ].each do |_faraday_adapter|
@@ -179,6 +223,10 @@ end
         builder.adapter faraday_adapter
       end
     end
+
+    def normalize_request_headers(headers)
+      headers
+    end
   end
 end
 

data/spec/support/shared_example_groups/hook_into_http_library.rb

@@ -3,6 +3,13 @@ require 'cgi'
 NET_CONNECT_NOT_ALLOWED_ERROR = /You can use VCR to automatically record this request and replay it later/
 
 shared_examples_for "a hook into an HTTP library" do |library, *other|
+  include HeaderDowncaser
+
+  def interactions_from(file)
+    hashes = YAML.load_file(File.join(VCR::SPEC_ROOT, 'fixtures', file))['http_interactions']
+    hashes.map { |h| VCR::HTTPInteraction.from_hash(h) }
+  end
+
   unless adapter_module = HTTP_LIBRARY_ADAPTERS[library]
     raise ArgumentError.new("No http library adapter module could be found for #{library}")
   end
@@ -54,6 +61,26 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
       end
     end
 
+    def self.test_record_and_playback(description, query)
+      describe "a request to a URL #{description}" do
+        define_method :get_body do
+          VCR.use_cassette('record_and_playback', :record => :once) do
+            get_body_string make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/record-and-playback?#{query}")
+          end
+        end
+
+        it "properly records and playsback a request with a URL #{description}" do
+          recorded_body = get_body
+          played_back_body = get_body
+          played_back_body.should eq(recorded_body)
+        end
+      end
+    end
+
+    test_record_and_playback "with spaces encoded as +",           "q=a+b"
+    test_record_and_playback "with spaces encoded as %20",         "q=a%20b"
+    test_record_and_playback "with a complex escaped query param", "q=#{CGI.escape("A&(! 234k !@ kasdj232\#$ kjw35")}"
+
     describe 'making an HTTP request' do
       let(:status)        { VCR::ResponseStatus.new(200, 'OK') }
       let(:interaction)   { VCR::HTTPInteraction.new(request, response) }
@@ -72,7 +99,7 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
         end
       end
 
-      def self.test_url(description, url)
+      def self.test_playback(description, url)
         context "when a URL #{description} has been stubbed" do
           let(:request)     { VCR::Request.new(:get, url) }
           let(:response)    { VCR::Response.new(status, nil, response_body, '1.1') }
@@ -83,23 +110,27 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
         end
       end
 
-      test_url "using https and no explicit port", "https://example.com/foo"
-      test_url "using https and port 443", "https://example.com:443/foo"
-      test_url "using https and some other port", "https://example.com:5190/foo"
-      test_url "that has query params",      "http://example.com/search?q=param"
-      test_url "with spaces encoded as +",   "http://example.com/search?q=a+b"
-      test_url "with spaces encoded as %20", "http://example.com/search?q=a%20b"
-      test_url "with an encoded ampersand",  "http://example.com:80/search?q=#{CGI.escape("Q&A")}"
-      test_url "with a complex escaped query param", "http://example.com:80/search?q=#{CGI.escape("A&(! 234k !@ kasdj232\#$ kjw35")}"
+      test_playback "using https and no explicit port", "https://example.com/foo"
+      test_playback "using https and port 443",         "https://example.com:443/foo"
+      test_playback "using https and some other port",  "https://example.com:5190/foo"
+      test_playback "that has query params",            "http://example.com/search?q=param"
+      test_playback "with an encoded ampersand",        "http://example.com:80/search?q=#{CGI.escape("Q&A")}"
     end
 
     describe '.stub_requests using specific match_attributes' do
       before(:each) { VCR.stub(:real_http_connections_allowed? => false) }
-      let(:interactions) { VCR::YAML.load_file(File.join(VCR::SPEC_ROOT, 'fixtures', 'match_requests_on.yml')) }
+      let(:interactions) { interactions_from('match_requests_on.yml') }
+
+      let(:normalized_interactions) do
+        interactions.each do |i|
+          i.request.headers = normalize_request_headers(i.request.headers)
+        end
+        interactions
+      end
 
       def self.matching_on(attribute, valid, invalid, &block)
         describe ":#{attribute}" do
-          let(:perform_stubbing) { stub_requests(interactions, [attribute]) }
+          let(:perform_stubbing) { stub_requests(normalized_interactions, [attribute]) }
 
           before(:each) { perform_stubbing }
           module_eval(&block)
@@ -146,7 +177,7 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
         end
       end
 
-      matching_on :headers, {{ 'X-HTTP-HEADER1' => 'val1' } => 'val1 header response', { 'X-HTTP-HEADER1' => 'val2' } => 'val2 header response' }, { 'X-HTTP-HEADER1' => 'val3' } do
+      matching_on :headers, {{ 'X-Http-Header1' => 'val1' } => 'val1 header response', { 'X-Http-Header1' => 'val2' } => 'val2 header response' }, { 'X-Http-Header1' => 'val3' } do
         def make_http_request(headers)
           make_request(:get, "http://wrong-domain.com/wrong/path", nil, headers)
         end
@@ -166,7 +197,7 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
           let(:recorded_interaction) do
             interaction = nil
             VCR.should_receive(:record_http_interaction) { |i| interaction = i }
-            make_http_request(:get, url)
+            make_http_request(:post, url, "the body", { 'X-Http-Foo' => 'bar' })
             interaction
           end
 
@@ -182,15 +213,16 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
           end
 
           it 'records the request method' do
-            recorded_interaction.request.method.should eq(:get)
+            recorded_interaction.request.method.should eq(:post)
           end
 
           it 'records the request body' do
-            recorded_interaction.request.body.should be_nil
+            recorded_interaction.request.body.should eq("the body")
           end
 
           it 'records the request headers' do
-            recorded_interaction.request.headers.should be_nil
+            headers = downcase_headers(recorded_interaction.request.headers)
+            headers.should include('x-http-foo' => ['bar'])
           end
 
           it 'records the response status code' do
@@ -198,7 +230,7 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
           end
 
           it 'records the response status message' do
-            recorded_interaction.response.status.message.should eq('OK')
+            recorded_interaction.response.status.message.strip.should eq('OK')
           end unless other.include?(:status_message_not_exposed)
 
           it 'records the response body' do
@@ -206,7 +238,8 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
           end
 
           it 'records the response headers' do
-            recorded_interaction.response.headers['content-type'].should eq(["text/html;charset=utf-8"])
+            headers = downcase_headers(recorded_interaction.response.headers)
+            headers.should include('content-type' => ["text/html;charset=utf-8"])
           end
         end
       else
@@ -244,9 +277,9 @@ shared_examples_for "a hook into an HTTP library" do |library, *other|
         end
 
         context 'when some requests are stubbed' do
+          let(:interactions) { interactions_from('fake_example.com_responses.yml') }
           before(:each) do
-            @recorded_interactions = VCR::YAML.load_file(File.join(VCR::SPEC_ROOT, 'fixtures', 'fake_example.com_responses.yml'))
-            stub_requests(@recorded_interactions, VCR::RequestMatcherRegistry::DEFAULT_MATCHERS)
+            stub_requests(interactions, VCR::RequestMatcherRegistry::DEFAULT_MATCHERS)
           end
 
           it 'gets the stubbed responses when requests are made to http://example.com/foo, and does not record them' do

data/spec/support/sinatra_app.rb

@@ -18,6 +18,10 @@ module VCR
       "FOO!"
     end
 
+    post '/foo' do
+      "FOO!"
+    end
+
     get '/set-cookie-headers/1' do
       headers 'Set-Cookie' => 'foo'
       'header set'
@@ -28,6 +32,14 @@ module VCR
       'header set'
     end
 
+    # we use a global counter so that every response is different;
+    # this ensures that the test demonstrates that the response
+    # is being played back (and not running a 2nd real request)
+    $record_and_playback_response_count ||= 0
+    get '/record-and-playback' do
+      "Response #{$record_and_playback_response_count += 1}"
+    end
+
     def self.port
       server.port
     end

data/spec/vcr/cassette/http_interaction_list_spec.rb

@@ -1,6 +1,6 @@
 require 'vcr/cassette/http_interaction_list'
 require 'vcr/request_matcher_registry'
-require 'vcr/structs/http_interaction'
+require 'vcr/structs'
 require 'uri'
 
 module VCR

data/spec/vcr/cassette/migrator_spec.rb

@@ -0,0 +1,183 @@
+require 'tmpdir'
+require 'vcr/cassette/migrator'
+
+describe VCR::Cassette::Migrator do
+  let(:original_contents) { <<-EOF
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://example.com:80/foo
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "9"
+    body: Hello foo
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://localhost:7777/bar
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "9"
+    body: Hello bar
+    http_version: "1.1"
+EOF
+  }
+
+  let(:updated_contents) { <<-EOF
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: http://example.com/foo
+    body: ""
+    headers: {}
+
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Content-Type: 
+      - text/html;charset=utf-8
+      Content-Length: 
+      - "9"
+    body: Hello foo
+    http_version: "1.1"
+  recorded_at: Wed, 04 May 2011 12:30:00 GMT
+- request: 
+    method: get
+    uri: http://localhost:7777/bar
+    body: ""
+    headers: {}
+
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Content-Type: 
+      - text/html;charset=utf-8
+      Content-Length: 
+      - "9"
+    body: Hello bar
+    http_version: "1.1"
+  recorded_at: Wed, 04 May 2011 12:30:00 GMT
+recorded_with: VCR 1.11.3
+EOF
+  }
+
+  attr_accessor :dir
+
+  around(:each) do |example|
+    Dir.mktmpdir do |dir|
+      self.dir = dir
+      example.run
+    end
+  end
+
+  # JRuby serializes YAML with some slightly different whitespace.
+  before(:each) do
+    [original_contents, updated_contents].each do |contents|
+      contents.gsub!(/^(\s+)-/, '\1  -')
+    end
+    updated_contents.gsub!(/^(- |  )/, '  \1')
+  end if RUBY_PLATFORM == 'java'
+
+  # Use syck on all rubies for consistent results...
+  before(:each) do
+    YAML::ENGINE.yamler = 'syck' if defined?(YAML::ENGINE)
+  end
+
+  after(:each) do
+    YAML::ENGINE.yamler = 'psych' if defined?(YAML::ENGINE)
+  end
+
+  let(:filemtime) { Time.utc(2011, 5, 4, 12, 30) }
+  let(:out_io)    { StringIO.new }
+  let(:file_name) { File.join(dir, "example.yml") }
+  let(:output)    { out_io.rewind; out_io.read }
+
+  subject { described_class.new(dir, out_io) }
+
+  before(:each) do
+    File.stub(:mtime).with(file_name).and_return(filemtime)
+  end
+
+  it 'migrates a cassette from the 1.x to 2.x format' do
+    File.open(file_name, 'w') { |f| f.write(original_contents) }
+    subject.migrate!
+    File.read(file_name).should eq(updated_contents)
+    output.should match(/Migrated example.yml/)
+  end
+
+  it 'ignores files that do not contain arrays' do
+    File.open(file_name, 'w') { |f| f.write(true.to_yaml) }
+    subject.migrate!
+    File.read(file_name).should eq(true.to_yaml)
+    output.should match(/Ignored example.yml since it does not appear to be a valid VCR 1.x cassette/)
+  end
+
+  it 'ignores files that contain YAML arrays of other things' do
+    File.open(file_name, 'w') { |f| f.write([{}, {}].to_yaml) }
+    subject.migrate!
+    File.read(file_name).should eq([{}, {}].to_yaml)
+    output.should match(/Ignored example.yml since it does not appear to be a valid VCR 1.x cassette/)
+  end
+
+  it 'ignores URIs that have sensitive data substitutions' do
+    modified_contents = original_contents.gsub('example.com', '<HOST>')
+    File.open(file_name, 'w') { |f| f.write(modified_contents) }
+    subject.migrate!
+    File.read(file_name).should eq(updated_contents.gsub('example.com', '<HOST>:80'))
+  end
+
+  it 'ignores files that are empty' do
+    File.open(file_name, 'w') { |f| f.write('') }
+    subject.migrate!
+    File.read(file_name).should eq('')
+    output.should match(/Ignored example.yml since it could not be parsed as YAML/)
+  end
+
+  shared_examples_for "ignoring invalid YAML" do
+    it 'ignores files that cannot be parsed as valid YAML (such as ERB cassettes)' do
+      modified_contents = original_contents.gsub(/\A---/, "---\n<% 3.times do %>")
+      modified_contents = modified_contents.gsub(/\z/, "<% end %>")
+      File.open(file_name, 'w') { |f| f.write(modified_contents) }
+      subject.migrate!
+      File.read(file_name).should eq(modified_contents)
+      output.should match(/Ignored example.yml since it could not be parsed as YAML/)
+    end
+  end
+
+  context 'with syck' do
+    it_behaves_like "ignoring invalid YAML"
+  end
+
+  context 'with psych' do
+    before(:each) do
+      pending "psych not available" unless defined?(YAML::ENGINE)
+      YAML::ENGINE.yamler = 'psych'
+    end
+
+    it_behaves_like "ignoring invalid YAML"
+  end
+end
+