backup-wakiki 2.4.1

data/backup.gemspec

@@ -0,0 +1,111 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backup}
+  s.version = "2.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael van Rooijen", "Fernando Migliorini Luiz\303\243o"]
+  s.date = %q{2010-06-25}
+  s.default_executable = %q{backup}
+  s.description = %q{
+                            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 and Files/Folders. All backups can be transferred to Amazon S3 or any remote server you
+                            have access to, using either SCP, SFTP or regular FTP. Backup handles Compression, Archiving, Encryption,
+                            Backup Cleaning (Cycling) and supports Email Notifications.
+                        }
+  s.email = %q{meskyanichi@gmail.com}
+  s.executables = ["backup"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "backup.gemspec",
+     "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_update/backup_update_generator.rb",
+     "generators/backup_update/templates/migrations/update_backup_tables.rb",
+     "lib/backup.rb",
+     "lib/backup/adapters/archive.rb",
+     "lib/backup/adapters/base.rb",
+     "lib/backup/adapters/custom.rb",
+     "lib/backup/adapters/mysql.rb",
+     "lib/backup/adapters/postgresql.rb",
+     "lib/backup/adapters/sqlite.rb",
+     "lib/backup/command_helper.rb",
+     "lib/backup/configuration/adapter.rb",
+     "lib/backup/configuration/adapter_options.rb",
+     "lib/backup/configuration/attributes.rb",
+     "lib/backup/configuration/base.rb",
+     "lib/backup/configuration/helpers.rb",
+     "lib/backup/configuration/mail.rb",
+     "lib/backup/configuration/smtp.rb",
+     "lib/backup/configuration/storage.rb",
+     "lib/backup/connection/s3.rb",
+     "lib/backup/environment/base.rb",
+     "lib/backup/environment/rails.rb",
+     "lib/backup/environment/unix.rb",
+     "lib/backup/mail/base.rb",
+     "lib/backup/mail/mail.txt",
+     "lib/backup/record/base.rb",
+     "lib/backup/record/ftp.rb",
+     "lib/backup/record/local.rb",
+     "lib/backup/record/s3.rb",
+     "lib/backup/record/scp.rb",
+     "lib/backup/record/sftp.rb",
+     "lib/backup/storage/ftp.rb",
+     "lib/backup/storage/local.rb",
+     "lib/backup/storage/s3.rb",
+     "lib/backup/storage/scp.rb",
+     "lib/backup/storage/sftp.rb",
+     "setup/backup.rb",
+     "setup/backup.sqlite3",
+     "spec/configuration/attributes_spec.rb"
+  ]
+  s.homepage = %q{http://final-creation.com/open-source}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Backup is a Ruby Gem that simplifies making backups for databases, files and folders.}
+  s.test_files = [
+    "spec/configuration/attributes_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+      s.add_runtime_dependency(%q<hirb>, [">= 0.2.9"])
+      s.add_runtime_dependency(%q<pony>, [">= 0.5"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+      s.add_dependency(%q<hirb>, [">= 0.2.9"])
+      s.add_dependency(%q<pony>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+    s.add_dependency(%q<hirb>, [">= 0.2.9"])
+    s.add_dependency(%q<pony>, [">= 0.5"])
+  end
+end
+

data/bin/backup

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+require 'backup'
+
+include Backup::Environment::Unix::Commands
+include Backup::Environment::Unix::Helpers
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  
+  opts.banner = "\nUsage: backup [options]\n "
+  
+  opts.on('-r', '--run [trigger]', "Runs backup process by trigger") do |trigger|
+    confirm_configuration_file_existence
+    puts "Running: #{trigger}."
+    Backup::Setup.new(trigger, @backup_procedures).initialize_adapter
+  end
+  
+  opts.on('-f', '--find [trigger]', "Finds backup records by trigger") do |trigger|
+    confirm_configuration_file_existence
+    puts "Finding backup records with trigger: #{trigger}."
+    backup = Backup::Setup.new(trigger, @backup_procedures)
+    records = Array.new
+    case backup.procedure.storage_name.to_sym
+      when :s3    then records = Backup::Record::S3.all    :conditions => {:trigger => trigger}
+      when :scp   then records = Backup::Record::SCP.all   :conditions => {:trigger => trigger}
+      when :ftp   then records = Backup::Record::FTP.all   :conditions => {:trigger => trigger}
+      when :sftp  then records = Backup::Record::SFTP.all  :conditions => {:trigger => trigger}
+      when :local then records = Backup::Record::Local.all :conditions => {:trigger => trigger}
+    end
+    
+    if options[:table]
+      puts Hirb::Helpers::AutoTable.render(records)
+    else
+      records.each do |record|
+        puts record.to_yaml
+      end
+    end
+  end
+  
+  opts.on('-t', '--truncate [trigger]', "Truncates backup records for specified trigger") do |trigger|
+    puts "Truncating backup records with trigger: #{trigger}."
+    Backup::Record::Base.destroy_all :trigger => trigger
+  end
+  
+  opts.on('-d', '--destroy [trigger]', "Destroys backup records and files for specified trigger") do |trigger|
+    confirm_configuration_file_existence
+    puts "Destroying backup records with trigger: #{trigger}."
+    backup = Backup::Setup.new(trigger, @backup_procedures)
+    case backup.procedure.storage_name.to_sym
+      when :s3    then Backup::Record::S3.destroy_all_backups     backup.procedure,  trigger
+      when :scp   then Backup::Record::SCP.destroy_all_backups    backup.procedure,  trigger
+      when :ftp   then Backup::Record::FTP.destroy_all_backups    backup.procedure,  trigger
+      when :sftp  then Backup::Record::SFTP.destroy_all_backups   backup.procedure,  trigger
+      when :local then Backup::Record::Local.destroy_all_backups  backup.procedure,  trigger
+    end
+  end
+  
+  opts.on('--truncate-all', "Truncates all backup records") do
+    puts "Truncating all backup records."
+    Backup::Record::Base.destroy_all
+  end
+
+  opts.on('--destroy-all', "Destroys all backup records and files") do
+    confirm_configuration_file_existence
+    puts "Destroying all backup records."
+    backup = Backup::Setup.new(false, @backup_procedures)
+    backup.procedures.each do |backup_procedure|
+      case backup_procedure.storage_name.to_sym
+        when :s3    then Backup::Record::S3.destroy_all_backups     backup_procedure,  backup_procedure.trigger
+        when :scp   then Backup::Record::SCP.destroy_all_backups    backup_procedure,  backup_procedure.trigger
+        when :ftp   then Backup::Record::FTP.destroy_all_backups    backup_procedure,  backup_procedure.trigger
+        when :sftp  then Backup::Record::SFTP.destroy_all_backups   backup_procedure,  backup_procedure.trigger
+        when :local then Backup::Record::Local.destroy_all_backups  backup.procedure,  backup_procedure.trigger
+      end
+    end
+  end
+
+  opts.on('--decrypt [file]', "Decrypts a \"Backup\" encrypted file") do |file|
+    puts "Attempting to decrypt: #{file}."
+    %x{ openssl enc -des-cbc -d -in #{file} -out #{file.gsub('.enc', '')} }
+  end
+  
+  options[:table] = false
+  opts.on('--table', "Shows records in table format") do |format|
+    options[:table] = true
+  end
+
+  opts.on('--setup', "Sets up Backup") do
+    setup
+  end
+  
+  opts.on('--reset', "Reinstalls Backup (This will remove ALL current settings!)") do
+    reset
+  end
+  
+  opts.on('--remove', "Removes Backup (This will remove ALL current settings!)") do
+    remove
+  end
+  
+  opts.on('-v', '--version', 'Displays installed Backup version') do
+    File.open(File.join(File.dirname(__FILE__), '..', 'VERSION')) do |file|
+      puts "Backup version #{file.read}"
+    end
+    exit
+  end  
+
+  opts.on('-h', '--help', 'Display help screen') do
+    puts opts
+    puts "\n "
+    exit
+  end  
+  
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::InvalidOption
+  puts "\nInvalid Option. See the list of available options below.\n"
+  puts optparse
+  puts "\n "
+  exit
+end

data/generators/backup/backup_generator.rb

@@ -0,0 +1,72 @@
+class BackupGenerator < 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 Rake Tasks and Backup Database
+      m.directory "lib/tasks"
+      m.directory "lib/tasks/backup"
+      m.file      "tasks/backup.rake",        "lib/tasks/backup/backup.rake"
+
+      # Generates the configuration file
+      m.directory "config"
+      m.file      "config/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"
+      
+      # Outputs the generators message to the terminal
+      puts message
+    end
+  end
+  
+  def message
+    <<-MESSAGE
+    
+    
+    
+    ==============================================================
+    Backup's files have been generated!
+    ==============================================================
+    
+    1: Add the "Backup" gem to the config/environment.rb file!
+    
+      config.gem "backup"
+    
+    
+    2: Migrate the database!
+
+      rake db:migrate
+    
+    
+    3: Set up some "Backup Settings" inside the backup configuration file!
+
+      config/backup.rb
+      
+    
+    4: Run the backups! Enjoy.
+    
+      rake backup:run trigger="your-specified-trigger"
+      
+    
+    For More Information:
+    http://github.com/meskyanichi/backup
+    
+    ==============================================================
+    
+    
+    
+    MESSAGE
+  end
+  
+end

data/generators/backup/templates/config/backup.rb

@@ -0,0 +1,202 @@
+# 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)
+#  - SCP    (Remote Server)
+#  - FTP    (Remote Server)
+#  - SFTP   (Remote Server)
+#  - LOCAL  (Local Server)
+#
+# GLOBAL OPTIONS
+#  - Keep Backups (keep_backups)
+#  - Encrypt With Pasword (encrypt_with_password)
+#  - 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='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