backup 2.2.1 → 2.3.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+BIG UPDATE
+=== 2.3.0 ====================================
+  
+  - Backup became independent of Ruby on Rails
+  - Backup now supports multiple environments: Rails and Unix
+  - Backup is now executable through the command-line when using the Unix environment
+
+SMALL FEATURE UPDATE
+=== 2.2.1 ====================================
+  
+  - use_ssl option added for S3 Storage Method
+  - additional_options option added for MySQL and PostgreSQL Adapters
+
+
 PRETTY BIG UPDATE
 === 2.2.0 ====================================
   

data/LICENSE

@@ -1,15 +1,4 @@
-Copyright (c) 2009 meskyanichi
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright (c) 2009 Michael van Rooijen - Final Creation (http://final-creation.com)
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
@@ -17,4 +6,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -1,66 +1,42 @@
 h1. Backup
 
-h2. A Backup Ruby Gem for Rails
+h2. A Backup Ruby Gem
 
-Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your
-MySQL/PostgreSQL databases *(and practically even any other database you can dump through the command line)*. It can also make backups of your *archives* (any files or folders).
+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).
 
-All backups can be transferred to either *"Amazon S3"* or "any remotely accessible server using the *SCP, SFTP or FTP* transfer methods".
+h2. Backup goes independent with the release of version 2.3.0! Ruby on Rails is no longer "required"!
 
-*Backup handles: Compression, Archiving, Encryption and Backup Cleaning.*
+*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!*
 
+I am pleased to announce that Backup (version 2.3.0+) has been released and am very satisfied with this update. Backup can now make use of an executable bin file! Why is this so awesome? Because now Backup is Ruby on Rails independent! This means you can make use of Backup whether you use Rails or not, and with the same simplicity! *(pshh.. It's actually simpler to be honest!)*.
 
-h2. What's new in 2.2.0?
+Imagine you have one or more web applications written in another language on the same server, for example, a Python or PHP application. It'd be nice if you could also back up these databases in the same way you are used to, using Backup. Or what about having a MySQL Server running on a separate remove server? It'd be nice to be able to backup directly from that server instead of create a dump from there to the application's server and then push it to Amazon S3 or elsewhere. Previously this wasn't really possible. But now it is! Check this out.
 
-*(S)FTP*
-FTP and SFTP Storage Methods have been added. This will allow you to transfer your backups
-through a (S)FTP if you cannot make use of SCP.
+*Install Backup Gem version 2.3.0 or later!*
 
-*MySQL*
-The following options have been added to the MySQL Adapter
-
-* host
-* socket
-* port
-* skip_tables
+bc. sudo gem install backup
 
-*PostgreSQL*
-The PostgreSQL Adapter has been added! It has about the same options as the MySQL Adapter
+*Setup Backup*
 
-* host/socket
-* port
-* skip_tables
+bc. sudo backup --setup
 
-If you are using PostgreSQL and the Adapter isn't working correctly, please notify me of this.
-I personally never used PostgreSQL, so I don't really have any experience with it, but since there are people that do use it, I wanted to implement it.
+*New folders and files are created in /opt/backup, these will look familiar if you've been using Backup.. Edit the config file!*
+The configuration file works *100% the same as the Ruby on Rails configuration file*, so no need to re-understand it!
 
-*Custom*
-This adapter will enable you, regardless of your database, to make SQL dumps. It's very simple.
-*Simply put: If you don't use MySQL or PostgreSQL then you can use Custom to backup your database format, regardless.*
-What the Custom Adapter does is it allows you to input one or more *commands* to execute (think of *mysqldump* or *pg_dump*, but for other databases).
+bc. sudo nano /opt/backup/config/backup.rb
 
-*The benefit of doing this through Backup* is that you will still gain all the other features that it provides, such as Archiving, Compression, Encryption and Backup Cleaning, even though Backup doesn't officially support your specific database format! You can basically see the Custom adapter as any other adapter, except that you have to *write the sql dump command yourself*. And then Backup handles the rest!
+*And now just run it like so!*
 
-*More info on the adapters:*
+bc. sudo backup --run mytrigger
 
-"http://wiki.github.com/meskyanichi/backup/configuration-file":http://wiki.github.com/meskyanichi/backup/configuration-file
+*For a full list of commands:*
 
-*A few bug fixes*
+bc. backup --help
 
-* Issue where two backup settings would conflict if they were using the same Adapter at the same second! (which can happens when running cronjobs!)
-* The temporary files will now be nicely name spaced by "trigger" so no conflict between two different triggers can occur
-* When an exception is raised during the backup process, the temporary files would not be removed. This is now fixed.
-* And some other minor patches have been applied.
 
-*Updated the Wiki based on this release.*
+*Another handy command I added to this backup utility, is the ability to decrypt files that were encrypted by Backup.*
 
-h3. Get Backup 2.2.x+ now!
-
-bc. sudo gem install backup
-
-And get up and running with Backup 2.2.x+ by reading the *Getting Started* Wiki Page!
-
-"http://wiki.github.com/meskyanichi/backup/getting-started":http://wiki.github.com/meskyanichi/backup/getting-started
+bc. sudo backup --decrypt /path/to/encrypted/file
 
 
 h2. (Current) Backup's Capabilities
@@ -72,7 +48,6 @@ h3. Storage Methods
 * Remote Server (SFTP)
 * Remote Server (FTP)
 
-
 h3. Adapters
 
 * MySQL
@@ -80,7 +55,6 @@ h3. Adapters
 * Archive (any files or folders)
 * Custom (any database format other than MySQL or PostgreSQL!)
 
-
 h3. Archiving
 
 *Backup supports Archiving.*
@@ -96,6 +70,9 @@ of which you wish to encrypt, and it will encrypt it with the specified password
 
 bc. encrypt_with_password "mypassword"
 
+As of *Backup 2.3.0*, backup is executable through the command line. To decrypt an encrypted file, backup provides you with a handy utility to do this:
+
+bc. sudo backup --decrypt /path/to/encrypted/file
 
 h3. Backup Cleaning
 
@@ -142,17 +119,22 @@ 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.
 
+*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!*
+
 *Runs the backup setting with the trigger "backup-logs"*
 
 bc. rake backup:run trigger="backup-logs"
+sudo backup --run backup-logs
 
 *Runs the backup setting with the trigger "backup-mysql"*
 
 bc. rake backup:run trigger="backup-mysql"
+sudo backup --run backup-mysql
 
 *Runs the backup setting with the trigger "backup-assets"*
 
 bc. rake backup:run trigger="backup-assets"
+sudo backup --run backup-assets
 
 h3. Additional Options for MySQL and PostgreSQL
 
@@ -169,17 +151,20 @@ bc. backup 'mysql-backup-s3' do
   .
 end
 
-etc. etc. etc. etc. etc. etc...
-
-
 
 h2. Interested in trying out Backup?
 
 h3. Check out the following Wiki pages to get up and running:
 
-h3. Getting started
 
-"http://wiki.github.com/meskyanichi/backup/getting-started":http://wiki.github.com/meskyanichi/backup/getting-started
+h3. Getting started (Unix Environment)
+
+"http://wiki.github.com/meskyanichi/backup/getting-started-unix":http://wiki.github.com/meskyanichi/backup/getting-started-unix
+
+
+h3. Getting started (Rails Environment)
+
+"http://wiki.github.com/meskyanichi/backup/getting-started-ruby-on-rails":http://wiki.github.com/meskyanichi/backup/getting-started-ruby-on-rails
 
 
 h3. Production Mode (important)

data/Rakefile

@@ -5,21 +5,26 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "backup"
-    gem.summary = %Q{Backup is a gem/plugin that enables you to very easily create backups and transfer these to Amazon S3 or another server with SSH.}
+    gem.summary = %Q{Backup is a Ruby Gem that simplifies making backups for databases, files and folders.}
     gem.description = %Q{
-                        Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your
-                        MySQL/PostgreSQL databases (and practically even any other database you can dump through the command line). It can also make backups of your archives (any files or folders).
-                        All backups can be transferred to either "Amazon S3" or "any remotely accessible server using the SCP, SFTP or FTP transfer methods".
-                        Backup handles: Compression, Archiving, Encryption and Backup Cleaning.
+                            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).
                         }
                         
     gem.email = "meskyan@gmail.com"
     gem.homepage = "http://final-creation.com/open-source"
     gem.authors = ["Michael van Rooijen"]
-    gem.add_dependency "aws-s3",    ">= 0.6.2"
-    gem.add_dependency "net-ssh",   ">= 2.0.15"
-    gem.add_dependency "net-scp",   ">= 1.0.2"
-    gem.add_dependency "net-sftp",  ">= 2.0.4"
+    gem.add_dependency "aws-s3",        ">= 0.6.2"
+    gem.add_dependency "net-ssh",       ">= 2.0.15"
+    gem.add_dependency "net-scp",       ">= 1.0.2"
+    gem.add_dependency "net-sftp",      ">= 2.0.4"
+    gem.add_dependency "activerecord",  ">= 2.3.5"
+    gem.add_dependency "sqlite3-ruby",  ">= 1.2.5"
+#    gem.add_dependency "hirb",          ">= 0.2.9"
+    
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"

data/VERSION

@@ -1 +1 @@
-2.2.1
+2.3.0

data/backup.gemspec

@@ -5,18 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "2.2.1"
+  s.version = "2.3.0"
 
   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-06}
+  s.date = %q{2009-12-08}
+  s.default_executable = %q{backup}
   s.description = %q{
-                        Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your
-                        MySQL/PostgreSQL databases (and practically even any other database you can dump through the command line). It can also make backups of your archives (any files or folders).
-                        All backups can be transferred to either "Amazon S3" or "any remotely accessible server using the SCP, SFTP or FTP transfer methods".
-                        Backup handles: Compression, Archiving, Encryption and Backup Cleaning.
+                            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).
                         }
   s.email = %q{meskyan@gmail.com}
+  s.executables = ["backup"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.textile"
@@ -30,6 +33,7 @@ Gem::Specification.new do |s|
      "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",
@@ -46,6 +50,9 @@ Gem::Specification.new do |s|
      "lib/backup/configuration/helpers.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/record/ftp.rb",
      "lib/backup/record/s3.rb",
      "lib/backup/record/scp.rb",
@@ -53,13 +60,15 @@ Gem::Specification.new do |s|
      "lib/backup/storage/ftp.rb",
      "lib/backup/storage/s3.rb",
      "lib/backup/storage/scp.rb",
-     "lib/backup/storage/sftp.rb"
+     "lib/backup/storage/sftp.rb",
+     "setup/backup.rb",
+     "setup/backup.sqlite3"
   ]
   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.5}
-  s.summary = %q{Backup is a gem/plugin that enables you to very easily create backups and transfer these to Amazon S3 or another server with SSH.}
+  s.summary = %q{Backup is a Ruby Gem that simplifies making backups for databases, files and folders.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -70,17 +79,23 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<net-ssh>, [">= 2.0.15"])
       s.add_runtime_dependency(%q<net-scp>, [">= 1.0.2"])
       s.add_runtime_dependency(%q<net-sftp>, [">= 2.0.4"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
     else
       s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
       s.add_dependency(%q<net-ssh>, [">= 2.0.15"])
       s.add_dependency(%q<net-scp>, [">= 1.0.2"])
       s.add_dependency(%q<net-sftp>, [">= 2.0.4"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
     end
   else
     s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
     s.add_dependency(%q<net-ssh>, [">= 2.0.15"])
     s.add_dependency(%q<net-scp>, [">= 1.0.2"])
     s.add_dependency(%q<net-sftp>, [">= 2.0.4"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
   end
 end
 

data/bin/backup

@@ -0,0 +1,126 @@
+#!/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
+    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
+    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}
+    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|
+    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
+  end
+  
+  opts.on('-d', '--destroy [trigger]', "Destroys backup records and files for specified trigger") do |trigger|
+    confirm_configuration_file_existence
+    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
+    end
+  end
+  
+  opts.on('--truncate-all', "Truncates all backup records") do
+    confirm_configuration_file_existence
+    Backup::Record::S3.destroy_all
+    Backup::Record::SCP.destroy_all
+    Backup::Record::FTP.destroy_all
+    Backup::Record::SFTP.destroy_all
+  end
+
+  opts.on('--destroy-all', "Destroys all backup records and files") do
+    confirm_configuration_file_existence
+    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
+      end
+    end
+  end
+
+  opts.on('--decrypt [file]', "Decrypts a \"Backup\" encrypted file") do |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/lib/backup.rb

@@ -1,46 +1,74 @@
-# Load in Connectivity and Transfer Gems
+#
+# Load Gems
+#
 require 'net/ssh'
 require 'net/scp'
 require 'net/ftp'
 require 'net/sftp'
 require 'aws/s3'
+require 'hirb'
 
-# Load in Adapters
+#
+# Load Environments
+# 
+require 'backup/environment/base'
+require 'backup/environment/unix'
+require 'backup/environment/rails'
+
+#
+# Load Configuration
+# 
+require 'backup/configuration/base'
+require 'backup/configuration/adapter'
+require 'backup/configuration/adapter_options'
+require 'backup/configuration/storage'
+require 'backup/configuration/helpers'
+
+# Include the Configuration adn 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 configuration
+if File.exist?(File.join(BACKUP_PATH, 'config', 'backup.rb'))
+  require File.join(BACKUP_PATH, 'config', 'backup.rb')
+end
+
+#
+# Load Adapters
+#
 require 'backup/adapters/base'
 require 'backup/adapters/mysql'
 require 'backup/adapters/postgresql'
 require 'backup/adapters/archive'
 require 'backup/adapters/custom'
 
-# Load in Connectors
+#
+# Load Connectors
+# 
 require 'backup/connection/s3'
 
-# Load in Storage
+#
+# Load Storage
+#
 require 'backup/storage/s3'
 require 'backup/storage/scp'
 require 'backup/storage/ftp'
 require 'backup/storage/sftp'
 
-# Load in Backup Recorders
+#
+# Backup Recorders
+#
 require 'backup/record/s3'
 require 'backup/record/scp'
 require 'backup/record/ftp'
 require 'backup/record/sftp'
 
-# Load in Configuration
-require 'backup/configuration/base'
-require 'backup/configuration/adapter'
-require 'backup/configuration/adapter_options'
-require 'backup/configuration/storage'
-require 'backup/configuration/helpers'
-
-# Load Backup Configuration Helpers
-include Backup::Configuration::Helpers
-
-# Load in User Configured Backup Procedures if the file exists
-if File.exist?(File.join(RAILS_ROOT, 'config', 'backup.rb'))
-  require File.join(RAILS_ROOT, 'config', 'backup.rb')
-end
 
 # Backup Module
 module Backup

data/lib/backup/adapters/base.rb

@@ -19,7 +19,7 @@ module Backup
         self.trigger                = trigger
         self.procedure              = procedure
         self.timestamp              = Time.now.strftime("%Y%m%d%H%M%S")
-        self.tmp_path               = File.join(RAILS_ROOT.gsub(' ', '\ '), 'tmp', 'backup', trigger)
+        self.tmp_path               = File.join(BACKUP_PATH.gsub(' ', '\ '), 'tmp', 'backup', trigger)
         self.encrypt_with_password  = procedure.attributes['encrypt_with_password']
         self.keep_backups           = procedure.attributes['keep_backups']
         create_tmp_folder

data/lib/backup/environment/base.rb

@@ -0,0 +1,12 @@
+module Backup
+  module Environment
+    module Base
+      
+      def current_environment
+        return :rails if defined?(RAILS_ENV)
+        return :unix
+      end
+      
+    end
+  end
+end

data/lib/backup/environment/rails.rb

@@ -0,0 +1,17 @@
+module Backup
+  module Environment
+    module Rails
+      
+      if defined? RAILS_ENV
+        
+        # Sets BACKUP_PATH equal to RAILS_ROOT
+        BACKUP_PATH = RAILS_ROOT
+      
+        # Sets DB_CONNECTION_SETTINGS to false
+        DB_CONNECTION_SETTINGS = false
+    
+      end
+    
+    end
+  end
+end

data/lib/backup/environment/unix.rb

@@ -0,0 +1,66 @@
+module Backup
+  module Environment
+    module Unix
+      
+      require 'active_record'
+      require 'optparse'
+      
+      # Sets BACKUP_PATH equal to /opt/backup
+      BACKUP_PATH = "/opt/backup"
+      
+      # Sets DB_CONNECTION_SETTINGS
+      DB_CONNECTION_SETTINGS = {
+        :adapter  => "sqlite3",
+        :database => "/opt/backup/backup.sqlite3",
+        :pool     => 5,
+        :timeout  => 5000 
+      }
+
+      module Commands
+        
+        def setup
+          unless File.directory?(BACKUP_PATH)
+            puts "Installing Backup in #{BACKUP_PATH}.."
+            %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')} }
+          else
+            puts "\nBackup is already installed in #{BACKUP_PATH}..\n"
+            puts "If you want to reset it, run:\n\nbackup --reset\n\n"
+            puts "This will reinstall it."
+            puts "Warning: All configuration will be lost!\n\n"
+          end
+        end
+
+        def reset
+          if File.directory?(BACKUP_PATH)
+            remove
+            setup
+          else
+            puts "Backup is not installed.\n"
+            puts "Run the following command to install it:\n\nbackup --setup"
+          end
+        end
+
+        def remove
+          puts "Removing Backup..\n"
+          %x{ sudo rm -rf #{BACKUP_PATH} }
+        end
+      end
+      
+      module Helpers
+
+        def confirm_configuration_file_existence
+          unless File.exist?(File.join(BACKUP_PATH, 'config', 'backup.rb'))
+            puts "\nBackup could not find the Backup Configuration File."
+            puts "Did you set up Backup? Do so if you haven't yet:"
+            puts "\nbackup --setup\n "
+            exit
+          end
+        end
+        
+      end
+    
+    end
+  end
+end

data/lib/backup/record/ftp.rb

@@ -1,7 +1,11 @@
 module Backup
   module Record
     class FTP < ActiveRecord::Base
-
+      
+      if DB_CONNECTION_SETTINGS
+        establish_connection(DB_CONNECTION_SETTINGS)
+      end
+      
       set_table_name 'backup'
       default_scope \
         :order => 'created_at desc',

data/lib/backup/record/s3.rb

@@ -2,18 +2,15 @@ module Backup
   module Record
     class S3 < ActiveRecord::Base
       
-      if connection.table_exists?('backup')
-        set_table_name 'backup'
-        default_scope \
-          :order => 'created_at desc',
-          :conditions => {:storage => 's3'}
-      else
-        set_table_name 'backup_s3'
-        attr_accessor :storage
-        default_scope \
-          :order => 'created_at desc'
+      if DB_CONNECTION_SETTINGS
+        establish_connection(DB_CONNECTION_SETTINGS)
       end
       
+      set_table_name 'backup'
+      default_scope \
+        :order => 'created_at desc',
+        :conditions => {:storage => 's3'}
+
       # Callbacks
       after_save :clean_backups
       

data/lib/backup/record/scp.rb

@@ -1,18 +1,15 @@
 module Backup
   module Record
     class SCP < ActiveRecord::Base
-      
-      if connection.table_exists?('backup')
-        set_table_name 'backup'
-        default_scope \
-          :order => 'created_at desc',
-          :conditions => {:storage => 'scp'}
-      else
-        set_table_name 'backup_scp'
-        attr_accessor :storage
-        default_scope \
-          :order => 'created_at desc'
-      end
+
+      if DB_CONNECTION_SETTINGS
+        establish_connection(DB_CONNECTION_SETTINGS)
+      end      
+
+      set_table_name 'backup'
+      default_scope \
+        :order => 'created_at desc',
+        :conditions => {:storage => 'scp'}
       
       # Callbacks
       after_save :clean_backups

data/lib/backup/record/sftp.rb

@@ -2,6 +2,10 @@ module Backup
   module Record
     class SFTP < ActiveRecord::Base
 
+      if DB_CONNECTION_SETTINGS
+        establish_connection(DB_CONNECTION_SETTINGS)
+      end
+
       set_table_name 'backup'
       default_scope \
         :order => 'created_at desc',

data/setup/backup.rb

@@ -0,0 +1,150 @@
+# 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
+#  - Archive
+#  - Custom
+#
+# STORAGE METHODS
+#  - S3 (Amazon)
+#  - SCP (Remote Server)
+#  - FTP (Remote Server)
+#  - SFTP (Remote Server)
+#
+# GLOBAL OPTIONS
+#  - Keep Backups (keep_backups)
+#  - Encrypt With Pasword (encrypt_with_password)
+#
+#  This is the "decrypt" command for all encrypted backups:
+#    openssl enc -des-cbc -d -in encrypted_file -out decrypted_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.
+# 
+# For more information on "Backup", please refer to the wiki on github
+#   http://wiki.github.com/meskyanichi/backup/configuration-file
+
+
+# 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
+  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'
+  
+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
+  end
+  
+  storage :scp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/postgresql/'
+  end
+
+  keep_backups :all
+  encrypt_with_password false
+  
+end
+
+
+# Initialize with:
+#   rake backup:run trigger='archive-backup-ftp'
+backup 'archive-backup-ftp' do
+  
+  adapter :archive do
+    files ["log", "db"]
+    # files "log"
+  end
+  
+  storage :ftp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/archive/'
+  end
+
+  keep_backups 10
+  encrypt_with_password 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'
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 +01:00
-default_executable: 
+date: 2009-12-08 00:00:00 +01:00
+default_executable: backup
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-s3
@@ -52,10 +52,30 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.0.4
     version: 
-description: "\n                        Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your\n                        MySQL/PostgreSQL databases (and practically even any other database you can dump through the command line). It can also make backups of your archives (any files or folders).\n                        All backups can be transferred to either \"Amazon S3\" or \"any remotely accessible server using the SCP, SFTP or FTP transfer methods\".\n                        Backup handles: Compression, Archiving, Encryption and Backup Cleaning.\n                        "
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.5
+    version: 
+description: "\n                            Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the\n                            Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as\n                            MySQL/PostgreSQL and Files/Folders. All backups can be transferred to Amazon S3 or any remote server you\n                            have access to, using either SCP, SFTP or regular FTP. Backup handles Compression, Archiving, Encryption\n                            and Backup Cleaning (Cycling).\n                        "
 email: meskyan@gmail.com
-executables: []
-
+executables: 
+- backup
 extensions: []
 
 extra_rdoc_files: 
@@ -70,6 +90,7 @@ files:
 - 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
@@ -86,6 +107,9 @@ files:
 - lib/backup/configuration/helpers.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/record/ftp.rb
 - lib/backup/record/s3.rb
 - lib/backup/record/scp.rb
@@ -94,6 +118,8 @@ files:
 - lib/backup/storage/s3.rb
 - lib/backup/storage/scp.rb
 - lib/backup/storage/sftp.rb
+- setup/backup.rb
+- setup/backup.sqlite3
 has_rdoc: true
 homepage: http://final-creation.com/open-source
 licenses: []
@@ -121,6 +147,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Backup is a gem/plugin that enables you to very easily create backups and transfer these to Amazon S3 or another server with SSH.
+summary: Backup is a Ruby Gem that simplifies making backups for databases, files and folders.
 test_files: []