Add VCR (#287)

* Add VCR Write all requests to cassetes. * Speed up specs. * Don't make new requests for every run of existing specs. * Remove environment variables from CI They're not needed anymore with VCR, also it seems that secret token had empty value and broke specs.
atipugin · Aug 18, 2023 · f6e9756 · f6e9756
1 parent e6c23c7
commit f6e9756
Show file tree

Hide file tree

Showing 12 changed files with 267 additions and 6 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,9 +32,6 @@ jobs:
         ruby:
           - 2.7
           - 3.2
-    env:
-      BOT_API_ENV: test
-      BOT_API_TOKEN: ${{ secrets.BOT_API_TOKEN }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3

diff --git a/Gemfile b/Gemfile
@@ -10,6 +10,7 @@ gem 'pry'
 gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.4'
+gem 'vcr', '~> 6.0'
 
 gem 'rubocop', '~> 1.54.1'
 gem 'rubocop-performance', '~> 1.18'

diff --git a/spec/cassettes/Telegram_Bot_Api/_call/has_result.yml b/spec/cassettes/Telegram_Bot_Api/_call/has_result.yml
diff --git a/spec/cassettes/Telegram_Bot_Api/_call/has_status.yml b/spec/cassettes/Telegram_Bot_Api/_call/has_status.yml
diff --git a/spec/cassettes/Telegram_Bot_Api/_call/returns_hash.yml b/spec/cassettes/Telegram_Bot_Api/_call/returns_hash.yml
diff --git a/spec/cassettes/Telegram_Bot_Api/_call/when_token_is_invalid/raises_an_error.yml b/spec/cassettes/Telegram_Bot_Api/_call/when_token_is_invalid/raises_an_error.yml
diff --git a/spec/cassettes/Telegram_Bot_Client/_run/returns_hash.yml b/spec/cassettes/Telegram_Bot_Client/_run/returns_hash.yml
diff --git a/spec/cassettes/Telegram_Bot_Exceptions_ResponseError/has_error_code.yml b/spec/cassettes/Telegram_Bot_Exceptions_ResponseError/has_error_code.yml
diff --git a/spec/lib/telegram/bot/api_spec.rb b/spec/lib/telegram/bot/api_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Telegram::Bot::Api do
+RSpec.describe Telegram::Bot::Api, :vcr do
   let(:token) { ENV.fetch('BOT_API_TOKEN') }
   let(:environment) { ENV.fetch('BOT_API_ENV', :test) }
   let(:endpoint) { 'getMe' }

diff --git a/spec/lib/telegram/bot/client_spec.rb b/spec/lib/telegram/bot/client_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Telegram::Bot::Client do
+RSpec.describe Telegram::Bot::Client, :vcr do
   subject(:client) { described_class.new(token, environment: environment) }
 
   let(:token) { ENV.fetch('BOT_API_TOKEN') }

diff --git a/spec/lib/telegram/bot/exceptions/response_error_spec.rb b/spec/lib/telegram/bot/exceptions/response_error_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Telegram::Bot::Exceptions::ResponseError do
+RSpec.describe Telegram::Bot::Exceptions::ResponseError, :vcr do
   subject(:error) do
     described_class.new(response)
   rescue StandardError => e

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,4 +1,21 @@
 # frozen_string_literal: true
 
 require 'dotenv/load'
+
+ENV['BOT_API_ENV'] ||= 'test'
+ENV['BOT_API_TOKEN'] ||= 'test_api_token'
+
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "#{__dir__}/cassettes"
+  config.default_cassette_options = { record_on_error: false }
+  config.hook_into :faraday
+  config.configure_rspec_metadata!
+
+  config.filter_sensitive_data('<BOT_API_TOKEN>') do
+    ENV.fetch('BOT_API_TOKEN')
+  end
+end
+
 require_relative '../lib/telegram/bot'