trashman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d5a7113f4f529dd666222dbed4816841d66e97d
+  data.tar.gz: 7ad829a02a4b986b99a4333cabc5612b3d047b6c
+SHA512:
+  metadata.gz: ff9ea4453ea673b1e35883da5d29855da00cd374335f02d2a122bf1f453b11edfe83bdd20f6c812d4cf372e422af57bad94f9504897a0f55412d77bbbdfefc7d
+  data.tar.gz: cb60bbbf0a9c0db585952964315bdc7f47ccd0396f0e8e62208f2a27f0673e9e433b1a934d4fbf54f7b743aa6dbc5412b5dae03b4bd6df7304315872ca32b0da

data/.gitignore

@@ -0,0 +1,8 @@
+coverage
+*.gem
+.bundle
+.rbenv-version
+Gemfile.lock
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ideal Project Group
+
+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,65 @@
+# TrashMan
+
+Removes outdated periodic backup files from your cloud storage bucket.
+
+## Install
+
+Into Gemfile from rubygems.org:
+
+```
+gem install trashman
+```
+
+## Note
+
+This gem assumes your filenames include a date and time e.g. backup.2015-07-07T10-32-01.tar.gz.
+
+```
+backup.$(date +'\%Y-\%m-\%dT\%H-\%M-\%S').tar.gz
+```
+
+Please use the `--dry-run` option to test your configuration before using trashman.
+
+## Usage
+
+trashman is best used as a cronjob. It assumes you have a cloud storage bucket where you store periodic backups with conventional filenames including date and time.
+
+To destroy outdated backups:
+
+```
+trashman prune --provider <FOG PROVIDER> --keep <NUMBER OF FILES TO KEEP> --container <CONTAINER/BUCKET> --credentials username:<USERNAME> password:<PASSWORD>
+
+trashman prune --provider rackspace --keep 100 --container "Test Container" --credentials rackspace_api_key:abc123 rackspace_username:example rackspace_region:ord
+
+trashman help prune
+
+Usage:
+  trashman prune --credentials=key:value -P, --provider=PROVIDER -c, --container=CONTAINER
+
+Options:
+  -P, --provider=PROVIDER          # A valid fog provider e.g. rackspace, aws, etc.
+  -c, --container=CONTAINER        # Container or bucket on fog provider.
+  -k, [--keep=N]                   # Number of files to keep.
+                                   # Default: 100
+      --credentials=key:value      # Credentials for your fog provider (depends on fog provider).
+      [--dry-run], [--no-dry-run]  # As normal, but it does not destroy old backups.
+```
+
+## Contributors
+
+Many thanks to:
+
+- [Bruno Sutic](https://github.com/bruno-)
+
+## How to contribute
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Write your tests and check everything passes
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request (into the master branch)
+
+## License
+
+Please refer to [LICENSE.md](https://github.com/idealprojectgroup/trashman/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :test => :spec
+task :default => :spec
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))

data/bin/trashman

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'trashman/cli'
+
+begin
+  TrashMan::CLI.start
+rescue
+  exit(1)
+end

data/lib/trashman/cli.rb

@@ -0,0 +1,46 @@
+require 'thor'
+require 'trashman'
+require 'trashman/manager'
+
+module TrashMan
+  class CLI < ::Thor
+
+    desc "prune", "Prunes old backups."
+    method_option :provider, type: :string, aliases: %w(-P),
+      required: true,
+      desc: "A valid fog provider e.g. rackspace, aws, etc."
+    method_option :container, type: :string, aliases: %w(-c),
+      required: true,
+      desc: "Container or bucket on fog provider."
+    method_option :keep, type: :numeric, aliases: %w(-k),
+      default: 100,
+      desc: "Number of files to keep."
+    method_option :credentials, type: :hash, required: true,
+      desc: "Credentials for your fog provider (depends on fog provider)."
+    method_option :dry_run, type: :boolean, default: false,
+      desc: "As normal, but it does not destroy old backups."
+    def prune
+      if options.dry_run
+        say "This is a dry-run. No files will be deleted."
+      end
+
+      manager = TrashMan::Manager.new(options.provider, options)
+      count = manager.cleanup! do |file|
+        say " -- deleting #{file.key}", :yellow
+      end
+
+      if options.dry_run
+        say "This was a dry-run. No files were deleted."
+      else
+        say "#{count} file(s) deleted.", :green
+      end
+    # This seems dirty.
+    # However, if the Fog::Storage provider throws any error,
+    # the user will be notified. Errors can be related to
+    # authentication, nonexistent bucket, etc.
+    rescue => e
+      say e.message
+    end
+
+  end
+end

data/lib/trashman/manager.rb

@@ -0,0 +1,49 @@
+require 'fog'
+require 'trashman'
+
+module TrashMan
+  class Manager
+    def initialize(provider, options = {})
+      @options = options
+
+      @connection = Fog::Storage.new(
+        { provider: provider }.merge(options[:credentials])
+      )
+    end
+
+    def cleanup!(&block)
+      queued_files.each do |file|
+        yield(file) if block
+
+        if !options[:dry_run]
+          file.destroy
+        end
+      end
+
+      queued_files.count
+    end
+
+  private
+
+    def options
+      @options
+    end
+
+    def connection
+      @connection
+    end
+
+    def container
+      @container ||= connection.directories.get(options[:container])
+    end
+
+    def files
+      @files ||= container.files.sort_by { |file| file.key }
+    end
+
+    def queued_files
+      files[0...(- options[:keep])]
+    end
+
+  end
+end

data/lib/trashman/version_number.rb

@@ -0,0 +1,18 @@
+module TrashMan
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+    def self.to_s
+      STRING
+    end
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+end

data/lib/trashman.rb

@@ -0,0 +1,5 @@
+module TrashMan
+
+end
+
+require 'trashman/version_number'

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'trashman'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/trashman/cli_spec.rb

@@ -0,0 +1,11 @@
+require 'trashman/cli'
+
+describe TrashMan::CLI do
+  describe ".prune" do
+    it "provides help" do
+      expect {
+        TrashMan::CLI.start(["help"])
+      }.to output(/prune/).to_stdout
+    end
+  end
+end

data/spec/trashman/manager_spec.rb

@@ -0,0 +1,63 @@
+require 'singleton'
+require 'trashman/manager'
+
+class MockFogFile < Struct.new(:key)
+  def destroy
+    true
+  end
+end
+
+class MockFogContainer
+  include Singleton
+
+  def files
+    @files ||= [
+      MockFogFile.new("backup.2015-01-01T10-00-01.tar.gz"),
+      MockFogFile.new("backup.2015-01-02T10-00-01.tar.gz"),
+      MockFogFile.new("backup.2015-01-03T10-00-01.tar.gz"),
+      MockFogFile.new("backup.2015-01-04T10-00-01.tar.gz"),
+      MockFogFile.new("backup.2015-01-05T10-00-01.tar.gz"),
+    ]
+  end
+end
+
+class MockFogDirectories
+  def get(container)
+    MockFogContainer.instance
+  end
+end
+
+class MockFogConnection
+  def directories
+    MockFogDirectories.new
+  end
+end
+
+describe TrashMan::Manager do
+  describe "#cleanup!" do
+    before do
+      # Provide a mock fog connection
+      allow(Fog::Storage).to receive(:new).with(
+        { provider: "rackspace" }
+      ).and_return(MockFogConnection.new)
+    end
+
+    it "yields to block" do
+      expect { |b| TrashMan::Manager.new("rackspace", { credentials: {}, keep: 4 }).cleanup!(&b) }.to yield_with_args(MockFogContainer.instance.files.first)
+    end
+
+    it "destroys correct number of files based on the keep setting" do
+      expect(MockFogContainer.instance.files[0]).to receive(:destroy)
+      expect(MockFogContainer.instance.files[1]).to receive(:destroy)
+
+      count = TrashMan::Manager.new("rackspace", { credentials: {}, keep: 3 }).cleanup!
+      expect(count).to eq 2
+    end
+
+    it "skips destruction if dry_run is enabled" do
+      expect_any_instance_of(MockFogFile).to_not receive(:destroy)
+
+      TrashMan::Manager.new("rackspace", { credentials: {}, keep: 3, dry_run: true }).cleanup!
+    end
+  end
+end

data/spec/trashman_spec.rb

@@ -0,0 +1,7 @@
+describe TrashMan do
+  describe ".version" do
+    it "provides a version" do
+      expect(TrashMan.version).to be
+    end
+  end
+end

data/trashman.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'trashman/version_number'
+
+Gem::Specification.new do |s|
+  s.name          = 'trashman'
+  s.version       = TrashMan.version
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Removes outdated periodic backup files from your cloud storage bucket"
+  s.description   = s.summary
+  s.authors       = ["Derek Hopper"]
+  s.email         = 'hopper.derek@gmail.com'
+  s.homepage      = 'http://github.com/idealprojectgroup/trashman'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 1.9'
+
+  s.add_dependency('thor', '~> 0.19')
+  s.add_dependency('fog', '~> 1.34')
+
+  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_development_dependency('rake')
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: trashman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Hopper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Removes outdated periodic backup files from your cloud storage bucket
+email: hopper.derek@gmail.com
+executables:
+- trashman
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/trashman
+- lib/trashman.rb
+- lib/trashman/cli.rb
+- lib/trashman/manager.rb
+- lib/trashman/version_number.rb
+- spec/spec_helper.rb
+- spec/trashman/cli_spec.rb
+- spec/trashman/manager_spec.rb
+- spec/trashman_spec.rb
+- trashman.gemspec
+homepage: http://github.com/idealprojectgroup/trashman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Removes outdated periodic backup files from your cloud storage bucket
+test_files:
+- spec/spec_helper.rb
+- spec/trashman/cli_spec.rb
+- spec/trashman/manager_spec.rb
+- spec/trashman_spec.rb
+has_rdoc: