backup 0.2.0 → 1.0.0

data/README.rdoc

@@ -3,6 +3,8 @@
 == What is "Backup"?
 
 "Backup" is a RubyGem written for Rails to (easily) handle backing up your database files and assets to either Amazon S3, or any other server using SSH.
+You barely have to get your hands dirty! Backup provides you with 2 (easily) configurable .yml files. These two files are the only ones you will need to use to configure
+all your backups.
 
 
 === Backup makes use of two storage methods:
@@ -11,11 +13,11 @@
 - Any Remote Server You Can Access Through "SSH"
 
 
-=== Currently it supports:
+=== Currently it supports these adapters:
 
 - SQLite3
 - MySQL
-- Folder (and Sub Folders) of Assets (Think of: Documents, Images, Etc.)
+- Assets/Folders (and Sub Folders) of Assets (Think of: Documents, Images, Etc.)
 
 
 === Your database type not on the list?
@@ -25,7 +27,21 @@
 I built in a simple class (called: Custom) that will allow you to manually create a SQL dump using a shell command.
 This looks basically the same as the other options, except that you will have to write (probably) only a "single
 line'd shell command" to generate a sql dump file. Once you generate the file, Backup will take care of the rest
-of the (optional)archiving, compressing and pushing to S3 or any remote server that supports SSH.
+of the (optional)archiving, compressing, encrypting and pushing to Amazon S3 or any remote server that supports SSH.
+
+=== Encryption
+
+Backup also provides encryption. Adding a single line to one of the configuration files will enable encryption for your backups!
+
+== Why?
+
+- I wanted a simple Backup Gem for Rails
+- I wanted minimum and easy configuration
+- I wanted it to take less than 2 minutes to set up 
+- I wanted it to support (AT LEAST) both SQLite3 as well as MySQL
+- I wanted it to support an additional (custom) adapter incase the database type isn't SQLite3 or MySQL
+- I wanted it to support some encryption
+- I wanted to be able to store my files on my private backup server and on Amazon S3
 
 ==== Setting up Backup takes me about 1-2 minutes and it's really easy!
 
@@ -64,6 +80,28 @@ http://wiki.github.com/meskyanichi/backup/resources
 If anyone wishes to see support for PostgreSQL or any other database format, please send me a message!
 
 
+=== Suggestions?
+
+Send me a message! Fork the project! Help out! :)
+
+
+=== Found a Bug?
+
+Report it!
+http://github.com/meskyanichi/backup/issues
+
+
+=== Upcoming Feature(s)
+
+The ability to set the amount of backups you wish to keep stored.
+This will be configurable inside the .yml files.
+It'd look something like this:
+
+  keep_backups: 50
+
+When this is set, and the 51th backup gets stored, it will remove the oldest one from S3 or what ever other
+server you've set up to back up to.
+
 === Copyright
 
 Copyright (c) 2009 Michael van Rooijen | Final Creation. See LICENSE for details.

data/Rakefile

@@ -6,9 +6,16 @@ begin
   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.description = %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.
-                        It currently supports MySQL, SQLite3 and basic Assets (documents, images, etc). The files will get tar'd / gzip'd and get a timestamp.
-                        After creation, these files can be transferred to either Amazon S3 or any remote server through SSH.}
+    gem.description = %Q{
+                          “Backup” is a RubyGem, written for Ruby on Rails. It's main purpose is to Backup any
+                          files to Amazon S3 or any remotely accessible server through SSH (SCP). It supports database
+                          and regular file backups. On top of that, it's extremely easy to set up. Backup will provide
+                          a generator script that will place all necessary files inside your Rails application.
+                          Two of which, are “yaml” configuration files. Using just these two files to configure a
+                          backup for database formats such as a MySQL, SQLite3 or any Assets folder.
+                          Setting up “Backup” takes only about a minute or two!
+                        }
+                        
     gem.email = "meskyan@gmail.com"
     gem.homepage = "http://github.com/meskyanichi/backup"
     gem.authors = ["meskyanichi"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/backup.gemspec

@@ -5,14 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["meskyanichi"]
-  s.date = %q{2009-10-03}
-  s.description = %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.
-                        It currently supports MySQL, SQLite3 and basic Assets (documents, images, etc). The files will get tar'd / gzip'd and get a timestamp.
-                        After creation, these files can be transferred to either Amazon S3 or any remote server through SSH.}
+  s.date = %q{2009-10-07}
+  s.description = %q{
+                          “Backup” is a RubyGem, written for Ruby on Rails. It's main purpose is to Backup any
+                          files to Amazon S3 or any remotely accessible server through SSH (SCP). It supports database
+                          and regular file backups. On top of that, it's extremely easy to set up. Backup will provide
+                          a generator script that will place all necessary files inside your Rails application.
+                          Two of which, are “yaml” configuration files. Using just these two files to configure a
+                          backup for database formats such as a MySQL, SQLite3 or any Assets folder.
+                          Setting up “Backup” takes only about a minute or two!
+                        }
   s.email = %q{meskyan@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -26,10 +32,12 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "backup.gemspec",
-     "generators/backup_rake_tasks/backup_rake_tasks_generator.rb",
-     "generators/backup_rake_tasks/templates/README.rdoc",
-     "generators/backup_rake_tasks/templates/s3.rake",
-     "generators/backup_rake_tasks/templates/ssh.rake",
+     "generators/backup_tasks/backup_tasks_generator.rb",
+     "generators/backup_tasks/templates/config.rake",
+     "generators/backup_tasks/templates/s3.rake",
+     "generators/backup_tasks/templates/s3.yml",
+     "generators/backup_tasks/templates/ssh.rake",
+     "generators/backup_tasks/templates/ssh.yml",
      "lib/backup.rb",
      "lib/backup/assets.rb",
      "lib/backup/base.rb",
@@ -37,6 +45,7 @@ Gem::Specification.new do |s|
      "lib/backup/connection/s3.rb",
      "lib/backup/connection/ssh.rb",
      "lib/backup/custom.rb",
+     "lib/backup/encrypt.rb",
      "lib/backup/mysql.rb",
      "lib/backup/sqlite3.rb",
      "lib/backup/transfer/base.rb",

data/generators/{backup_rake_tasks/backup_rake_tasks_generator.rb → backup_tasks/backup_tasks_generator.rb}

@@ -1,4 +1,4 @@
-class BackupRakeTasksGenerator < Rails::Generator::Base
+class BackupTasksGenerator < Rails::Generator::Base
 
   # This method gets initialized when the generator gets run.
   # It will receive an array of arguments inside @args
@@ -13,11 +13,19 @@ class BackupRakeTasksGenerator < Rails::Generator::Base
   # This will automatically be run after the initialize method
   def manifest
     record do |m|
+      
+      # Generate the Rake Tasks
       m.directory "lib/tasks/"
       m.directory "lib/tasks/backup"
-      m.file      "README.rdoc",  "lib/tasks/backup/README.rdoc"
+      m.file      "config.rake",  "lib/tasks/backup/config.rake"
       m.file      "s3.rake",      "lib/tasks/backup/s3.rake"
       m.file      "ssh.rake",     "lib/tasks/backup/ssh.rake"
+      
+      # Generate the YAML files
+      m.directory "config/backup"
+      m.file      "s3.yml",       "config/backup/s3.yml"
+      m.file      "ssh.yml",      "config/backup/ssh.yml"
+      
     end
   end
   

data/generators/backup_tasks/templates/config.rake

@@ -0,0 +1,33 @@
+namespace :backup do
+
+  task :s3_config => :environment do
+    @config = YAML.load_file(File.join(RAILS_ROOT, 'config', 'backup', 's3.yml'))
+    
+    @config.each do |key, value|
+      value.each do |k, v|
+        if @config[key][k].is_a?(String)
+          @config[key][k] = @config[key][k][v].gsub(/:rails_root/, RAILS_ROOT)
+        end     
+        if @config[key][k].is_a?(Array)
+          @config[key][k].map! {|string| string.gsub(/:rails_root/, RAILS_ROOT)}
+        end
+      end
+    end
+  end
+  
+  task :ssh_config => :environment do
+    @config = YAML.load_file(File.join(RAILS_ROOT, 'config', 'backup', 'ssh.yml'))
+    
+    @config.each do |key, value|
+      value.each do |k, v|
+        if @config[key][k].is_a?(String)
+          @config[key][k] = @config[key][k][v].gsub(/:rails_root/, RAILS_ROOT)
+        end     
+        if @config[key][k].is_a?(Array)
+          @config[key][k].map! {|string| string.gsub(/:rails_root/, RAILS_ROOT)}
+        end
+      end
+    end
+  end
+  
+end

data/generators/{backup_rake_tasks → backup_tasks}/templates/s3.rake

@@ -8,19 +8,23 @@ namespace :backup do
     # Specify which bucket you wish to store your files to.
     # If you wish to put specific files in subfolders inside the bucket, you may do so by doing something like this:
     # :bucket => "my_bucket/subfolder1/subfolder2" etc.
-    task :mysql => :environment do
+    desc 'Makes a backup from a MySQL database and transfers it to Amazon S3.'
+    task :mysql => :s3_config do
+      @config = @config['mysql']
       Backup::Mysql.new({
         :mysql => {
-          :user     => "",
-          :password => "",
-          :database => ""
+          :user     => @config['mysql_config']['user'],
+          :password => @config['mysql_config']['password'],
+          :database => @config['mysql_config']['database']
         },
         
+        :encrypt => @config['encrypt'],
+        
         :use => :s3,
         :s3 => {
-          :access_key_id      => '',
-          :secret_access_key  => '',
-          :bucket             => 'mybucket/backups/etc'
+          :access_key_id      => @config['s3']['access_key_id'],
+          :secret_access_key  => @config['s3']['secret_access_key'],
+          :bucket             => @config['s3']['bucket']
         }
       }).run
     end
@@ -32,15 +36,19 @@ namespace :backup do
     # Specify which bucket you wish to store your files to.
     # If you wish to put specific files in subfolders inside the bucket, you may do so by doing something like this:
     # :bucket => "my_bucket/subfolder1/subfolder2" etc.
-    task :sqlite3 => :environment do
+    desc 'Makes a backup from a SQLite3 database and transfers it to Amazon S3.'
+    task :sqlite3 => :s3_config do
+      @config = @config['sqlite3']
       Backup::Sqlite3.new({
-        :file => 'production.sqlite3', # "production.sqlite3" is default, can remove the whole :file attribute or change it's value
-        
+        :file     => @config['file'],
+        :path     => @config['path'],
+        :encrypt  => @config['encrypt'],
+                
         :use => :s3,
         :s3 => {
-          :access_key_id      => '',
-          :secret_access_key  => '',
-          :bucket             => 'mybucket/backups/etc'
+          :access_key_id      => @config['s3']['access_key_id'],
+          :secret_access_key  => @config['s3']['secret_access_key'],
+          :bucket             => @config['s3']['bucket']
         }
       }).run
     end
@@ -52,15 +60,18 @@ namespace :backup do
     # Specify which bucket you wish to store your files to.
     # If you wish to put specific files in subfolders inside the bucket, you may do so by doing something like this:
     # :bucket => "my_bucket/subfolder1/subfolder2" etc.
-    task :assets => :environment do
+    desc 'Makes a backup from Assets and transfers it to Amazon S3.'
+    task :assets => :s3_config do
+      @config = @config['assets']
       Backup::Assets.new({
-        :path => "#{RAILS_ROOT}/public/assets",
+        :path     => @config['path'],
+        :encrypt  => @config['encrypt'],
         
         :use => :s3,
         :s3 => {
-          :access_key_id      => '',
-          :secret_access_key  => '',
-          :bucket             => 'mybucket/backups/etc'
+          :access_key_id      => @config['s3']['access_key_id'],
+          :secret_access_key  => @config['s3']['secret_access_key'],
+          :bucket             => @config['s3']['bucket']
         }
       }).run
     end
@@ -99,19 +110,20 @@ namespace :backup do
     # 
     # Just use the ":use => :s3" as usual to tell it you would like to back up these files using S3.
     # And then, like in the example below, provide the S3 credentials/details to be able to connect to the server you wish to back these files up to.
-    task :custom => :environment do
+    desc 'Makes a backup from a Custom database and transfers it to Amazon S3.'
+    task :custom => :s3_config do
+      @config = @config['custom']
       Backup::Custom.new({
-        :command  => ["mysqldump --quick -u root --password='' foobar > #{RAILS_ROOT}/db/foobar1.sql",
-                      "mysqldump --quick -u root --password='' foobar > #{RAILS_ROOT}/db/foobar2.sql"],
-                      
-        :path     => "#{RAILS_ROOT}/db",
-        :file     => ["foobar1.sql","foobar2.sql"],
+        :file     => @config['file'],
+        :path     => @config['path'],
+        :command  => @config['command'],
+        :encrypt  => @config['encrypt'],
                 
         :use => :s3,
         :s3 => { 
-          :access_key_id      => '',
-          :secret_access_key  => '',
-          :bucket             => 'mybucket/backups/etc'
+          :access_key_id      => @config['s3']['access_key_id'],
+          :secret_access_key  => @config['s3']['secret_access_key'],
+          :bucket             => @config['s3']['bucket']
         }
       }).run
     end

data/generators/backup_tasks/templates/s3.yml

@@ -0,0 +1,88 @@
+# Backup Configuration file for "Amazon S3 Backups"
+# This file was generated with the Backup Generator
+#
+# FOR MORE INFORMATION, VIEW THE WIKI ON GITHUB:
+#  http://wiki.github.com/meskyanichi/backup
+# 
+# If you wish to make use of the Amazon S3 service to store your
+# backups, use this configuration file.
+# 
+# Step by Step
+# 
+# Step 1
+#  Choose the adapter you would like to use to back up your files
+#  (MySQL, SQLite3, Assets or something Custom)
+# 
+# Step 2
+#  Fill in the values for the adapter you choose.
+#  You do not need to fill in the values for every adapter,
+#  only the ones you are going to use. The rest you can leave untouched or remove.
+# 
+# Step 3
+#  Once you've filled in all values, you are ready to execute the rake task that
+#  starts that backup process. Above each Adapter you will see what rake task should
+#  be run to start the backup process for that specific Adapter.
+#
+# Step 4
+#  Once set up, you could set these rake tasks up in a cronjob to execute it periodically.
+#  For handling this, I recommend using the javan-whenever gem
+# 
+#  See here: http://github.com/javan/whenever
+
+
+# MySQL Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:s3:mysql
+mysql:
+  mysql_config:
+    user: root
+    password: '' 
+    database: my_database
+  s3:
+    access_key_id: my_access_key_id
+    secret_access_key: my_secret_access_key
+    bucket: my_bucket
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+
+
+# SQLite3 Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:s3:sqlite3
+sqlite3:
+  file: production.sqlite3
+  path: ':rails_root/db'
+  s3:
+    access_key_id: my_access_key_id
+    secret_access_key: my_secret_access_key
+    bucket: my_bucket
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+
+
+# Asset Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:s3:assets
+assets:
+  path: ':rails_root/public/assets'
+  s3:
+    access_key_id: my_access_key_id
+    secret_access_key: my_secret_access_key
+    bucket: my_bucket
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+
+
+# Custom Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:s3:custom
+custom:
+  path: ':rails_root/db'
+  file:
+    - 'foobar1.sql'
+    - 'foobar2.sql'
+  command:
+    - 'mysqldump --quick -u root --password="" foobar > :rails_root/db/foobar1.sql'
+    - 'mysqldump --quick -u root --password="" foobar > :rails_root/db/foobar2.sql'
+  s3:
+    access_key_id: my_access_key_id
+    secret_access_key: my_secret_access_key
+    bucket: my_bucket
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup

data/generators/{backup_rake_tasks → backup_tasks}/templates/ssh.rake

@@ -6,38 +6,46 @@ namespace :backup do
     # Specify that you want to use :ssh
     # Specify what user should connect through SSH, to what address (be it IP or an URL) and the absolute path on the backup-server
     # to where Backup should store the backups.
-    task :mysql => :environment do
+    desc 'Makes a backup from a MySQL database and transfers it through SSH (SCP).'
+    task :mysql => :ssh_config do
+      @config = @config['mysql']
       Backup::Mysql.new({
         :mysql => {
-          :user     => "",
-          :password => "",
-          :database => ""
+          :user     => @config['mysql_config']['user'],
+          :password => @config['mysql_config']['password'],
+          :database => @config['mysql_config']['database']
         },
         
+        :encrypt => @config['encrypt'],
+        
         :use => :ssh,
         :ssh => {
-          :user => "root",
-          :ip   => "mydomain.com", # or: 123.45.678.90
-          :path => "/var/backups/etc"
+          :user => @config['ssh']['user'],
+          :ip   => @config['ssh']['ip'],
+          :path => @config['ssh']['path']
         }
       }).run
     end
-    
+
     # => rake backup:ssh:sqlite3
     # Specify which sqlite3 file you wish to back up. This will generally be "production.sqlite3". (and this is the default, so you can remove the :file attribute if it is)
     # If your sqlite3 file is not located inside the #{RAILS_ROOT}/db folder, then add a :path => "#{RAILS_ROOT}/path/to/db/folder" 
     # Specify that you want to use :ssh
     # Specify what user should connect through SSH, to what address (be it IP or an URL) and the absolute path on the backup-server
     # to where Backup should store the backups.
-    task :sqlite3 => :environment do
+    desc 'Makes a backup from a SQLite3 database and transfers it through SSH (SCP).'
+    task :sqlite3 => :ssh_config do
+      @config = @config['sqlite3']
       Backup::Sqlite3.new({
-        :file => 'production.sqlite3', # "production.sqlite3" is default, can remove the whole :file attribute or change it's value
+        :file     => @config['file'],
+        :path     => @config['path'],
+        :encrypt  => @config['encrypt'],
         
         :use => :ssh,
         :ssh => {
-          :user => "root",
-          :ip   => "mydomain.com", # or: 123.45.678.90
-          :path => "/var/backups/etc"
+          :user => @config['ssh']['user'],
+          :ip   => @config['ssh']['ip'],
+          :path => @config['ssh']['path']
         }
       }).run
     end
@@ -47,15 +55,18 @@ namespace :backup do
     # Specify that you want to use :ssh
     # Specify what user should connect through SSH, to what address (be it IP or an URL) and the absolute path on the backup-server
     # to where Backup should store the backups.
-    task :assets => :environment do
+    desc 'Makes a backup from Assets and transfers it through SSH (SCP).'
+    task :assets => :ssh_config do
+      @config = @config['assets']
       Backup::Assets.new({
-        :path => "#{RAILS_ROOT}/public/assets",
+        :path     => @config['path'],
+        :encrypt  => @config['encrypt'],
         
         :use => :ssh,
         :ssh => { 
-          :user => "root",
-          :ip   => "mydomain.com", # or: 123.45.678.90
-          :path => "/var/backups/etc"
+          :user => @config['ssh']['user'],
+          :ip   => @config['ssh']['ip'],
+          :path => @config['ssh']['path']
         }
       }).run
     end
@@ -94,19 +105,20 @@ namespace :backup do
     #
     # Just use the ":use => :ssh" as usual to tell it you would like to back up these files using SSH.
     # And then, like in the example below, provide the SSH details to be able to connect to the server you wish to back these files up to.
-    task :custom => :environment do
+    desc 'Makes a backup from a Custom database and transfers it through SSH (SCP).'
+    task :custom => :ssh_config do
+      @config = @config['custom']
       Backup::Custom.new({
-        :command  => ["mysqldump --quick -u root --password='' foobar > #{RAILS_ROOT}/db/foobar1.sql",
-                      "mysqldump --quick -u root --password='' foobar > #{RAILS_ROOT}/db/foobar2.sql"],
-                      
-        :path     => "#{RAILS_ROOT}/db",
-        :file     => ["foobar1.sql", "foobar2.sql"],
+        :file     => @config['file'],
+        :path     => @config['path'],
+        :command  => @config['command'],
+        :encrypt  => @config['encrypt'],
                 
         :use => :ssh,
         :ssh => { 
-          :user => "root",
-          :ip   => "mydomain.com", # or: 123.45.678.90
-          :path => "/var/backups/etc"
+          :user => @config['ssh']['user'],
+          :ip   => @config['ssh']['ip'],
+          :path => @config['ssh']['path']
         }
       }).run
     end

data/generators/backup_tasks/templates/ssh.yml

@@ -0,0 +1,88 @@
+# Backup Configuration file for "SSH (SCP) Backups"
+# This file was generated with the Backup Generator
+#
+# FOR MORE INFORMATION, VIEW THE WIKI ON GITHUB:
+#  http://wiki.github.com/meskyanichi/backup
+# 
+# If you wish to make use of SSH (SCP) to store your
+# backups to another server, use this configuration file.
+# 
+# Step by Step
+# 
+# Step 1
+#  Choose the adapter you would like to use to back up your files
+#  (MySQL, SQLite3, Assets or something Custom)
+# 
+# Step 2
+#  Fill in the values for the adapter you choose.
+#  You do not need to fill in the values for every adapter,
+#  only the ones you are going to use. The rest you can leave untouched or remove.
+# 
+# Step 3
+#  Once you've filled in all values, you are ready to execute the rake task that
+#  starts that backup process. Above each Adapter you will see what rake task should
+#  be run to start the backup process for that specific Adapter.
+#
+# Step 4
+#  Once set up, you could set these rake tasks up in a cronjob to execute it periodically.
+#  For handling this, I recommend using the javan-whenever gem
+# 
+#  See here: http://github.com/javan/whenever
+
+
+# MySQL Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:ssh:mysql
+mysql:
+  mysql_config:
+    user: root
+    password: '' 
+    database: foobar
+  ssh:
+    user: root
+    ip: my-domain.com
+    path: '/var/backups'
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+    
+    
+# SQLite3 Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:ssh:sqlite3
+sqlite3:
+  file: production.sqlite3
+  path: ':rails_root/db'
+  ssh:
+    user: root
+    ip: my-domain.com
+    path: '/var/backups'
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+
+
+# Asset Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:ssh:assets
+assets:
+  path: ':rails_root/public/assets'
+  ssh:
+    user: root
+    ip: my-domain.com
+    path: '/var/backups'
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup
+
+
+# Custom Adapter
+# To run this adapter, execute the following rake task:
+# rake backup:ssh:custom
+custom:
+  path: ':rails_root/db'
+  file:
+    - 'foobar1.sql'
+    - 'foobar2.sql'
+  command:
+    - 'mysqldump --quick -u root --password="" foobar1 > :rails_root/db/foobar1.sql'
+    - 'mysqldump --quick -u root --password="" foobar2 > :rails_root/db/foobar2.sql'
+  ssh:
+    user: root
+    ip: my-domain.com
+    path: '/var/backups'
+  #encrypt: my_secret_password # Uncomment me if you want to encrypt the backup

data/lib/backup.rb

@@ -3,6 +3,7 @@ require 'backup/sqlite3'
 require 'backup/mysql'
 require 'backup/assets'
 require 'backup/custom'
+require 'backup/encrypt'
 require 'backup/transfer/base'
 require 'backup/transfer/s3'
 require 'backup/transfer/ssh'

data/lib/backup/assets.rb

@@ -13,6 +13,8 @@ module Backup
     #   Archives the specified folder to a .tar
     # - Compress
     #   Compresses the .tar file using Gzip
+    # - Encrypt
+    #   Encrypts the backup file
     # - Transfer
     #   Initializes the transfer to either S3 or using SSH
     # - Remove Temp Files
@@ -20,6 +22,7 @@ module Backup
     def run
       archive
       compress
+      encrypt
       transfer
       remove_temp_files
     end

data/lib/backup/base.rb

@@ -38,6 +38,17 @@ module Backup
         end
       end
       
+      # Encrypts the backup file
+      # Only if the encrypt option is specified inside the .yml config file
+      # Otherwise, the encryption will be not be executed.
+      # Encryption is OPTIONAL.
+      def encrypt
+        unless options[:encrypt].blank?
+          Backup::Encrypt.new(options).run
+          options[:backup_file] = "#{options[:backup_file]}.enc"
+        end
+      end
+      
       # Removes files that were stored in the tmp/backups/* directory of the Rails application
       # It completely cleans up the backup folders so theres no trash stored on the production server
       def remove_temp_files
@@ -48,12 +59,14 @@ module Backup
       # This can remove either a single file or an array of files
       # Depending on whether the options[:file] is an Array or a String
       def remove_original_file
-        if options[:file].is_a?(Array)
-          options[:file].each do |file|
-            %x{ rm #{File.join(options[:path], file)} }          
+        unless options[:keep_original_files].eql?(true)
+          if options[:file].is_a?(Array)
+            options[:file].each do |file|
+              %x{ rm #{File.join(options[:path], file)} }          
+            end
+          else
+            %x{ rm #{File.join(options[:path], options[:file])} }
           end
-        else
-          %x{ rm #{File.join(options[:path], options[:file])} }
         end
       end
       

data/lib/backup/custom.rb

@@ -15,6 +15,8 @@ module Backup
     #   Archives the specified folder to a .tar
     # - Compress
     #   Compresses the .tar file using Gzip
+    # - Encrypt
+    #   Encrypts the backup file
     # - Transfer
     #   Initializes the transfer to either S3 or using SSH
     # - Remove Temp Files
@@ -25,9 +27,10 @@ module Backup
       command
       archive
       compress
+      encrypt
       transfer
       remove_temp_files
-      remove_original_file unless options[:keep_original_files].eql?(true)
+      remove_original_file
     end
     
     private

data/lib/backup/encrypt.rb

@@ -0,0 +1,18 @@
+module Backup
+  class Encrypt
+    
+    attr_accessor :options
+    
+    def initialize(options = {})
+      self.options = options
+    end
+    
+    # Encrypts the backup file
+    def run
+      unencrypted_file  = File.join(options[:backup_path], options[:backup_file])
+      encrypted_file    = File.join(options[:backup_path], options[:backup_file] + '.enc')
+      %x{ openssl enc -des-cbc -in #{unencrypted_file} -out #{encrypted_file} -k #{options[:encrypt]} }
+    end
+    
+  end  
+end

data/lib/backup/mysql.rb

@@ -13,6 +13,8 @@ module Backup
     #   Creates a MySQL dump based on the parameters provided by the user
     # - Compress
     #   Compresses the .tar file using Gzip
+    # - Encrypt
+    #   Encrypts the backup file
     # - Transfer
     #   Initializes the transfer to either S3 or using SSH
     # - Remove Temp Files
@@ -20,6 +22,7 @@ module Backup
     def run
       make_mysql_dump
       compress
+      encrypt
       transfer
       remove_temp_files
     end

data/lib/backup/sqlite3.rb

@@ -11,12 +11,15 @@ module Backup
     #
     # - Compress
     #   Compresses the .tar file using Gzip
+    # - Encrypt
+    #   Encrypts the backup file
     # - Transfer
     #   Initializes the transfer to either S3 or using SSH
     # - Remove Temp Files
     #   Removes temporary files after the process is complete
     def run
       compress
+      encrypt
       transfer
       remove_temp_files
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - meskyanichi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-03 00:00:00 +02:00
+date: 2009-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,10 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: |-
-  Backup is a gem/plugin that enables you to very easily create backups and transfer these to Amazon S3 or another server with SSH.
-                          It currently supports MySQL, SQLite3 and basic Assets (documents, images, etc). The files will get tar'd / gzip'd and get a timestamp.
-                          After creation, these files can be transferred to either Amazon S3 or any remote server through SSH.
+description: "\n                          \xE2\x80\x9CBackup\xE2\x80\x9D is a RubyGem, written for Ruby on Rails. It's main purpose is to Backup any\n                          files to Amazon S3 or any remotely accessible server through SSH (SCP). It supports database\n                          and regular file backups. On top of that, it's extremely easy to set up. Backup will provide\n                          a generator script that will place all necessary files inside your Rails application.\n                          Two of which, are \xE2\x80\x9Cyaml\xE2\x80\x9D configuration files. Using just these two files to configure a\n                          backup for database formats such as a MySQL, SQLite3 or any Assets folder.\n                          Setting up \xE2\x80\x9CBackup\xE2\x80\x9D takes only about a minute or two!\n                        "
 email: meskyan@gmail.com
 executables: []
 
@@ -42,10 +39,12 @@ files:
 - Rakefile
 - VERSION
 - backup.gemspec
-- generators/backup_rake_tasks/backup_rake_tasks_generator.rb
-- generators/backup_rake_tasks/templates/README.rdoc
-- generators/backup_rake_tasks/templates/s3.rake
-- generators/backup_rake_tasks/templates/ssh.rake
+- generators/backup_tasks/backup_tasks_generator.rb
+- generators/backup_tasks/templates/config.rake
+- generators/backup_tasks/templates/s3.rake
+- generators/backup_tasks/templates/s3.yml
+- generators/backup_tasks/templates/ssh.rake
+- generators/backup_tasks/templates/ssh.yml
 - lib/backup.rb
 - lib/backup/assets.rb
 - lib/backup/base.rb
@@ -53,6 +52,7 @@ files:
 - lib/backup/connection/s3.rb
 - lib/backup/connection/ssh.rb
 - lib/backup/custom.rb
+- lib/backup/encrypt.rb
 - lib/backup/mysql.rb
 - lib/backup/sqlite3.rb
 - lib/backup/transfer/base.rb

data/generators/backup_rake_tasks/templates/README.rdoc

@@ -1,25 +0,0 @@
-* Backup's Generated Rake Tasks
-	http://github.com/meskyanichi/backup
-
-Quite simple, the generator has now generated all (currently!) possible backup options in the form of rake tasks!
-Just open the desired backup-method's file (S3 or SHH or BOTH!). The basic structure of every task is already setup correctly.
-Above each task you will find a description about the settings of each task. Please be sure to read this first before asking questions.
-
-All in all this is extremely straight forward, there is no need to setup anything else inside your Rails Application other than installing the plugin,
-running (this) generator and changing the values inside the rake task files.
-
-Here is a list of the current rake tasks that are available:
-
-backup:s3:mysql
-backup:s3:sqlite3
-backup:s3:assets
-backup:s3:custom
-backup:ssh:mysql
-backup:ssh:sqlite3
-backup:ssh:assets
-backup:ssh:custom
-
-
-So now you have rake tasks for all your essential backups.
-What I like to do is use a cronjob manager gem to manage my cronjobs to trigger these rake tasks.
-javan-whenever is a good gem for doing this! Try it, or any other method you can think of to trigger these rake tasks periodically.