s3_db_assets_backup 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,12 +1,14 @@
 = S3DbAssetsBackup
 
-Generates rake tasks for backing up your database and public folder (which should also contain any uploaded assets) to an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This script is "very largly based on" the following (http://www.magnionlabs.com/2009/7/7/db-backups).
+Generates rake tasks for backing up and restoring your database and public folder (which should also contain any uploaded assets) to and from an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This plugin is based on (http://www.magnionlabs.com/2009/7/7/db-backups).
 
 == Install
 
   script/plugin install git://github.com/randomutterings/s3_db_assets_backup.git
-  
-Edit config/assets_backup_config.yml with your aws credentials.
+
+or
+
+  gem install s3_db_assets_backup
 
 Install aws-s3 library
 
@@ -14,46 +16,50 @@ Install aws-s3 library
   
 Create the backup rake tasks, config file, and initializer.
 
-  script/generate assets_backup
+  script/generate s3_backup
+
+Edit config/assets_backup_config.yml with your aws credentials.
+
+== Usage
 
 Backup the production database.
 
   rake db:backup RAILS_ENV=production
 
+Restore the production database (you will be prompted to select an existing backup)
+
+  rake db:restore RAILS_ENV=production
+
 Backup the public folder
 
   rake assets:backup
 
-Optionally setup cron to do your backups with the following crontab
-
-  # Full backup every Wednesday at 11:01
-  1 23 * * 3  cd /path/to/your/project && /var/lib/gems/1.8/bin/rake db:backup RAILS_ENV=production
-  1 23 * * 3  cd /path/to/your/project && /var/lib/gems/1.8/bin/rake assets:backup
+Restore the public folder (you will be prompted to select an existing backup)
 
-If you ever need to restore the production database, use the tool of your choice to download the backup from S3 and run.
+  rake assets:restore
 
-  gzip -dc production_dump-YYYY-MM-DD_HH-MM-SS.sql.gz | mysql -u root -p <production database>
+Optionally setup cron to do your backups with the following crontab
+  
+  # db backup every day at 11:01
+  1 23 * * *  cd /path/to/your/project && /var/lib/gems/1.8/bin/rake db:backup RAILS_ENV=production
+  
+  # asset backup every wednesday at 11:30
+  30 23 * * 3  cd /path/to/your/project && /var/lib/gems/1.8/bin/rake assets:backup
   
 == Troubleshooting and FAQs
 
-<b>I get "cannot create ./tmp/production_dump-YYYY-MM-DD_HH-MM-SS.sql.gz: Directory nonexistent" when running the database backup to S3</b>
+<b>I get "cannot create ./tmp/production_dump-YYYY-MM-DD-HH-MM-SS.sql.gz: Directory nonexistent" when running the database backup to S3</b>
 
-You need to create a tmp directory in the root.
+You need to create a tmp directory in the project root.
 
   mkdir tmp
 
-<b>Another problem?</b>
-
-Make sure you're using Rails 2.3.5.
-
-
 == Found a bug?
 
-If you are having a problem with the site, first look at the FAQs above. If you still cannot resolve it, please submit an issue here.
+If you are having a problem with the plugin, first look at the FAQs above. If you still cannot resolve it, please submit an issue here.
 
 http://github.com/randomutterings/s3_db_assets_backup/issues
 
-
 == Rails 3
 
 This project does not yet officially work with Rails 3.

data/generators/{assets_backup → s3_backup}/USAGE

@@ -2,7 +2,7 @@ Description:
     generates backup rake tasks, config yaml file, and initializer
 
 Example:
-    ./script/generate assets_backup
+    ./script/generate s3_backup
 
     This will create:
         lib/tasks/assets_backup.rake

data/generators/{assets_backup/assets_backup_generator.rb → s3_backup/s3_backup_generator.rb}

@@ -1,4 +1,4 @@
-class AssetsBackupGenerator < Rails::Generator::Base
+class S3BackupGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       m.file "assets_backup_config.yml", "config/assets_backup_config.yml"

data/generators/s3_backup/templates/assets_backup.rake

@@ -0,0 +1,75 @@
+require 'find'
+require 'ftools'
+require 'aws/s3'
+
+namespace :assets do
+  desc "Backup everything in the public folder." 
+  task :backup => [:environment] do
+    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
+    BUCKET = APP_CONFIG['bucket']
+
+    datestamp = Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+    base_path = ENV["RAILS_ROOT"] || "." 
+    file_name = "assets-#{datestamp}.tgz" 
+    backup_file = File.join(base_path, "tmp", file_name)
+    sh "tar -cvzpf #{backup_file} public"
+    AWS::S3::S3Object.store(file_name, open(backup_file), BUCKET)
+    puts "Created backup: #{file_name}" 
+    FileUtils.rm_rf(backup_file)
+
+    bucket = AWS::S3::Bucket.find(BUCKET)
+    all_backups = bucket.objects.select { |f| f.key.match(/assets/) }.sort { |a,b| a.key <=> b.key }.reverse
+    max_backups = APP_CONFIG['assets_backups_to_keep'].to_i || 28
+    unwanted_backups = all_backups[max_backups..-1] || []
+    for unwanted_backup in unwanted_backups
+      unwanted_backup.delete
+      puts "deleted #{unwanted_backup.key}" 
+    end
+    puts "Deleted #{unwanted_backups.length} backups, #{all_backups.length - unwanted_backups.length} backups available" 
+  end
+end
+
+namespace :assets do
+  desc "Restore the public folder from an available backup." 
+  task :restore => [:environment] do
+    base_path = ENV["RAILS_ROOT"] || "." 
+    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
+    bucket_name = APP_CONFIG['bucket']
+    backups = AWS::S3::Bucket.objects(bucket_name)
+    if backups.size == 0
+      puts "no backups available, check your settings in config/assets_backup_config.yml"
+    else
+      puts "#{backups.size} backups are available..."
+      counter = 0
+      backups.each do |backup|
+        puts "[#{counter}] #{backup.key}"
+        counter += 1
+      end
+      if backups.size == 1
+        puts "Which backup should we restore? [0]"
+      else
+        puts "Which backup should we restore? [0-#{backups.size - 1}]"
+      end
+      STDOUT.flush()
+      selected = STDIN.gets.chomp.to_i
+      if backups.at(selected).nil?
+        puts "Backup not found, aborting"
+      else
+        file_name = backups.at(selected).key
+        backup_file = File.join(base_path, file_name)
+        destination = File.join(base_path, "public")
+        puts "downloading backup..."
+        open(backup_file, 'w') do |file|
+          AWS::S3::S3Object.stream(file_name, bucket_name) do |chunk|
+            file.write chunk
+          end
+        end
+        FileUtils.remove_dir(destination)
+        sh "tar zxfv #{backup_file}"
+        puts "cleaning up..."
+        FileUtils.rm_rf(backup_file)
+        puts "Finished"
+      end
+    end
+  end
+end

data/generators/s3_backup/templates/db_backup.rake

@@ -0,0 +1,76 @@
+require 'find'
+require 'ftools'
+require 'aws/s3'
+
+namespace :db do
+  desc "Backup the database to a file. Options: RAILS_ENV=production" 
+  task :backup => [:environment] do
+    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
+    BUCKET = APP_CONFIG['bucket']
+
+    datestamp = Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+    base_path = ENV["RAILS_ROOT"] || "." 
+    file_name = "#{RAILS_ENV}_dump-#{datestamp}.sql.gz" 
+    backup_file = File.join(base_path, "tmp", file_name)
+    db_config = ActiveRecord::Base.configurations[RAILS_ENV]
+    sh "mysqldump -u #{db_config['username']} -p#{db_config['password']} -Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE #{db_config['database']} | gzip -c > #{backup_file}" 
+    AWS::S3::S3Object.store(file_name, open(backup_file), BUCKET)
+    puts "Created backup: #{file_name}" 
+    FileUtils.rm_rf(backup_file)
+
+    bucket = AWS::S3::Bucket.find(BUCKET)
+    all_backups = bucket.objects.select { |f| f.key.match(/dump/) }.sort { |a,b| a.key <=> b.key }.reverse
+    max_backups = APP_CONFIG['database_backups_to_keep'].to_i || 28
+    unwanted_backups = all_backups[max_backups..-1] || []
+    for unwanted_backup in unwanted_backups
+      unwanted_backup.delete
+      puts "deleted #{unwanted_backup.key}" 
+    end
+    puts "Deleted #{unwanted_backups.length} backups, #{all_backups.length - unwanted_backups.length} backups available" 
+  end
+end
+
+namespace :db do
+  desc "Restore the database from an available backup. Options: RAILS_ENV=production" 
+  task :restore => [:environment] do
+    base_path = ENV["RAILS_ROOT"] || "." 
+    db_config = ActiveRecord::Base.configurations[RAILS_ENV]
+    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
+    bucket_name = APP_CONFIG['bucket']
+    backups = AWS::S3::Bucket.objects(bucket_name)
+    if backups.size == 0
+      puts "no backups available, check your settings in config/assets_backup_config.yml"
+    else
+      puts "#{backups.size} backups are available..."
+      counter = 0
+      backups.each do |backup|
+        puts "[#{counter}] #{backup.key}"
+        counter += 1
+      end
+      if backups.size == 1
+        puts "Which backup should we restore? [0]"
+      else
+        puts "Which backup should we restore? [0-#{backups.size - 1}]"
+      end
+      STDOUT.flush()
+      selected = STDIN.gets.chomp.to_i
+      if backups.at(selected).nil?
+        puts "Backup not found, aborting"
+      else
+        file_name = backups.at(selected).key
+        backup_file = File.join(base_path, "tmp", file_name)
+        puts "downloading backup..."
+        open(backup_file, 'w') do |file|
+          AWS::S3::S3Object.stream(file_name, bucket_name) do |chunk|
+            file.write chunk
+          end
+        end
+        puts "download complete, restoring to #{RAILS_ENV} database"
+        sh "gzip -dc #{backup_file} | mysql -u #{db_config['username']} -p#{db_config['password']} #{db_config['database']}"
+        puts "cleaning up..."
+        FileUtils.rm_rf(backup_file)
+        puts "Finished"
+      end
+    end
+  end
+end

data/s3_db_assets_backup.gemspec

@@ -9,13 +9,13 @@ PKG_FILES = FileList[
 
 spec = Gem::Specification.new do |s|
   s.name = "s3_db_assets_backup"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
   s.author = "Chris Barnes"
   s.email = "randomutterings@gmail.com"
   s.homepage = "http://www.randomutterings.com/projects/s3_db_assets_backup"
   s.platform = Gem::Platform::RUBY
-  s.summary = "Generates rake tasks for backing up db and public folder to an existing S3 bucket"
-  s.description = "Generates rake tasks for backing up your database and public folder (which should also contain any uploaded assets) to an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This script is 'very largly based on' the following (http://www.magnionlabs.com/2009/7/7/db-backups)."
+  s.summary = "Generates rake tasks for backing up and restoring db and public folder to and from an existing S3 bucket"
+  s.description = "Generates rake tasks for backing up and restoring your database and public folder (which should also contain any uploaded assets) to and from an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This gem is based on (http://www.magnionlabs.com/2009/7/7/db-backups)."
   s.files = PKG_FILES.to_a
   s.extra_rdoc_files = ["README.rdoc"]
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Chris Barnes
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 -04:00
+date: 2010-04-18 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Generates rake tasks for backing up your database and public folder (which should also contain any uploaded assets) to an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This script is 'very largly based on' the following (http://www.magnionlabs.com/2009/7/7/db-backups).
+description: Generates rake tasks for backing up and restoring your database and public folder (which should also contain any uploaded assets) to and from an existing bucket in your Amazon S3 account.  The rake tasks compresses and uploads each backup with a time stamp and the config file allows you to set how many of each backup to keep.  This gem is based on (http://www.magnionlabs.com/2009/7/7/db-backups).
 email: randomutterings@gmail.com
 executables: []
 
@@ -30,14 +30,13 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
-- s3_db_assets_backup-0.0.3.gem
 - s3_db_assets_backup.gemspec
-- generators/assets_backup/assets_backup_generator.rb
-- generators/assets_backup/templates/assets_backup.rake
-- generators/assets_backup/templates/assets_backup_config.yml
-- generators/assets_backup/templates/db_backup.rake
-- generators/assets_backup/templates/load_assets_backup_config.rb
-- generators/assets_backup/USAGE
+- generators/s3_backup/s3_backup_generator.rb
+- generators/s3_backup/templates/assets_backup.rake
+- generators/s3_backup/templates/assets_backup_config.yml
+- generators/s3_backup/templates/db_backup.rake
+- generators/s3_backup/templates/load_assets_backup_config.rb
+- generators/s3_backup/USAGE
 - lib/s3_db_assets_backup.rb
 - test/s3_db_assets_backup_test.rb
 - test/test_helper.rb
@@ -70,6 +69,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Generates rake tasks for backing up db and public folder to an existing S3 bucket
+summary: Generates rake tasks for backing up and restoring db and public folder to and from an existing S3 bucket
 test_files: []
 

data/generators/assets_backup/templates/assets_backup.rake

@@ -1,30 +0,0 @@
-require 'find'
-require 'ftools'
-require 'aws/s3'
-
-namespace :assets do
-  desc "Backup everything in the public folder." 
-  task :backup => [:environment] do
-    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
-    BUCKET = APP_CONFIG['bucket']
-
-    datestamp = Time.now.strftime("%Y-%m-%d_%H-%M-%S")
-    base_path = ENV["RAILS_ROOT"] || "." 
-    file_name = "#{RAILS_ENV}_assets-#{datestamp}.tgz" 
-    backup_file = File.join(base_path, "tmp", file_name)
-    sh "tar -cvzpf #{backup_file} public"
-    AWS::S3::S3Object.store(file_name, open(backup_file), BUCKET)
-    puts "Created backup: #{file_name}" 
-    FileUtils.rm_rf(backup_file)
-
-    bucket = AWS::S3::Bucket.find(BUCKET)
-    all_backups = bucket.objects.select { |f| f.key.match(/assets/) }.sort { |a,b| a.key <=> b.key }.reverse
-    max_backups = APP_CONFIG['assets_backups_to_keep'].to_i || 28
-    unwanted_backups = all_backups[max_backups..-1] || []
-    for unwanted_backup in unwanted_backups
-      unwanted_backup.delete
-      puts "deleted #{unwanted_backup.key}" 
-    end
-    puts "Deleted #{unwanted_backups.length} backups, #{all_backups.length - unwanted_backups.length} backups available" 
-  end
-end

data/generators/assets_backup/templates/db_backup.rake

@@ -1,31 +0,0 @@
-require 'find'
-require 'ftools'
-require 'aws/s3'
-
-namespace :db do
-  desc "Backup the database to a file. Options: RAILS_ENV=production" 
-  task :backup => [:environment] do
-    AWS::S3::Base.establish_connection!(:access_key_id => APP_CONFIG['access_key_id'], :secret_access_key => APP_CONFIG['secret_access_key'])
-    BUCKET = APP_CONFIG['bucket']
-
-    datestamp = Time.now.strftime("%Y-%m-%d_%H-%M-%S")
-    base_path = ENV["RAILS_ROOT"] || "." 
-    file_name = "#{RAILS_ENV}_dump-#{datestamp}.sql.gz" 
-    backup_file = File.join(base_path, "tmp", file_name)
-    db_config = ActiveRecord::Base.configurations[RAILS_ENV]
-    sh "mysqldump -u #{db_config['username']} -p#{db_config['password']} -Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE #{db_config['database']} | gzip -c > #{backup_file}" 
-    AWS::S3::S3Object.store(file_name, open(backup_file), BUCKET)
-    puts "Created backup: #{file_name}" 
-    FileUtils.rm_rf(backup_file)
-
-    bucket = AWS::S3::Bucket.find(BUCKET)
-    all_backups = bucket.objects.select { |f| f.key.match(/dump/) }.sort { |a,b| a.key <=> b.key }.reverse
-    max_backups = APP_CONFIG['database_backups_to_keep'].to_i || 28
-    unwanted_backups = all_backups[max_backups..-1] || []
-    for unwanted_backup in unwanted_backups
-      unwanted_backup.delete
-      puts "deleted #{unwanted_backup.key}" 
-    end
-    puts "Deleted #{unwanted_backups.length} backups, #{all_backups.length - unwanted_backups.length} backups available" 
-  end
-end