s3_db_assets_backup 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Barnes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,59 @@
+= 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)
+
+== Install
+
+  script/plugin install git://github.com/randomutterings/s3_db_assets_backup.git
+  
+Edit config/assets_backup_config.yml with your aws credentials.
+
+Install aws-s3 library
+
+  gem install aws-s3
+  
+Create the backup rake tasks, config file, and initializer.
+
+  script/generate assets_backup
+
+Backup the production database.
+
+  rake db:backup 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
+
+If you ever need to restore the production database, use the tool of your choice to download the backup from S3 and run.
+
+  gzip -dc production_dump-YYYY-MM-DD_HH-MM-SS.sql.gz | mysql -u root -p <production database>
+  
+== 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>
+
+You need to create a tmp directory in the 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.
+
+http://github.com/randomutterings/s3_db_assets_backup/issues
+
+
+== Rails 3
+
+This project does not yet officially work with Rails 3.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the s3_db_assets_backup plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the s3_db_assets_backup plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'S3DbAssetsBackup'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "s3_db_assets_backup"
+  s.version = "0.0.1"
+  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 S3 bucket"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/generators/assets_backup/USAGE

@@ -0,0 +1,11 @@
+Description:
+    generates backup rake tasks, config yaml file, and initializer
+
+Example:
+    ./script/generate assets_backup
+
+    This will create:
+        lib/tasks/assets_backup.rake
+        lib/tasks/db_backup.rake
+        config/assets_backup_config.yml
+        config/initializers/load_assets_backup_config.rb

data/generators/assets_backup/assets_backup_generator.rb

@@ -0,0 +1,10 @@
+class AssetsBackupGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "assets_backup_config.yml", "config/assets_backup_config.yml"
+      m.file "load_assets_backup_config.rb", "config/initializers/load_assets_backup_config.rb"
+      m.file "assets_backup.rake", "lib/tasks/assets_backup.rake"
+      m.file "db_backup.rake", "lib/tasks/db_backup.rake"
+    end
+  end
+end

data/generators/assets_backup/templates/assets_backup.rake

@@ -0,0 +1,30 @@
+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/assets_backup_config.yml

@@ -0,0 +1,11 @@
+# amazon aws credentials
+access_key_id: your-aws-access-key-id
+secret_access_key: your-aws-secret-access-key
+
+# bucket you would like to use for backups
+bucket: your_existing_s3_bucket
+
+# how many backups would you like to keep for
+# the database and public folder
+database_backups_to_keep: 8
+assets_backups_to_keep: 3

data/generators/assets_backup/templates/db_backup.rake

@@ -0,0 +1,31 @@
+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

data/generators/assets_backup/templates/load_assets_backup_config.rb

@@ -0,0 +1,6 @@
+config_file = "#{RAILS_ROOT}/config/assets_backup_config.yml"
+if FileTest.exists?(config_file)
+  APP_CONFIG = YAML.load_file(config_file)
+else
+  raise "Can't find assets_backup_config.yml"
+end

data/test/s3_db_assets_backup_test.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+class S3DbAssetsBackupTest < Test::Unit::TestCase
+
+  def setup
+    # creates all dirs down to initializers and tasks
+    FileUtils.mkdir_p(initializers_dir)
+    FileUtils.mkdir_p(tasks_dir)
+    Rails::Generator::Scripts::Generate.new.run(["assets_backup"], :destination => fake_rails_root)
+  end
+
+  def teardown
+    FileUtils.rm_r(fake_rails_root)
+  end
+
+  def test_generates_backup_config_yaml_file
+    assert_generated_file("config/assets_backup_config.yml")
+  end
+  
+  def test_generates_backup_config_initializer
+    assert_generated_file("config/initializers/load_assets_backup_config.rb")
+  end
+  
+  def test_generates_assets_backup_rake_task
+    assert_generated_file("lib/tasks/assets_backup.rake")
+  end
+  
+  def test_generates_db_backup_rake_task
+    assert_generated_file("lib/tasks/db_backup.rake")
+  end
+  
+  private
+
+    def fake_rails_root
+      File.join(File.dirname(__FILE__), 'rails_root')
+    end
+    
+    def config_dir
+      File.join(File.dirname(__FILE__), 'rails_root/config')
+    end
+    
+    def initializers_dir
+      File.join(File.dirname(__FILE__), 'rails_root/config/initializers')
+    end
+    
+    def tasks_dir
+      File.join(File.dirname(__FILE__), 'rails_root/lib/tasks')
+    end
+    
+    # Asserts that the given file was generated.
+    # The contents of the file is passed to a block.
+    def assert_generated_file(path)
+      assert_file_exists(path)
+      File.open("#{fake_rails_root}/#{path}") do |f|
+        yield f.read if block_given?
+      end
+    end
+
+    # asserts that the given file exists
+    def assert_file_exists(path)
+      assert File.exist?("#{fake_rails_root}/#{path}"),
+        "The file '#{fake_rails_root}/#{path}' should exist"
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: s3_db_assets_backup
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Barnes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: randomutterings@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- 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
+- test/s3_db_assets_backup_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://www.randomutterings.com/projects/s3_db_assets_backup
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generates rake tasks for backing up db and public folder to S3 bucket
+test_files: []
+