Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
100644 173 lines (135 sloc) 10.176 kb
3e442f3 @myronmarston Change History file to markdown format and renamed it to changelog.
1 #Changelog
4839e58 @myronmarston Improved the :all record mode so that it keeps previously recorded inter...
3 ## In git
5 * Improved the `:all` record mode so that it keeps previously recorded interactions that do not match the
6 new recorded interactions. Previously, all of the previously recorded interactions were deleted.
b827a7b @myronmarston 1.1.2 release.
8 ## 1.1.2 (September 9, 2010)
10 * Fixed a minor bug with the WebMock integration: WebMock extends each `Net::HTTPResponse` with an extension
11 module after reading the body, and VCR was doing the same thing, leading to some slight deviance from
12 standard Net::HTTP behavior. The fix prevents VCR from adding the same extension to a `Net::HTTPResponse`
13 that has already been extende by WebMock.
14 * Fixed a minor bug in the `VCR::Net::HTTPResponse` module so that it correctly handles nil bodies (such as
15 for a HEAD request).
16 * Refactored `VCR::Net::HTTPResponse` module so it is implemented in a much simpler manner.
17 * Updated specs and features so they pass against the latest WebMock release (1.3.5).
18 * Minor documentation updates.
69c0fe7 @myronmarston 1.1.1 release.
20 ## 1.1.1 (August 26, 2010)
4d68e93 @myronmarston Optimized #stub_requests a bit.
ed4a662 @myronmarston The latest FakeWeb passes this spec (was pending before).
22 * Updated to use and require FakeWeb 1.3.0. It includes a fix for a bug related to multiple values for the
23 same response header.
7f58282 @myronmarston Use FakeWeb::Utility.request_uri_as_string rather than our own logic to ...
24 * Use new `FakeWeb::Utility.request_uri_as_string` method rather than our own logic to construct a request uri.
5fc0ba4 @myronmarston Use a localhost regex with FakeWeb.allow_net_connect for the ignore_loca...
25 * Use new `FakeWeb.allow_net_connect = /url regex/` feature to power the `ignore_localhost` VCR option rather
26 then toggling `FakeWeb.allow_net_connect` in our Net::HTTP extension.
4d68e93 @myronmarston Optimized #stub_requests a bit.
27 * Optimized `VCR.http_stubbing_adapter.stub_requests` a bit.
5f5da7a @myronmarston Change http stubbing adapters to be modules rather than classes.
28 * Changed the http stubbing adapters to be modules rather than classes. They should never be instantiated and
29 don't really hold state, so a module is more appropriate.
0a979b4 @myronmarston Refactored and updated #check_version! on FakeWeb/WebMock adapters so th...
30 * Warn when FakeWeb or WebMock are a minor or major version number ahead of the required version, as the new
31 version isn't known to work with VCR.
4d68e93 @myronmarston Optimized #stub_requests a bit.
4a465ca @myronmarston 1.1.0 release.
33 ## 1.1.0 (August 22, 2010)
0289298 @myronmarston Removed task runner as it's no longer needed.
3def0be @myronmarston Documentation updates for new :match_requests_on option.
35 * Added `:match_requests_on` cassette option, which determines how VCR matches requests.
0289298 @myronmarston Removed task runner as it's no longer needed.
36 * Removed VCR::TaskRunner and the corresponding rake task definition. The rake task migrated cassettes from the
37 0.3.1 format to the 0.4+ format. If you are still on 0.3.1 or earlier, I recommend you upgrade to 0.4.1 first,
38 migrate your cassettes and deal with migration warnings, then upgrade to the current release.
606e328 @myronmarston Raise an error if is given invalid options.
39 * Added some code to to check the options passed to the cassette and raise an error if any
40 invalid options are passed.
f2bb986 @myronmarston Optimized ERB rendering a bit.
41 * Optimized ERB rendering a bit. Rather than creating a new struct subclass for each time we render an ERB
42 cassette with locals, we keep a cache of reusable struct subclasses based on the desired attributes.
43 [Benchmarking]( reveals this is about 28% faster.
a40025f @myronmarston Updated em-http-request to 0.2.10.
44 * Upgraded tests to use em-http-request 0.2.10 rather than 0.2.7.
0289298 @myronmarston Removed task runner as it's no longer needed.
ce13279 @myronmarston 1.0.3 release.
46 ## 1.0.3 (August 5, 2010)
48 * Upgraded VCR specs to RSpec 2.
49 * Updated `VCR::CucumberTags` so that it uses an `around` hook rather than a `before` hook and an `after` hook.
50 Around hooks were added to Cucumber in the 0.7.3 release, so you'll have to be on that version or higher to use
51 the `VCR::CucumberTags` feature.
52 * Updated the WebMock version requirement to 1.3.3 or greater. 1.3.2 and earlier versions did not properly handle
53 multiple value for the same response header.
54 * Miscellaneous documentation updates.
e13d215 @myronmarston 1.0.2 release.
56 ## 1.0.2 (July 6, 2010)
58 * Fixed VCR to work with [rest-client]( Rest-client extends the Net::HTTP
59 response body string with a module containing additional data, which got serialized to the cassette file YAML
60 and occasionally caused problems when the YAML was deserialized. Bug reported by
61 [Thibaud Guillaume-Gentil](
62 * Setup bundler to manage development dependencies.
ade8181 @myronmarston 1.0.1 release.
64 ## 1.0.1 (July 1, 2010)
66 * Fixed specs and features so they pass on MRI 1.9.2-preview3 and JRuby 1.5.1.
67 * Normalized response and request headers so that they are stored the same (i.e. lower case keys, arrays of values)
68 in the cassette yaml files, regardless of which HTTP library is used. This is the same way Net::HTTP normalizes
69 HTTP headers.
70 * Fixed `VCR.use_cassette` so that it doesn't eject a cassette if an exception occurs while inserting one.
71 * Fixed FakeWeb adapter so that it works for requests that use basic auth. Patch submitted by
72 [Eric Allam](
a5ac5bf @myronmarston 1.0.0 release.
74 ## 1.0.0 (June 22, 2010)
76 * New Features
77 * Added support for [HTTPClient](, [Patron]( and
78 [em-http-request]( when WebMock is used. Any future http libraries
79 WebMock supports should (theoretically, at least) work without any VCR code changes. Thanks to
80 [Bartosz Blimke]( for adding the necessary code to WebMock to make this happen!
81 * Added support for dynamic responses using ERB. A cassette will be evaluated as ERB before the YAML
82 is deserialized if you pass it an `:erb => true` option. You can pass variables using
83 `:erb => { :var1 => 'some value', :var2 => 'another value' }`.
84 * Added `ignore_localhost` configuration setting, which defaults to false. Setting it true does the following:
85 * Localhost requests will proceed as normal. The "Real HTTP connections are disabled" error will not occur.
86 * Localhost requests will not be recorded.
87 * Previously recorded localhost requests will not be replayed.
88 * Exposed the version number:
89 * `VCR.version` => string (in the format "major.minor.patch")
90 * `` => array of integers
91 * `VCR.version.major` => integer
92 * `VCR.version.minor` => integer
93 * `VCR.version.patch` => integer
94 * Added test coverage and documentation of using a regex for non-deterministic URLs (i.e. URLs that include
95 a timestamp as a query parameter). It turns out this feature worked before, and I just didn't realize it :).
97 * Breaking Changes
98 * The `:allow_real_http => lambda { |uri| ... }` cassette option has been removed. There was no way to get
99 this to work with the newly supported http libraries without extensive monkeypatching, and it was mostly
100 useful for localhost requests, which is more easily handled by the new `ignore_localhost` config setting.
101 * Removed methods and options that had been previously deprecated. If you're upgrading from an old version,
102 I recommend upgrading to 0.4.1 first, deal with all the deprecation warnings, then upgrade to 1.0.0.
104 * Misc Changes:
105 * Removed dependency on [jeweler]( Manage the gemspec by hand instead.
106 * Removed some extensions that are no longer necessary.
dfceeb1 @myronmarston 0.4.1 release.
108 ## 0.4.1 May 11, 2010
109 * Fixed a bug: when `Net::HTTPResponse#read_body` was called after VCR had read the body to record a new request,
110 it raised an error (`IOError: Net::HTTPResponse#read_body called twice`). My fix extends Net::HTTPResponse
111 so that it no longer raises this error.
7663252 @myronmarston 0.4.0 release.
113 ## 0.4.0 April 28, 2010
af61cfc @myronmarston Updated CHANGELOG with the info about what is coming in the next release...
114 * Added support for webmock. All the fakeweb-specific code is now in an adapter (as is the webmock code).
116 * Changed the format of the VCR cassettes. The old format was tied directly to Net::HTTP, but webmock supports
117 other HTTP libraries and I plan to allow VCR to use them in the future. Note that this is a breaking change--your
118 old VCR cassettes from prior releases will not work with VCR 0.4.0. However, VCR provides a rake task to assist
119 you in migrating your cassettes to the new format. Simply add `load 'vcr/tasks/vcr.rake'` to your project's Rakefile,
120 and run:
122 $ rake vcr:migrate_cassettes DIR=path/to/cassete/library/directory
124 * The new cassette format records more information about the request (i.e. the request headers and body), so that it
125 can potentially be used with webmock in the future.
127 * Made most of `VCR::Cassette`'s methods private. I had forgotten to make the methods private before, and most of them
128 don't need to be exposed.
130 * Automatically disallow http connections using the appropriate setting of the http stubbing library (fakeweb or webmock).
131 This relieves users from the need to set the option themselves, so they hopefully aren't using either fakeweb or webmock
132 directly, making it much easier to switch between these.
134 * Change documentation from rdoc to markdown format.
136 * Lots of other refactoring.
3e442f3 @myronmarston Change History file to markdown format and renamed it to changelog.
138 ## 0.3.1 April 10, 2010
139 * Fixed a bug: when `Net::HTTP#request` was called with a block that had a return statement, the response was not being recorded.
141 ## 0.3.0 March 24, 2010
142 * Renamed a bunch of methods, replacing them with method names that more clearly fit the VCR/cassette metaphor:
143 * `VCR.create_cassette!` => `VCR.insert_cassette`
144 * `VCR.destroy_cassette!` => `VCR.eject_cassette`
145 * `VCR.with_cassette` => `VCR.use_cassette`
146 * `VCR::Cassette#destroy!` => `VCR::Cassette#eject`
147 * `VCR::Cassette#cache_file` => `VCR::Cassette#file`
148 * `VCR::Config.cache_dir` => `VCR::Config.cassette_library_dir`
149 * `:unregistered` record mode => `:new_episodes` record mode
151 * All the old methods still work, but you'll get deprecation warnings.
153 ## 0.2.0 March 9, 2010
154 * Added `:allow_real_http` cassette option, which allows VCR to work with capybara and a javascript driver.
155 Bug reported by [Ben Hutton](
157 * Deprecated the `default_cassette_record_mode` option. Use `default_cassette_options[:record_mode]` instead.
159 ## 0.1.2 March 4, 2010
160 * Added explanatory note about VCR to `FakeWeb::NetConnectNotAllowedError#message`.
162 * Got things to work for when a cassette records multiple requests made to the same URL with the same HTTP verb,
163 but different responses. We have to register an array of responses with fakeweb.
165 * Fixed our `Net::HTTP` monkey patch so that it only stores the recorded response once per request.
166 Internally, `Net::HTTP#request` recursively calls itself (passing slightly different arguments) in certain circumstances.
168 ## 0.1.1 February 25, 2010
169 * Handle asynchronous HTTP requests (such as for mechanize). Bug reported by [Thibaud Guillaume-Gentil](
171 ## 0.1.0 February 25, 2010
ade8181 @myronmarston 1.0.1 release.
172 * Initial release. Basic recording and replaying of responses works.
Something went wrong with that request. Please try again.