s3_db_assets_backup 0.1.5 → 0.2.0

data/README.rdoc

@@ -1,13 +1,12 @@
 = S3DbAssetsBackup
 
-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).
+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.  Additionally, the plugin can be configured to generate and send a backup status report via email.
 
 == Install
 
-Edit your Gemfile to include the following
+Edit your Gemfile to include
 
   gem "s3_db_assets_backup"
-  gem "aws-s3"
   
 Then run
 
@@ -17,7 +16,7 @@ Create the config file.
 
   rails g s3_backup
 
-Edit config/s3_backup_config.yml with your aws credentials.
+Edit config/s3_backup_config.yml with your aws credentials and email settings
 
 Rails 2.x (switch to the rails_2.x branch)
 
@@ -39,21 +38,37 @@ Restore the public folder (you will be prompted to select an existing backup)
 
   rake assets:restore
 
-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
+Send a backup status report to the configured email address
+
+  rake db:backup:status
+
+== Scheduling with whenever
+
+Optionally, you can use "whenever" to automate backups and status reports. 
+
+Add whenever to your Gemfile
+
+  gem 'whenever', :require => false
+
+To create the whenever config file, run the following command from the app root directory.
+
+  wheneverize .
+
+Edit config/schedule.rb to schedule the rake tasks.
+
+  every 12.hours do
+    rake "db:backup"
+  end
   
-Running RVM and Ruby 1.9.2, I had to setup cron like this (rvm is loaded in .profile).
+  every 4.days do
+    rake "db:backup:status"
+  end
 
-  SHELL=/bin/bash
-  HOME=/home/ubuntu
+Then run the following command to write the config to your cron file
 
-  # db backup every day at 11:01
-  01 23 * * * source ~/.profile && cd /home/ubuntu/cpos && rake db:backup RAILS_ENV=production
+  whenever -w
+
+For more information on the whenever gem, visit https://github.com/javan/whenever
   
 == Troubleshooting and FAQs
 
@@ -67,6 +82,10 @@ You need to create a tmp directory in the project root.
 
 You need to create the S3 bucket you're trying to backup to.
 
+<b>My crontab doesn't run in development.</b>
+
+Deving on a mac?  Cron is deprecated in Mountain Lion.
+
 == Found a bug?
 
 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.

data/config/initializers/load_s3_backup_config.rb

@@ -1,6 +1,7 @@
 config_file = "#{Rails.root.to_s}/config/s3_backup_config.yml"
 if FileTest.exists?(config_file)
   S3_CONFIG = YAML.load_file(config_file)[Rails.env].symbolize_keys
+  EMAIL_CONFIG = YAML.load_file(config_file)["email_config"].symbolize_keys
 else
   puts "WARNING: Can't find s3_backup_config.yml"
-end
+end 

data/lib/generators/s3_backup/templates/s3_backup_config.yml

@@ -22,4 +22,19 @@ production:
   # how many backups would you like to keep for
   # the database and public folder
   database_backups_to_keep: 8
-  assets_backups_to_keep: 3
+  assets_backups_to_keep: 3
+
+email_config:
+  # email address that will receive email reports
+  to: report_receiver@domain.com
+
+  # server settings that Pony will use to send emails
+  via: :smtp
+  subject: <MYSITE> Backup Report
+  address: smtp_server_address
+  port: '587'
+  enable_starttls_auto: true
+  user_name: email_user_name
+  password: email_password
+  authentication: :plain
+  domain: HELO

data/lib/s3_db_assets_backup/railties/db_backup.rake

@@ -1,23 +1,32 @@
 require 'find'
 require 'fileutils'
 require 'aws/s3'
+require 'pony'
 
 namespace :db do
   desc "Backup the database to a file. Options: RAILS_ENV=production" 
   task :backup => [:environment] do
+    # Establish connection to Amazon S3 and fetch the bucket name from the config
     AWS::S3::Base.establish_connection!(:access_key_id => S3_CONFIG[:access_key_id], :secret_access_key => S3_CONFIG[:secret_access_key])
     BUCKET = S3_CONFIG[:bucket]
 
+    # Build the backup directory and filename
     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)
+
+    # Load database configuration and dump the sql database to the backup file
     db_config = ActiveRecord::Base.configurations[Rails.env]
     sh "mysqldump -u #{db_config['username']} -p#{db_config['password']} --default-character-set=latin1 -N -Q --add-drop-table #{db_config['database']} | gzip -c > #{backup_file}" 
+    
+    # Upload the backup file to Amazon and remove the file from the local filesystem
     AWS::S3::S3Object.store(file_name, open(backup_file), BUCKET)
     puts "Created backup: #{file_name}" 
     FileUtils.rm_rf(backup_file)
 
+    # Check the bucket for the number of backups and remove the oldest backups if
+    # it is over the number of backups sets configured
     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 = S3_CONFIG[:database_backups_to_keep].to_i || 28
@@ -73,4 +82,37 @@ namespace :db do
       end
     end
   end
-end
+end
+
+namespace :db do
+  namespace :backup do
+    desc "Email a report of current backups."
+    task :status => [:environment] do
+      AWS::S3::Base.establish_connection!(:access_key_id => S3_CONFIG[:access_key_id], :secret_access_key => S3_CONFIG[:secret_access_key])
+      BUCKET = S3_CONFIG[:bucket]
+      bucket = AWS::S3::Bucket.find(BUCKET)
+      all_backups = bucket.objects.select { |f| f.key.match(/dump/) }.sort { |a,b| a.key <=> b.key }.reverse
+
+      message = "Archive contains the following backups:\n\n"
+      all_backups.each { |f| message << f.key + "\n" }
+      email = EMAIL_CONFIG
+
+      Pony.mail(  
+        :to => email[:to], 
+        :via => email[:via], 
+        :subject => email[:subject],
+        :body => message,
+
+        :via_options => {
+          :address => email[:address],
+          :port => email[:port],
+          :enable_starttls_auto => email[:enable_starttls_auto],
+          :user_name => email[:user_name],
+          :password => email[:password],
+          :authentication => email[:authentication],
+          :domain => email[:domain]
+        }
+      )
+    end
+  end
+end

metadata

@@ -2,18 +2,40 @@
 name: s3_db_assets_backup
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chris Barnes
+- Michael Burk
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-10-09 00:00:00 Z
-dependencies: []
-
-description: Generates rake tasks for backing up and restoring your database and public folder (which should also contain any user 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).
+date: 2012-11-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id002
+description: Generates rake tasks for backing up and restoring your database and public folder (which should also contain any user 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.  Additionally, the plugin can be configured to generate and send a backup status report via email.
 email: chris@randomutterings.com
 executables: []
 
@@ -54,10 +76,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Generates rake tasks for backing up and restoring db and public folder to and from an existing S3 bucket
+summary: Rake tasks for backing up and restoring db and public folder to and from an existing S3 bucket with email notifications.
 test_files: []
 
 has_rdoc: