backup 2.3.0.1 → 2.3.0.2

data/README.textile

@@ -4,6 +4,29 @@ h2. 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 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 and Backup Cleaning (Cycling).
 
+h2. New Commands as of 2.3.0.2
+
+*Finders*
+
+Unix Environment:
+
+bc. sudo backup --find [trigger]
+
+Rails Environment:
+
+bc. rake backup:find trigger='trigger'
+
+*Finders in Table Format*
+
+Unix Environment:
+
+bc. sudo backup --table --find [trigger]
+
+Rails Environment:
+
+bc. rake backup:find trigger='trigger' table=true
+
+
 h2. Backup goes independent with the release of version 2.3.0! Ruby on Rails is no longer "required"!
 
 *Before you read on, let me tell you that even though all this awesomeness has been added, Backup will still work as it did in the previous version with Ruby on Rails!*
@@ -92,6 +115,9 @@ bc. keep_backups 20
 
 h3. Quick Example of a Single Backup Setting inside the Backup Configuration File
 
+* In *Rails Environments* this file is located in *RAILS_ROOT/config/backup.rb*
+* In *Unix Environments* this file is located in */opt/backup/config/backup.rb*
+
 bc. backup 'mysql-backup-s3' do
   adapter :mysql do
     user      'user'
@@ -108,7 +134,6 @@ bc. backup 'mysql-backup-s3' do
   encrypt_with_password 'password'
 end
   
-  
 The (backup 'mysql-backup-s3' do) is what I call a "backup setting". The first argument of the block is the so called "trigger".
 
 bc. backup 'mysql-backup-s3' do
@@ -118,12 +143,18 @@ end
 This acts as an "identifier" for the "backup setting". The (above) "backup setting" is all pretty straightforward.
 So now that we've set up a "backup setting", we can run it using a rake task, like so:
 
+*If you're using this inside a Unix Environment, use the Backup utility:*
+
+bc. sudo backup --run mysql-backup-s3
+
+*If you're using this inside a Ruby on Rails Environment, use the Backup rake task:*
+
 bc. rake backup:run trigger="mysql-backup-s3"
 
 *That's it, the MySQL database has been "backed up" to Amazon S3. It has been dumped, compressed and encrypted with password.*
-Note: You can add as many "backup setting" blocks as you want inside the "config/backup.rb" configuration file and invoke each of them by their own "trigger". This means you can have as many backup setups as you want, which "don't" all run simultaneously when you initialize a backup.
+Note: You can add as many "backup setting" blocks as you want inside the ("/opt/backup/config/backup.rb" for Unix) or ("RAILS_ROOT/config/backup.rb" for Ruby on Rails) configuration file and invoke each of them by their own "trigger". This means you can have as many backup setups as you want, which "don't" all run simultaneously when you initialize a backup.
 
-*Depending on what environment you're running backup on, you will use different commands. Rails uses Rake Tasks, while Unix uses regular executable commands. See below!*
+*Depending on what environment you're running backup on, you will use different commands. Rails uses Rake Tasks, while Unix uses Backup's utility commands. See below!*
 
 *Runs the backup setting with the trigger "backup-logs"*
 
@@ -181,7 +212,9 @@ h3. Backup Configuration File (All Adapters, Storage Methods and Options)
 "http://wiki.github.com/meskyanichi/backup/configuration-file":http://wiki.github.com/meskyanichi/backup/configuration-file
 
 
-h3. Rake Tasks
+h3. Utility Commands and Rake Tasks
+
+"http://wiki.github.com/meskyanichi/backup/utility-commands":http://wiki.github.com/meskyanichi/backup/utility-commands
 
 "http://wiki.github.com/meskyanichi/backup/rake-tasks":http://wiki.github.com/meskyanichi/backup/rake-tasks
 

data/VERSION

@@ -1 +1 @@
-2.3.0.1
+2.3.0.2

data/backup.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "2.3.0.1"
+  s.version = "2.3.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael van Rooijen"]
-  s.date = %q{2009-12-08}
+  s.date = %q{2009-12-12}
   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

data/bin/backup

@@ -13,11 +13,13 @@ optparse = OptionParser.new do |opts|
   
   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
@@ -37,19 +39,16 @@ optparse = OptionParser.new do |opts|
   end
   
   opts.on('-t', '--truncate [trigger]', "Truncates backup records for specified trigger") do |trigger|
-    confirm_configuration_file_existence
-    puts "Truncating backups 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   :trigger => trigger, :storage => 's3'
-      when :scp   then Backup::Record::SCP.destroy_all  :trigger => trigger, :storage => 'scp'
-      when :ftp   then Backup::Record::FTP.destroy_all  :trigger => trigger, :storage => 'ftp'
-      when :sftp  then Backup::Record::SFTP.destroy_all :trigger => trigger, :storage => 'sftp'
-    end
+    puts "Truncating backup records with trigger: #{trigger}."
+    Backup::Record::S3.destroy_all    :trigger => trigger, :storage => 's3'
+    Backup::Record::SCP.destroy_all   :trigger => trigger, :storage => 'scp'
+    Backup::Record::FTP.destroy_all   :trigger => trigger, :storage => 'ftp'
+    Backup::Record::SFTP.destroy_all  :trigger => trigger, :storage => 'sftp'
   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
@@ -60,7 +59,7 @@ optparse = OptionParser.new do |opts|
   end
   
   opts.on('--truncate-all', "Truncates all backup records") do
-    confirm_configuration_file_existence
+    puts "Truncating all backup records."
     Backup::Record::S3.destroy_all
     Backup::Record::SCP.destroy_all
     Backup::Record::FTP.destroy_all
@@ -69,6 +68,7 @@ optparse = OptionParser.new do |opts|
 
   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
@@ -81,6 +81,7 @@ optparse = OptionParser.new do |opts|
   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
   

data/generators/backup/templates/tasks/backup.rake

@@ -2,22 +2,43 @@ namespace :backup do
 
   desc "Run Backup Procedure."
   task :run => :environment do
+    puts "Running: #{ENV['trigger']}."
     Backup::Setup.new(ENV['trigger'], @backup_procedures).initialize_adapter
   end
   
-  desc "Truncates all records for the specified \"trigger\", excluding the physical files on s3 or the remote server."
-  task :truncate => :environment do
+  desc "Finds backup records by trigger"
+  task :find => :environment do
+    puts "Finding backup records with trigger: #{ENV['trigger']}."
     backup = Backup::Setup.new(ENV['trigger'], @backup_procedures)
+    records = Array.new
     case backup.procedure.storage_name.to_sym
-      when :s3    then Backup::Record::S3.destroy_all   :trigger => ENV['trigger'], :storage => 's3'
-      when :scp   then Backup::Record::SCP.destroy_all  :trigger => ENV['trigger'], :storage => 'scp'
-      when :ftp   then Backup::Record::FTP.destroy_all  :trigger => ENV['trigger'], :storage => 'ftp'
-      when :sftp  then Backup::Record::SFTP.destroy_all :trigger => ENV['trigger'], :storage => 'sftp'
+      when :s3    then records = Backup::Record::S3.all   :conditions => {:trigger => ENV['trigger']}
+      when :scp   then records = Backup::Record::SCP.all  :conditions => {:trigger => ENV['trigger']}
+      when :ftp   then records = Backup::Record::FTP.all  :conditions => {:trigger => ENV['trigger']}
+      when :sftp  then records = Backup::Record::SFTP.all :conditions => {:trigger => ENV['trigger']}
+    end
+    
+    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 => :environment do
+    puts "Truncating backup records with trigger: #{ENV['trigger']}."
+    Backup::Record::S3.destroy_all    :trigger => ENV['trigger'], :storage => 's3'
+    Backup::Record::SCP.destroy_all   :trigger => ENV['trigger'], :storage => 'scp'
+    Backup::Record::FTP.destroy_all   :trigger => ENV['trigger'], :storage => 'ftp'
+    Backup::Record::SFTP.destroy_all  :trigger => ENV['trigger'], :storage => 'sftp'
+  end
+  
   desc "Truncates everything."
   task :truncate_all => :environment do
+    puts "Truncating all backup records."
     Backup::Record::S3.destroy_all
     Backup::Record::SCP.destroy_all
     Backup::Record::FTP.destroy_all
@@ -26,6 +47,7 @@ namespace :backup do
   
   desc "Destroys all records for the specified \"trigger\", including the physical files on s3 or the remote server."
   task :destroy => :environment do
+    puts "Destroying backup records with trigger: #{ENV['trigger']}."
     backup = Backup::Setup.new(ENV['trigger'], @backup_procedures)
     case backup.procedure.storage_name.to_sym
       when :s3    then Backup::Record::S3.destroy_all_backups   backup.procedure,  ENV['trigger']
@@ -37,6 +59,7 @@ namespace :backup do
   
   desc "Destroys all records for the specified \"trigger\", including the physical files on s3 or the remote server."
   task :destroy_all => :environment do
+    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

data/lib/backup.rb

@@ -91,7 +91,9 @@ module Backup
         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 raise "Unknown Adapter: \"#{procedure.adapter_name}\"."
+        else
+          puts "Unknown Adapter: \"#{procedure.adapter_name}\"."
+          exit
       end
     end
   
@@ -106,7 +108,8 @@ module Backup
         end
       end
       available_triggers = procedures.each.map {|procedure| "- #{procedure.trigger}\n" }
-      raise "Could not find a backup procedure with the trigger \"#{trigger}\". \nHere's a list of available triggers:\n#{available_triggers}"
+      puts "Could not find a backup procedure with the trigger \"#{trigger}\". \nHere's a list of available triggers:\n#{available_triggers}"
+      exit
     end
 
   end

data/lib/backup/connection/s3.rb

@@ -2,26 +2,23 @@ module Backup
   module Connection
     class S3
       
-      attr_accessor :adapter, :access_key_id, :secret_access_key, :s3_bucket, :use_ssl, :final_file, :tmp_path
+      attr_accessor :adapter, :procedure, :access_key_id, :secret_access_key, :s3_bucket, :use_ssl, :final_file, :tmp_path
       
       # Initializes the S3 connection, setting the values using the S3 adapter
       def initialize(adapter = false)
         if adapter
+          self.adapter            = adapter
+          self.procedure          = adapter.procedure
           self.final_file         = adapter.final_file
           self.tmp_path           = adapter.tmp_path.gsub('\ ', ' ')
-          self.access_key_id      = adapter.procedure.get_storage_configuration.attributes['access_key_id']
-          self.secret_access_key  = adapter.procedure.get_storage_configuration.attributes['secret_access_key']
-          self.s3_bucket          = adapter.procedure.get_storage_configuration.attributes['bucket']
-          self.use_ssl            = adapter.procedure.get_storage_configuration.attributes['use_ssl']
+          load_storage_configuration_attributes
         end
       end
       
       # Sets values from a procedure, rather than from the adapter object
       def static_initialize(procedure)
-        self.access_key_id      = procedure.get_storage_configuration.attributes['access_key_id']
-        self.secret_access_key  = procedure.get_storage_configuration.attributes['secret_access_key']
-        self.s3_bucket          = procedure.get_storage_configuration.attributes['bucket']
-        self.use_ssl            = procedure.get_storage_configuration.attributes['use_ssl']
+        self.procedure = procedure
+        load_storage_configuration_attributes(true)
       end
       
       # Establishes a connection with Amazon S3 using the credentials provided by the user
@@ -65,6 +62,24 @@ module Backup
           bucket )
       end
       
+      private
+      
+        def load_storage_configuration_attributes(static = false)          
+          %w(access_key_id secret_access_key use_ssl).each do |attribute|
+            if static
+              send("#{attribute}=", procedure.get_storage_configuration.attributes[attribute])
+            else
+              send("#{attribute}=", adapter.procedure.get_storage_configuration.attributes[attribute])
+            end
+          end
+          
+          if static
+            self.s3_bucket = procedure.get_storage_configuration.attributes['bucket']
+          else
+            self.s3_bucket = adapter.procedure.get_storage_configuration.attributes['bucket']
+          end
+        end
+        
     end
   end 
 end

data/lib/backup/environment/unix.rb

@@ -24,6 +24,34 @@ module Backup
             %x{ sudo mkdir -p #{File.join(BACKUP_PATH, 'config')} }
             %x{ sudo cp #{File.join(File.dirname(__FILE__), '..', '..', '..', 'setup', 'backup.sqlite3')} #{BACKUP_PATH} }
             %x{ sudo cp #{File.join(File.dirname(__FILE__), '..', '..', '..', 'setup', 'backup.rb')} #{File.join(BACKUP_PATH, 'config')} }
+            puts <<-MESSAGE
+              
+  ==============================================================
+  Backup has been set up!
+  ==============================================================
+
+  1: Set up some "Backup Settings" inside the configuration file!
+
+    /opt/backup/config/backup.rb
+
+
+  2: Run the backups!
+
+    sudo backup --run [trigger]
+
+
+  For a list of Backup commands:
+
+    sudo backup --help
+  
+
+  For More Information:
+
+    http://github.com/meskyanichi/backup
+
+  ==============================================================
+              
+            MESSAGE
           else
             puts "\nBackup is already installed in #{BACKUP_PATH}..\n"
             puts "If you want to reset it, run:\n\nbackup --reset\n\n"

data/lib/backup/record/s3.rb

@@ -61,12 +61,8 @@ module Backup
             end
             
             unless backups_to_destroy.empty?
-              # Create a new Amazon S3 Object
               s3 = Backup::Connection::S3.new(adapter_config)
-              # Connect to Amazon S3 with provided credentials
               s3.connect
-            
-              # Loop through all backups that should be destroyed and remove them from S3.
               backups_to_destroy.each do |backup|
                 puts "\nDestroying backup \"#{backup.filename}\" from bucket \"#{backup.bucket}\"."
                 s3.destroy(backup.filename, backup.bucket)

data/lib/backup/storage/ftp.rb

@@ -7,7 +7,7 @@ module Backup
       # 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])
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
         end
         
         final_file = adapter.final_file
@@ -17,14 +17,16 @@ module Backup
           begin
             ftp.chdir(path)
           rescue
-            raise "Could not find or access \"#{path}\" on \"#{ip}\", please ensure this directory exists and is accessible by the user \"#{user}\"."
+            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
-            raise "Could not save file to backup server. Is the \"#{path}\" directory writable?"
+            puts "Could not save file to backup server. Is the \"#{path}\" directory writable?"
+            exit
           end
         end
       end

data/lib/backup/storage/scp.rb

@@ -7,7 +7,7 @@ module Backup
       # 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])
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
         end
         
         final_file = adapter.final_file

data/lib/backup/storage/sftp.rb

@@ -7,7 +7,7 @@ module Backup
       # 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])
+          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
         end
         
         final_file = adapter.final_file
@@ -18,7 +18,8 @@ module Backup
             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
-            raise "Could not find \"#{path}\" on \"#{ip}\", please ensure this directory exists."
+            puts "Could not find \"#{path}\" on \"#{ip}\", please ensure this directory exists."
+            exit
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  version: 2.3.0.1
+  version: 2.3.0.2
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 +01:00
+date: 2009-12-12 00:00:00 +01:00
 default_executable: backup
 dependencies: 
 - !ruby/object:Gem::Dependency