rack-vcr 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a363c46853907046d67adc464963251eecd4b276
-  data.tar.gz: c2a672a981910a93d2cbca50a8aee7b0f74e8e9e
+SHA256:
+  metadata.gz: dd81d08f1fea87a51788e471948f8209f83a3ca27d7b1e9476a2442e36910038
+  data.tar.gz: 1ae3ef6efcce039cf0de32f252aa432514ffe038087aa0273470dc77f6838c78
 SHA512:
-  metadata.gz: f4f10f5006867f4b86d472f242e4e40e7f8f475e8f745439b2fcbdfc8470d0d9356d7f034379ecca26faa7f292ee0f22abaea5224f37176a75de605c121fecc2
-  data.tar.gz: 734e6a3adcf2e8f8f0c6da178a69bb8b0fa8e2147c31e5cc8df3da5a42bf5e2b7ea7ee7f2aa72b9530ad3f13505eb9a7ff99a7f034a500c3c075e420d957ce68
+  metadata.gz: 957402e260aa2976b59e84260172e296984451c6c5d09591ab03f94e1f0bb28ef63aa5a9fba0d29da484c02ae89e6cb85b522359fb62234781f187df7dc5a509
+  data.tar.gz: a89328c6aade966b0fa30af74ed5b04f995c984ede7bbf14282a5bc91968c25660834614e3975b6e5f1048bbc57f5284eb343092805e419d6fcd860c0088caa1

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Run tests
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        rack_version:
+          - ~> 1.6
+          - ~> 2.0.9
+          - ~> 2.1.4
+          - ~> 2.2.3
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Run tests on ruby ${{ matrix.ruby_version }} with rack ${{ matrix.rack_version }}
+        run: |
+          bundle check || bundle update
+          bundle exec rake
+        env:
+          RACK_VERSION: ${{ matrix.rack_version }}

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.1.6 (2020/10/31)
+- Support Rack 2.1+ (#10)
+
+## 0.1.5 (2017/07/11)
+- Documentation fixes
+- Support VCR 3+
+
+## 0.1.4 (2015/06/18)
+- Add :record option to override the default :new_episodes
+
+## 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
+
 ## 0.1.1 (2015/06/17)
 - Add Rails example in doc
 

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-vcr.gemspec
 gemspec
+
+gem 'rack', ENV['RACK_VERSION']

data/README.md

@@ -20,9 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails
+### Capturing in Rails
 
-In `config/initializer/rack_vcr.rb`:
+In `config/initializers/rack_vcr.rb`:
 
 ```ruby
 if Rails.env.test?
@@ -37,6 +37,20 @@ VCR.configure do |config|
   config.cassette_library_dir = 'doc/cassettes'
 end
 
+RSpec.configure do |config|
+  config.around(:each, type: :request) do |example|
+    host! "yourapp.hostname"
+    name = example.full_description.gsub /[^\w\-]/, '_'
+    VCR.use_cassette(name, record: :all) do
+      example.run
+    end
+  end
+end
+```
+
+The above example might not work if you were using RSpec 2.x, in which case you might need to write as follows:
+
+```ruby
 RSpec.configure do |config|
   config.around(:each, type: :request) do |ex|
     host! "yourapp.hostname"
@@ -48,9 +62,12 @@ RSpec.configure do |config|
 end
 ```
 
-### Sinatra/Rack
+Read more about the changes around `example` on [RSpec blog post](http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/).
+
+### 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 +93,53 @@ 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", record: :new_episodes
+  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. It also records the result to the cassette for further requests with the `:record` option set to `:new_episodes`.
+
+You can set `:record` option to `:none` for example, to only serve what's already recorded in the cassette. The default value for `:record` option is `:new_episodes`.
+
+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(cassette, 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

@@ -4,16 +4,35 @@ require "vcr"
 
 module Rack
   class VCR
-    def initialize(app)
+    def initialize(app, options = {})
       @app = app
+      @replay = options[:replay]
+      @cassette = options[:cassette]
+      @record   = options[:record] || :new_episodes
     end
 
     def call(env)
+      if @cassette
+        ::VCR.use_cassette(@cassette, record: @record) do
+          run_request(env)
+        end
+      else
+        run_request(env)
+      end
+    end
+
+    def run_request(env)
       req = Rack::Request.new(env)
-      status, headers, body = @app.call(env)
-      res = Rack::Response.new(body, status, headers)
-      Transaction.capture(req, res)
-      [status, headers, body]
+      transaction = Transaction.new(req)
+
+      if @replay && transaction.can_replay?
+        transaction.replay
+      else
+        status, headers, body = @app.call(env)
+        res = Rack::Response.new(body, status, headers)
+        transaction.capture(res)
+        [status, headers, body]
+      end
     end
   end
 end

data/lib/rack/vcr/transaction.rb

@@ -1,39 +1,55 @@
 module Rack
   class VCR
     class Transaction
-      def self.capture(*args)
-        new(*args).record
+      def initialize(req)
+        @req = req
       end
 
-      def initialize(req, res)
-        @req, @res = req, res
+      def capture(res)
+        @res = res
+        ::VCR.record_http_interaction(::VCR::HTTPInteraction.new(vcr_request, vcr_response))
       end
 
-      def record
-        ::VCR.record_http_interaction(::VCR::HTTPInteraction.new(vcr_request, vcr_response))
+      def can_replay?
+        ::VCR.http_interactions.has_interaction_matching?(vcr_request)
+      end
+
+      def replay
+        to_rack_response(::VCR.http_interactions.response_for(vcr_request))
       end
 
       private
 
       def vcr_request
-        ::VCR::Request.new(@req.request_method, @req.url, try_read(@req.body), request_headers)
+        @vcr_request ||=
+          ::VCR::Request.new(@req.request_method, @req.url, try_read(@req.body), request_headers)
       end
 
       def vcr_response
         ::VCR::Response.new(
           ::VCR::ResponseStatus.new(@res.status, nil),
           @res.headers,
-          @res.body.join(''),
+          @res.body.to_enum.to_a.join(''),
         )
       end
 
+      def to_rack_response(res)
+        [
+          res.status.code,
+          Hash[res.headers.map {|k, v| [k, v.join("\n")] }],
+          [res.body],
+        ]
+      end
+
       def request_headers
         headers_hash_from_env.merge(content_field_hash)
       end
 
       def headers_hash_from_env
-        fields = @req.env.select {|k, v| k.start_with? 'HTTP_' }
-                 .collect { |k, v| [normalize_header_field(k), v] }
+        fields = @req.env
+                   .map { |k, v| [k.to_s, v] }
+                   .select {|k, v| k.start_with?('HTTP_') }
+                   .collect { |k, v| [normalize_header_field(k), v] }
         Hash[fields]
       end
 

data/lib/rack/vcr/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class VCR
-    VERSION = "0.1.1"
+    VERSION = "0.1.6"
   end
 end

data/rack-vcr.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "vcr", "~> 2.9"
+  spec.add_dependency "vcr", ">= 2.9"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.10"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec"
 
-  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "sinatra", ">= 1.4"
   spec.add_development_dependency "rack-test", "~> 0.6"
-  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "webmock", "~> 3"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rack-vcr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -70,14 +70,14 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3'
 description: This Rack middleware records incoming Rack request and responses in a
   VCR compatible format.
 email:
@@ -118,9 +118,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -151,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Record incoming Rack request as VCR cassettes

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.0
-before_install: gem install bundler -v 1.10.3