rack-vcr 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3825c1470087671fef46cf5a1109efd7471b371b
-  data.tar.gz: 21302ea609c296cf2e727550183ddccc9c2032b2
+  metadata.gz: b6eaa58258aa9c40597d031ac0d03e66802213d7
+  data.tar.gz: 552949bbaae571fefe1585362e9f37c512de92f1
 SHA512:
-  metadata.gz: 45d499d8e3558ae702bc7caeb004a2c59369666f61a5c1b73430fb8882fa782c91ab755683b126f198cb2bf3344673b6dc72af120b62d29278e1cc37ab8c6c59
-  data.tar.gz: df1645554a7dd7dbeb84fa96788901cd80483a071d22cda77b2518a9945f6341229769ef7287ac9f74f3e241e7d3f1a4cd2329a2d66b08f9b4e6dfe28caa1bd3
+  metadata.gz: 3a74839ff79299c0ff6534eb941494d6020fb165150128e068bf0c020f5c1d5f6443ecec46fe3272460604a43bc55208536bbb255e0cb2a32671e26db851f482
+  data.tar.gz: 15378c43828be779772e2dfcd0deec5b062d4c7e0a8b80f23bcf3a6de7f968e3c1faaecd648786211836bc1cbef47e050fe96972ef461bd560aeb569a220cdbb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.3 (2015/06/18)
+- Document replay/cassette option and add tests for them
+
 ## 0.1.2 (2015/06/17)
 - Add experimental `replay: true` option to replay VCR cassette on the Rack layer
 

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails
+### Capturing in Rails
 
 In `config/initializer/rack_vcr.rb`:
 
@@ -48,9 +48,10 @@ RSpec.configure do |config|
 end
 ```
 
-### Sinatra/Rack
+### Capturing in Sinatra/Rack
+
+In `spec/spec_helper.rb`:
 
-To capture HTTP interactions, enable VCR configuration in addition to this middleware, in the spec:
 
 ```ruby
 require 'rack/test'
@@ -76,7 +77,50 @@ describe 'My Web App' do
     # Now you get vcr_cassettes/hello.yml saved
   end
 end
-````
+```
+
+### Replaying
+
+Rack::VCR also supports *replaying* recorded VCR cassettes. It means you can record the HTTP interactions with the real app (on CI), then use the cassette to run a fake/mock API server using Rack::VCR!
+
+To replay cassettes, enable Rack::VCR with `:replay` option in `config.ru` or its equivalent.
+
+```ruby
+VCR.configure do |config|
+  config.cassette_library_dir = "/path/to/cassettes"
+end
+
+Rack::Builder.new do
+  use Rack::VCR, replay: true, cassette: "test"
+  run MyApp
+end
+```
+
+With the above setting, Rack::VCR will try to locate the cassette named "test" to replay if the request matches with what's recorded, and fall through to the original application if it's not there.
+
+To customize the cassette name in runtime, you can write a custom piece of Rack middleware around Rack::VCR to wrap the application in `VCR.use_cassette` with its own `:record` option.
+
+```ruby
+class CassetteLocator
+  def initialize(app)
+    @app = app
+  end
+  
+  def call(env)
+    cassette = ... # determine cassette from env
+    VCR.use_cassette(casssette, record: :none) do
+      @app.call(env)
+    end
+  end
+end
+
+Rack::Builder.new do 
+  use CassetteLocator
+  use Rack::VCR, replay: true
+  run MyApp
+end
+```
+
 
 ## Notes
 

data/lib/rack/vcr.rb

@@ -7,9 +7,20 @@ module Rack
     def initialize(app, options = {})
       @app = app
       @replay = options[:replay]
+      @cassette = options[:cassette]
     end
 
     def call(env)
+      if @cassette
+        ::VCR.use_cassette(@cassette, record: :new_episodes) do
+          run_request(env)
+        end
+      else
+        run_request(env)
+      end
+    end
+
+    def run_request(env)
       req = Rack::Request.new(env)
       transaction = Transaction.new(req)
 

data/lib/rack/vcr/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class VCR
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-vcr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr