vcr_better_binary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99824329525ac6e2443b2fdd9312b518fd59fd8c64d69ffc707675706dcde35a
+  data.tar.gz: b12e5a52879cf7d2080289417d93636e408eb407c20e8f39112c630d8840df3a
+SHA512:
+  metadata.gz: 8d8de28648b2eb946c478de83baf90ee005f56b5c179e2633a4ce8dea11a1765f524cca27a191f9b28bd65b46f352f865ca60c8cf20b60ecfdb4811164ed4339
+  data.tar.gz: c981ae81c955320beeecb6afac34b80ee1eddd0df146135175d558b3ce99676b874310501ab923a9182fc5356da196b7c3f998d76cbe84bd2051665c0ed39e0d

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+---
+version: 2
+
+#-------------------------------------------------------------------------------
+
+base_job: &base_job
+  working_directory: ~/repo
+  steps:
+    - checkout
+
+    - restore_cache:
+        keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies
+
+    - run:
+        name: install dependencies
+        command: |
+          gem install bundler --version "~> 2.0"
+          bundle config set path 'vendor/bundle'
+          bundle install --jobs=4 --retry=3
+
+    - save_cache:
+        paths:
+          - ./vendor/bundle
+        key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: run tests
+        command: |
+          mkdir /tmp/test-results
+          bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml
+
+    # collect reports
+    - store_test_results:
+        path: /tmp/test-results
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: test-results
+
+#-------------------------------------------------------------------------------
+
+jobs:
+  ruby-2.5:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.5
+  ruby-2.6:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.6
+  ruby-2.7:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.7
+
+#-------------------------------------------------------------------------------
+
+workflows:
+  version: 2
+  multiple-rubies:
+    jobs:
+      - ruby-2.5
+      - ruby-2.6
+      - ruby-2.7

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby_version
+
+# rspec state
+spec/examples.txt
+
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    vcr_better_binary (0.1.0)
+      vcr (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hashdiff (1.0.1)
+    jet_black (0.6.0)
+    json (2.3.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jet_black
+  pry
+  rake
+  rspec
+  rspec_junit_formatter
+  simplecov
+  vcr_better_binary!
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Oliver Peate
+
+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,90 @@
+# VCR: Better Binary Serializer
+
+[![CircleCI](https://circleci.com/gh/odlp/vcr_better_binary.svg?style=shield)](https://circleci.com/gh/odlp/vcr_better_binary)
+
+## What
+
+This gem is a [VCR] serializer which persists any binary data in the HTTP
+request or response bodies outside the cassette.
+
+[VCR]: https://github.com/vcr/vcr
+
+## Why
+
+- Keeps the cassettes human readable
+- You can `git diff` the cassette more easily (and git won't diff the binary
+  data stored elsewhere)
+- Github won't collapse the diffs for cassettes in PRs (the default for large files)
+
+## How
+
+Add the gem to your `Gemfile` and `bundle install`:
+
+```ruby
+group :test do
+  gem "vcr_better_binary"
+end
+```
+
+Configure VCR to use the serializer:
+
+```ruby
+# spec/support/vcr.rb (or wherever you configure VCR)
+
+VCR.configure do |config|
+  config.cassette_serializers[:better_binary] = VcrBetterBinary::Serializer.new
+  config.default_cassette_options = { serialize_with: :better_binary } # or specify inline in 'VCR.use_cassette'
+end
+```
+
+When you re-record or delete a cassette there may be stale references leftover
+in the storage directory.
+
+Add a hook after all your tests have run to prevent unused data from building
+up:
+
+```ruby
+RSpec.configure do |config|
+  config.after(:suite) do
+    VcrBetterBinary::Serializer.new.prune_bin_data
+  end
+end
+```
+
+And you're set!
+
+## The end-result
+
+When you record requests with binary data the resulting cassette will
+look similar to this:
+
+```yaml
+# Abridged example
+http_interactions:
+- request:
+    method: post
+    uri: https://example.com/upload
+    body:
+      encoding: ASCII-8BIT
+      bin_key: lymom-vudim-vunek-mobad-fepak-taset-zosyl-zuhaf-setag
+  response:
+    status:
+      code: 200
+      message: OK
+    body:
+      encoding: ASCII-8BIT
+      bin_key: xohog-badok-paneg-memek-tahum-degab-kasip-pefik-colol
+```
+
+And the following files will have been persisted:
+
+```
+spec/fixtures/vcr_cassettes
+├── my-cassette.yml
+└── bin_data
+    ├── lymom-vudim-vunek-mobad-fepak-taset-zosyl-zuhaf-setag
+    └── xohog-badok-paneg-memek-tahum-degab-kasip-pefik-colol
+```
+
+All remaining VCR functionality will operate as normal; the only adjustment is
+the storage of binary data.

data/Rakefile

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

data/lib/vcr_better_binary.rb

@@ -0,0 +1,5 @@
+require "vcr_better_binary/serializer"
+require "vcr_better_binary/version"
+
+module VcrBetterBinary
+end

data/lib/vcr_better_binary/pruner.rb

@@ -0,0 +1,41 @@
+require "vcr"
+
+module VcrBetterBinary
+  class Pruner
+    def prune_bin_data(bin_data_dir:, cassette_http_bodies:)
+      if in_git_repo? && no_cassette_changes?
+        return
+      end
+
+      in_use_keys = find_in_use_keys(cassette_http_bodies)
+
+      Dir.glob(File.expand_path("*", bin_data_dir)).each do |bin_file|
+        unless in_use_keys.include?(File.basename(bin_file))
+          File.delete(bin_file)
+        end
+      end
+    end
+
+    private
+
+    def find_in_use_keys(cassette_http_bodies)
+      cassette_http_bodies.each_with_object(Set.new) do |http_body, in_use_keys|
+        if http_body.key?(Serializer::BIN_KEY)
+          in_use_keys << http_body[Serializer::BIN_KEY]
+        end
+      end
+    end
+
+    def in_git_repo?
+      system("git -C '#{cassette_dir}' rev-parse --is-inside-work-tree > /dev/null 2>&1")
+    end
+
+    def no_cassette_changes?
+      `git -C '#{cassette_dir}' status --porcelain -- '#{cassette_dir}'`.empty?
+    end
+
+    def cassette_dir
+      VCR.configuration.cassette_library_dir
+    end
+  end
+end

data/lib/vcr_better_binary/serializer.rb

@@ -0,0 +1,115 @@
+require "digest/bubblebabble"
+require "fileutils"
+require "vcr_better_binary/pruner"
+require "vcr/cassette/serializers"
+
+module VcrBetterBinary
+  class Serializer
+    BIN_KEY = "bin_key"
+
+    def initialize(base_serializer: VCR::Cassette::Serializers::YAML)
+      @base_serializer = base_serializer
+    end
+
+    def file_extension
+      base_serializer.file_extension
+    end
+
+    def serialize(data)
+      yield_http_bodies(data) do |body|
+        stash_binary_body_data(body)
+      end
+
+      base_serializer.serialize(data)
+    end
+
+    def deserialize(string)
+      data = base_serializer.deserialize(string)
+
+      yield_http_bodies(data) do |body|
+        restore_binary_body_data(body)
+      end
+
+      data
+    end
+
+    def prune_bin_data
+      Pruner.new.prune_bin_data(
+        bin_data_dir: bin_data_dir,
+        cassette_http_bodies: all_cassette_http_bodies
+      )
+    end
+
+    private
+
+    attr_reader :base_serializer
+
+    def yield_http_bodies(data)
+      data.fetch("http_interactions").each do |interaction|
+        request_body = interaction.dig("request", "body")
+        yield(request_body) unless request_body.nil?
+
+        response_body = interaction.dig("response", "body")
+        yield(response_body) unless response_body.nil?
+      end
+    end
+
+    def stash_binary_body_data(body)
+      return unless body["encoding"] == Encoding::BINARY.name
+      return if body["string"].nil? || body["string"].empty?
+
+      bin_key = filename_safe_digest(body["string"])
+      bin_storage_path = File.expand_path(bin_key, bin_data_dir)
+
+      write_binary_data(bin_storage_path, body["string"])
+      body[BIN_KEY] = bin_key
+      body.delete("string")
+
+      bin_key
+    end
+
+    def restore_binary_body_data(body)
+      return unless body.key?(BIN_KEY)
+
+      bin_storage_path = File.expand_path(body[BIN_KEY], bin_data_dir)
+      body["string"] = read_binary_data(bin_storage_path)
+      body.delete(BIN_KEY)
+    end
+
+    def bin_data_dir
+      File.expand_path("bin_data", cassette_dir).tap do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def filename_safe_digest(content)
+      Digest::SHA256.bubblebabble(content)
+    end
+
+    def cassette_dir
+      VCR.configuration.cassette_library_dir
+    end
+
+    def read_binary_data(path)
+      File.open(path, "rb") { |file| file.read }
+    end
+
+    def write_binary_data(path, data)
+      File.open(path, "wb") { |file| file.write(data) }
+    end
+
+    def all_cassette_http_bodies
+      Enumerator::Lazy.new(cassette_paths) do |yielder, cassette_path|
+        data = base_serializer.deserialize(File.read(cassette_path))
+
+        yield_http_bodies(data) do |body|
+          yielder << body
+        end
+      end
+    end
+
+    def cassette_paths
+      Dir.glob(File.expand_path("*.#{file_extension}", cassette_dir))
+    end
+  end
+end

data/lib/vcr_better_binary/version.rb

@@ -0,0 +1,3 @@
+module VcrBetterBinary
+  VERSION = "0.1.0"
+end

data/vcr_better_binary.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/vcr_better_binary/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vcr_better_binary"
+  spec.version       = VcrBetterBinary::VERSION
+  spec.authors       = ["Oliver Peate"]
+
+  spec.summary       = "Persist binary data outside your VCR cassettes"
+  spec.homepage      = "https://github.com/odlp/vcr_better_binary"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "vcr", "~> 5.0"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "jet_black"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: vcr_better_binary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Peate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  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: 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: webmock
+  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: simplecov
+  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: jet_black
+  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: rspec_junit_formatter
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vcr_better_binary.rb
+- lib/vcr_better_binary/pruner.rb
+- lib/vcr_better_binary/serializer.rb
+- lib/vcr_better_binary/version.rb
+- vcr_better_binary.gemspec
+homepage: https://github.com/odlp/vcr_better_binary
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/odlp/vcr_better_binary
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Persist binary data outside your VCR cassettes
+test_files: []