rack-vcr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b52f5eecaf0bb0a9faca2dc3dd5c7bd548a1685c
+  data.tar.gz: e5aa7389b370b3d6a432deed7aaae7773319645a
+SHA512:
+  metadata.gz: 8196ada048868ee8ae3307b2ffd09dd8a36406b43be2ce9768f0e04fa66111476e911ab024b22bdf11ce9fbb70e9a5169bdea36f1d8ca5331b39a6b47b7beba7
+  data.tar.gz: fdcadc1e66695e5c683292f2f2193de6d8f4dfc35e375c675ed9bde6badf3084c43604930e81237e3b36a526324cd1e6762a9be91ea1e9e77fbc086e0302afdf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2015/06/15)
+- Initial release
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-vcr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tatsuhiko Miyagawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Rack::VCR
+
+Rack::VCR captures incoming HTTP requests and responses on your Rack application (Rails, Sinatra) and saves them as a VCR fixture in cassettes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-vcr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-vcr
+
+## Usage
+
+### Rails
+
+TBD
+
+### Sinatra/Rack
+
+To capture HTTP interactions, enable VCR configuration in addition to this middleware, in the spec:
+
+```ruby
+require 'rack/test'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "vcr_cassettes"
+end
+
+describe 'My Web App' do
+  include Rack::Test::Methods
+
+  let(:app) {
+    Rack::Builder.new do
+      use Rack::VCR
+      run Sinatra::Application
+    end
+  }
+
+  it 'runs the request' do
+    VCR.use_cassette('hello', record: :all) do
+      get "/hello"
+    end
+    # Now you get vcr_cassettes/hello.yml saved
+  end
+end
+````
+
+## Notes
+
+There's a few similar gems available on Rubygems and GitHub:
+
+* [VCR::Middleware::Rack](https://www.relishapp.com/vcr/vcr/v/1-6-0/docs/middleware/rack) - Records *outgoing* HTTP requests inside a Rack application. Quite opposite to what Rack::VCR gem does.
+* [rack-recorder](https://github.com/kodev/rack-recorder) - Essentially the same with Rack::VCR, but is very limited in what it does. It doesn't export the captured transaction in VCR compatible format.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/miyagawa/rack-vcr.
+
+## Author
+
+Tatsuhiko Miyagawa
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/vcr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/vcr.rb

@@ -0,0 +1,19 @@
+require "rack/vcr/version"
+require "rack/vcr/transaction"
+require "vcr"
+
+module Rack
+  class VCR
+    def initialize(app)
+      @app = app
+    end
+
+    def call(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]
+    end
+  end
+end

data/lib/rack/vcr/transaction.rb

@@ -0,0 +1,59 @@
+module Rack
+  class VCR
+    class Transaction
+      def self.capture(*args)
+        new(*args).record
+      end
+
+      def initialize(req, res)
+        @req, @res = req, res
+      end
+
+      def record
+        ::VCR.record_http_interaction(::VCR::HTTPInteraction.new(vcr_request, vcr_response))
+      end
+
+      private
+
+      def 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(''),
+        )
+      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] }
+        Hash[fields]
+      end
+
+      def content_field_hash
+        { "Content-Type"   => @req.env["CONTENT_TYPE"],
+          "Content-Length" => @req.env["CONTENT_LENGTH"] }.reject {|k, v| v.nil? or v == "0" }
+      end
+
+      def normalize_header_field(k)
+        k.sub(/^HTTP_/, '')
+          .split('_').map(&:capitalize).join('-')
+      end
+
+      def try_read(body)
+        if body
+          b = body.read
+          body.rewind
+          b
+        end
+      end
+    end
+  end
+end

data/lib/rack/vcr/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class VCR
+    VERSION = "0.1.0"
+  end
+end

data/rack-vcr.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/vcr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-vcr"
+  spec.version       = Rack::VCR::VERSION
+  spec.authors       = ["Tatsuhiko Miyagawa"]
+  spec.email         = ["miyagawa@bulknews.net"]
+
+  spec.summary       = %q{Record incoming Rack request as VCR cassettes}
+  spec.description   = %q{This Rack middleware records incoming Rack request and responses in a VCR compatible format.}
+  spec.homepage      = "https://github.com/miyagawa/rack-vcr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "vcr", "~> 2.9"
+
+  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 "rack-test", "~> 0.6"
+  spec.add_development_dependency "webmock", "~> 1.21"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rack-vcr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tatsuhiko Miyagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  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
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: This Rack middleware records incoming Rack request and responses in a
+  VCR compatible format.
+email:
+- miyagawa@bulknews.net
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/vcr.rb
+- lib/rack/vcr/transaction.rb
+- lib/rack/vcr/version.rb
+- rack-vcr.gemspec
+homepage: https://github.com/miyagawa/rack-vcr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Record incoming Rack request as VCR cassettes
+test_files: []