VCR/WebMock/RSpecで外部と通信を行うテストを書く

VCRのインストール

Gemfileに以下を追加してbundle install

group :test do
  gem 'vcr'
  gem 'webmock', ">= 1.8.0", "< 1.12"
end

RSpec用設定

spec/spec_helper.rbに以下の内容を追加

spec/spec_helper.rb

RSpec.configure do |config|
  #  some other codes… #

  VCR.configure do |c|
    c.cassette_library_dir = 'spec/vcr_cassettes'
    c.hook_into :webmock
  end

  # SpecのDescriptionを元にVCRのファイル名を生成する
  config.around(:each, :vcr) do |example|
    name = example.metadata[:full_description].split(/\s+/, 2).join("/").underscore.gsub(/[^\w\/]+/, "_")
    options = example.metadata.slice(:record, :match_requests_on).except(:example_group)
    options.reverse_merge!(record: :new_episodes)
    VCR.use_cassette(name, options) { example.call }
  end
end

c.cassette_library_dirの場所は色々流儀があるようだが、通常FactoryGirlのfactoryデータがspec/factories下に入っているはずなので、それに合わせる形で、spec/vcr_cassettesと指定している。

参考:

• https://github.com/vcr/vcr
• http://natashatherobot.com/vcr-gem-rails-rspec/
• http://morizyun.github.io/blog/webmock-vcr-gem-rails/
• http://qiita.com/sawamur@github/items/e6fa877e35b383903e2e