backup 2.3.3.1 → 2.4.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+BIG UPDATE
+=== 2.4.0 =======================================
+  
+  Ruby on Rails 3 support
+  
+
 PATCH
 === 2.3.3.1 =====================================
 

data/README.md

@@ -2,7 +2,13 @@
 
 ## A Backup Ruby Gem
 
-Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as MySQL/PostgreSQL/SQLite and Files/Folders. All backups can be transferred to Amazon S3, Rackspace Cloud Files, any remote server you have access to (using either SCP, SFTP or regular FTP), or a Local server. Backup handles Compression, Archiving, Encryption, Backup Cleaning (Cycling) and supports Email Notifications.
+__Backup__ is a Ruby Gem written for __Unix__ and __Ruby on Rails (2 and 3)__ environments. It can be used both with and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as MySQL/PostgreSQL/SQLite and Files/Folders. All backups can be transferred to Amazon S3, Rackspace Cloud Files, any remote server you have access to (using either SCP, SFTP or regular FTP), or a Local server. Backup handles Compression, Archiving, Encryption, Backup Cleaning (Cycling) and supports Email Notifications.
+
+## Written for Environments
+
+* UNIX (Ubuntu, OSX, etc.)
+* Ruby on Rails 3
+* Ruby on Rails 2
 
 ## Authors/Maintainers
 

data/VERSION

@@ -1 +1 @@
-2.3.3.1
+2.4.0

data/bin/backup

@@ -3,8 +3,10 @@
 require 'optparse'
 require 'backup'
 
-include Backup::Environment::Unix::Commands
-include Backup::Environment::Unix::Helpers
+Backup::System.boot!
+
+include Backup::Environment::UnixConfiguration::Commands
+include Backup::Environment::UnixConfiguration::Helpers
 
 options = {}
 

data/generators/backup/backup_generator.rb

@@ -13,17 +13,16 @@ class BackupGenerator < Rails::Generator::Base
       
       # Generates the Rake Tasks and Backup Database
       m.directory "lib/tasks"
-      m.directory "lib/tasks/backup"
-      m.file      "tasks/backup.rake",        "lib/tasks/backup/backup.rake"
+      m.file      "backup.rake", "lib/tasks/backup.rake"
 
       # Generates the configuration file
       m.directory "config"
-      m.file      "config/backup.rb",         "config/backup.rb"
+      m.file      "backup.rb", "config/backup.rb"
       
       # Generates the database migration file
-      m.migration_template                    "migrations/create_backup_tables.rb",
-                                              "db/migrate",
-                                              :migration_file_name => "create_backup_tables"
+      m.migration_template "create_backup_tables.rb",
+                           "db/migrate",
+                           :migration_file_name => "create_backup_tables"
       
       # Outputs the generators message to the terminal
       puts message
@@ -34,7 +33,6 @@ class BackupGenerator < Rails::Generator::Base
     <<-MESSAGE
     
     
-    
     ==============================================================
     Backup's files have been generated!
     ==============================================================
@@ -65,7 +63,6 @@ class BackupGenerator < Rails::Generator::Base
     ==============================================================
     
     
-    
     MESSAGE
   end
   

data/generators/backup/templates/{tasks/backup.rake → backup.rake}

@@ -1,13 +1,17 @@
 namespace :backup do
-
+  
+  task :boot => :environment do
+    Backup::System.boot!
+  end
+  
   desc "Run Backup Procedure."
-  task :run => :environment do
+  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 => :environment do
+  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']} )
@@ -22,26 +26,26 @@ namespace :backup do
   end
   
   desc "Truncates all records for the specified \"trigger\", excluding the physical files on s3 or the remote server."
-  task :truncate => :environment do
+  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 => :environment do
+  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 => :environment do
+  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 => :environment do
+  task :destroy_all => :boot do
     puts "Destroying all backup records."
     backup = Backup::Setup.new(false, @backup_procedures)
     backup.procedures.each do |backup_procedure|

data/generators/backup/templates/{config/backup.rb → backup.rb}

@@ -31,6 +31,7 @@
 # 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:
@@ -119,6 +120,15 @@ backup 'mysql-backup-cloudfiles' do
     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:

data/lib/backup.rb

@@ -1,46 +1,56 @@
-# Load Gems
-require 'hirb'
+BACKUP_SYSTEM = Proc.new do
+  # Load Gems
+  require 'hirb'
 
-# Load Environments
-require 'backup/environment/base'
-require 'backup/environment/unix'
-require 'backup/environment/rails'
+  # 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'
+  # 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'
+  require 'backup/command_helper'
 
-# Include the Configuration and Environment Helpers
-include Backup::Configuration::Helpers
-include Backup::Environment::Base
+  # 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::Unix
-  when :rails then include Backup::Environment::Rails
-end
+  # 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 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'
+  # 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)
+  # 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'
@@ -95,7 +105,7 @@ module Backup
           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

data/lib/backup/environment/base.rb

@@ -3,7 +3,7 @@ module Backup
     module Base
       
       def current_environment
-        return :rails if defined?(RAILS_ENV)
+        return :rails if defined?(Rails.root)
         return :unix
       end
       

data/lib/backup/environment/{rails.rb → rails_configuration.rb}

@@ -1,15 +1,13 @@
 module Backup
   module Environment
-    module Rails
+    module RailsConfiguration
       
-      if defined? RAILS_ENV
-        
-        # Sets BACKUP_PATH equal to RAILS_ROOT
-        BACKUP_PATH = RAILS_ROOT
+      if defined?(Rails.root)
+        # Sets BACKUP_PATH equal to Rails.root
+        BACKUP_PATH = Rails.root.to_s
       
         # Sets DB_CONNECTION_SETTINGS to false
         DB_CONNECTION_SETTINGS = false
-    
       end
     
     end

data/lib/backup/environment/{unix.rb → unix_configuration.rb}

@@ -1,6 +1,6 @@
 module Backup
   module Environment
-    module Unix
+    module UnixConfiguration
       
       require 'active_record'
       

data/lib/generators/backup/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Backup's Ruby on Rails 3 Generator
+
+Example:
+  rails generate backup
+
+  This will create:
+    * lib/tasks/backup.rake
+    * config/backup.rb
+    * db/migrate/<DateTime>_create_backup_tables.rb

data/lib/generators/backup/backup_generator.rb

@@ -0,0 +1,47 @@
+class BackupGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def copy_files
+    copy_file 'backup.rake',              'lib/tasks/backup.rake'
+    copy_file 'backup.rb',                'config/backup.rb'
+    
+    unless Dir["#{Rails.root}/db/migrate/*create_backup_tables.rb"].any?
+      copy_file 'create_backup_tables.rb',  "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_create_backup_tables.rb"
+    end
+    
+    puts message
+  end
+  
+  def message
+<<-MESSAGE
+
+
+  ==============================================================
+  Backup's files have been generated!
+  ==============================================================
+  
+  1: Migrate the database!
+  
+    rake db:migrate
+  
+  
+  2: Set up some "Backup Settings" inside the backup configuration file!
+  
+    config/backup.rb
+  
+  
+  3: Run the backups! Enjoy.
+  
+    rake backup:run trigger="your-specified-trigger"
+  
+  
+  For More Information:
+  http://github.com/meskyanichi/backup
+  
+  ==============================================================
+
+
+MESSAGE
+  end
+  
+end

data/lib/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/lib/generators/backup/templates/backup.rb

@@ -0,0 +1,229 @@
+# 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)
+#  - 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

data/lib/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/setup/backup.rb

@@ -31,6 +31,7 @@
 # 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:

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  hash: 121
+  hash: 31
   prerelease: false
   segments: 
   - 2
-  - 3
-  - 3
-  - 1
-  version: 2.3.3.1
+  - 4
+  - 0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-21 00:00:00 +02:00
+date: 2010-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -163,7 +162,7 @@ dependencies:
   type: :runtime
   version_requirements: *id009
 description: |-
-  Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with
+  Backup is a Ruby Gem written for Unix and Ruby on Rails (2 and 3) environments. It can be used both with
     and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases
     such as MySQL/PostgreSQL/SQLite and Files/Folders. All backups can be transferred to Amazon S3, Rackspace Cloud Files,
     any remote server you have access to (using either SCP, SFTP or regular FTP), or a Local server. Backup handles
@@ -198,8 +197,8 @@ files:
 - lib/backup/connection/cloudfiles.rb
 - lib/backup/connection/s3.rb
 - lib/backup/environment/base.rb
-- lib/backup/environment/rails.rb
-- lib/backup/environment/unix.rb
+- lib/backup/environment/rails_configuration.rb
+- lib/backup/environment/unix_configuration.rb
 - lib/backup/mail/base.rb
 - lib/backup/mail/mail.txt
 - lib/backup/record/base.rb
@@ -217,11 +216,16 @@ files:
 - lib/backup/storage/scp.rb
 - lib/backup/storage/sftp.rb
 - lib/backup.rb
+- lib/generators/backup/backup_generator.rb
+- lib/generators/backup/templates/backup.rake
+- lib/generators/backup/templates/backup.rb
+- lib/generators/backup/templates/create_backup_tables.rb
+- lib/generators/backup/USAGE
 - bin/backup
 - generators/backup/backup_generator.rb
-- generators/backup/templates/config/backup.rb
-- generators/backup/templates/migrations/create_backup_tables.rb
-- generators/backup/templates/tasks/backup.rake
+- generators/backup/templates/backup.rake
+- generators/backup/templates/backup.rb
+- generators/backup/templates/create_backup_tables.rb
 - generators/backup_update/backup_update_generator.rb
 - generators/backup_update/templates/migrations/update_backup_tables.rb
 - setup/backup.rb