backup 2.1.2 → 2.2.0

data/CHANGELOG

@@ -0,0 +1,41 @@
+PRETTY BIG UPDATE
+=== 2.2.0 ====================================
+  
+  - Added Storage Methods: FTP and SFTP
+  - Added Adapters: PostgreSQL and Custom
+  - Added more options to the MySQL Adapter
+  - A couple of bug fixes
+
+
+MINOR UPDATE
+=== 2.1.2 ====================================
+  
+  - The backup generator will now provide you with a step-by-step guide to getting up and running
+  - Updated the generator itself
+  - Removed SQLite3 dependencies
+  
+
+2 TABLES 2 1
+=== 2.1.1 ====================================
+  
+  - Backup will from now on only utilize one table, instead of one for each storage method
+  - Still backwards compatible to 2.1.0
+  
+
+FIXED A CRUCIAL BUG
+=== 2.1.0 ====================================
+
+  - Problem with Backup::Record. It tried to connect to the SQLite3 database.
+
+
+MAJOR RELEASE
+=== 2.0.0 ====================================
+
+  - Should be a lot more backwards compatible with every update I do.
+  - Does not depend on the separate local SQLite3 file any longer.
+  - Will provide a db migration file for your Rails Application to store backup record data in.
+  - Does not use YAML files to do configuration any longer.
+  - Uses a SINGLE ruby file for "all" configuration (config/backup.rb) using elegant block notations!
+  - Uses a SINGLE rake task to handle the initialization of any backup setting.
+  - Can now configure an unlimited amount of customizable backup settings and run them each "individually"!
+  - HIGHLY IMPROVED USABILITY!

data/README.textile

@@ -0,0 +1,226 @@
+h1. Backup
+
+h2. A Backup Ruby Gem for Rails
+
+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.*
+
+
+h2. What's new in 2.2.0?
+
+*(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.
+
+*MySQL*
+The following options have been added to the MySQL Adapter
+
+* host
+* socket
+* port
+* skip_tables
+
+*PostgreSQL*
+The PostgreSQL Adapter has been added! It has about the same options as the MySQL Adapter
+
+* host/socket
+* port
+* skip_tables
+
+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.
+
+*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).
+
+*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!
+
+*More info on the adapters:*
+
+"http://wiki.github.com/meskyanichi/backup/configuration-file":http://wiki.github.com/meskyanichi/backup/configuration-file
+
+*A few bug fixes*
+
+* 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 "can" occur
+* When an exception is raised during the backup process, the temporary files will not be removed. This will be fixed as of 2.2.0 as well.
+* And some other minor patches will be applied.
+
+*Updated the Wiki based on this release.*
+
+h3. Get Backup 2.2.x+ now!
+
+bc. sudo gem install backup
+
+
+h2. (Current) Backup's Capabilities
+
+h3. Storage Methods
+
+* Amazon (S3)
+* Remote Server (SCP)
+* Remote Server (SFTP)
+* Remote Server (FTP)
+
+
+h3. Adapters
+
+* MySQL
+* PostgreSQL
+* Archive (any files or folders)
+* Custom (any database format other than MySQL or PostgreSQL!)
+
+
+h3. Archiving
+
+*Backup supports Archiving.*
+When you use the Archive adapter to backup a bunch of files and folders, backup will archive and compress these all together.
+Archiving also happens when using the *Custom* adapter. If you issue a few commands using it, to dump maybe 1-3 databases, Backup will
+handle the archiving, compression and encryption for you!
+
+h3. Encryption
+
+*Backup supports a simple form of encryption.*
+All adapters support encryption. This is very simple to enable. Just add the following method inside of the backup settings
+of which you wish to encrypt, and it will encrypt it with the specified password:
+
+bc. encrypt_with_password "mypassword"
+
+
+h3. Backup Cleaning
+
+*Backup supports backup cleaning.*
+Backup Cleaning enables you to specify the amount of backups that may be stored on either Amazon S3 or a Remote Server. If you for example tell backup to limit the amount of backups at 20, then when the 21st backup gets pushed to the storage location, the oldest version will automatically be destroyed.
+
+The idea behind this is to not flood either your backup server, which might resort in possible lack of hard disk space. Another good reason to utilize this would be for Amazon. Although Amazon S3 is extremely cheap, when backing up 1-2GB of MySQL dumps twice a day, it can become quite expensive if you never remove old ones.
+
+To enable this you simply call the following method inside the desired "backup setting":
+
+bc. keep_backups 20
+
+
+h3. Quick Example of a Single Backup Setting inside the Backup Configuration File
+
+bc. backup 'mysql-backup-s3' do
+  adapter :mysql do
+    user      'user'
+    password  'password'
+    database  'database'
+  end
+  storage :s3 do
+    access_key_id     'access_key_id'
+    secret_access_key 'secret_access_key'
+    bucket            '/bucket/backups/mysql/'
+  end
+  keep_backups 25
+  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
+  # Configuration Here
+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:
+
+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.
+
+*Runs the backup setting with the trigger "backup-logs"*
+
+bc. rake backup:run trigger="backup-logs"
+
+*Runs the backup setting with the trigger "backup-mysql"*
+
+bc. rake backup:run trigger="backup-mysql"
+
+*Runs the backup setting with the trigger "backup-assets"*
+
+bc. rake backup:run trigger="backup-assets"
+
+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. 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
+
+"http://wiki.github.com/meskyanichi/backup/rake-tasks":http://wiki.github.com/meskyanichi/backup/rake-tasks
+
+
+h3. Automatic Backups
+
+"http://wiki.github.com/meskyanichi/backup/automatic-backups":http://wiki.github.com/meskyanichi/backup/automatic-backups
+
+
+h3. Capistrano Recipes
+
+"http://wiki.github.com/meskyanichi/backup/capistrano-recipes":http://wiki.github.com/meskyanichi/backup/capistrano-recipes
+
+
+h3. Capistrano, Whenever!
+
+"http://wiki.github.com/meskyanichi/backup/capistrano-whenever":http://wiki.github.com/meskyanichi/backup/capistrano-whenever
+
+
+h3. Understanding "The Backup Database"
+
+"http://wiki.github.com/meskyanichi/backup/the-backup-database":http://wiki.github.com/meskyanichi/backup/the-backup-database
+
+
+h3. Trouble Shooting
+
+"http://wiki.github.com/meskyanichi/backup/troubleshooting":http://wiki.github.com/meskyanichi/backup/troubleshooting
+
+
+h3. Requirements
+
+"http://wiki.github.com/meskyanichi/backup/requirements":http://wiki.github.com/meskyanichi/backup/requirements
+
+
+h3. Resources
+
+"http://wiki.github.com/meskyanichi/backup/resources":http://wiki.github.com/meskyanichi/backup/resources
+
+
+h3. Requests
+
+If anyone has any requests, please send me a message!
+
+
+h3. Suggestions?
+
+Send me a message! Fork the project!
+
+
+h3. Found a Bug?
+
+"http://github.com/meskyanichi/backup/issues":http://github.com/meskyanichi/backup/issues
+
+
+h3. Copyright
+
+Copyright (c) 2009 Michael van Rooijen | Final Creation. ("http://final-creation.com":http://final-creation.com) See LICENSE for details.

data/Rakefile

@@ -7,19 +7,19 @@ begin
     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 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 database (soon PostgreSQL and possibly more) and Archives (any files or folders)
-                          to "Amazon S3" or "any remotely accessible server using SCP". Backup handles: Compression, Archiving, Encryption and Backup Cleaning.
+                        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.
                         }
                         
     gem.email = "meskyan@gmail.com"
-    gem.homepage = ""
+    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.files.include 'generators/**/*'
-#    gem.files.include 'lib/**/*'
+    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"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"

data/VERSION

@@ -1 +1 @@
-2.1.2
+2.2.0

data/backup.gemspec

@@ -5,26 +5,28 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "2.1.2"
+  s.version = "2.2.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-01}
+  s.date = %q{2009-12-03}
   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 database (soon PostgreSQL and possibly more) and Archives (any files or folders)
-                          to "Amazon S3" or "any remotely accessible server using SCP". Backup handles: Compression, Archiving, Encryption and Backup Cleaning.
+                        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.
                         }
   s.email = %q{meskyan@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.textile"
   ]
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "LICENSE",
-     "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "backup.gemspec",
@@ -35,18 +37,25 @@ Gem::Specification.new do |s|
      "lib/backup.rb",
      "lib/backup/adapters/archive.rb",
      "lib/backup/adapters/base.rb",
+     "lib/backup/adapters/custom.rb",
      "lib/backup/adapters/mysql.rb",
+     "lib/backup/adapters/postgresql.rb",
      "lib/backup/configuration/adapter.rb",
+     "lib/backup/configuration/adapter_options.rb",
      "lib/backup/configuration/base.rb",
      "lib/backup/configuration/helpers.rb",
      "lib/backup/configuration/storage.rb",
      "lib/backup/connection/s3.rb",
+     "lib/backup/record/ftp.rb",
      "lib/backup/record/s3.rb",
      "lib/backup/record/scp.rb",
+     "lib/backup/record/sftp.rb",
+     "lib/backup/storage/ftp.rb",
      "lib/backup/storage/s3.rb",
-     "lib/backup/storage/scp.rb"
+     "lib/backup/storage/scp.rb",
+     "lib/backup/storage/sftp.rb"
   ]
-  s.homepage = %q{}
+  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}
@@ -60,15 +69,18 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<aws-s3>, [">= 0.6.2"])
       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"])
     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"])
     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"])
   end
 end
 

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

@@ -1,18 +1,45 @@
 
 # Backup Configuration File
 # 
-# Use the "backup" method to add another backup setting to the configuration file.
-# The argument before the "do" in (backup "argument" do) is called the "trigger".
+# 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 configuration
-# inside that block. To initialize the backup process, you invoke it with the following rake task:
+# 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
 
@@ -22,9 +49,17 @@
 backup 'mysql-backup-s3' do
   
   adapter :mysql do
-    user      'user'
-    password  'password'
-    database  'database'
+    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
@@ -40,21 +75,76 @@ end
 
 
 # Initialize with:
-#   rake backup:run trigger='mysql-backup-s3'
-backup 'archive-backup-scp' do
+#   rake backup:run trigger='postgresql-backup-s3'
+backup 'postgresql-backup-scp' do
   
-  adapter :archive do
-    files ["#{RAILS_ROOT}/log", "#{RAILS_ROOT}/public/assets"]
+  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/archive/'
+    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 ["#{RAILS_ROOT}/log", "#{RAILS_ROOT}/db"]
+    # files "#{RAILS_ROOT}/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