namxam-backup 2.4.5

data/lib/backup/record/scp.rb

@@ -0,0 +1,33 @@
+require 'net/scp'
+
+module Backup
+  module Record
+    class SCP < Backup::Record::Base
+
+      attr_accessor :ip, :user, :password
+      
+      def load_specific_settings(adapter)
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+      end
+      
+      private
+        
+        def self.destroy_backups(procedure, backups)
+          ip        = procedure.get_storage_configuration.attributes['ip']
+          user      = procedure.get_storage_configuration.attributes['user']
+          password  = procedure.get_storage_configuration.attributes['password']
+          
+          Net::SSH.start(ip, user, :password => password) do |ssh|
+            backups.each do |backup|
+              puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+              ssh.exec("rm #{File.join(backup.path, backup.filename)}")
+              backup.destroy
+            end
+          end
+        end
+        
+    end
+  end
+end

data/lib/backup/record/sftp.rb

@@ -0,0 +1,38 @@
+require 'net/sftp'
+
+module Backup
+  module Record
+    class SFTP < Backup::Record::Base
+
+      attr_accessor :ip, :user, :password
+      
+      def load_specific_settings(adapter)
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+      end
+      
+      private
+        
+        def self.destroy_backups(procedure, backups)
+          ip        = procedure.get_storage_configuration.attributes['ip']
+          user      = procedure.get_storage_configuration.attributes['user']
+          password  = procedure.get_storage_configuration.attributes['password']
+          
+          Net::SFTP.start(ip, user, :password => password) do |sftp|
+            backups.each do |backup|
+              puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+              begin
+                sftp.remove!(File.join(backup.path, backup.filename))
+                backup.destroy
+              rescue
+                puts "Could not find backup #{backup.path}/#{backup.filename}.."
+                backup.destroy
+              end
+            end
+          end
+        end
+        
+    end
+  end
+end

data/lib/backup/storage/base.rb

@@ -0,0 +1,10 @@
+module Backup
+  module Storage
+    class Base
+      include Backup::CommandHelper
+
+    end
+  end
+end
+
+

data/lib/backup/storage/cloudfiles.rb

@@ -0,0 +1,16 @@
+require 'backup/connection/cloudfiles'
+
+module Backup
+  module Storage
+    class CloudFiles < Base
+
+      # Stores the backup file on the remote server using Rackspace Cloud Files
+      def initialize(adapter)
+        cf = Backup::Connection::CloudFiles.new(adapter)
+        cf.connect
+        cf.store
+      end
+
+    end
+  end
+end

data/lib/backup/storage/dropbox.rb

@@ -0,0 +1,12 @@
+require 'backup/connection/dropbox'
+
+module Backup
+  module Storage
+    class Dropbox < Base
+      def initialize(adapter)
+        dropbox = Backup::Connection::Dropbox.new(adapter)
+        dropbox.store
+      end
+    end
+  end
+end

data/lib/backup/storage/ftp.rb

@@ -0,0 +1,38 @@
+require 'net/ftp'
+
+module Backup
+  module Storage
+    class FTP < Backup::Storage::Base
+      
+      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
+      
+      # Stores the backup file on the remote server using FTP
+      def initialize(adapter)
+        %w(ip user password path).each do |method|
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+        
+        final_file = adapter.final_file
+        tmp_path   = adapter.tmp_path
+        
+        Net::FTP.open(ip, user, password) do |ftp|
+          begin
+            ftp.chdir(path)
+          rescue
+            puts "Could not find or access \"#{path}\" on \"#{ip}\", please ensure this directory exists and is accessible by the user \"#{user}\"."
+            exit
+          end
+          
+          begin
+            puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
+            ftp.putbinaryfile(File.join(tmp_path, final_file).gsub('\ ', ' '), File.join(path, final_file))
+          rescue
+            puts "Could not save file to backup server. Is the \"#{path}\" directory writable?"
+            exit
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/backup/storage/local.rb

@@ -0,0 +1,22 @@
+module Backup
+  module Storage
+    class Local < Base
+      
+      # Store on same machine, preferentially in a different hard drive or in 
+      # a mounted network path (NFS, Samba, etc)
+      attr_accessor :path, :tmp_path, :final_file
+      
+      # Stores the backup file on local machine
+      def initialize(adapter)
+        self.path = adapter.procedure.get_storage_configuration.attributes['path']
+        self.tmp_path   = adapter.tmp_path
+        self.final_file = adapter.final_file
+        
+        run "mkdir -p #{path}"
+        run "cp #{File.join(tmp_path, final_file).gsub('\ ', ' ')} #{File.join(path, final_file)}"
+      end
+      
+    end
+  end
+end
+

data/lib/backup/storage/s3.rb

@@ -0,0 +1,15 @@
+require 'backup/connection/s3'
+
+module Backup
+  module Storage
+    class S3 < Base
+      
+      # Stores the backup file on the remote server using S3
+      def initialize(adapter)
+        s3 = Backup::Connection::S3.new(adapter)
+        s3.store
+      end
+      
+    end
+  end
+end

data/lib/backup/storage/scp.rb

@@ -0,0 +1,30 @@
+require 'net/scp'
+
+module Backup
+  module Storage
+    class SCP < Base
+      
+      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
+      
+      # Stores the backup file on the remote server using SCP
+      def initialize(adapter)
+        %w(ip user password path).each do |method|
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+        
+        final_file = adapter.final_file
+        tmp_path   = adapter.tmp_path
+        
+        Net::SSH.start(ip, user, :password => password) do |ssh|
+          ssh.exec "mkdir -p #{path}"
+        end
+        
+        puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
+        Net::SCP.start(ip, user, :password => password) do |scp|
+          scp.upload! File.join(tmp_path, final_file).gsub('\ ', ' '), path
+        end
+      end
+      
+    end
+  end
+end

data/lib/backup/storage/sftp.rb

@@ -0,0 +1,31 @@
+require 'net/sftp'
+
+module Backup
+  module Storage
+    class SFTP < Base
+      
+      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
+      
+      # Stores the backup file on the remote server using SFTP
+      def initialize(adapter)
+        %w(ip user password path).each do |method|
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+        
+        final_file = adapter.final_file
+        tmp_path   = adapter.tmp_path
+        
+        Net::SFTP.start(ip, user, :password => password) do |sftp|
+          begin
+            puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
+            sftp.upload!(File.join(tmp_path, final_file).gsub('\ ', ' '), File.join(path, final_file))
+          rescue
+            puts "Could not find \"#{path}\" on \"#{ip}\", please ensure this directory exists."
+            exit
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/backup/version.rb

@@ -0,0 +1,3 @@
+module Backup
+  VERSION = "2.4.5"
+end

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,236 @@
+# 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
+#  - MongoDB
+#  - 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='mongo-backup-s3'
+backup 'mongo-backup-s3' do
+  
+  adapter :mongo do
+    database "your_mongo_database"
+    #There are two ways to backup mongo:
+    # * :mongodump (DEFAULT) fairly fast, non-blocking, creates smaller bson files, need to import to recover
+    # * :disk_copy locks the database (use a slave!!!), does a disk-level copy, and then unlocks.  fast, blocking, large archives, but very fast to recover
+    backup_method :mongodump #default
+    database :my_mongo_collection
+    options do
+      # host mongo.mysite.com
+      # port 27018  #perhaps you have a slave instance
+      # username user
+      # password secret
+    end
+  end
+  
+  storage :s3 do
+    access_key_id     'access_key_id'
+    secret_access_key 'secret_access_key'
+    # host              's3-ap-southeast-1.amazonaws.com' #the s3 location.  Defaults to us-east-1
+    bucket            '/bucket/backups/mysql/'
+    use_ssl           true
+  end
+  
+  keep_backups 25
+  encrypt_with_gpg_public_key <<-KEY
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.10 (Darwin)
+
+public key goes here
+-----END PGP PUBLIC KEY BLOCK-----
+  KEY
+  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