RubyGems - vcr - Versions diffs - 0.1.0 - Mend

vcr 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

data/.document +5 -0
data/.gitignore +22 -0
data/LICENSE +20 -0
data/README.rdoc +156 -0
data/Rakefile +60 -0
data/VERSION +1 -0
data/features/fixtures/vcr_cassettes/1.8.6/cucumber_tags/replay_cassette1.yml +43 -0
data/features/fixtures/vcr_cassettes/1.8.6/cucumber_tags/replay_cassette2.yml +45 -0
data/features/fixtures/vcr_cassettes/1.8.6/nested_replay_cassette.yml +23 -0
data/features/fixtures/vcr_cassettes/1.8.6/not_the_real_response.yml +43 -0
data/features/fixtures/vcr_cassettes/1.8.7/cucumber_tags/replay_cassette1.yml +43 -0
data/features/fixtures/vcr_cassettes/1.8.7/cucumber_tags/replay_cassette2.yml +45 -0
data/features/fixtures/vcr_cassettes/1.8.7/nested_replay_cassette.yml +23 -0
data/features/fixtures/vcr_cassettes/1.8.7/not_the_real_response.yml +43 -0
data/features/fixtures/vcr_cassettes/1.9.1/cucumber_tags/replay_cassette1.yml +43 -0
data/features/fixtures/vcr_cassettes/1.9.1/cucumber_tags/replay_cassette2.yml +61 -0
data/features/fixtures/vcr_cassettes/1.9.1/nested_replay_cassette.yml +31 -0
data/features/fixtures/vcr_cassettes/1.9.1/not_the_real_response.yml +43 -0
data/features/record_response.feature +55 -0
data/features/replay_recorded_response.feature +53 -0
data/features/step_definitions/vcr_steps.rb +88 -0
data/features/support/env.rb +55 -0
data/lib/vcr.rb +48 -0
data/lib/vcr/cassette.rb +89 -0
data/lib/vcr/config.rb +19 -0
data/lib/vcr/cucumber_tags.rb +38 -0
data/lib/vcr/fake_web_extensions.rb +18 -0
data/lib/vcr/net_http_extensions.rb +39 -0
data/lib/vcr/recorded_response.rb +4 -0
data/spec/cassette_spec.rb +185 -0
data/spec/config_spec.rb +27 -0
data/spec/cucumber_tags_spec.rb +71 -0
data/spec/fake_web_extensions_spec.rb +26 -0
data/spec/fixtures/1.8.6/cassette_spec/example.yml +78 -0
data/spec/fixtures/1.8.7/cassette_spec/example.yml +78 -0
data/spec/fixtures/1.9.1/cassette_spec/example.yml +77 -0
data/spec/net_http_extensions_spec.rb +40 -0
data/spec/recorded_response_spec.rb +25 -0
data/spec/spec.opts +2 -0
data/spec/spec_helper.rb +22 -0
data/spec/support/temp_cache_dir.rb +16 -0
data/spec/vcr_spec.rb +95 -0
metadata +154 -0

data/features/fixtures/vcr_cassettes/1.8.7/cucumber_tags/replay_cassette2.yml ADDED

@@ -0,0 +1,45 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  method: :get
+  uri: http://example.com:80/before_nested
+  response: !ruby/object:Net::HTTPNotFound
+    body: The before_nested response
+    body_exist: true
+    code: "404"
+    header:
+      content-type:
+      - text/html; charset=iso-8859-1
+      connection:
+      - close
+      server:
+      - Apache/2.2.3 (CentOS)
+      date:
+      - Thu, 25 Feb 2010 15:23:39 GMT
+      content-length:
+      - "287"
+    http_version: "1.1"
+    message: Not Found
+    read: true
+    socket:
+- !ruby/struct:VCR::RecordedResponse
+  method: :get
+  uri: http://example.com:80/after_nested
+  response: !ruby/object:Net::HTTPNotFound
+    body: The after_nested response
+    body_exist: true
+    code: "404"
+    header:
+      content-type:
+      - text/html; charset=iso-8859-1
+      connection:
+      - close
+      server:
+      - Apache/2.2.3 (CentOS)
+      date:
+      - Thu, 25 Feb 2010 15:23:39 GMT
+      content-length:
+      - "286"
+    http_version: "1.1"
+    message: Not Found
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.8.7/nested_replay_cassette.yml ADDED

@@ -0,0 +1,23 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  method: :get
+  uri: http://example.com:80/nested
+  response: !ruby/object:Net::HTTPNotFound
+    body: The nested response
+    body_exist: true
+    code: "404"
+    header:
+      content-type:
+      - text/html; charset=iso-8859-1
+      connection:
+      - close
+      server:
+      - Apache/2.2.3 (CentOS)
+      date:
+      - Thu, 25 Feb 2010 15:19:40 GMT
+      content-length:
+      - "280"
+    http_version: "1.1"
+    message: Not Found
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.8.7/not_the_real_response.yml ADDED

@@ -0,0 +1,43 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  method: :get
+  uri: http://example.com:80/
+  response: !ruby/object:Net::HTTPOK
+    body: |
+      <HTML>
+      <HEAD>
+        <TITLE>Example Web Page</TITLE>
+      </HEAD>
+      <body>
+      <p>
+        This is not the real response from example.com
+      </p>
+      </BODY>
+      </HTML>
+    body_exist: true
+    code: "200"
+    header:
+      etag:
+      - "\"24ec5-1b6-4059a80bfd280\""
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      connection:
+      - Keep-Alive
+      content-type:
+      - text/html; charset=UTF-8
+      date:
+      - Thu, 25 Feb 2010 15:20:47 GMT
+      server:
+      - Apache/2.2.3 (CentOS)
+      content-length:
+      - "438"
+      age:
+      - "2546"
+      accept-ranges:
+      - bytes
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.9.1/cucumber_tags/replay_cassette1.yml ADDED

@@ -0,0 +1,43 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  :method: :get
+  :uri: http://example.com:80/
+  :response: !ruby/object:Net::HTTPOK
+    body: |
+      <HTML>
+      <HEAD>
+        <TITLE>Example Web Page</TITLE>
+      </HEAD>
+      <body>
+      <p>
+        This is not the real response from example.com
+      </p>
+      </BODY>
+      </HTML>
+    body_exist: true
+    code: "200"
+    header:
+      server:
+      - Apache/2.2.3 (Red Hat)
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      etag:
+      - "\"b300b4-1b6-4059a80bfd280\""
+      accept-ranges:
+      - bytes
+      content-type:
+      - text/html; charset=UTF-8
+      connection:
+      - Keep-Alive
+      date:
+      - Thu, 28 Jan 2010 07:14:48 GMT
+      age:
+      - "1696"
+      content-length:
+      - "438"
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.9.1/cucumber_tags/replay_cassette2.yml ADDED

@@ -0,0 +1,61 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  :method: :get
+  :uri: http://example.com:80/before_nested
+  :response: !ruby/object:Net::HTTPOK
+    body: The before_nested response
+    body_exist: true
+    code: "200"
+    header:
+      server:
+      - Apache/2.2.3 (Red Hat)
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      etag:
+      - "\"b300b4-1b6-4059a80bfd280\""
+      accept-ranges:
+      - bytes
+      content-type:
+      - text/html; charset=UTF-8
+      connection:
+      - Keep-Alive
+      date:
+      - Thu, 28 Jan 2010 07:14:48 GMT
+      age:
+      - "1696"
+      content-length:
+      - "438"
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:
+- !ruby/struct:VCR::RecordedResponse
+  :method: :get
+  :uri: http://example.com:80/after_nested
+  :response: !ruby/object:Net::HTTPOK
+    body: The after_nested response
+    body_exist: true
+    code: "200"
+    header:
+      server:
+      - Apache/2.2.3 (Red Hat)
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      etag:
+      - "\"b300b4-1b6-4059a80bfd280\""
+      accept-ranges:
+      - bytes
+      content-type:
+      - text/html; charset=UTF-8
+      connection:
+      - Keep-Alive
+      date:
+      - Thu, 28 Jan 2010 07:14:48 GMT
+      age:
+      - "1696"
+      content-length:
+      - "438"
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.9.1/nested_replay_cassette.yml ADDED

@@ -0,0 +1,31 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  :method: :get
+  :uri: http://example.com:80/nested
+  :response: !ruby/object:Net::HTTPOK
+    body: The nested response
+    body_exist: true
+    code: "200"
+    header:
+      server:
+      - Apache/2.2.3 (Red Hat)
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      etag:
+      - "\"b300b4-1b6-4059a80bfd280\""
+      accept-ranges:
+      - bytes
+      content-type:
+      - text/html; charset=UTF-8
+      connection:
+      - Keep-Alive
+      date:
+      - Thu, 28 Jan 2010 07:14:48 GMT
+      age:
+      - "1696"
+      content-length:
+      - "438"
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:

data/features/fixtures/vcr_cassettes/1.9.1/not_the_real_response.yml ADDED

@@ -0,0 +1,43 @@
+---
+- !ruby/struct:VCR::RecordedResponse
+  :method: :get
+  :uri: http://example.com:80/
+  :response: !ruby/object:Net::HTTPOK
+    body: |
+      <HTML>
+      <HEAD>
+        <TITLE>Example Web Page</TITLE>
+      </HEAD>
+      <body>
+      <p>
+        This is not the real response from example.com
+      </p>
+      </BODY>
+      </HTML>
+    body_exist: true
+    code: "200"
+    header:
+      server:
+      - Apache/2.2.3 (Red Hat)
+      last-modified:
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      etag:
+      - "\"b300b4-1b6-4059a80bfd280\""
+      accept-ranges:
+      - bytes
+      content-type:
+      - text/html; charset=UTF-8
+      connection:
+      - Keep-Alive
+      date:
+      - Thu, 28 Jan 2010 07:14:48 GMT
+      age:
+      - "1696"
+      content-length:
+      - "438"
+    http_version: "1.1"
+    message: OK
+    read: true
+    socket:

data/features/record_response.feature ADDED

@@ -0,0 +1,55 @@
+Feature: Record response
+  In order to have deterministic, fast tests that do not depend on an internet connection
+  As a TDD/BDD developer
+  I want to record responses for requests to URIs that are not registered with fakeweb so I can use them with fakeweb in the future
+  Scenario: Record a response using VCR.with_cassette
+    Given we do not have a "temp/cassette" cassette
+     When I make an HTTP get request to "http://example.com" within the "temp/cassette" cassette
+     Then the "temp/cassette" cache file should have a response for "http://example.com" that matches /You have reached this web page by typing.*example\.com/
+  @record_cassette1
+  Scenario: Record a response using a tagged scenario
+    Given we do not have a "cucumber_tags/record_cassette1" cassette
+      And this scenario is tagged with the vcr cassette tag: "@record_cassette1"
+     When I make an HTTP get request to "http://example.com"
+     Then I can test the scenario cassette's recorded responses in the next scenario, after the cassette has been destroyed
+  Scenario: Check the recorded response for the previous scenario
+    Given the previous scenario was tagged with the vcr cassette tag: "@record_cassette1"
+     Then the "cucumber_tags/record_cassette1" cache file should have a response for "http://example.com" that matches /You have reached this web page by typing.*example\.com/
+  @record_cassette2
+  Scenario: Use both a tagged scenario cassette and a nested cassette within a single step definition
+    Given we do not have a "cucumber_tags/record_cassette2" cassette
+      And we do not have a "temp/nested" cassette
+      And this scenario is tagged with the vcr cassette tag: "@record_cassette2"
+     When I make an HTTP get request to "http://example.com/before_nested"
+      And I make an HTTP get request to "http://example.com/nested" within the "temp/nested" cassette
+      And I make an HTTP get request to "http://example.com/after_nested"
+     Then I can test the scenario cassette's recorded responses in the next scenario, after the cassette has been destroyed
+      And the "temp/nested" cache file should have a response for "http://example.com/nested" that matches /The requested URL \/nested was not found/
+  Scenario: Check the recorded response for the previous scenario
+    Given the previous scenario was tagged with the vcr cassette tag: "@record_cassette2"
+     Then the "cucumber_tags/record_cassette2" cache file should have a response for "http://example.com/before_nested" that matches /The requested URL \/before_nested was not found/
+      And the "cucumber_tags/record_cassette2" cache file should have a response for "http://example.com/after_nested" that matches /The requested URL \/after_nested was not found/
+  Scenario: Make an HTTP request in a cassette with record mode set to :all
+    Given we do not have a "temp/record_all_cassette" cassette
+     When I make an HTTP get request to "http://example.com" within the "temp/record_all_cassette" all cassette
+     Then the "temp/record_all_cassette" cache file should have a response for "http://example.com" that matches /You have reached this web page by typing.*example\.com/
+  Scenario: Make an HTTP request in a cassette with record mode set to :none
+    Given we do not have a "temp/record_none_cassette" cassette
+     When I make an HTTP get request to "http://example.com" within the "temp/record_none_cassette" none cassette
+     Then the HTTP get request to "http://example.com" should result in a fakeweb error
+      And there should not be a "temp/record_none_cassette" cache file
+  @copy_not_the_real_response_to_temp
+  Scenario: Make an HTTP request in a cassette with record mode set to :unregistered
+    Given we have a "temp/not_the_real_response" file with a previously recorded response for "http://example.com"
+      And we have a "temp/not_the_real_response" file with no previously recorded response for "http://example.com/foo"
+     When I make HTTP get requests to "http://example.com" and "http://example.com/foo" within the "temp/not_the_real_response" unregistered cassette
+     Then the "temp/not_the_real_response" cache file should have a response for "http://example.com" that matches /This is not the real response from example\.com/
+      And the "temp/not_the_real_response" cache file should have a response for "http://example.com/foo" that matches /The requested URL \/foo was not found/

data/features/replay_recorded_response.feature ADDED

@@ -0,0 +1,53 @@
+Feature: Replay recorded response
+  In order to have deterministic, fast tests that do not depend on an internet connection
+  As a TDD/BDD developer
+  I want to replay responses for requests I have previously recorded
+  Scenario: Replay recorded response for a request in a VCR.with_cassette block
+    Given the "not_the_real_response" cache file has a response for "http://example.com" that matches /This is not the real response from example\.com/
+     When I make an HTTP get request to "http://example.com" within the "not_the_real_response" cassette
+     Then the response for "http://example.com" should match /This is not the real response from example\.com/
+  @replay_cassette1
+  Scenario: Replay recorded response for a request within a tagged scenario
+    Given this scenario is tagged with the vcr cassette tag: "@replay_cassette1"
+      And the "cucumber_tags/replay_cassette1" cache file has a response for "http://example.com" that matches /This is not the real response from example\.com/
+     When I make an HTTP get request to "http://example.com"
+     Then the response for "http://example.com" should match /This is not the real response from example\.com/
+  @replay_cassette2
+  Scenario: Use both a tagged scenario cassette and a nested cassette within a single step definition
+    Given this scenario is tagged with the vcr cassette tag: "@replay_cassette2"
+      And the "cucumber_tags/replay_cassette2" cache file has a response for "http://example.com/before_nested" that matches /The before_nested response/
+      And the "nested_replay_cassette" cache file has a response for "http://example.com/nested" that matches /The nested response/
+      And the "cucumber_tags/replay_cassette2" cache file has a response for "http://example.com/after_nested" that matches /The after_nested response/
+     When I make an HTTP get request to "http://example.com/before_nested"
+      And I make an HTTP get request to "http://example.com/nested" within the "nested_replay_cassette" cassette
+      And I make an HTTP get request to "http://example.com/after_nested"
+     Then the response for "http://example.com/before_nested" should match /The before_nested response/
+      And the response for "http://example.com/nested" should match /The nested response/
+      And the response for "http://example.com/after_nested" should match /The after_nested response/
+  @copy_not_the_real_response_to_temp
+  Scenario: Make an HTTP request in a cassette with record mode set to :all
+    Given we have a "temp/not_the_real_response" file with a previously recorded response for "http://example.com"
+      And we have a "temp/not_the_real_response" file with no previously recorded response for "http://example.com/foo"
+     When I make HTTP get requests to "http://example.com" and "http://example.com/foo" within the "temp/not_the_real_response" all cassette
+     Then the response for "http://example.com" should match /You have reached this web page by typing.*example\.com/
+      And the response for "http://example.com/foo" should match /The requested URL \/foo was not found/
+  @copy_not_the_real_response_to_temp
+  Scenario: Make an HTTP request in a cassette with record mode set to :none
+    Given we have a "temp/not_the_real_response" file with a previously recorded response for "http://example.com"
+      And we have a "temp/not_the_real_response" file with no previously recorded response for "http://example.com/foo"
+     When I make HTTP get requests to "http://example.com" and "http://example.com/foo" within the "temp/not_the_real_response" none cassette
+     Then the response for "http://example.com" should match /This is not the real response from example\.com/
+      And the HTTP get request to "http://example.com/foo" should result in a fakeweb error
+  @copy_not_the_real_response_to_temp
+  Scenario: Make an HTTP request in a cassette with record mode set to :unregistered
+  Given we have a "temp/not_the_real_response" file with a previously recorded response for "http://example.com"
+    And we have a "temp/not_the_real_response" file with no previously recorded response for "http://example.com/foo"
+   When I make HTTP get requests to "http://example.com" and "http://example.com/foo" within the "temp/not_the_real_response" unregistered cassette
+   Then the response for "http://example.com" should match /This is not the real response from example\.com/
+    And the response for "http://example.com/foo" should match /The requested URL \/foo was not found/

data/features/step_definitions/vcr_steps.rb ADDED

@@ -0,0 +1,88 @@
+require 'tmpdir'
+module VCRHelpers
+  def have_expected_response(url, regex_str)
+    simple_matcher("a response from #{url} that matches /#{regex_str}/") do |responses|
+      regex = /#{regex_str}/i
+      response = responses.detect { |r| URI.parse(r.uri) == URI.parse(url) }
+      response.should_not be_nil
+      response.response.body.should =~ regex
+    end
+  end
+end
+World(VCRHelpers)
+Given /^we do not have a "([^\"]*)" cassette$/ do |cassette_name|
+  fixture_file = File.join(VCR::Config.cache_dir, "#{cassette_name}.yml")
+  File.exist?(fixture_file).should be_false
+end
+Given /^we have a "([^\"]*)" file with (a|no) previously recorded response for "([^\"]*)"$/ do |file_name, a_or_no, url|
+  fixture_file = File.join(VCR::Config.cache_dir, "#{file_name}.yml")
+  File.exist?(fixture_file).should be_true
+  responses = File.open(fixture_file, 'r') { |f| YAML.load(f.read) }
+  should_method = a_or_no == 'a' ? :should : :should_not
+  responses.map{ |r| URI.parse(r.uri) }.send(should_method, include(URI.parse(url)))
+end
+Given /^the "([^\"]*)" cache file has a response for "([^\"]*)" that matches \/(.+)\/$/ do |cassette_name, url, regex_str|
+  Given %{we have a "#{cassette_name}" file with a previously recorded response for "#{url}"}
+  Then %{the "#{cassette_name}" cache file should have a response for "#{url}" that matches /#{regex_str}/}
+end
+Given /^this scenario is tagged with the vcr cassette tag: "([^\"]+)"$/ do |tag|
+  VCR.current_cucumber_scenario.should be_tagged_with(tag)
+  VCR::CucumberTags.tags.should include(tag)
+end
+Given /^the previous scenario was tagged with the vcr cassette tag: "([^\"]*)"$/ do |tag|
+  last_scenario = VCR.completed_cucumber_scenarios.last
+  last_scenario.should_not be_nil
+  last_scenario.should be_tagged_with(tag)
+  VCR::CucumberTags.tags.should include(tag)
+end
+When /^I make an HTTP get request to "([^\"]*)"$/ do |url|
+  @http_requests ||= {}
+  begin
+    result = Net::HTTP.get_response(URI.parse(url))
+  rescue => e
+    result = e
+  end
+  @http_requests[url] = result
+end
+When /^I make (?:an )?HTTP get requests? to "([^\"]*)"(?: and "([^\"]*)")? within the "([^\"]*)" ?(#{VCR::Cassette::VALID_RECORD_MODES.join('|')})? cassette$/ do |url1, url2, cassette_name, record_mode|
+  record_mode ||= :unregistered
+  record_mode = record_mode.to_sym
+  urls = [url1, url2].select { |u| u.to_s.size > 0 }
+  VCR.with_cassette(cassette_name, :record => record_mode) do
+    urls.each do |url|
+      When %{I make an HTTP get request to "#{url}"}
+    end
+  end
+end
+Then /^the "([^\"]*)" cache file should have a response for "([^\"]*)" that matches \/(.+)\/$/ do |cassette_name, url, regex_str|
+  yaml_file = File.join(VCR::Config.cache_dir, "#{cassette_name}.yml")
+  responses = File.open(yaml_file, 'r') { |f| YAML.load(f.read) }
+  responses.should have_expected_response(url, regex_str)
+end
+Then /^I can test the scenario cassette's recorded responses in the next scenario, after the cassette has been destroyed$/ do
+  # do nothing...
+end
+Then /^the HTTP get request to "([^\"]*)" should result in a fakeweb error$/ do |url|
+  @http_requests[url].should be_instance_of(FakeWeb::NetConnectNotAllowedError)
+end
+Then /^the response for "([^\"]*)" should match \/(.+)\/$/ do |url, regex_str|
+  regex = /#{regex_str}/i
+  @http_requests[url].body.should =~ regex
+end
+Then /^there should not be a "([^\"]*)" cache file$/ do |cassette_name|
+  yaml_file = File.join(VCR::Config.cache_dir, "#{cassette_name}.yml")
+  File.exist?(yaml_file).should be_false
+end