mc_duck 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e4c9b22dafed37d818d289001e72357f0a9b550
+  data.tar.gz: ac5773ef61a12e730acd982b95e9906f4143d192
+SHA512:
+  metadata.gz: cc36914c2ab2a43ba75c5b91ba91e912b0859a3066d37958dfb346fb872e12e2b54988f8b5ced8612ff4c291e48958b473bc756dd097ca31094048618748e37c
+  data.tar.gz: b5357e5b377be9d0543a473bed279edf20496a18c36e91ea4d0b3750c62b1770aca980dd2b4dd569c3df576d2b90263ecdd40458cd726cd04038a2d0bf04b2e3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Tiago Scolari
+
+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,43 @@
+[![Code Climate](https://codeclimate.com/github/tscolari/mc_duck.png)](https://codeclimate.com/github/tscolari/mc_duck)
+
+McDuck
+====
+
+![McDuck](http://4.bp.blogspot.com/-zTL0Y4xVkXw/UkB4gmoMoiI/AAAAAAAAAuU/mwq3PtIBRY0/s1600/Scrooge.jpg)
+
+Single "file" backup tool with versions to S3.
+
+The objective is to backup individual files with versions on S3,
+for example keeping database backups.
+
+```
+Usage: mc_duck OPTIONS
+    -k, --aws-key-id KEY_ID          AWS key id
+    -a, --aws-access-key ACCESS_KEY  AWS access key
+    -b, --s3-bucket BUCKET_NAME      S3 bucket name
+    -v, --verbose                    Verbose
+    -f, --file_name REMOTE_FILENAME  Target folder in s3, e.g. 'production'
+    --keep [10]                      Number of versions to keep
+```
+
+Example:
+
+```
+pg_dump ... | gzip | mc_duck -k $AWS_KEY -a $AWS_SECRET -b my_bucket -f backups/postgres.gz
+```
+
+this will create inside the bucket:
+
+```
+  /backups/postgres.gz/TIMESTAMP
+```
+
+the `--keep` option controls how many versions do you want to keep, by default it keeps 10.
+
+Theoretically it can backup anything you can pipe through the command line.
+
+Other examples:
+
+* `cat big_backup.gz | mc_duck -k $AWS_KEY -a $AWS_SECRET -b my_bucket -f backups/postgres.gz`
+* `tar cz | mc_duck -k $AWS_KEY -a $AWS_SECRET -b my_bucket -f backups/postgres.gz`
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+

data/bin/mc_duck

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/mc_duck'
+require_relative '../lib/mc_duck/command_line'
+McDuck::CommandLine.new.run(ARGV, ARGF)

data/lib/mc_duck.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require_relative 'mc_duck/backup'
+require_relative 'mc_duck/s3_manager'

data/lib/mc_duck/backup.rb

@@ -0,0 +1,25 @@
+module McDuck
+  class Backup
+
+    def initialize(key_id, access_key, logger = Logger.new)
+      @logger = logger
+      @s3_manager = S3Mananger.new(key_id, access_key, @logger)
+    end
+
+    def run(bucket_name, file_name, file_content, keep)
+      backup(bucket_name, file_name, file_content)
+      cleanup(bucket_name, file_name, keep || 10)
+    end
+
+    private
+
+    def backup(bucket, backup_file_name, content)
+      @s3_manager.upload(bucket, backup_file_name, content)
+    end
+
+    def cleanup(bucket_name, file_name, keep)
+      @s3_manager.cleanup(bucket_name, file_name, keep)
+    end
+
+  end
+end

data/lib/mc_duck/command_line.rb

@@ -0,0 +1,51 @@
+module McDuck
+  class CommandLine
+    require 'optparse'
+    require 'logger'
+
+    def run(args, file)
+      logger = Logger.new($stdout)
+      logger.level = Logger::WARN
+
+      options = fetch_options(args, logger)
+      Backup.new(options.delete(:key_id), options.delete(:access_key), logger).
+        run(options.delete(:bucket), options.delete(:file_name), file.read, options.delete(:keep))
+    end
+
+    private
+
+    def fetch_options(args, logger)
+      Hash.new.tap do |options|
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: s3ckup OPTIONS'
+
+          opts.on('-k', '--aws-key-id KEY_ID', 'AWS key id') do |key_id|
+            options[:key_id] = key_id
+          end
+
+          opts.on('-a', '--aws-access-key ACCESS_KEY', 'AWS access key') do |access_key|
+            options[:access_key] = access_key
+          end
+
+          opts.on('-b', '--s3-bucket BUCKET_NAME', 'S3 bucket name') do |bucket_name|
+            options[:bucket] = bucket_name
+          end
+
+          opts.on('-v', '--verbose', 'Verbose') do
+            logger.level = Logger::INFO
+          end
+
+          opts.on('--keep [10]', 'Backups to keep') do |keep|
+            options[:keep] = keep
+          end
+
+          opts.on('-f', '--file_name REMOTE_FILE_NAME', 'Backups filename in S3') do |file_name|
+            options[:file_name] = file_name
+          end
+
+        end.parse!(args)
+      end
+    end
+
+  end
+end

data/lib/mc_duck/s3_manager.rb

@@ -0,0 +1,54 @@
+require 'aws/s3'
+
+module McDuck
+  class S3Mananger
+
+    def initialize(key_id, access_key, logger = Logger.new)
+      connect!(key_id, access_key)
+      @logger = logger
+    end
+
+    def upload(bucket, file_name, file_content)
+      target_name = create_target_name(file_name)
+      @logger.info("Uploading file: #{target_name}...")
+      AWS::S3::S3Object.store(target_name, file_content, bucket)
+    end
+
+    def backups_list(bucket_name, file_name)
+      bucket = AWS::S3::Bucket.find(bucket_name)
+      backups = bucket.map(&:key).sort
+      backups.select { |file| file.include?(file_name) }
+    end
+
+    def cleanup(bucket_name, file_name, backups_to_keep = 10)
+      expired_backups = backups_to_delete(bucket_name, file_name, backups_to_keep)
+      expired_backups.each do |backup|
+        @logger.info("Deleting old backup: #{backup}...")
+        AWS::S3::S3Object.delete backup, bucket_name
+      end
+    end
+
+    private
+
+    def backups_to_delete(bucket, file_name, backups_to_keep)
+      backups = backups_list(bucket, file_name)
+      backups - backups.last(backups_to_keep.to_i)
+    end
+
+    def create_target_name(file_name)
+      "#{file_name}/#{timestamp}"
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def connect!(key_id, access_key)
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => key_id,
+        :secret_access_key => access_key
+      )
+    end
+
+  end
+end

data/lib/mc_duck/version.rb

@@ -0,0 +1,3 @@
+module McDuck
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mc_duck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tiago Scolari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 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: pry-nav
+  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: Uploads command outputs to s3.
+email:
+- tscolari@gmail.com
+executables:
+- mc_duck
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/mc_duck
+- lib/mc_duck.rb
+- lib/mc_duck/backup.rb
+- lib/mc_duck/command_line.rb
+- lib/mc_duck/s3_manager.rb
+- lib/mc_duck/version.rb
+homepage: https://github.com/tscolari/s3ckup
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Versioned file backup tool to S3.
+test_files: []