vcr_assistant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce3f6971903eeec4ad0cb9bbe40c6b671bf42cd
+  data.tar.gz: ccab9f45f747e919469e975728d8b2d840d2456a
+SHA512:
+  metadata.gz: 9956fe2b6aec65b2d2d6dbb84cadb988cfa1c41e2006a8d99a8614eedb6623279482eaa47d55bd02e676c1229b54ba7030bee9993a7a0ea958a351c2e9513a4d
+  data.tar.gz: d9e34022fe676336afb3f6458418bee33e4a2cdc62b0f3dd9983c8ea6ba2c6c6c325f0957f9a03c74a39b24085ab70203f7077992d1bdee865942b2fed62ec3e

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pat@freelancing-gods.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Pat Allan
+
+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,163 @@
+# VCR Assistant
+
+VCR Assistant is a tidy approach to managing VCR cassettes and setup/teardown logic. Currently it's built for use within RSpec v3 (but patches for other test frameworks are certainly welcome).
+
+It will automatically name your VCR cassette for you (based on the current example file name and description). You can also configure your assistant to automatically perform setup and teardown code. Here's a quick example for use with Stripe's test sandbox:
+
+```ruby
+class StripeAssistant
+  def initialize(vcr_cassette)
+    @vcr_cassette = vcr_cassette
+  end
+
+  def setup
+    # Clear out Stripe data at the beginning of a recording
+    # to ensure the sandbox environment is consistent.
+    Stripe::Customer.all.each &:delete
+    Stripe::Coupon.all.each &:delete
+    Stripe::Plan.all.each &:delete
+  end
+end
+
+VCRAssistant.assistant = lambda { |label, vcr_cassette|
+  StripeAssistant.new vcr_cassette
+}
+
+it 'automatically clears Stripe before tests' do |example|
+  assisted_cassette(example) do |assistant|
+    # assistant is an instance of StripeAssistant
+    # and the `setup` method has already been called.
+
+    # run test code with external HTTP calls
+    # assert expectations
+
+    # if assistant responded to a teardown method, that
+    # would automatically be invoked at the end of this block.
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vcr_assistant', '~> 0.1.0', :group => :test
+```
+
+To have the `assisted_cassette` helper to be available in all specs, you can require `'vcr_assistant/rspec'` either in your Gemfile:
+
+```ruby
+gem 'vcr_assistant', '~> 0.1.0',
+  :group   => :test,
+  :require => 'vcr_assistant/rspec'
+```
+
+Or in your `spec_helper.rb` or `rails_helper.rb` file:
+
+```ruby
+require 'vcr_assistant/rspec'
+```
+
+## Usage
+
+Instead of calling `VCR.use_cassette`, instead use either the `assisted_cassette` helper method or `VCRAssistant::Cassette.call(example)` directly. Either way, you need to pass in the current RSpec
+
+```ruby
+it 'should make external HTTP calls' do |example|
+  assisted_cassette example do |assistant|
+    # make API calls
+
+    # assert expectations
+  end
+end
+
+# or
+
+it 'should make external HTTP calls' do |example|
+  VCRAssistant::Cassette.call example do |assistant|
+    # make API calls
+
+    # assert expectations
+  end
+end
+```
+
+### Custom assistants
+
+A standard assistant won't do anything much - you'll just get the advantage of automatically named cassettes. To have a custom assistant, you need to change the value of `VCRAssistant.assistant` to something that responds to `call` - perhaps a Proc or lambda - and then returns an object.
+
+If this object responds to `setup`, that will be called before the cassette block is invoked, and same with `teardown` after the block. The arguments sent to the assistant generator are the label and the underlying VCR cassette. The label is useful to distinguish between different uses of VCR - it's the optional second argument for `assisted_cassette` / `VCRAssistant::Cassette.call`. If it's not provided, it has the value `:default`.
+
+```ruby
+VCRAssistant.assistant = lambda { |label, vcr_cassette|
+  case label
+  when :stripe
+    StripeAssistant.new vcr_cassette
+  when :paypal
+    PayPalAssistant.new vcr_cassette
+  else
+    nil # An assistant object is not essential
+  end
+}
+```
+
+You may want to add further functionality to your assistant - such as preparing regularly used data. For the example of Stripe, you may want to prepare customer or plan objects in some tests:
+
+```ruby
+# This is example code - it does not exist in VCR Assistant.
+class StripeAssistant
+  def initialize(vcr_cassette)
+    @vcr_cassette = vcr_cassette
+  end
+
+  def setup
+    Stripe::Customer.all.each &:delete
+    Stripe::Coupon.all.each &:delete
+    Stripe::Plan.all.each &:delete
+  end
+
+  def customer(email)
+    Stripe::Customer.create :email => email
+  end
+end
+
+# and then in a test:
+it 'should make external HTTP calls' do |example|
+  assisted_cassette example do |assistant|
+    customer = assistant.customer 'pat@example.com'
+
+    # run tests that may involve the new customer object
+
+    # assert expectations
+  end
+end
+```
+
+### Custom cassette file names
+
+The default approach to naming cassettes is to take the spec's file name (minus the _spec.rb suffix) as a folder name, and the specific example's description as the file name (lowercased and with underscores instead of spaces). Thus, a cassette in testing_stripe_spec.rb within an example description `'creates subscriptions'` would be named `testing_stripe/creates_subscriptions.yml`.
+
+If you'd like to have your own name generator, you can change `VCRAssistant.namer` to be a callable object that returns the appropriate file name as a string.
+
+```ruby
+VCRAssistant.namer = lambda { |example|
+  # Just use the spec's file name. Useless if you have
+  # more than one cassette in any given file.
+  example.metadata[:file_path].gsub(/_spec\.rb$/, '')
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vcr_assistant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Licence
+
+Copyright (c) 2016, VCR Assistant is developed and maintained by Pat Allan, and is released under the open MIT Licence.

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 "vcr_assistant"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vcr_assistant.rb

@@ -0,0 +1,24 @@
+require 'vcr'
+
+module VCRAssistant
+  def self.assistant
+    @assistant ||= VCRAssistant::Assistant
+  end
+
+  def self.assistant=(assistant)
+    @assistant = assistant
+  end
+
+  def self.namer
+    @namer ||= VCRAssistant::FileName
+  end
+
+  def self.namer=(namer)
+    @namer = namer
+  end
+end
+
+require 'vcr_assistant/assistant'
+require 'vcr_assistant/cassette'
+require 'vcr_assistant/file_name'
+require 'vcr_assistant/test_helpers'

data/lib/vcr_assistant/assistant.rb

@@ -0,0 +1,11 @@
+class VCRAssistant::Assistant
+  attr_reader :label, :vcr_cassette
+
+  def self.call(label, vcr_cassette)
+    new label, vcr_cassette
+  end
+
+  def initialize(label, vcr_cassette)
+    @label, @vcr_cassette = label, vcr_cassette
+  end
+end

data/lib/vcr_assistant/cassette.rb

@@ -0,0 +1,27 @@
+class VCRAssistant::Cassette
+  def self.call(example, label = :default, &block)
+    new(example, label, &block).call
+  end
+
+  def initialize(example, label, &block)
+    @example, @label, @block = example, label, block
+  end
+
+  def call
+    VCR.use_cassette(file_name) do |vcr_cassette|
+      assistant = VCRAssistant.assistant.call label, vcr_cassette
+
+      assistant.setup    if assistant.respond_to?(:setup)
+      block.call assistant
+      assistant.teardown if assistant.respond_to?(:teardown)
+    end
+  end
+
+  private
+
+  attr_reader :example, :label, :block
+
+  def file_name
+    VCRAssistant.namer.call example
+  end
+end

data/lib/vcr_assistant/file_name.rb

@@ -0,0 +1,25 @@
+class VCRAssistant::FileName
+  def self.call(example)
+    new(example).call
+  end
+
+  def initialize(example)
+    @example = example
+  end
+
+  def call
+    "#{folder}/#{file}"
+  end
+
+  private
+
+  attr_reader :example
+
+  def file
+    example.metadata[:description].downcase.gsub(/\s+/, '_').gsub(/[\W]+/, '')
+  end
+
+  def folder
+    File.basename example.metadata[:file_path], '_spec.rb'
+  end
+end

data/lib/vcr_assistant/rspec.rb

@@ -0,0 +1,5 @@
+require 'vcr_assistant'
+
+RSpec.configure do |config|
+  config.include VCRAssistant::TestHelpers
+end

data/lib/vcr_assistant/test_helpers.rb

@@ -0,0 +1,5 @@
+module VCRAssistant::TestHelpers
+  def assisted_cassette(example, &block)
+    VCRAssistant::Cassette.call example, &block
+  end
+end

data/vcr_assistant.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "vcr_assistant"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Pat Allan"]
+  spec.email         = ["pat@freelancing-gods.com"]
+
+  spec.summary       = %q{Manages VCR cassettes and set-up logic.}
+  spec.homepage      = "https://github.com/pat/vcr_assistant"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |file|
+    file.match(%r{^(test|spec|features)/})
+  }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "vcr", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: vcr_assistant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vcr_assistant.rb
+- lib/vcr_assistant/assistant.rb
+- lib/vcr_assistant/cassette.rb
+- lib/vcr_assistant/file_name.rb
+- lib/vcr_assistant/rspec.rb
+- lib/vcr_assistant/test_helpers.rb
+- vcr_assistant.gemspec
+homepage: https://github.com/pat/vcr_assistant
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Manages VCR cassettes and set-up logic.
+test_files: []