nxt_vcr_harness 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2118cfc8a4f0910979cd1ea2b57b738ae816b8c426f8fd352583692f4dd4d96
-  data.tar.gz: 1a5a8c82bb44ca5e793417e88a6e99dff755599e05397287f3c71f6cc36f44f4
+  metadata.gz: 299a23a4cea677b8985726471cfb9fbcc28b48d2ce70c78de1a90748fa768bc3
+  data.tar.gz: 2db4abfd09dffc697204cbb3881bda70a15ad72ce5fdf59cf1a92ba44a5e53d8
 SHA512:
-  metadata.gz: 6b36b78337acf1c353d5bdee04e0728b5e6bea5a94f0f3a533cfc9958c73be6b999f5ae72f840a4ba86d8f05c4210dea9d86df1a642c5813bd3a2f44832bca04
-  data.tar.gz: be78321c292bf108faf2f9ab2cb053472c102162ebda3e62f4e2d464c606f4a9593bac85cdc2bf825cb1275a98e432948ac5c982eb7281e7bc872720303333a4
+  metadata.gz: 47ec2fe863122f365fd32e1226bb9fe020c3bea55237b394242ef062940c73563e0d5c7c1adf312754e2aea7ee505c0b780b57e98cbc7e878564e8a3d4599395
+  data.tar.gz: f81055d1d0e94684e8c3063f301e5175300769669d321e2de43191f4780b83e0f9b40c27c591273759f33d7990675facdbf5985100c05b3e9d0b8b28fdad4915

data/.circleci/config.yml

@@ -1,55 +1,37 @@
-version: 2
+# See https://circleci.com/docs/2.0/language-ruby/ for more details
+
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@2.0.1
 
 jobs:
-  build:
-    working_directory: /home/circleci/app
+  checks:
+    parallelism: 1
+    resource_class: small
     docker:
-      - image: circleci/ruby:2.6.2-node
-    environment:
-      RACK_ENV: test
-      RAILS_ENV: test
-      COVERAGE: true
-      # CC_TEST_REPORTER_ID: YOUR_REPO_CC_TEST_REPORTER_ID # ENV var set in CircleCI user interface
+      - image: cimg/ruby:3.2.2
     steps:
       - checkout
-      # libpq-dev: required for compiling the `pg` gem
-      # nodejs: required for asset compilation (see https://github.com/rails/execjs)
-      - run:
-          name: Install apt dependencies
-          command: |
-            sudo apt update -q \
-            && sudo apt upgrade -q
-      - restore_cache:
-          key: v3-bundler-{{ checksum "Gemfile.lock" }}-{{ arch }}
-      - run: gem install bundler
-      - run: bundle config build.nokogiri --use-system-libraries
-      - run: bundle install --without staging:production --path=vendor/bundle --jobs=4 --retry=3
-      - save_cache:
-          key: v3-bundler-{{ checksum "Gemfile.lock" }}-{{ arch }}
-          paths:
-            - vendor/bundle
+      - ruby/install-deps:
+          key: gems-v2
+          include-branch-in-cache-key: false
+      # - ruby/rubocop-check
       - run:
-          name: Collect and filter specs
-          command: |
-            mkdir -p tmp/circleci
-            circleci tests glob "spec/**/*_spec.rb" > tmp/circleci/all_tests.txt
-            circleci tests split --split-by=timings < tmp/circleci/all_tests.txt > tmp/circleci/tests_to_run.txt
-            echo "These specs will be run:"
-            cat tmp/circleci/tests_to_run.txt
-      - run:
-          name: Parallel RSpec
-          command: |
-            bundle exec rspec \
-              --color \
-              --format progress \
-              --require spec_helper \
-              --format RspecJunitFormatter --out /tmp/rspec/junit.xml \
-              $(cat tmp/circleci/tests_to_run.txt)
+          name: RSpec Tests
+          command: |-
+            bundle exec rspec --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec/results.xml --format progress
       # actually not necessary for test results to be collected, but these files
       # won't show up in the web UI otherwise
       - store_artifacts:
           path: /tmp/rspec/
           destination: rspec
-
       - store_test_results:
           path: /tmp/rspec/
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - checks

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# v0.2.0 2024-02-17
+## Added
+- Added `strip_unneeded_headers_before_save` method to keep cassette size down
+
+# v0.1.4 2020-12-03
+
+### Updated
+
+- Updated Ruby, Bundler & fixed deprecation warnings.
+
+[Compare v0.1.3...v0.1.4](https://github.com/nxt-insurance/nxt_clients/compare/v0.1.3...v0.1.4)

data/Gemfile.lock

@@ -1,47 +1,47 @@
 PATH
   remote: .
   specs:
-    nxt_vcr_harness (0.1.2)
+    nxt_vcr_harness (0.2.0)
       rspec (~> 3.0)
-      vcr (~> 5.0)
+      vcr (~> 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.3)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.2)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    vcr (5.0.0)
+    vcr (6.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler
   nxt_vcr_harness!
   pry
-  rake (~> 12.3)
-  rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.4.1)
+  rake
+  rspec
+  rspec_junit_formatter
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -22,11 +22,16 @@ Or install it yourself as:
 
 ## Usage
 
-NxtVcrHarness currently has two features. You can use it to find vcr cassettes that are not being used when you 
-run your test suite. Enable it by calling `NxtVcrHarness.track_cassettes`. Note that the output only makes sense when
-you run your complete test suite. If you run only a subset all cassettes that are used by your other test will be included too.
+NxtVcrHarness provides three features.
 
-The second feature is that you can enable your custom :vcr tag by calling `NxtVcrHarness.enable_vcr_tag`. This will 
+### 1. List unused cassettes after each test run.
+You can use it to find vcr cassettes that are not being used when you 
+run your test suite. Enable it by calling `NxtVcrHarness.track_cassettes_if(...your condition in here...)`. 
+Note that the output only makes sense when you run your complete test suite. 
+If you run only a subset all cassettes that are used by your other test will be included too.
+
+### 2. Use custom VCR tag
+You can enable your custom :vcr tag by calling `NxtVcrHarness.enable_vcr_tag`. This will 
 automatically name your vcr cassettes based on the your rspec example and the surrounding contexts. You can also 
 setup default cassette options for your vcr tag. 
 
@@ -34,6 +39,56 @@ setup default cassette options for your vcr tag.
 NxtVcrHarness.enable_vcr_tag(tag_name: :my_vcr_tag, default_cassette_options: { ... })
 ```
 
+### 3. Keep cassettes small by removing unneeded headers
+API responses typically contain useful headers, such as information about rate limits and pagination,
+but also many more unnecessary headers.
+You can drastically reduce the size of your cassettes by stripping unnecessary headers before saving.
+
+```ruby
+# After VCR.configure:
+NxtVcrHarness.strip_unneeded_headers_before_save
+```
+
+By default, nxt_vcr_harness will remove the following kinds of headers (case-insensitive) from responses:
+- CORS headers (`Access-Control-*`)
+- Headers for browsers (`X-Frame-Options`, `Content-Security-Policy`, `Strict-Transport-Security`, `X-Xss-Protection`, `Expect-Ct`...)
+- Headers for browsers/proxies/CDNs (`Cache-Control`, `Etag`, `Vary`...)
+- Common cloud provider headers (CloudFlare, AWS)
+- Server details (`Server-Timing`, `X-Powered-By`, `X-Runtime`, `Via`, `Date`)
+
+From requests, `Accept-Encoding` and `Expect` headers will be removed.
+
+See `NxtVcrHarness::UnneededHeaders.default_headers_to_strip` for the full list of removed headers.
+
+You can add or override headers to be removed (regexes or strings):
+
+```ruby
+NxtVcrHarness.strip_unneeded_headers_before_save do |headers_to_strip|
+  headers_to_strip[:response] << /X-Dixa-.+/i
+end
+```
+
+To run this slimming on existing cassettes, you can create a simple Ruby script or Rake task, for example::
+
+```rb
+require 'vcr'
+require 'nxt_vcr_harness'
+
+headers_to_strip = NxtVcrHarness::UnneededHeaders.default_headers_to_strip
+headers_to_strip[:responses] << /X-Dixa-.+/i
+
+task slim_cassettes: :environment do
+  Dir[Rails.root.join('spec/fixtures/vcr_cassettes/**/**.yml')].each do |file_path|
+    cassette = ::YAML.load(File.read(file_path))
+    cassette['http_interactions'].each do |interaction|
+      NxtVcrHarness::UnneededHeaders.strip(interaction['request']['headers'], headers_to_strip[:requests])
+      NxtVcrHarness::UnneededHeaders.strip(interaction['response']['headers'], headers_to_strip[:responses])
+    end
+    File.write(file_path, VCR.cassette_serializers[:yaml].serialize(cassette))
+  end
+end
+```
+
 ## 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.

data/lib/nxt_vcr_harness/unneeded_headers.rb

@@ -0,0 +1,74 @@
+module NxtVcrHarness
+  module UnneededHeaders
+    REQUEST_HEADERS = %w[
+      Accept-Encoding
+      Expect
+    ].freeze
+
+    BROWSER_HEADERS = [
+      /Access-Control-.+/i,
+      'Alt-Svc',
+      /(X-)?Content-Security-Policy.*/i,
+      'Cache-Control',
+      'Etag',
+      'Expect-Ct',
+      'NEL',
+      'Referrer-Policy',
+      'Report-To',
+      'Reporting-Endpoints',
+      'Set-Cookie',
+      'Strict-Transport-Security',
+      'Vary',
+      /X-(Content-Type-Options|Download-Options|Frame-Options|Permitted-Cross-Domain-Policies|Webkit-Csp|Xss-Protection)/i,
+    ].freeze
+
+    SERVER_DETAILS = [
+      'Date',
+      'Server',
+      'Server-Timing',
+      /X-(Powered-By|Runtime|Served-By|Server-Elapsed)/i,
+      /X-Envoy-(Decorator-Operation|Upstream-Service-Time)/i,
+      'Via',
+    ].freeze
+
+    AMAZON_HEADERS = [
+      /X-Amzn?-.+/i,
+      'X-Cache',
+    ].freeze
+
+    CLOUDFLARE_HEADERS = [
+      /Cf-.+/i,
+    ].freeze
+
+    RESPONSE_HEADERS = [
+      *BROWSER_HEADERS,
+      *SERVER_DETAILS,
+      *AMAZON_HEADERS,
+      *CLOUDFLARE_HEADERS,
+    ].freeze
+
+    def default_headers_to_strip
+      {
+        requests: UnneededHeaders::REQUEST_HEADERS.dup,
+        responses: UnneededHeaders::RESPONSE_HEADERS.dup,
+      }
+    end
+
+    def strip(headers_hash, headers_to_strip)
+      headers_hash.delete_if do |k, v|
+        headers_to_strip.any? do |header|
+          case header
+          when String
+            k == header || k == header.downcase
+          when Regexp
+            k.match?(header)
+          else
+            raise ArgumentError, "Unexpected key type in headers_to_strip hash: #{header}"
+          end
+        end
+      end
+    end
+
+    module_function :default_headers_to_strip, :strip
+  end
+end

data/lib/nxt_vcr_harness/version.rb

@@ -1,3 +1,3 @@
 module NxtVcrHarness
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/nxt_vcr_harness.rb

@@ -1,12 +1,14 @@
 require "nxt_vcr_harness/version"
 require 'nxt_vcr_harness/cassette_name_by_example'
 require 'nxt_vcr_harness/cassette_tracker'
+require 'nxt_vcr_harness/unneeded_headers'
+require 'digest'
 
 module NxtVcrHarness
   module VcrCassetteHelper
     def with_vcr_cassette(example, **options, &block)
       cassette_by_example_options = %i[prefix suffix]
-      cassette_path = CassetteNameByExample.new(example).call(options.slice(*cassette_by_example_options))
+      cassette_path = CassetteNameByExample.new(example).call(**options.slice(*cassette_by_example_options))
 
       vcr_options = options.reject { |k,_| k.in?(cassette_by_example_options) }
 
@@ -17,7 +19,7 @@ module NxtVcrHarness
 
     def hash_from_example(example, **options)
       cassette_by_example_options = %i[prefix suffix]
-      name = CassetteNameByExample.new(example).call(options.slice(*cassette_by_example_options))
+      name = CassetteNameByExample.new(example).call(**options.slice(*cassette_by_example_options))
       Digest::MD5.hexdigest(name)
     end
   end
@@ -28,7 +30,7 @@ module NxtVcrHarness
 
     RSpec.configure do |config|
       config.around(:each, tag_name) do |example|
-        cassette_path = CassetteNameByExample.new(example).call(options.slice(:prefix, :suffix))
+        cassette_path = CassetteNameByExample.new(example).call(**options.slice(:prefix, :suffix))
         cassette_options = example.metadata[tag_name].is_a?(TrueClass) ? {} : example.metadata[tag_name]
         cassette_options = default_cassette_options.merge(cassette_options)
 
@@ -65,5 +67,19 @@ module NxtVcrHarness
     end
   end
 
-  module_function :enable_vcr_tag, :track_cassettes, :enable_vcr_cassette_helper, :track_cassettes_if
+  def strip_unneeded_headers_before_save
+    headers_to_strip = UnneededHeaders.default_headers_to_strip
+
+    yield headers_to_strip if block_given?
+
+    ::VCR.configure do |config|
+      config.before_record do |interaction, _cassette|
+        UnneededHeaders.strip(interaction.request.headers, headers_to_strip[:requests])
+        UnneededHeaders.strip(interaction.response.headers, headers_to_strip[:responses])
+      end
+    end
+  end
+
+  module_function :enable_vcr_tag, :track_cassettes, :enable_vcr_cassette_helper, :track_cassettes_if,
+    :strip_unneeded_headers_before_save
 end

data/nxt_vcr_harness.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_vcr_harness"
+    spec.metadata["changelog_uri"] = "https://github.com/nxt-insurance/nxt_vcr_harness/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -36,11 +37,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "vcr", "~> 5.0"
+  spec.add_dependency "vcr", "~> 6.0"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
+  spec.add_development_dependency "rspec_junit_formatter"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: nxt_vcr_harness
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Andreas Robecke
 - Nils Sommer
 - Raphael Kallensee
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,56 +32,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -100,16 +100,16 @@ dependencies:
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0'
 description: Names your vcr cassettes based on your rspec examples and let's you pass
   in options on the fly
 email:
@@ -122,7 +122,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -133,6 +133,7 @@ files:
 - lib/nxt_vcr_harness.rb
 - lib/nxt_vcr_harness/cassette_name_by_example.rb
 - lib/nxt_vcr_harness/cassette_tracker.rb
+- lib/nxt_vcr_harness/unneeded_headers.rb
 - lib/nxt_vcr_harness/version.rb
 - nxt_vcr_harness.gemspec
 homepage: https://github.com/nxt-insurance
@@ -142,7 +143,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/nxt-insurance
   source_code_uri: https://github.com/nxt-insurance/nxt_vcr_harness
-post_install_message: 
+  changelog_uri: https://github.com/nxt-insurance/nxt_vcr_harness/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Intuitive VCR cassette naming
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 1.17.2