backup2s3 0.2.0

data/Manifest

@@ -0,0 +1,14 @@
+CHANGELOG
+Manifest
+README
+Rakefile
+generators/backup2s3/USAGE
+generators/backup2s3/backup2s3_generator.rb
+generators/backup2s3/templates/backup2s3.rake
+generators/backup2s3/templates/backup2s3.yml
+init.rb
+lib/adapters/s3_adapter.rb
+lib/backup2s3.rb
+lib/backup_management/backup.rb
+lib/backup_management/backup_manager.rb
+lib/system.rb

data/README

@@ -0,0 +1,29 @@
+SETUP:
+
+  1. Install the gem
+  gem install backup2s3
+
+  
+  2. Add the below code to config/environment.rb
+  config.gem "backup2s3", :version => ">= 0.1.0"
+
+
+  3. Run the generator in your application root directory
+  script/generate backup2s3
+
+
+  4. Change your settings in config/backup2s3.yml  
+
+
+USAGE:
+
+  Backup tasks
+
+    rake backup2s3:backup:create  - Creates a backup and moves it to S3
+    rake backup2s3:backup:delete  - Deletes the specific backup
+    rake backup2s3:backup:list    - Lists all backups that are currently on S3
+    rake backup2s3:backup:restore - Restores a specific backup
+
+  Some handy tasks
+
+    rake backup2s3:statistics     - Shows you the size of your DB

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('backup2s3', '0.2.0') do |p|
+  p.description = "Backup application and database to S3"
+  p.url         = "http://github.com/aricwalker/backup2s3"
+  p.author      = "Aric Walker"
+  p.email       = "aric@truespire.com"
+  p.ignore_pattern = ["nbproject/*/*", "nbproject/*"]
+  p.development_dependencies = []
+end

data/backup2s3.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backup2s3}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aric Walker"]
+  s.date = %q{2010-04-18}
+  s.description = %q{Backup application and database to S3}
+  s.email = %q{aric@truespire.com}
+  s.extra_rdoc_files = ["CHANGELOG", "README", "lib/adapters/s3_adapter.rb", "lib/backup2s3.rb", "lib/backup_management/backup.rb", "lib/backup_management/backup_manager.rb", "lib/system.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "generators/backup2s3/USAGE", "generators/backup2s3/backup2s3_generator.rb", "generators/backup2s3/templates/backup2s3.rake", "generators/backup2s3/templates/backup2s3.yml", "init.rb", "lib/adapters/s3_adapter.rb", "lib/backup2s3.rb", "lib/backup_management/backup.rb", "lib/backup_management/backup_manager.rb", "lib/system.rb", "backup2s3.gemspec"]
+  s.homepage = %q{http://github.com/aricwalker/backup2s3}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backup2s3", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{backup2s3}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Backup application and database to S3}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/generators/backup2s3/USAGE

@@ -0,0 +1 @@
+backup2s3 generator

data/generators/backup2s3/backup2s3_generator.rb

@@ -0,0 +1,45 @@
+class Backup2s3Generator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      
+      m.directory("lib/tasks")
+      m.file("backup2s3.rake", "lib/tasks/backup2s3.rake")
+
+      m.directory("config")
+      m.file("backup2s3.yml", "config/backup2s3.yml")
+
+      puts message
+    end
+  end
+
+  def message
+    <<-MESSAGE
+
+    -------------------------------------------------------------------
+
+    You have successfully installed backup2s3!
+
+    1. Modify your configuration file:
+
+      config/backup2s3.yml
+
+    2. Get started.
+
+      Backup tasks
+      
+        rake backup2s3:backup:create  - Creates a backup and moves it to S3
+        rake backup2s3:backup:delete  - Deletes the specific backup
+        rake backup2s3:backup:list    - Lists all backups that are currently on S3
+        rake backup2s3:backup:restore - Restores a specific backup
+
+      Some handy tasks
+
+        rake backup2s3:statistics     - Shows you the size of your DB
+
+    -------------------------------------------------------------------
+
+    MESSAGE
+  end
+
+end

data/generators/backup2s3/templates/backup2s3.rake

@@ -0,0 +1,36 @@
+namespace :backup2s3 do
+  namespace :backup do
+    desc "Save a full back to S3"
+    task :create => :environment do
+      Backup2s3.new.create
+    end
+
+    desc "Save a full back to S3"
+    task :delete => :environment do
+      Backup2s3.new.delete
+    end
+
+    desc "Save a full back to S3"
+    task :list => :environment do
+      Backup2s3.new.list
+    end
+
+    desc "Restore your DB from S3"
+    task :restore => :environment do
+      Backup2s3.new.restore
+    end
+
+#    desc "Keep all backups for the last day, one per day for the last week, and one per week before that. Delete the rest."
+#    task :clean => :environment do
+#      Backup2s3.new.clean
+#    end
+  end
+
+  desc "Show table sizes for your database"
+  task :statistics => :environment do
+    rows = Backup2s3.new.statistics
+    rows.sort_by {|x| -x[3].to_i }
+    header = [["Type", "Data MB", "Index", "Rows", "Name"], []]
+    puts (header + rows).collect {|x| x.join("\t") }
+  end
+end

data/generators/backup2s3/templates/backup2s3.yml

@@ -0,0 +1,15 @@
+#Sample backup2s3 configuration file
+:backups:
+  :max_number_of_backups: 5
+  :backup_database: true
+  :backup_application_folders:
+    - public    
+    - lib
+
+:adapter:
+  :access_key_id: XXXXXXXXXXXXXXXXXXXX
+  :secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+  :use_ssl: true
+
+
+

data/init.rb

@@ -0,0 +1 @@
+require 'backup2s3'

data/lib/adapters/s3_adapter.rb

@@ -0,0 +1,69 @@
+require 'aws/s3'
+require 'tidy'
+
+class Adapters::S3Adapter
+
+  def initialize(config)
+    @config = config
+    @connected = false
+  end
+
+  def ensure_connected
+    return if @connected    
+    AWS::S3::Base.establish_connection!(@config)
+    AWS::S3::Bucket.create(bucket)
+    @connected = true
+  end
+
+  def store(file_name, file)
+    ensure_connected
+    AWS::S3::S3Object.store(file_name, file, bucket)
+  end
+
+  def fetch(file_name)
+    ensure_connected
+    AWS::S3::S3Object.find(file_name, bucket)
+
+    file = Tempfile.new("temp")
+    open(file.path, 'w') do |f|
+      AWS::S3::S3Object.stream(file_name, bucket) do |chunk|
+        f.write chunk
+      end
+    end
+    file
+  end
+
+  def read(file_name)
+    puts "trying..."
+    ensure_connected
+    puts "trying..."
+    return AWS::S3::S3Object.find(file_name, bucket)
+  end
+
+  def list
+    ensure_connected
+    AWS::S3::Bucket.find(bucket).objects.collect {|x| x.path }
+  end
+
+  def delete(file_name)
+    if object = AWS::S3::S3Object.find(file_name, bucket)
+      object.delete
+    end
+  end
+
+  private
+
+  def access_key_id
+
+  end
+
+  def bucket    
+    @bucket ||= clean("#{ActiveRecord::Base.connection.current_database.to_str.downcase}-ON-#{`hostname`.to_str.downcase}")
+  end
+
+  def clean(str)
+    str.gsub!(".", "-dot-")
+    str.gsub!("_", "-")    
+    return str.tidy
+  end
+end

data/lib/backup2s3.rb

@@ -0,0 +1,137 @@
+require 'rubygems'
+require 'active_support'
+require 'tempfile'
+require 'yaml'
+
+class Backup2s3
+  include System
+
+  def initialize
+    STDOUT.sync = true #used so that print will not buffer output
+    #ActiveResource::Base.logger = true
+    load_configuration
+    load_adapter
+    load_backup_manager
+    @database_file = ""
+    @application_file = ""
+    @time = Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+
+  #CREATE creates a backup
+  def create(comment = ENV['comment'])
+    create_backup(comment)
+    save_backup_manager
+  end
+
+  #DELETE deletes a backup
+  def delete(backup_id = ENV['id'])
+    raise "ID to delete is blank!" and return if backup_id == nil
+    delete_backup(backup_id)
+    save_backup_manager
+  end
+
+  #RESTORE restores a backup
+  def restore(backup_id = ENV['id'])
+    raise "ID to restore is blank!" and return if backup_id == nil
+    restore_backup(backup_id)
+    save_backup_manager
+  end
+
+  #LIST
+  def list
+    @backup_manager.list_backups
+  end
+
+
+  private
+
+  # Creates both the application file backup and database backup and moves them
+  # to S3.  This method will also update the BackupManager and store it's updated
+  # information.
+  def create_backup(comment)
+    if @conf[:backups][:backup_database]
+      @database_file = "#{@time}-#{System.db_credentials['database']}-database.sql"
+      database_temp = System.db_dump      
+      puts "\n- System dump size: " << database_temp.size.to_s << " B"; print "--- Backing up database..."
+      @adapter.store(@database_file, open(database_temp.path))
+      puts "done"
+    end
+    
+    if @conf[:backups][:backup_application_folders].is_a?(Array)
+      @application_file = "#{@time}-#{System.db_credentials['database']}-application.tar.gz"
+      application_temp = System.tarzip_folders(@conf[:backups][:backup_application_folders])
+      puts "\n- Application tarball size: " << application_temp.size.to_s << " B"; print "--- Backing up application folders..."
+      @adapter.store(@application_file, open(application_temp.path))
+      puts "done"
+    end
+
+    if @conf[:backups][:max_number_of_backups] == @backup_manager.number_of_backups then
+      puts "\nReached max_number_of_backups, removing oldest backup..."
+      backup_to_delete = @backup_manager.get_oldest_backup
+      delete_backup(backup_to_delete.time)
+    end
+    backup = BackupManagement::Backup.new(@time, @application_file, @database_file, comment)
+    @backup_manager.add_backup(backup)
+    puts ""
+  end
+
+  # Deletes the Backup, application backup files and database files associated
+  # with the Backup identified by backup_id.  
+  def delete_backup(backup_id)
+    backup = @backup_manager.get_backup(backup_id)
+    if backup.nil? then
+      puts "Backup with ID #{backup_id} does not exist."
+      return
+    end    
+    begin @adapter.delete(backup.application_file) rescue puts "Could not delete #{backup.application_file}!" end
+    begin @adapter.delete(backup.database_file) rescue puts "Could not delete #{backup.database_file}!" end
+    puts (@backup_manager.delete_backup(backup) ?
+        "Backup with ID #{backup.time} was successfully deleted." :
+        "Warning: Backup with ID #{backup.time} was not found and therefore not deleted.")
+  end
+
+#  def restore_backup(backup_id)
+#    backup = backup_manager.get_backup(backup_id)
+#    if backup.nil? then
+#      puts "Backup with ID #{backup_id} does not exist."
+#      return
+#    end
+#
+#  end
+
+  # Loads the config/backup2s3.yml configuration file
+  def load_configuration
+    @conf = YAML.load_file("#{RAILS_ROOT}/config/backup2s3.yml")
+  end
+
+  # Creates instance of class used to interface with S3
+  def load_adapter    
+    @adapter = Adapters::S3Adapter.new(@conf[:adapter])
+  end
+
+  def load_backup_manager
+    BackupManagement::BackupManager.new()
+    BackupManagement::Backup.new(nil, nil, nil)
+    begin           
+      @backup_manager = YAML.load_file(@adapter.fetch(BackupManagement::BackupManager.filename).path)
+      @backup_manager ||= YAML.load_file(BackupManagement::BackupManager.local_filename)
+    rescue
+      @backup_manager ||= BackupManagement::BackupManager.new
+    end
+  end
+
+  def save_backup_manager
+    begin
+      File.open(BackupManagement::BackupManager.local_filename, "w") { |f| YAML.dump(@backup_manager, f) }
+    rescue
+      puts "Unable to save local file: " << BackupManagement::BackupManager.local_filename
+    end
+    begin
+      @adapter.store(BackupManagement::BackupManager.filename, open(BackupManagement::BackupManager.local_filename))
+    rescue
+      puts "Unable to save BackupManager to S3"
+    end
+  end 
+
+end

data/lib/backup_management/backup.rb

@@ -0,0 +1,19 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require 'yaml'
+
+class BackupManagement::Backup
+
+  attr_accessor :time, :application_file, :database_file, :comment
+  
+  def initialize(time, application_file, database_file, comment = nil)
+    self.time = time
+    self.application_file = application_file
+    self.database_file = database_file
+    self.comment = comment
+  end
+
+  def human_readable_time
+    DateTime.parse(self.time).strftime("%m-%d-%Y %H:%M:%S")
+  end
+end

data/lib/backup_management/backup_manager.rb

@@ -0,0 +1,70 @@
+require 'yaml'
+
+class BackupManagement::BackupManager
+  include System
+  
+  attr_accessor :backup_list_filename, :backups
+
+
+  def initialize    
+    self.backups = Array.new
+  end
+
+  def self.filename
+    "#{System.db_credentials['database']}_ON_#{`hostname`.tidy}_backups.yaml".tidy
+  end
+
+  def self.local_filename
+    "#{RAILS_ROOT}/lib/#{filename}"
+  end
+
+  def add_backup(backup)
+    self.backups << backup
+  end
+
+  def delete_backup(backup)
+    self.backups.delete(backup)
+  end
+
+  def delete_backup_by_id(backup_id)
+    self.backups.each { |backup|
+      if backup.time == backup_id then
+        self.backups.delete(backup)
+      end
+    }
+    nil
+  end
+
+  def get_oldest_backup
+    self.backups.sort{|a,b| b.time <=> a.time}.last
+  end
+
+  def get_backup(backup_id)
+    self.backups.each { |backup|
+      if backup.time == backup_id then
+        return backup
+      end
+    }
+    nil
+  end
+
+  def list_backups(details = ENV['details'])
+    puts "\n--- Backups by Date ---"
+    count = 1
+    self.backups.sort{|a,b| b.time <=> a.time}.each do |backup|
+      puts "#{count}. #{backup.human_readable_time}, ID - #{backup.time}"
+      if details then
+        puts "   --- App -> #{backup.application_file}"
+        puts "   --- DB -> #{backup.database_file}"
+        puts "   --- Comment -> #{backup.comment}"
+      end
+      count = count.next
+    end
+    puts "-----------------------\n\n"
+  end  
+
+  def number_of_backups
+    backups.size
+  end
+  
+end

data/lib/system.rb

@@ -0,0 +1,46 @@
+require 'tempfile'
+
+module System
+
+  def self.db_credentials    
+    ActiveRecord::Base.configurations[RAILS_ENV]
+  end
+
+  # Run system commands
+  def self.run(command)
+    result = system(command)
+    raise("error, process exited with status #{$?.exitstatus}") unless result
+  end
+
+  # Creates app tar file
+  def self.tarzip_folders(folders)
+    application_tar = Tempfile.new("app")
+    if folders.is_a?(Array)      
+      cmd = "tar --dereference -czf #{application_tar.path} #{folders.join(" ")}"
+    elsif folders.is_a?(String)
+      cmd = "tar --dereference -czf #{application_tar.path} #{folders}"
+    end
+    run(cmd)
+    return application_tar
+  end
+
+  # Creates and runs mysqldump and throws into .tar.gz file.
+  # Returns .tar.gz file
+  def self.db_dump
+    dump_file = Tempfile.new("dump")
+    cmd = "mysqldump --quick --single-transaction --create-options #{mysql_options}"
+    cmd += " > #{dump_file.path}"
+    run(cmd)
+    return dump_file
+  end
+
+  def self.mysql_options
+    cmd = ''
+    cmd += " -u #{db_credentials['username']} " unless db_credentials['username'].nil?
+    cmd += " -p'#{db_credentials['password']}'" unless db_credentials['password'].nil?
+    cmd += " -h '#{db_credentials['host']}'"    unless db_credentials['host'].nil?
+    cmd += " #{db_credentials['database']}"
+  end
+    
+end
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: backup2s3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aric Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-18 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Backup application and database to S3
+email: aric@truespire.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- lib/adapters/s3_adapter.rb
+- lib/backup2s3.rb
+- lib/backup_management/backup.rb
+- lib/backup_management/backup_manager.rb
+- lib/system.rb
+files: 
+- CHANGELOG
+- Manifest
+- README
+- Rakefile
+- generators/backup2s3/USAGE
+- generators/backup2s3/backup2s3_generator.rb
+- generators/backup2s3/templates/backup2s3.rake
+- generators/backup2s3/templates/backup2s3.yml
+- init.rb
+- lib/adapters/s3_adapter.rb
+- lib/backup2s3.rb
+- lib/backup_management/backup.rb
+- lib/backup_management/backup_manager.rb
+- lib/system.rb
+- backup2s3.gemspec
+has_rdoc: true
+homepage: http://github.com/aricwalker/backup2s3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Backup2s3
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: backup2s3
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Backup application and database to S3
+test_files: []
+