blockbuster 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bdda5e73f8cf27127f1e0e256f9049ea96d0fd3
+  data.tar.gz: a5e0150870a52e9e4e559e3f7a151ab29d163cff
+SHA512:
+  metadata.gz: a7c390e1556f8bb3a9f0c905c543b01fab2c938e6c6638b4d5a5ec33c307058c1ab07ad8d7ea3183875e62cd276dd8c26756efee4843dd1c1e431c1492b01918
+  data.tar.gz: 6d7a7349a31718c0a0680d762ba2a5844a34f3bdcd15523bdca57d91f504ac81a5972781a651753c72a0b79a1753bce50087a8cf35bb6941d4e23fc88bff16db

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+!/spec/fixtures/*gz
+/test/

data/.rubocop.yml

@@ -0,0 +1,4 @@
+LineLength:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+script:
+    - bundle exec bundle-audit check --update
+    - bundle exec rake rubocop
+    - bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+0.4.1
+===
+
+- Use target_path instead of file_name for output
+
+0.4.0
+===
+
+- introduce Delta features (opt-in feature)
+- manager accepts a configuration object
+- packager broken up into extractor and packager
+- master file represented by Master object
+- delta files represented by Delta object
+- delegate files to extract to ExtractionList object
+- add a Comparator object as blockbuster's in-memory datastore
+
+0.3.0
+====
+
+- configuration class introduced
+- manager delegates to configuration
+- Blockbuster allow a `configure` setup block

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lukas Eklund
+
+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,196 @@
+# Blockbuster
+
+[![Build Status](https://travis-ci.org/fastly/blockbuster.svg?branch=master)](https://travis-ci.org/fastly/blockbuster)
+
+Managing your VCR cassettes since 2016.
+
+The task of this gem is to take all your VCR cassettes and package them into one `.tar.gz` file
+for adding to git or other distributed version control system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blockbuster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blockbuster
+
+Optionally, ignore your cassettes in git and make sure to include the tar.gz file:
+
+```
+# .gitignore
+
+test/cassettes
+!test/vcr_cassettes.tar.gz
+```
+
+## Usage
+
+#### Minitest example
+
+Given a directory layout of:
+
+```
+-- test
+   |-- blockbuster_spec.rb
+   |-- cassettes
+   |   |-- foo.yml
+   |   `-- bar.yml
+   `-- test_helper.rb
+```
+
+In your `test_helper.rb` add
+
+
+
+```
+require 'blockbuster'
+
+manager = Blockbuster::Manager.new do |c|
+  c.test_directory = File.dirname(__FILE__)
+  c.silent = false
+end
+
+# Alternatively you can pass Blockbuster::Manager.new a Blockbuster::Configuration object.  But do not do both.  The block will win if you attempt to do both.  To be clear, passing a configuration as an argument AND additionally providing a block isn't destructive, it just has no purpose.  Pick one or the other.
+
+manager.rent
+```
+
+And then in an after run block
+
+```
+Minitest.after_run do
+  manager.drop_off
+end
+```
+
+If there were changes/additions/deletions to your cassette files a new tar.gz cassette file will be created.
+
+#### Blockbuster::Configuration
+
+The configuration constructor takes the following options:
+
+```
+cassette_directory: String
+  Name of directory where cassette files are stored.
+  Will be stored under the test directory.
+  default: 'casssettes'
+master_tar_file: String
+  name of gz cassettes file.
+  default: 'vcr_cassettes.tar.gz'
+test_directory: String
+  path to test directory where cassete file and cassetes will be stored.
+  default: 'test'
+silent: Boolean
+  Silence all output.
+  default: false
+wipe_cassette_dir: Boolean
+  If true, will wipe the existing cassette directory when `rent` is called.
+  default: false
+enable_deltas: Boolean (more on this below)
+  Toggle the Delta feature
+  default: false
+delta_directory: String
+  Name of the directory to store deltas (relative to test_directory)
+  default: 'deltas'
+current_delta_name: String
+  Field that names the current delta
+  default: 'current_delta.tar.gz'
+```
+
+These are all read-only attributes with the exception of `silent`. This is writeable so that one can suppress output
+on setup but see output about new/changed cassettes upon `drop_off`.
+
+There are 3 public methods
+
+```
+manager.rent
+manager.setup
+```
+
+Extracts all cassettes from `test/vcr_cassettes.tar.gz` into `test/cassetes`
+directory. To wipe the existing directory before extracting cassettes
+initialize the manager with `wipe_cassette_dir: true`.
+
+```
+manager.rewind?
+```
+
+Compares the the files in `test/cassettes` to the files created during setup. Returns `true`
+if there are any changes or additions. Returns `false` if they are identical.
+
+```
+manager.drop_off
+manager.teardown
+```
+
+Packages cassete files into `test/vcr_cassettes.tar.gz` if `rewind?` returns true.
+Can be called with `force: true` to force it to create the cassete file.
+
+#### Recreating a cassette file
+
+If you are using automatic re-recording of cassettes Blockbuster will see the changes and create a new package.
+To skip the cassete extraction and use the existing local cassettes you can run your tests with `VCR_MODE=local`
+
+```
+VCR_MODE=local rake test
+```
+
+You can remove a single existing cassette and run in local mode and VCR will re-record that cassette and Blockbuster will
+package a new cassettes file.
+
+#### Removing or renaming a cassette file
+
+If you rename a cassette or need to delete one from the archive you need to do the following:
+
+* Run your test suite so that you have an up-to-date cassette directory
+* Do the work to rename test/cassette etc
+* Run tests (even that single test) with `VCR_MODE=local`
+
+#### Re-record all cassettes
+
+```
+> rm -r test/cassettes
+> rm test/vcr_cassettes.tar.gz
+> rake test
+```
+
+### Delta feature (*Experimental*)
+
+If you are working on a project that requires a lot of re-recording, or is in active development with HTTP interactions to different systems and multiple developers working on the project, the benefits of Blockbuster degrade quite quickly.  Merge conflicts happen very frequently since all cassettes are stored in one file, and the only resolution is to re-record everything. 
+
+This is why deltas were built.  The idea is inspired by Sphinx's delta index system.  The idea is to add changes or creations to delta files, and not a master file.  In the typical git branching workflow, this would work as follows:
+
+- If no master file exists, one is generated the first time someone utilizes blockbuster.
+- current_delta_name is set by dynamically retrieving the git branch name (This git-branch retrieval is the responsibility of the application to configure)
+- as long as a master file exists, Blockbuster will only add changes to a new tarball.
+- once you've switched to a new branch (presumably you've gotten your branch merged into master), Blockbuster stops writing to that delta, and only applies changes to a new delta based off the new branch name.
+- The delta file names include a timestamp, based on when the file was packaged.  This allows Blockbuster to use best-effort sorting to load in all delta files.
+- Blockbuster maintains an in-memory datastore of files and their last checksums.  To build this, Blockbuster extracts files from all available tarballs in a sorted order.  The order is always Master first, and then delta files sorted by filename, which for all intents and purposes is based on time of creation (since the name includes a timestamp).  This means that if more than one tarball contains the exact same file, the checksum in the datastore will come from the last file in the sort that contains it.
+- This allows conflicts to become far less possible.  Additionally, even if a conflict does occur, resolving the conflict becomes much easier, as the conflict will be isolated to the changes you are actively working on.
+- Deletions aren't managed by deltas.  This is because we want to maintain the principle of never touching any other tarball other than master or the the current delta.  To actually delete a file, we'd have to remove it from any tarball it exists in.  This isn't worth the advantage of the guarantee of leaving existing deltas alone.  In the end, regenerating a Master file will resolve deleted files.
+- Regenerating a new Master file is actually relatively simple.  The only mechanism required to have Blockbuster do this automatically is to simply delete the existing Master file.  It is additionally currently the responsibility of the application to remove deltas when regenerating a new master file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/blockbuster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run rubocop'
+RuboCop::RakeTask.new do |task|
+  task.options       = %w(--display-cop-names)
+  task.formatters    = %w(fuubar)
+  task.fail_on_error = true
+end
+
+task spec: :test
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'blockbuster'
+
+# 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 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blockbuster.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blockbuster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blockbuster'
+  spec.version       = Blockbuster::VERSION
+  spec.authors       = ['Lukas Eklund', 'Alexander Bergman', 'Hassan Shahid']
+  spec.email         = ['leklund@fastly.com', 'alexander@fastly.com', 'hassan@fastly.com']
+
+  spec.summary       = 'Packaging VCR cassettes for git since 2016'
+  spec.homepage      = 'https://github.com/fastly/blockbuster'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.37'
+end

data/lib/blockbuster.rb

@@ -0,0 +1,20 @@
+require 'fileutils'
+require 'rubygems/package'
+require 'zlib'
+
+require 'blockbuster/configuration'
+require 'blockbuster/concerns/file_helpers'
+require 'blockbuster/concerns/output_helpers'
+require 'blockbuster/concerns/extractor'
+require 'blockbuster/concerns/packager'
+require 'blockbuster/master'
+require 'blockbuster/delta'
+require 'blockbuster/comparator'
+require 'blockbuster/extraction_list'
+
+require 'blockbuster/manager'
+require 'blockbuster/version'
+
+# nodoc
+module Blockbuster
+end

data/lib/blockbuster/comparator.rb

@@ -0,0 +1,90 @@
+module Blockbuster
+  # Data store for files, sources, states, and checksums
+  class Comparator
+    include Blockbuster::FileHelpers
+    include Blockbuster::OutputHelpers
+
+    CONTENT = 'content'.freeze
+    SOURCE  = 'source'.freeze
+
+    attr_reader :configuration, :inventory, :edited, :current_delta_files, :deleted
+
+    def initialize(configuration)
+      @configuration       = configuration
+      @inventory           = {}
+      @edited              = []
+      @current_delta_files = []
+      @deleted             = []
+    end
+
+    def add(key, value, source)
+      inventory[key] = { CONTENT => value, SOURCE => source }
+    end
+
+    def delete(key)
+      inventory.delete(key)
+    end
+
+    def keys
+      inventory.keys
+    end
+
+    def present?
+      !keys.empty?
+    end
+
+    def edited?(file)
+      (edited + current_delta_files).include?(file)
+    end
+
+    def store_current_delta_files
+      inventory.each do |k, v|
+        scrubbed = Blockbuster::Delta.file_name_without_timestamp(v[SOURCE])
+        current_delta_files << k if scrubbed == configuration.current_delta_name
+      end
+    end
+
+    def compare(key, new_digest)
+      digest = inventory[key]
+
+      if digest.nil?
+        silent_puts "New cassette: #{key}"
+        return true
+      elsif digest[CONTENT] != new_digest
+        silent_puts "Cassette changed: #{key}"
+        return true
+      end
+    end
+
+    def rewind?(files) # rubocop:disable Metrics/AbcSize
+      base_files = []
+
+      files.each do |file|
+        next unless File.file?(file)
+
+        key = configuration.key_from_path(file)
+        base_files << key
+
+        edited << key if compare(key, file_digest(file))
+      end
+
+      @deleted = keys - base_files
+
+      return true if any_deleted?
+
+      !edited.empty?
+    end
+
+    def any_deleted?
+      if configuration.deltas_disabled? && !@deleted.empty?
+        silent_puts "Cassettes deleted: #{@deleted}"
+        return true
+      elsif configuration.deltas_enabled? && !(current_delta_files & @deleted).empty?
+        silent_puts "Cassettes deleted: #{@deleted}"
+        return true
+      end
+
+      false
+    end
+  end
+end

data/lib/blockbuster/concerns/extractor.rb

@@ -0,0 +1,34 @@
+module Blockbuster
+  # extracts files from gzipped tarballs
+  module Extractor
+    def extract_cassettes
+      return unless File.exist?(file_path)
+      File.open(file_path, 'rb') do |file|
+        Zlib::GzipReader.wrap(file) do |gz|
+          Gem::Package::TarReader.new(gz) do |tar|
+            tar.each do |entry|
+              untar_file(entry) if entry.file?
+            end
+          end
+        end
+      end
+    end
+
+    def untar_file(entry)
+      contents = entry.read
+      @comparator.add(entry.full_name, Digest::MD5.hexdigest(contents), file_name)
+
+      save_to_disk(entry, contents) unless configuration.local_mode
+    end
+
+    def save_to_disk(entry, contents)
+      destination = File.join configuration.test_directory, entry.full_name
+
+      FileUtils.mkdir_p(File.dirname(destination))
+      File.open(destination, 'wb') do |cass|
+        cass.write(contents)
+      end
+      File.chmod(entry.header.mode, destination)
+    end
+  end
+end

data/lib/blockbuster/concerns/file_helpers.rb

@@ -0,0 +1,12 @@
+module Blockbuster
+  # file helper methods
+  module FileHelpers
+    def file_digest(file)
+      Digest::MD5.file(file).hexdigest
+    end
+
+    def tar_digest(content)
+      Digest::MD5.hexdigest(content)
+    end
+  end
+end

data/lib/blockbuster/concerns/output_helpers.rb

@@ -0,0 +1,8 @@
+module Blockbuster
+  # helpers for outputting to STDOUT
+  module OutputHelpers
+    def silent_puts(msg)
+      puts "[Blockbuster] #{msg}" unless configuration.silent?
+    end
+  end
+end

data/lib/blockbuster/concerns/packager.rb

@@ -0,0 +1,40 @@
+module Blockbuster
+  # pure ruby implmentation of tar gzip and diff
+  module Packager
+    def create_cassette_file
+      FileUtils.rm(file_path) if File.exist?(file_path)
+      File.open(target_path, 'wb') do |file|
+        Zlib::GzipWriter.wrap(file) do |gz|
+          Gem::Package::TarWriter.new(gz) do |tar|
+            configuration.cassette_files.each do |cass|
+              tar_file(tar, cass)
+            end
+          end
+        end
+      end
+    end
+
+    def tar_file(tar, file)
+      rel_path = configuration.key_from_path(file)
+
+      if configuration.deltas_enabled?
+        return unless @comparator.edited?(rel_path)
+      end
+
+      write_to_disk(tar, file)
+    end
+
+    def write_to_disk(tar, file)
+      mode     = File.stat(file).mode
+      rel_path = configuration.key_from_path(file)
+
+      if File.directory?(file)
+        tar.mkdir rel_path, mode
+      else
+        tar.add_file_simple rel_path, mode, File.size(file) do |io|
+          File.open(file, 'rb') { |f| io.write f.read }
+        end
+      end
+    end
+  end
+end

data/lib/blockbuster/configuration.rb

@@ -0,0 +1,98 @@
+module Blockbuster
+  # Manages blockbuster configuration
+  class Configuration
+    MASTER_TAR_FILE    = 'vcr_cassettes'.freeze
+    CASSETTE_DIRECTORY = 'cassettes'.freeze
+    TEST_DIRECTORY     = 'test'.freeze
+    WIPE_CASSETTE_DIR  = false
+    LOCAL_MODE         = 'local'.freeze
+    SILENT             = false
+    ENABLE_DELTAS      = false
+    DELTA_DIRECTORY    = 'deltas'.freeze
+    CURRENT_DELTA_NAME = 'current_delta'.freeze
+    EXTENSION          = '.tar.gz'.freeze
+
+    # @param cassette_directory [String] Name of directory cassette files are stored.
+    #  Will be stored under the test directory. default: 'casssettes'
+    # @param master_tar_file [String] name of gz cassettes file. default: 'vcr_cassettes.tar.gz'
+    # @param test_directory [String] path to test directory where cassete file and cassetes will be stored.
+    #  default: 'test'
+    # @param silent [Boolean] Silence all output. default: false
+    # @param enable_deltas [Boolean] Enables delta functionality. default: false
+    # @param delta_directory [String] Specifies directory for deltas. default: 'deltas'
+    # @param current_delta_name [String] Name of the current delta. default: 'current_delta.tar.gz'
+    attr_writer :cassette_directory, :master_tar_file, :local_mode, :test_directory, :wipe_cassette_dir, :silent, :enable_deltas, :delta_directory, :current_delta_name
+
+    def cassette_directory
+      @cassette_directory ||= CASSETTE_DIRECTORY
+    end
+
+    def master_tar_file
+      @master_tar_file ||= MASTER_TAR_FILE
+    end
+
+    def test_directory
+      @test_directory ||= TEST_DIRECTORY
+    end
+
+    def silent
+      @silent ||= SILENT
+    end
+
+    alias silent? silent
+
+    def wipe_cassette_dir
+      @wipe_cassette_dir ||= WIPE_CASSETTE_DIR
+    end
+
+    def local_mode
+      @local_mode ||= ENV['VCR_MODE'] == LOCAL_MODE
+    end
+
+    def enable_deltas
+      @enable_deltas ||= ENABLE_DELTAS
+    end
+
+    alias deltas_enabled? enable_deltas
+
+    def deltas_disabled?
+      !deltas_enabled?
+    end
+
+    def delta_directory
+      @delta_directory ||= DELTA_DIRECTORY
+    end
+
+    def full_delta_directory
+      File.join(test_directory, delta_directory)
+    end
+
+    def current_delta_name
+      @current_delta_name ||= CURRENT_DELTA_NAME
+      @current_delta_name += EXTENSION unless @current_delta_name.include?(EXTENSION)
+
+      @current_delta_name
+    end
+
+    def key_from_path(file)
+      path_array = File.dirname(file).split('/')
+      idx = path_array.index(cassette_directory)
+      path_array[idx..-1].push(File.basename(file)).join('/')
+    end
+
+    def cassette_dir
+      File.join(test_directory, cassette_directory)
+    end
+
+    def cassette_files
+      Dir.glob("#{cassette_dir}/**/*")
+    end
+
+    def master_tar_file_path
+      name = File.join(test_directory, master_tar_file)
+      name += EXTENSION unless name.include?(EXTENSION)
+
+      name
+    end
+  end
+end

data/lib/blockbuster/delta.rb

@@ -0,0 +1,76 @@
+module Blockbuster
+  # Delta file objects
+  class Delta
+    include Blockbuster::Extractor
+    include Blockbuster::Packager
+
+    attr_reader :current, :file_name, :configuration
+
+    # nodoc
+    class NotEnabledError < StandardError
+      def message
+        'Deltas are not enabled.  Please enable them via configuration to use them'
+      end
+    end
+
+    INITIALIZING_NUMBER = 101_010_101
+
+    def self.files(directory)
+      Dir.glob("#{directory}/*.tar.gz").sort.map { |file| File.basename(file) }
+    end
+
+    def self.initialize_for_each(comparator, configuration)
+      setup_directory(configuration.full_delta_directory)
+
+      delta_files = files(configuration.full_delta_directory)
+
+      # If the current delta doesn't exist we want to add it
+      current_delta = configuration.current_delta_name
+      delta_files << "#{INITIALIZING_NUMBER}_#{current_delta}" unless delta_files.any? { |file| file_name_without_timestamp(file) == current_delta }
+
+      delta_files.map do |file|
+        new(file, comparator, configuration)
+      end
+    end
+
+    def self.setup_directory(directory)
+      return if Dir.exist?(directory)
+
+      FileUtils.mkdir_p(directory)
+      FileUtils.touch("#{directory}/.keep")
+    end
+
+    def self.file_name_without_timestamp(file_name)
+      file_name.sub(/^\d+_/, '')
+    end
+
+    def initialize(file_name, comparator, configuration)
+      raise NotEnabledError if configuration.deltas_disabled?
+
+      @configuration = configuration
+      @comparator    = comparator
+      @file_name     = file_name
+      @current       = true if file_name_without_timestamp == configuration.current_delta_name
+    end
+
+    def file_name_without_timestamp
+      self.class.file_name_without_timestamp(file_name)
+    end
+
+    def current
+      @current || false
+    end
+
+    alias current? current
+
+    def file_path
+      File.join(configuration.full_delta_directory, file_name)
+    end
+
+    def target_path
+      target = [Time.now.to_i, configuration.current_delta_name].join('_')
+
+      File.join(configuration.full_delta_directory, target)
+    end
+  end
+end

data/lib/blockbuster/extraction_list.rb

@@ -0,0 +1,50 @@
+module Blockbuster
+  # generates an ordered collection of files to extract
+  class ExtractionList
+    attr_reader :files, :configuration
+
+    def initialize(comparator, configuration)
+      @configuration = configuration
+      @comparator    = comparator
+
+      list = [master]
+      list << deltas if configuration.deltas_enabled?
+
+      @files = list.flatten
+    end
+
+    def current_delta
+      deltas.find(&:current?)
+    end
+
+    def deltas
+      @deltas ||= Delta.initialize_for_each(@comparator, configuration)
+    end
+
+    def extract_cassettes
+      files.map(&:extract_cassettes)
+    end
+
+    def master
+      @master ||= Master.new(@comparator, configuration)
+    end
+
+    # determines what file representation to return for writing to
+    #
+    # 1.  master when deltas are disabled
+    #
+    # 2.  master when master does not exist.  This handles two scenarios:
+    #     - master does not exist (if this happens, we should always regenerate master)
+    #     - we want to regenerate master (this assumes some other mechanism is responsible
+    #       for deleting master to make this work)
+    #
+    # 3.  current_delta
+    def primary
+      return master if configuration.deltas_disabled?
+
+      return master unless File.exist?(master.file_path)
+
+      current_delta
+    end
+  end
+end

data/lib/blockbuster/manager.rb

@@ -0,0 +1,63 @@
+module Blockbuster
+  # Manages cassette packaging and unpackaging
+  class Manager
+    include Blockbuster::OutputHelpers
+
+    attr_accessor :comparator
+
+    def initialize(instance_configuration = Blockbuster::Configuration.new)
+      yield configuration if block_given?
+
+      @configuration ||= instance_configuration
+
+      @comparator      = Comparator.new(@configuration)
+      @extraction_list = ExtractionList.new(@comparator, @configuration)
+    end
+
+    def configuration
+      @configuration ||= Blockbuster::Configuration.new
+    end
+
+    # extracts cassettes from a tar.gz file
+    #
+    # tracks a md5 hash of each file in the tarball
+    def rent
+      master_file_path = @extraction_list.master.file_path
+
+      unless File.exist?(master_file_path)
+        silent_puts "File does not exist: #{master_file_path}."
+        return false
+      end
+
+      remove_existing_cassette_directory if configuration.wipe_cassette_dir
+
+      silent_puts "Extracting VCR cassettes to #{configuration.cassette_dir}"
+
+      @extraction_list.extract_cassettes
+
+      @comparator.store_current_delta_files if configuration.deltas_enabled?
+    end
+
+    # repackages cassettes into a compressed tarball
+    def drop_off(force: false)
+      if comparator.rewind?(configuration.cassette_files) || force
+        silent_puts "Recreating cassette file #{@extraction_list.primary.target_path}"
+        @extraction_list.primary.create_cassette_file
+      end
+    end
+
+    alias setup rent
+    alias teardown drop_off
+
+    private
+
+    def remove_existing_cassette_directory
+      return if configuration.local_mode
+
+      dir = configuration.cassette_dir
+
+      silent_puts "Wiping cassettes directory: #{dir}"
+      FileUtils.rm_r(dir) if Dir.exist?(dir)
+    end
+  end
+end

data/lib/blockbuster/master.rb

@@ -0,0 +1,25 @@
+module Blockbuster
+  # Master file object
+  class Master
+    include Blockbuster::Extractor
+    include Blockbuster::Packager
+
+    attr_reader :file_name, :configuration
+
+    def initialize(comparator, configuration)
+      @configuration = configuration
+      @comparator    = comparator
+      @file_name     = configuration.master_tar_file
+    end
+
+    # read path
+    def file_path
+      configuration.master_tar_file_path
+    end
+
+    # write path (master will always write to the same file name)
+    def target_path
+      file_path
+    end
+  end
+end

data/lib/blockbuster/version.rb

@@ -0,0 +1,3 @@
+module Blockbuster
+  VERSION = '0.4.1'.freeze
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: blockbuster
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Lukas Eklund
+- Alexander Bergman
+- Hassan Shahid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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: minitest
+  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: mocha
+  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: 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: '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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+description: 
+email:
+- leklund@fastly.com
+- alexander@fastly.com
+- hassan@fastly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blockbuster.gemspec
+- lib/blockbuster.rb
+- lib/blockbuster/comparator.rb
+- lib/blockbuster/concerns/extractor.rb
+- lib/blockbuster/concerns/file_helpers.rb
+- lib/blockbuster/concerns/output_helpers.rb
+- lib/blockbuster/concerns/packager.rb
+- lib/blockbuster/configuration.rb
+- lib/blockbuster/delta.rb
+- lib/blockbuster/extraction_list.rb
+- lib/blockbuster/manager.rb
+- lib/blockbuster/master.rb
+- lib/blockbuster/version.rb
+homepage: https://github.com/fastly/blockbuster
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Packaging VCR cassettes for git since 2016
+test_files: []