tarsnap_pruner 0.1.0

data/.dotenv.rspec

@@ -0,0 +1,3 @@
+TARSNAP=/usr/local/bin/tarsnap
+KEY_DIRECTORY=spec/fixtures/keys
+CACHES_DIRECTORY=tmp/spec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

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 tarsnap_pruner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 West Arete Computing, Inc.
+
+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,41 @@
+# TarsnapPruner
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tarsnap_pruner`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tarsnap_pruner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tarsnap_pruner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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. Run `bundle exec tarsnap_pruner` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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]/tarsnap_pruner. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tarsnap_pruner"
+
+require "irb"
+IRB.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/exe/tarsnap_pruner

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+# Prune old backups from tarsnap, in order to save on storage costs.
+
+require "tarsnap_pruner"
+
+TarsnapPruner.configure(ARGV.first)
+unless ENV['KEY_DIRECTORY']
+  puts "Supply a config file or define ENV['KEY_DIRECTORY']"
+  exit 1
+end
+
+TarsnapPruner::Machine.all.each do |machine|
+  puts
+  puts "===== #{machine.hostname} ====="
+
+  scheduler = TarsnapPruner::Scheduler.new(machine.archives)
+
+  puts "Daily backups to keep:"
+  puts scheduler.dailies
+
+  puts "Weekly backups to keep:"
+  puts scheduler.weeklies_to_keep
+
+  puts "Monthly backups to keep:"
+  puts scheduler.monthlies_to_keep
+
+  puts "----- 8< -----"
+
+  puts "Weekly backups to prune:"
+  puts scheduler.weeklies_to_prune
+
+  puts "Monthly backups to prune:"
+  puts scheduler.monthlies_to_prune
+
+  puts "Unknown backups to prune:"
+  puts scheduler.unknowns
+
+  machine.delete(scheduler.archives_to_prune)
+end

data/lib/tarsnap_pruner/archive.rb

@@ -0,0 +1,32 @@
+require 'date'
+
+module TarsnapPruner
+
+  # An instance of this class represents a single tarsnap backup.
+  #
+  # We expect the name of each archive to contain an iso8601 date that
+  # represents the date that the backup was taken.
+  class Archive
+
+    # Expects the name of the archive, as given to tarsnap. It should contain
+    # an iso8601 date (e.g. 2015-05-15) that represents when the backup was
+    # taken.
+    def initialize(name)
+      @name = name
+    end
+
+    attr_reader :name
+
+    # Return a Ruby Date object for the backup's date, or nil if one could not
+    # be discerned from the archive name.
+    def date
+      name =~ /.*(\d{4}-\d{2}-\d{2})/ ? Date.parse($1) : nil
+    end
+
+    # The number of days that have elapsed since the backup date.
+    def elapsed
+      date ? Date.today - date : nil
+    end
+
+  end
+end

data/lib/tarsnap_pruner/machine.rb

@@ -0,0 +1,48 @@
+require 'tmpdir'
+
+module TarsnapPruner
+
+  # An instance of this class represents one machine that's being backed up.
+  class Machine
+
+    def self.key_files
+      Dir.glob(File.join(ENV['KEY_DIRECTORY'], '*.key')).sort
+    end
+
+    def self.all
+      key_files.map { |f| new(f) }
+    end
+
+    def initialize(key_file, tarsnap=nil)
+      @key_file = key_file
+      @tarsnap = tarsnap || Tarsnap.new(@key_file)
+    end
+
+    attr_reader :key_file
+
+    def hostname
+      key_file =~ /tarsnap-(.*)\.key$/ ? $1 : 'unknown'
+    end
+
+    def archives
+      @tarsnap.list_archives.split.sort.map { |name| Archive.new(name) }
+    end
+
+    def delete(archives_to_delete)
+      if archives_to_delete.any?
+        Dir.mktmpdir("cache-", ENV['CACHES_DIRECTORY']) do |cache_directory|
+          # fsck so that we have an up-to-date cache (required for pruning). This
+          # means that each machine will have to fsck again, but there's apparently
+          # no way around it.
+          # Ref: http://mail.tarsnap.com/tarsnap-users/msg00512.html
+          @tarsnap.fsck(cache_directory)
+          archives_to_delete.each do |archive|
+            @tarsnap.delete(archive, cache_directory)
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/tarsnap_pruner/scheduler.rb

@@ -0,0 +1,53 @@
+module TarsnapPruner
+
+  class Scheduler
+
+    def initialize(archives, daily_boundary=182, weekly_boundary=730)
+      @archives = archives
+      @daily_boundary = daily_boundary
+      @weekly_boundary = weekly_boundary
+    end
+
+    def knowns
+      @archives.select(&:date)
+    end
+
+    def unknowns
+      @archives.reject(&:date)
+    end
+
+    def dailies
+      knowns.select { |a| a.elapsed < @daily_boundary }
+    end
+
+    def weeklies
+      knowns.select { |a| a.elapsed >= @daily_boundary && a.elapsed < @weekly_boundary }
+    end
+
+    def monthlies
+      knowns.select { |a| a.elapsed >= @weekly_boundary }
+    end
+
+    def weeklies_to_keep
+      weeklies.group_by { |a| a.date.cweek }.values.map(&:last)
+    end
+
+    def weeklies_to_prune
+      weeklies - weeklies_to_keep
+    end
+
+    def monthlies_to_keep
+      monthlies.group_by { |a| a.date.month }.values.map(&:last)
+    end
+
+    def monthlies_to_prune
+      monthlies - monthlies_to_keep
+    end
+
+    def archives_to_prune
+      unknowns + monthlies_to_prune + weeklies_to_prune
+    end
+
+  end
+
+end

data/lib/tarsnap_pruner/tarsnap.rb

@@ -0,0 +1,30 @@
+module TarsnapPruner
+
+  # A class to encapsulate invoking the command-line tarsnap commands.
+  class Tarsnap
+
+    def initialize(key_file)
+      @key_file = key_file
+    end
+
+    def list_archives
+      `#{tarsnap} --list-archives --keyfile #{@key_file}`
+    end
+
+    def fsck(cache_directory)
+      system "#{tarsnap} --fsck --keyfile #{@key_file} --cachedir #{cache_directory} > /dev/null"
+    end
+
+    def delete(archive, cache_directory)
+      system "#{tarsnap} -d --keyfile #{@key_file} --cachedir #{cache_directory} -f #{archive.name} > /dev/null"
+    end
+
+    private
+
+    def tarsnap
+      ENV['TARSNAP_COMMAND']
+    end
+
+  end
+
+end

data/lib/tarsnap_pruner/version.rb

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

data/lib/tarsnap_pruner.rb

@@ -0,0 +1,21 @@
+require "tarsnap_pruner/version"
+require "tarsnap_pruner/archive"
+require "tarsnap_pruner/scheduler"
+require "tarsnap_pruner/tarsnap"
+require "tarsnap_pruner/machine"
+
+require 'dotenv'
+
+module TarsnapPruner
+
+  module_function
+
+  def configure(config_file=nil)
+    if config_file
+      Dotenv.load(config_file)
+    else
+      Dotenv.load
+    end
+  end
+
+end

data/tarsnap_pruner.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tarsnap_pruner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tarsnap_pruner"
+  spec.version       = TarsnapPruner::VERSION
+  spec.authors       = ["Scott Woods"]
+  spec.email         = ["scott@westarete.com"]
+
+  spec.summary       = %q{A method of deleting old tarsnap backups.}
+  spec.description   = %q{The Tarsnap backup service charges based on storage and bandwith. This gem provides a technique for grandfathering old backups in order to save on storage costs.}
+  spec.homepage      = "https://github.com/westarete/tarsnap_pruner"
+  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_runtime_dependency "dotenv"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: tarsnap_pruner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Woods
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Tarsnap backup service charges based on storage and bandwith. This
+  gem provides a technique for grandfathering old backups in order to save on storage
+  costs.
+email:
+- scott@westarete.com
+executables:
+- tarsnap_pruner
+extensions: []
+extra_rdoc_files: []
+files:
+- .dotenv.rspec
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tarsnap_pruner
+- lib/tarsnap_pruner.rb
+- lib/tarsnap_pruner/archive.rb
+- lib/tarsnap_pruner/machine.rb
+- lib/tarsnap_pruner/scheduler.rb
+- lib/tarsnap_pruner/tarsnap.rb
+- lib/tarsnap_pruner/version.rb
+- tarsnap_pruner.gemspec
+- tmp/spec/.gitkeep
+homepage: https://github.com/westarete/tarsnap_pruner
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A method of deleting old tarsnap backups.
+test_files: []