backup 1.3.4 → 2.0.0

data/README.rdoc

@@ -1,98 +1,167 @@
 = Backup
 
-== What is "Backup"?
+== A Backup Ruby Gem for Rails
 
-“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!
+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 just updated to version 2.0.0(+)!
 
-=== Backup makes use of two storage methods:
+This was a major update (read below) and a lot of stuff has changed since version 1.x.x!
+Notable changes:
+* 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!
 
-- Amazon S3
-- Any Remote Server You Can Access Through "SSH"
+== HAVING TROUBLE WITH VERSION "2.0.0"?
 
+I have encountered and issue with Backup version "2.0.0" after the release. This issue has been addressed and patched to both version 2.0.0 as well as version 2.1.0. This involved the use of the SQLite3 database, which is no longer utilized by Backup. So for people that are going to install Backup version 2.0.0 (or later) right now, this issue no longer applies. However, for users that installed Backup 2.0.0 pretty early after the release, this might cause problems.
 
-=== Currently it supports these adapters:
+==== If you are running Backup version "2.0.0", please run the following to ensure you have a "good" install.
+
+  sudo gem uninstall backup -v 2.0.0
+  sudo gem install backup
+
+This will obviously uninstall your currently installed backup version 2.0.0 and install the latest version of Backup.
+Do this and you're set! My apologies for the initial hassle! ;)
+
+
+=== Refer to the Getting Started page to get up and running incredibly fast with "Backup 2"!
+http://wiki.github.com/meskyanichi/backup/getting-started
 
-- SQLite3
-- MySQL
-- Assets/Folders (and Sub Folders) of Assets (Think of: Documents, Images, Etc.)
 
+==== 100% Rewrite!
+This was a 100% rewrite of the gem. So if you discover any issues with it, please report them here so I can fix them as soon as possible!
+http://github.com/meskyanichi/backup/issues
+
+==== Coded Quickly!
+I've been going all hardcore on this one, building it in a very small amount of time compared to the first version. As far as I can see it fully works,
+but it is of course likely that you or anyone else might encounter some issues. Please report them if you do.
+
+==== Updated The Wiki Quickly!
+So when I finished crafting the Backup Gem, I immediately started working on the Wiki and, as for the gem, updated it very quickly on a late sunday night.
+I will come back to the Wiki and see if I can improve it even more next weekend when I have more time. I just wanted to get the essentials built in and I think it worked out pretty nicely regardless. If you have any questions though, don't bother asking!
 
-=== Your database type not on the list?
+==== More to come!
+Yes, Backup currently supports the most used backup adapters: MySQL and Archive(Files, Folders).
+It Archives, Compresses, Encrypts and cleans up old backups if needed.
 
-- Custom
+I do have plans for adding the PostgreSQL and Custom adapter for version 2 as well very soon!
+If there are requests for more/other adapters, I'm all ears! Enjoy.
 
-Custom enables you to, regardless whether "Backup" supports your database type or not, to still enable you to make backups and benefit from the other features!
-There is just one thing you must do yourself inside one of the configuration files that Backup provides, and that is (assuming you know how to create a SQL dump through the command line for your database type), to actually create that command. If you don't how, you can probably find out how when searching through "google". Usually, it takes just "one line" to make a SQL dump, regardless of what database type we're talking about. So now, if you know that particular command to generate that SQL dump for your database, you're practically set to benefit from "Backup"!
 
-==== Again, whether "Backup" has an adapter that supports your database or not,
-==== if you are able to generate the SQL dump through command line, you will still benefit from the following:
+== (Current) Backup's Capabilities
+More to be added!
 
-- Backup Archiving
-- Backup Compression
-- Backup Encryption (see below)
-- Backup Cleaning (see below)
-- Backup Transfer to S3
-- Backup Transfer through SSH(SCP) to any remote server
+=== Storage Methods
 
-The only difference is that you now have to know how to produce a SQL dump yourself. Here's an example of the PostgreSQL command:
+- Amazon (S3)
+- Remote Server (SCP)
 
-  pg_dump -U {user-name} {source_db} -f {dumpfilename.sql}
 
-So, after you experimented using the command you found, and see it works, you just copy that 'working command' inside the configuration files in a special section,
-and you're set to use it with "Backup" and benefit from the other features!
+=== Adapters
+
+- MySQL
+- Archive (Any physical files/folders)
+
+(More will be added later, such as PostgreSQL and Custom)
 
+
+=== 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.
  
 
 === Encryption
 
-Backup also provides encryption. Adding a single line to one of the configuration files will enable encryption for your backups!
-This is what that line looks like:
-
-  encrypt: my_secret_password
+==== Backup supports a simple form of encryption.
+This is optional. All adapters support encryption. This is very simple to enable. Just add the following method inside on of your backup settings
+and it will encrypt it with the specified password:
 
-Now all backups will be encrypted with the specified password.
+  encrypt_with_password "mypassword"
 
 
 === Backup Cleaning
 
-Backup has the ability to clean up old backup files. If you don't feel the need to have more than 120 backups on your S3 account then you can easily specify so! It's as simple as adding this line to your configuration file. (or rather, uncommenting it)
+==== Backup supports backup cleaning.
+Backup Cleaning (which is optional) 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 by 20, when the 21st backup gets pushed to the storage location, the oldest version will automatically be destroyed.
 
-  keep_backups: 120 
+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.
 
-It will now automagically remove the oldest backup from for example, S3, when the 121st backup gets uploaded.
+To enable this you simply call the following method inside the desired "backup setting":
 
+  keep_backups 20
+  
+  
+=== Quick Example of a Single Backup Setting inside the Backup Configuration File
 
-== Why?
+  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".
 
-- 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 compression
-- I wanted it to support archiving
-- I wanted it to support encryption
-- I wanted to be able to store my files on my private backup server and on Amazon S3
-- I wanted it to be able to automatically remove old backups to keep S3/backup server costs low
+  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:
 
-==== Setting up Backup takes me about 1-2 minutes and it's really easy!
+  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.
 
-== Interested in trying out Backup?
+==== Runs the backup setting with the trigger "backup-logs"
+  rake backup:run trigger="backup-logs"
+
+==== Runs the backup setting with the trigger "backup-mysql"
+  rake backup:run trigger="backup-mysql"
 
-=== Check out the following Wiki pages:
+==== Runs the backup setting with the trigger "backup-assets"
+  rake backup:run trigger="backup-assets"
 
-=== Installation
+etc. etc. etc. etc. etc. etc...
 
-http://wiki.github.com/meskyanichi/backup/installation
 
 
+== Interested in trying out Backup?
+
+=== Check out the following Wiki pages to get up and running:
+
 === Getting started
 
 http://wiki.github.com/meskyanichi/backup/getting-started
 
 
+=== Backup Configuration File (All Adapters, Storage Methods and Options)
+
+http://wiki.github.com/meskyanichi/backup/configuration-file
+
+
 === Rake Tasks
 
 http://wiki.github.com/meskyanichi/backup/rake-tasks
@@ -135,20 +204,19 @@ http://wiki.github.com/meskyanichi/backup/resources
 
 === Requests
 
-If anyone wishes to see support for PostgreSQL or any other database format, please send me a message!
+If anyone has any requests, please send me a message!
 
 
 === Suggestions?
 
-Send me a message! Fork the project! Help out! :)
+Send me a message! Fork the project!
 
 
 === Found a Bug?
 
-Report it!
 http://github.com/meskyanichi/backup/issues
 
 
 === Copyright
 
-Copyright (c) 2009 Michael van Rooijen | Final Creation. See LICENSE for details.
+Copyright (c) 2009 Michael van Rooijen | Final Creation. (http://final-creation.com/) See LICENSE for details.

data/Rakefile

@@ -7,13 +7,9 @@ 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 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!
+                          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.
                         }
                         
     gem.email = "meskyan@gmail.com"
@@ -22,7 +18,6 @@ begin
     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 "sqlite3-ruby", ">= 1.2.5"
 #    gem.files.include 'generators/**/*'
 #    gem.files.include 'lib/**/*'
   end

data/VERSION

@@ -1 +1 @@
-1.3.4
+2.0.0

data/backup.gemspec

@@ -5,19 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "1.3.4"
+  s.version = "2.0.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-11-08}
+  s.date = %q{2009-12-01}
   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!
+                          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.
                         }
   s.email = %q{meskyan@gmail.com}
   s.extra_rdoc_files = [
@@ -32,30 +28,23 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "backup.gemspec",
-     "generators/backup_files/backup_files_generator.rb",
-     "generators/backup_files/templates/backup.sqlite3",
-     "generators/backup_files/templates/config.rake",
-     "generators/backup_files/templates/db.rake",
-     "generators/backup_files/templates/s3.rake",
-     "generators/backup_files/templates/s3.yml",
-     "generators/backup_files/templates/setup.rake",
-     "generators/backup_files/templates/ssh.rake",
-     "generators/backup_files/templates/ssh.yml",
+     "generators/backup/backup_generator.rb",
+     "generators/backup/templates/config/backup.rb",
+     "generators/backup/templates/migrations/create_backup_tables.rb",
+     "generators/backup/templates/tasks/backup.rake",
      "lib/backup.rb",
-     "lib/backup/adapter/assets.rb",
-     "lib/backup/adapter/custom.rb",
-     "lib/backup/adapter/mysql.rb",
-     "lib/backup/adapter/sqlite3.rb",
-     "lib/backup/backup_record/s3.rb",
-     "lib/backup/backup_record/ssh.rb",
-     "lib/backup/base.rb",
-     "lib/backup/connection/base.rb",
+     "lib/backup/adapters/archive.rb",
+     "lib/backup/adapters/base.rb",
+     "lib/backup/adapters/mysql.rb",
+     "lib/backup/configuration/adapter.rb",
+     "lib/backup/configuration/base.rb",
+     "lib/backup/configuration/helpers.rb",
+     "lib/backup/configuration/storage.rb",
      "lib/backup/connection/s3.rb",
-     "lib/backup/connection/ssh.rb",
-     "lib/backup/encrypt.rb",
-     "lib/backup/transfer/base.rb",
-     "lib/backup/transfer/s3.rb",
-     "lib/backup/transfer/ssh.rb"
+     "lib/backup/record/s3.rb",
+     "lib/backup/record/scp.rb",
+     "lib/backup/storage/s3.rb",
+     "lib/backup/storage/scp.rb"
   ]
   s.homepage = %q{}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -71,18 +60,15 @@ 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<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<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<sqlite3-ruby>, [">= 1.2.5"])
   end
 end
 

data/generators/backup/backup_generator.rb

@@ -0,0 +1,31 @@
+class BackupGenerator < Rails::Generator::Base
+
+  # This method gets initialized when the generator gets run.
+  # It will receive an array of arguments inside @args
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  # Processes the file generation/templating
+  # This will automatically be run after the initialize method
+  def manifest
+    record do |m|
+      
+      # Generates the Rake Tasks and Backup Database
+      m.directory "lib/tasks"
+      m.directory "lib/tasks/backup"
+      m.file      "tasks/backup.rake",        "lib/tasks/backup/backup.rake"
+
+      # Generates the configuration file
+      m.directory "config"
+      m.file      "config/backup.rb",         "config/backup.rb"
+      
+      # Generates the database migration file
+      m.migration_template                    "migrations/create_backup_tables.rb",
+                                              "db/migrate",
+                                              :migration_file_name => "create_backup_tables"
+      
+    end
+  end
+  
+end

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

@@ -0,0 +1,60 @@
+
+# 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".
+# 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:
+#
+#   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.
+# 
+# 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'
+  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
+
+
+# Initialize with:
+#   rake backup:run trigger='mysql-backup-s3'
+backup 'archive-backup-scp' do
+  
+  adapter :archive do
+    files ["#{RAILS_ROOT}/log", "#{RAILS_ROOT}/public/assets"]
+  end
+  
+  storage :scp do
+    ip        'example.com'
+    user      'user'
+    password  'password'
+    path      '/var/backups/archive/'
+  end
+
+  keep_backups :all
+  encrypt_with_password false
+  
+end