backup_driver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a378df25915fe18d6e94d2949f6f18e8b9666d5e
+  data.tar.gz: aed135c8be75849d5da4eaa03daa3147dbb90e9f
+SHA512:
+  metadata.gz: a67b68257fee90001be6f0a3dd4eb54a8935b0fa67885d90c637056b653fa4c49d6dfc0735c54fd9b52cd11b21219fa3b4ac65a5b2b774df748f2a6a52ffbbec
+  data.tar.gz: 4bf272c699026d6c2caccc1b1fae815de3c320102e331375b96c10153340ae40f6e1f3525e787847177376a3737070c0c34a8ab239ed6fda3294524965909458

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vinicius Teles
+
+MIT License
+
+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,63 @@
+# BackupDriver
+
+BackupDriver is a tool created to backup files from Unix systems. It's was created to address some very specific personal needs:
+
+  * Backup log files to Amazon S3 and remove them from the server
+  * Backup local mysql databases to Amazon S3
+
+The generated backup file is encrypted using [gpg][] and sent to Amazon S3. The operations are performed using tools that must be installed on the system:
+
+  * [gpg][]
+  * [s3cmd][]
+  * [mysqldump][]
+
+[Backup][b] is another tool that you might be interested in checking out. It's scope is much broader. So it can be useful in many situations that are not covered by BackupDriver. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backup_driver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backup_driver
+
+## Usage
+
+### Backup nginx log files
+
+```shell
+backup_driver backup --source /var/log/nginx --bucket "s3://mybucket" --gpg-options "--recipient 'my@email.com'"
+```
+
+**CAUTION**: BackupDriver removes the log files after sending them to Amazon S3. If you don't want that to happen, please consider using a different tool or change the code to suite your needs.
+
+### Backup mysql database
+
+```shell
+backup_driver mysql --name db_name --user db_user --password db_password --gpg-options "--recipient 'my@email.com'"  
+```
+
+## Contributing
+
+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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+**Copyright (c) 2013 [Vinícius Manhães Teles][v] ([@viniciusteles][t])**  
+Released under the [MIT License][l].
+
+[gpg]:       http://www.gnupg.org/
+[s3cmd]:     http://s3tools.org/s3cmd
+[mysqldump]: http://dev.mysql.com/doc/refman/5.1/en/mysqldump.html
+[b]:         https://github.com/meskyanichi/backup
+[v]:         http://viniciusteles.com
+[t]:         https://twitter.com/viniciusteles
+[l]:         https://github.com/viniciusteles/backup_driver/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/backup_driver.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backup_driver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backup_driver"
+  spec.version       = BackupDriver::VERSION
+  spec.authors       = ["Vinicius Teles"]
+  spec.email         = ["vinicius@improveit.com.br"]
+  spec.description   = %q{BackupDriver is a tool created to backup files from Unix systems.}
+  spec.summary       = %q{BackupDriver can be used to backup log files and mysql databases to Amazon S3.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', '= 0.18.1'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/bin/backup_driver

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/backup_driver", __FILE__)
+BackupDriver::CLI.start

data/lib/backup_driver.rb

@@ -0,0 +1,22 @@
+require "thor"
+
+module BackupDriver
+
+  LIBRARY_PATH = File.join(File.dirname(__FILE__), 'backup_driver')
+
+  %w(
+    command
+    create_command
+    mysql_create_command
+    encrypt_command
+    store_command
+    clean_command
+    driver
+    cli
+    version
+  ).each { |lib| require File.join(LIBRARY_PATH, lib) }
+
+  def self.backup
+    Driver.new.backup
+  end
+end

data/lib/backup_driver/clean_command.rb

@@ -0,0 +1,16 @@
+module BackupDriver
+  class CleanCommand < Command
+    def do
+      remove_source_files
+      remove_temp_dir
+    end
+
+    def remove_source_files
+      driver.log << `/bin/rm #{driver.create_command.source}/*`
+    end
+
+    def remove_temp_dir
+      driver.log << `/bin/rm -r #{driver.create_command.temp_dir}`
+    end
+  end
+end

data/lib/backup_driver/cli.rb

@@ -0,0 +1,22 @@
+module BackupDriver
+  class CLI < Thor
+    desc 'files', "Backup a file or directory"
+    option :gpg_options
+    option :source, :required => true
+    option :bucket, :required => true
+    def backup
+      Driver.new(options).backup
+    end              
+
+    desc 'mysql', "Backup a mysql database"
+    option :mysql, :default => true
+    option :name, :required => true
+    option :user, :required => true
+    option :bucket, :required => true
+    option :gpg_options
+    option :password
+    def mysql
+      Driver.new(options).backup
+    end
+  end
+end

data/lib/backup_driver/command.rb

@@ -0,0 +1,13 @@
+module BackupDriver
+  class Command
+    attr_reader :driver
+
+    def initialize(driver)
+      @driver = driver
+    end
+
+    def options
+      driver.options
+    end
+  end
+end

data/lib/backup_driver/create_command.rb

@@ -0,0 +1,49 @@
+module BackupDriver
+  class CreateCommand < Command
+    def do
+      create_temp_dir
+      prepare_source
+      driver.log << `/bin/tar -C #{source_parent} -cvf #{backup_file} #{source_basename}`
+    end
+
+    def create_temp_dir
+      driver.log << `/bin/mkdir -p #{temp_dir}`
+    end
+
+    def temp_dir
+      "/tmp/backup_driver"
+    end
+
+    def prepare_source
+     # Implemented in subclasses only 
+    end
+
+    def backup_file
+      "#{temp_dir}/#{file_name}"
+    end
+
+    def file_name
+      "#{backup_basename}-#{formatted_time}.tar"
+    end
+
+    def backup_basename
+      source_basename
+    end
+    
+    def source_basename
+      File.basename(source)
+    end
+
+    def source
+      options[:source]
+    end
+
+    def source_parent
+      File.dirname(source)
+    end
+
+    def formatted_time
+      driver.time.strftime("%Y%m%d-%H%M%S")
+    end
+  end
+end

data/lib/backup_driver/driver.rb

@@ -0,0 +1,44 @@
+module BackupDriver
+  class Driver
+    attr_reader :options, :time, :log
+
+    def initialize(options)
+      @options = options
+      @time = Time.now
+      @log  = []
+    end
+
+    def backup
+      create_command.do
+      encrypt_command.do
+      store_command.do
+      clean_command.do
+      output_log
+    end
+
+    def output_log
+      puts @log.join("\n")
+    end
+
+    def create_command
+      @create_command ||= select_create_command
+    end
+
+    def select_create_command
+      return MysqlCreateCommand.new(self) if options[:mysql]
+      CreateCommand.new(self)
+    end
+
+    def encrypt_command
+      @encrypt_command ||= EncryptCommand.new(self)
+    end
+
+    def store_command
+      @store_command ||= StoreCommand.new(self)
+    end
+
+    def clean_command
+      @clean_command ||= CleanCommand.new(self)
+    end
+  end
+end

data/lib/backup_driver/encrypt_command.rb

@@ -0,0 +1,15 @@
+module BackupDriver
+  class EncryptCommand < Command
+    def do
+      driver.log << `/usr/bin/gpg #{options[:gpg_options]} --encrypt --compress-algo bzip2 --output #{encrypted_file} #{backup_file}`
+    end
+
+    def encrypted_file
+      "#{backup_file}.gpg"
+    end
+
+    def backup_file
+      driver.create_command.backup_file        
+    end
+  end
+end

data/lib/backup_driver/mysql_create_command.rb

@@ -0,0 +1,21 @@
+module BackupDriver
+  class MysqlCreateCommand < CreateCommand
+    def prepare_source
+      driver.log << `/bin/mkdir -p #{temp_dir}/mysql`
+      driver.log << `/usr/bin/mysqldump -u #{options[:user]} #{password_params} #{options[:name]} > #{source}/#{options[:name]}.sql`
+    end
+
+    def backup_basename
+      options[:name]
+    end
+    
+    def source
+      "#{temp_dir}/mysql"
+    end
+
+    def password_params
+      return "-p #{options[:password]}" if options[:password]
+      ""
+    end
+  end
+end

data/lib/backup_driver/store_command.rb

@@ -0,0 +1,36 @@
+module BackupDriver
+  class StoreCommand < Command
+    def do
+      driver.log << `/usr/bin/s3cmd put --reduced-redundancy #{encrypted_file} #{bucket}/#{path}`
+    end
+
+    def encrypted_file
+      driver.encrypt_command.encrypted_file
+    end
+
+    def bucket
+      options[:bucket]
+    end
+
+    def path
+      "#{basedir}#{basename}/#{year}/#{month}/"
+    end
+
+    def basedir
+      return "mysql/" if options[:mysql]
+      ""
+    end
+
+    def basename
+      driver.create_command.backup_basename
+    end
+
+    def year
+      driver.time.strftime("%Y")
+    end
+
+    def month
+      driver.time.strftime("%m-%b")
+    end
+  end
+end

data/lib/backup_driver/version.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: backup_driver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vinicius Teles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: BackupDriver is a tool created to backup files from Unix systems.
+email:
+- vinicius@improveit.com.br
+executables:
+- backup_driver
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backup_driver.gemspec
+- bin/backup_driver
+- lib/backup_driver.rb
+- lib/backup_driver/clean_command.rb
+- lib/backup_driver/cli.rb
+- lib/backup_driver/command.rb
+- lib/backup_driver/create_command.rb
+- lib/backup_driver/driver.rb
+- lib/backup_driver/encrypt_command.rb
+- lib/backup_driver/mysql_create_command.rb
+- lib/backup_driver/store_command.rb
+- lib/backup_driver/version.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: BackupDriver can be used to backup log files and mysql databases to Amazon
+  S3.
+test_files: []