namxam-backup 2.4.5

data/generators/backup/templates/backup.rake

@@ -0,0 +1,56 @@
+namespace :backup do
+  
+  task :boot => :environment do
+    Backup::System.boot!
+  end
+  
+  desc "Run Backup Procedure."
+  task :run => :boot do
+    puts "Running: #{ENV['trigger']}."
+    Backup::Setup.new(ENV['trigger'], @backup_procedures).initialize_adapter
+  end
+  
+  desc "Finds backup records by trigger"
+  task :find => :boot do
+    puts "Finding backup records with trigger: #{ENV['trigger']}."
+    backup = Backup::Setup.new(ENV['trigger'], @backup_procedures)
+    records = backup.procedure.record_class.all( :conditions => {:trigger => ENV['trigger']} )
+    
+    if ENV['table'].eql?("true")
+      puts Hirb::Helpers::AutoTable.render(records)
+    else
+      records.each do |record|
+        puts record.to_yaml
+      end
+    end
+  end
+  
+  desc "Truncates all records for the specified \"trigger\", excluding the physical files on s3 or the remote server."
+  task :truncate => :boot do
+    puts "Truncating backup records with trigger: #{ENV['trigger']}."
+    Backup::Record::Base.destroy_all :trigger => ENV['trigger']
+  end
+  
+  desc "Truncates everything."
+  task :truncate_all => :boot do
+    puts "Truncating all backup records."
+    Backup::Record::Base.destroy_all
+  end
+  
+  desc "Destroys all records for the specified \"trigger\", including the physical files on s3 or the remote server."
+  task :destroy => :boot do
+    puts "Destroying backup records with trigger: #{ENV['trigger']}."
+    backup = Backup::Setup.new(ENV['trigger'], @backup_procedures)
+    backup.procedure.record_class.destroy_all_backups( backup.procedure, ENV['trigger'] )
+  end
+  
+  desc "Destroys all records for the specified \"trigger\", including the physical files on s3 or the remote server."
+  task :destroy_all => :boot do
+    puts "Destroying all backup records."
+    backup = Backup::Setup.new(false, @backup_procedures)
+    backup.procedures.each do |backup_procedure|
+      backup_procedure.record_class.destroy_all_backups( backup_procedure, backup_procedure.trigger )
+    end
+  end
+  
+end

data/generators/backup/templates/backup.rb

@@ -0,0 +1,253 @@
+# Backup Configuration File
+# 
+# Use the "backup" block to add backup settings to the configuration file.
+# The argument before the "do" in (backup "argument" do) is called a "trigger".
+# This acts as the identifier for the configuration.
+#
+# In the example below we have a "mysql-backup-s3" trigger for the backup setting.
+# All the configuration is done inside this block. To initialize the backup process for this block,
+# you invoke it using the following rake task:
+#
+#   rake backup:run trigger="mysql-backup-s3"
+# 
+# You can add as many backup block settings as you want, just be sure every trigger is unique and you can run
+# each of them separately.
+# 
+# ADAPTERS
+#  - MySQL
+#  - PostgreSQL
+#  - SQLite
+#  - Archive
+#  - Custom
+#
+# STORAGE METHODS
+#  - S3      (Amazon)
+#  - CF      (Rackspace Cloud Files)
+#  - Dropbox (Dropbox Web Service)
+#  - SCP     (Remote Server)
+#  - FTP     (Remote Server)
+#  - SFTP    (Remote Server)
+#  - LOCAL   (Local Server)
+#
+# GLOBAL OPTIONS
+#  - Keep Backups (keep_backups)
+#  - Encrypt With Pasword (encrypt_with_password)
+#  - Encrypt With GPG Public Key (encrypt_with_gpg_public_key)
+#  - Notify (notify)
+#
+#  This is the "decrypt" command for all encrypted backups:
+#    sudo backup --decrypt /path/to/encrypted/file
+#
+# Each Backup Setting can contain:
+# - 1 Adapter
+# - 1 Storage Method
+# - Multiple Global Options
+#
+# The combination of these, however, do not matter! So experiment with it.
+# 
+# You can also let Backup notify you by email on successfully created backups.
+# - Just uncomment the block of code below (notifier_settings) and fill in your credentials.
+# - Then for set "notify" to "true" in each (backup) block you wish to be notified of.
+# 
+# For more information on "Backup", please refer to the wiki on github
+#   http://wiki.github.com/meskyanichi/backup/configuration-file
+
+
+# Notifier
+#   Uncomment this if you want to enable notification by email on successful backup runs
+#   You will also have to set "notify true" inside each backup block below to enable it for that particular backup
+# notifier_settings do
+#   
+#   to    "example1@gmail.com"
+#   from  "example2@gmail.com"
+#   
+#   smtp do
+#     host            "smtp.gmail.com"
+#     port            "587"
+#     username        "example1@gmail.com"
+#     password        "example1password"
+#     authentication  "plain"
+#     domain          "localhost.localdomain"
+#     tls             true
+#   end
+# 
+# end
+
+
+# Initialize with:
+#   rake backup:run trigger='mysql-backup-s3'
+backup 'mysql-backup-s3' do
+  
+  adapter :mysql do
+    user        'user'
+    password    'password'
+    database    'database'
+  
+    # skip_tables ['table1', 'table2', 'table3']
+    # 
+    # options do
+    #   host    '123.45.678.90'
+    #   port    '80'
+    #   socket  '/tmp/socket.sock'
+    # end
+    # additional_options '--single-transaction  --quick'
+  end
+  
+  storage :s3 do
+    access_key_id     'access_key_id'
+    secret_access_key 'secret_access_key'
+    bucket            '/bucket/backups/mysql/'
+    use_ssl           true
+  end
+  
+  keep_backups 25
+  encrypt_with_password 'password'
+  notify false
+  
+end
+
+# Initialize with:
+#   rake backup:run trigger='mysql-backup-cloudfiles'
+backup 'mysql-backup-cloudfiles' do
+
+  adapter :mysql do
+    user        'user'
+    password    'password'
+    database    'database'
+  end
+
+  storage :cloudfiles do
+    username  'username'
+    api_key   'api_key'
+    container 'mysql_backup'
+  end
+  
+  encrypt_with_gpg_public_key <<-KEY
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.7 (Darwin)
+
+Your very long public key goes here
+-----END PGP PUBLIC KEY BLOCK-----
+KEY
+
+end
+
+# Initialize with:
+#   rake backup:run trigger='postgresql-backup-s3'
+backup 'postgresql-backup-scp' do
+  
+  adapter :postgresql do
+    user      'user'
+    database  'database'
+
+    # skip_tables ['table1', 'table2', 'table3']
+  
+    # options do
+    #   host    '123.45.678.90'
+    #   port    '80'
+    #   socket  '/tmp/socket.sock'
+    # end
+    # additional_options '--clean --blobs'
+  end
+  
+  storage :scp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/postgresql/'
+  end
+
+  keep_backups :all
+  encrypt_with_password false
+  notify false
+
+end
+
+
+# Initialize with:
+#   rake backup:run trigger='archive-backup-ftp'
+backup 'archive-backup-ftp' do
+  
+  adapter :archive do
+    files ["#{RAILS_ROOT}/log", "#{RAILS_ROOT}/db"]
+  end
+  
+  storage :ftp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/archive/'
+  end
+
+  keep_backups 10
+  encrypt_with_password false
+  notify false
+
+end
+
+
+# Initialize with:
+#   rake backup:run trigger='custom-backup-sftp'
+backup 'custom-backup-sftp' do
+  
+  adapter :custom do
+    commands \
+      [ "mysqldump            [options] [database] > :tmp_path/my_mysql_dump.sql",
+        "pg_dump              [options] [database] > :tmp_path/my_postgresql_dump.sql",
+        "any_other_db_format  [options] [database] > :tmp_path/my_any_other_db_format.sql" ]
+  end
+  
+  storage :sftp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/custom/'
+  end
+
+  keep_backups :all
+  encrypt_with_password 'password'
+  notify false
+  
+end
+
+
+# Initializ with:
+#   rake backup:run trigger='sqlite-backup-local'
+backup 'sqlite-backup-local' do
+  
+  adapter :sqlite do
+    database "#{RAILS_ROOT}/db/production.sqlite3"
+  end
+  
+  storage :local do
+    path "/path/to/storage/location/"
+  end
+  
+  keep_backups :all
+  encrypt_with_password false
+  notify false
+  
+end
+
+
+# Initialize with
+# rake backup:run trigger='postgresql-backup-dropbox'
+backup 'postgresql-backup-dropbox' do
+  
+  adapter :postgresql do
+    user      'devmen'
+    database  'domowoi_test'
+  end
+  
+  storage :dropbox do
+    api_key           'your_api_key'
+    secret_access_key 'your_api_secret'
+    username          'user@example.org'
+    password          'super_s3cret'
+    path              'backups'
+  end
+
+  keep_backups :all
+  encrypt_with_password false
+  notify false
+end

data/generators/backup/templates/create_backup_tables.rb

@@ -0,0 +1,18 @@
+class CreateBackupTables < ActiveRecord::Migration
+  def self.up
+    create_table :backup do |t|
+      t.string :trigger
+      t.string :adapter
+      t.string :filename
+      t.string :md5sum
+      t.string :path
+      t.string :bucket
+      t.string :type
+      t.timestamps          
+    end
+  end
+
+  def self.down
+    drop_table :backup
+  end
+end

data/generators/backup_update/backup_update_generator.rb

@@ -0,0 +1,50 @@
+class BackupUpdateGenerator < Rails::Generator::Base
+
+  # This method gets initialized when the generator gets run.
+  # It will receive an array of arguments inside @args
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  # Processes the file generation/templating
+  # This will automatically be run after the initialize method
+  def manifest
+    record do |m|
+      
+      # Generates the database update migration file
+      m.migration_template                    "migrations/update_backup_tables.rb",
+                                              "db/migrate",
+                                              :migration_file_name => "update_backup_tables"
+      
+      # Outputs the generators message to the terminal
+      puts message
+    end
+  end
+  
+  def message
+    <<-MESSAGE
+    
+    
+    
+    ==============================================================
+    Backup's update files have been generated!
+    ==============================================================
+    
+    Please follow these instructions Backup:
+    
+    1: Please migrate the database to finish the update!
+
+      rake db:migrate
+    
+    
+    For More Information:
+    http://github.com/meskyanichi/backup
+    
+    ==============================================================
+    
+    
+    
+    MESSAGE
+  end
+  
+end

data/generators/backup_update/templates/migrations/update_backup_tables.rb

@@ -0,0 +1,27 @@
+class UpdateBackupTables < ActiveRecord::Migration
+  def self.up
+    change_table :backup do |t|
+      t.rename :storage, :type # will use STI from now
+      t.string :md5sum
+    end
+    
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='Backup::Record::FTP' WHERE type='ftp'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='Backup::Record::Local' WHERE type='local'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='Backup::Record::S3' WHERE type='s3'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='Backup::Record::SCP' WHERE type='scp'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='Backup::Record::SFTP' WHERE type='sftp'"
+  end
+
+  def self.down
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='ftp' WHERE type='Backup::Record::FTP'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='local' WHERE type='Backup::Record::Local'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='s3' WHERE type='Backup::Record::S3'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='scp' WHERE type='Backup::Record::SCP'"
+    ActiveRecord::Base.connection.execute "UPDATE backup SET type='sftp' WHERE type='Backup::Record::SFTP'"
+    
+    change_table :backup do |t|
+      t.rename :type, :storage
+      t.remove :md5sum
+    end
+  end
+end

data/lib/backup.rb

@@ -0,0 +1,132 @@
+BACKUP_SYSTEM = Proc.new do
+  # Load Gems
+  require 'hirb'
+
+  # Load Extensions
+  require 'backup/core_ext/object'
+
+  # Load Environments
+  require 'backup/environment/base'
+  require 'backup/environment/unix_configuration'
+  require 'backup/environment/rails_configuration'
+
+  # Load Configuration
+  require 'backup/configuration/attributes'
+  require 'backup/configuration/base'
+  require 'backup/configuration/adapter'
+  require 'backup/configuration/adapter_options'
+  require 'backup/configuration/storage'
+  require 'backup/configuration/mail'
+  require 'backup/configuration/smtp'
+  require 'backup/configuration/helpers'
+
+  require 'backup/command_helper'
+
+  # Include the Configuration and Environment Helpers
+  include Backup::Configuration::Helpers
+  include Backup::Environment::Base
+
+  # Load either UNIX or RAILS environment configuration
+  case current_environment
+    when :unix  then include Backup::Environment::UnixConfiguration
+    when :rails then include Backup::Environment::RailsConfiguration
+  end
+
+  # Load configuration
+  if File.exist?(File.join(BACKUP_PATH, 'config', 'backup.rb'))
+    require File.join(BACKUP_PATH, 'config', 'backup.rb')
+  end
+
+  # Load Mail Notifier
+  require 'backup/mail/base'
+
+  # Set Mail Configuration (extracted from the backup.rb configuration file) inside the Mail Class
+  Backup::Mail::Base.setup(@mail_configuration)
+end
+
+# Backup Module
+module Backup
+  
+  class System
+    def self.boot!
+      BACKUP_SYSTEM.call
+      true
+    end
+  end
+  
+  module Adapters
+    autoload :Base,       'backup/adapters/base'
+    autoload :MySQL,      'backup/adapters/mysql'
+    autoload :MongoDB,     'backup/adapters/mongo_db'
+    autoload :SQLite,     'backup/adapters/sqlite'
+    autoload :PostgreSQL, 'backup/adapters/postgresql'
+    autoload :Archive,    'backup/adapters/archive'
+    autoload :Custom,     'backup/adapters/custom'
+  end
+
+  module Storage
+    autoload :Base,       'backup/storage/base'
+    autoload :CloudFiles, 'backup/storage/cloudfiles'
+    autoload :S3,         'backup/storage/s3'
+    autoload :SCP,        'backup/storage/scp'
+    autoload :FTP,        'backup/storage/ftp'
+    autoload :SFTP,       'backup/storage/sftp'
+    autoload :Local,      'backup/storage/local'
+    autoload :Dropbox,    'backup/storage/dropbox'
+  end
+
+  module Record
+    autoload :Base,       'backup/record/base'
+    autoload :CloudFiles, 'backup/record/cloudfiles'
+    autoload :S3,         'backup/record/s3'
+    autoload :SCP,        'backup/record/scp'
+    autoload :FTP,        'backup/record/ftp'
+    autoload :SFTP,       'backup/record/sftp'
+    autoload :Local,      'backup/record/local'
+    autoload :Dropbox,    'backup/record/dropbox'
+  end
+
+  class Setup
+  
+    attr_accessor :trigger, :procedures, :procedure
+    
+    # Sets the Trigger and All Available Procedures.
+    # Will not find a specific procedure if the "trigger" argument is set to false.
+    def initialize(trigger, procedures)
+      self.trigger    = trigger
+      self.procedures = procedures
+      self.procedure  = find_triggered_procedure unless trigger.eql?(false)
+    end
+    
+    # Initializes one of the few adapters and start the backup process
+    def initialize_adapter
+      case procedure.adapter_name.to_sym
+        when :mongo       then Backup::Adapters::MongoDB.new    trigger, procedure
+        when :mysql       then Backup::Adapters::MySQL.new      trigger, procedure
+        when :sqlite      then Backup::Adapters::SQLite.new     trigger, procedure
+        when :postgresql  then Backup::Adapters::PostgreSQL.new trigger, procedure
+        when :archive     then Backup::Adapters::Archive.new    trigger, procedure
+        when :custom      then Backup::Adapters::Custom.new     trigger, procedure
+        else
+          puts "Unknown Adapter: \"#{procedure.adapter_name}\"."
+          exit
+      end
+    end
+    
+    # Scans through all the backup settings and returns the backup setting
+    # that was specified in the "trigger" argument.
+    # If an non-existing trigger is specified, it will raise an error and display
+    # all the available triggers.
+    def find_triggered_procedure
+      procedures.each do |procedure|
+        if procedure.trigger.eql?(trigger)
+          return procedure
+        end
+      end
+      available_triggers = procedures.map {|procedure| "- #{procedure.trigger}\n" }
+      puts "Could not find a backup procedure with the trigger \"#{trigger}\". \nHere's a list of available triggers:\n#{available_triggers}"
+      exit
+    end
+
+  end
+end