backup2s3 0.2.4 → 0.2.5

data/README

@@ -1,52 +1,43 @@
-SETUP:
+SETUP
 
-  1. Install the gem
-  gem install backup2s3
+    1. Install the gem
+        gem install backup2s3
 
-  
-  2. Add the below code to config/environment.rb
-  config.gem "backup2s3", :version => ">= 0.2.3"
 
+    2. Run the generator in your application root directory
+        script/generate backup2s3
 
-  3. Run the generator in your application root directory
-  script/generate backup2s3
 
+    3. Change your settings in config/backup2s3.yml  
 
-  4. Change your settings in config/backup2s3.yml  
 
 
-USAGE:
 
-  2. Get started.
+USAGE (rake tasks)
+    
 
-      Backup tasks
+    Create -- Creates a backup and moves it to S3
+           -- comment - Add notes here to mark specific backups (optional)
 
-        Create -- Creates a backup and moves it to S3
-               -- comment - Add notes here to mark specific backups (optional)
+      rake backup2s3:backup:create
+      rake backup2s3:backup:create  comment='put notes about backup here if needed'
 
-          rake backup2s3:backup:create
-          rake backup2s3:backup:create  comment='put notes about backup here if needed'
 
+    Delete  -- Deletes the specified backup
+            -- id - Backup to delete, backup ids will be found using List
 
-        Delete  -- Deletes the specific backup
-                -- id - Backup to delete, backup ids will be found using List
+      rake backup2s3:backup:delete  id='20100913180541'
 
-          rake backup2s3:backup:delete  id='20100913180541'
 
+    List    -- Lists all backups that are currently on S3
+            -- details - Setting details to true will display backup file names
+                         and backup comments (optional)
 
-        List    -- Lists all backups that are currently on S3
-                -- details - Setting details to true will display backup file names
-                             and backup comments (optional)
+      rake backup2s3:backup:list
+      rake backup2s3:backup:list  details=true
 
-          rake backup2s3:backup:list
-          rake backup2s3:backup:list  details=true
 
+    Restore -- Restores a specific backup
+            -- id - Backup to restore, backup ids will be found using List task
 
-        Restore -- Restores a specific backup
-                -- id - Backup to restore, backup ids will be found using List
-
-          rake backup2s3:backup:restore id='20100913180541'
-
-      Some handy tasks
-
-        rake backup2s3:statistics     - Shows you the size of your DB
+      rake backup2s3:backup:restore id='20100913180541'

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('backup2s3', '0.2.4') do |p|
+Echoe.new('backup2s3', '0.2.5') do |p|
   p.description = "Backup2s3 is a gem that performs database and application backups and stores this data on Amazon S3."
   p.summary     = "Backup2s3 is a gem that creates, deletes and restores db and application backups."
   p.url         = "http://github.com/aricwalker/backup2s3"

data/backup2s3.gemspec

@@ -2,24 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup2s3}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aric Walker"]
-  s.date = %q{2011-03-18}
+  s.authors = [%q{Aric Walker}]
+  s.date = %q{2011-08-15}
   s.description = %q{Backup2s3 is a gem that performs database and application backups and stores this data on Amazon S3.}
   s.email = %q{aric@truespire.com}
-  s.extra_rdoc_files = ["CHANGELOG", "README", "lib/adapters/s3_adapter.rb", "lib/adapters/s3cmd_adapter.rb", "lib/backup2s3.rb", "lib/backup_management/backup.rb", "lib/backup_management/backup_manager.rb", "lib/system.rb"]
-  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "generators/backup2s3/USAGE", "generators/backup2s3/backup2s3_generator.rb", "generators/backup2s3/templates/backup2s3.rake", "generators/backup2s3/templates/backup2s3.yml", "init.rb", "lib/adapters/s3_adapter.rb", "lib/adapters/s3cmd_adapter.rb", "lib/backup2s3.rb", "lib/backup_management/backup.rb", "lib/backup_management/backup_manager.rb", "lib/system.rb", "backup2s3.gemspec"]
+  s.extra_rdoc_files = [%q{CHANGELOG}, %q{README}, %q{lib/adapters/s3_adapter.rb}, %q{lib/adapters/s3cmd_adapter.rb}, %q{lib/backup2s3.rb}, %q{lib/backup_management/backup.rb}, %q{lib/backup_management/backup_manager.rb}, %q{lib/system.rb}]
+  s.files = [%q{CHANGELOG}, %q{Manifest}, %q{README}, %q{Rakefile}, %q{generators/backup2s3/USAGE}, %q{generators/backup2s3/backup2s3_generator.rb}, %q{generators/backup2s3/templates/backup2s3.rake}, %q{generators/backup2s3/templates/backup2s3.yml}, %q{init.rb}, %q{lib/adapters/s3_adapter.rb}, %q{lib/adapters/s3cmd_adapter.rb}, %q{lib/backup2s3.rb}, %q{lib/backup_management/backup.rb}, %q{lib/backup_management/backup_manager.rb}, %q{lib/system.rb}, %q{backup2s3.gemspec}]
   s.homepage = %q{http://github.com/aricwalker/backup2s3}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backup2s3", "--main", "README"]
-  s.require_paths = ["lib"]
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Backup2s3}, %q{--main}, %q{README}]
+  s.require_paths = [%q{lib}]
   s.rubyforge_project = %q{backup2s3}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{Backup2s3 is a gem that creates, deletes and restores db and application backups.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/generators/backup2s3/backup2s3_generator.rb

@@ -35,7 +35,7 @@ class Backup2s3Generator < Rails::Generator::Base
           rake backup2s3:backup:create  comment='put notes about backup here if needed'
 
 
-        Delete  -- Deletes the specific backup
+        Delete  -- Deletes a backup specified by id parameter
                 -- id - Backup to delete, backup ids will be found using List
 
           rake backup2s3:backup:delete  id='20100913180541'
@@ -49,14 +49,10 @@ class Backup2s3Generator < Rails::Generator::Base
           rake backup2s3:backup:list  details=true
 
 
-        Restore -- Restores a specific backup
+        Restore -- Restores a backup specified by id parameter
                 -- id - Backup to restore, backup ids will be found using List
 
-          rake backup2s3:backup:restore id='20100913180541'
-
-      Some handy tasks
-
-        rake backup2s3:statistics     - Shows you the size of your DB
+          rake backup2s3:backup:restore id='20100913180541'      
 
     -------------------------------------------------------------------
 

data/generators/backup2s3/templates/backup2s3.rake

@@ -21,13 +21,5 @@ namespace :backup2s3 do
     task :restore do
       Backup2s3.new.restore
     end
-  end
-
-  desc "Show table sizes for your database"
-  task :statistics => :environment do
-    rows = Backup2s3.new.statistics
-    rows.sort_by {|x| -x[3].to_i }
-    header = [["Type", "Data MB", "Index", "Rows", "Name"], []]
-    puts (header + rows).collect {|x| x.join("\t") }
-  end
+  end  
 end

data/generators/backup2s3/templates/backup2s3.yml

@@ -1,10 +1,40 @@
 #Sample backup2s3 configuration file
 #
-#   Available adapter types:
-#     S3Adapter - Uses aws-s3 gem.
-#     S3cmdAdapter - Uses s3cmd 0.9.9.91 Python library found here: http://s3tools.org/s3cmd
+#  -backups section-
 #
+#     :max_number_of_backups - Sets the number of backups to keep related to this 
+#                              application on your S3 account. When the limit is
+#                              reached, the oldest backup will be deleted. 
+#     :backup_database - This is a boolean value.  Backup2s3 will backup your 
+#                        database if this is true and skip database backup if false.
+#     :backup_application_folder - An array of the top level application folders
+#                                  that Backup2s3 should tar, zip and backup to S3.
 #
+#
+#  -adapter section-
+#
+#     :type - The adapter type you would like to use. 
+#
+#             Currently available adapter types:
+#                 S3Adapter - Uses aws-s3 gem and does not provide a status/percentage 
+#                             report, failsafe or throttling.
+#                 S3cmdAdapter - Uses s3cmd 0.9.9.91 Python library found here: 
+#                                  http://s3tools.org/s3cmd
+#                                This adapter displays upload progress and also has 
+#                                failsafes and throttling incase an upload fails.
+#                                The failsafe will slow the upload speed and retry 
+#                                the upload incase of failure. 
+#
+#     :access_key_id - Your Amazon S3 access key id
+#
+#     :secret_access_key - Your Amazon S3 secret access key
+#
+#     :use_ssl - Uses an ssl connection for backups if set to true.
+#
+
+
+
+
 :backups:
   :max_number_of_backups: 5
   :backup_database: true

data/lib/adapters/s3_adapter.rb

@@ -57,14 +57,7 @@ class S3Adapter
   private
 
   def bucket    
-    @bucket ||= clean("#{System.db_credentials['database'].downcase}-ON-#{System.hostname.downcase}")
-  end
-
-  def clean(str)
-    str.gsub!(".", "-dot-")
-    str.gsub!("_", "-")
-    str.gsub!("\n", "")
-    return str
+    @bucket ||= System.clean("#{System.db_credentials['database'].downcase}-ON-#{System.hostname.downcase}")
   end
   
 end

data/lib/adapters/s3cmd_adapter.rb

@@ -25,16 +25,6 @@ class S3cmdAdapter
     file
   end
 
-#  def read(file_name)
-#    ensure_connected
-#    return AWS::S3::S3Object.find(file_name, bucket)
-#  end
-
-#  def list
-#    ensure_connected
-#    AWS::S3::Bucket.find(bucket).objects.collect {|x| x.path }
-#  end
-
   def delete(file_name)
     #TODO use s3cmd ls here to create 'find' like functionality similar to s3_adapter
     begin
@@ -47,14 +37,7 @@ class S3cmdAdapter
   private
 
   def bucket
-    @bucket ||= clean("#{System.db_credentials['database'].downcase}-ON-#{System.hostname.downcase}")
-  end
-
-  def clean(str)
-    str.gsub!(".", "-dot-")
-    str.gsub!("_", "-")
-    str.gsub!("\n", "")
-    return str
+    @bucket ||= System.clean("#{System.db_credentials['database'].downcase}-ON-#{System.hostname.downcase}")
   end
 
 end

data/lib/backup2s3.rb

@@ -57,7 +57,7 @@ class Backup2s3
   # information.
   def create_backup(comment)
     if @conf[:backups][:backup_database]
-      @database_file = "#{@time}-#{System.db_credentials['database']}-database.sql"
+      @database_file = System.clean("#{@time}-#{System.db_credentials['database']}-database.sql")
       print "\nDumping database..."
       database_temp = System.db_dump      
       puts "done\n- Database dump file size: " << database_temp.size.to_s << " B"; print "Backing up database dump file..."
@@ -66,7 +66,7 @@ class Backup2s3
     end
     
     if @conf[:backups][:backup_application_folders].is_a?(Array)
-      @application_file = "#{@time}-#{System.db_credentials['database']}-application.tar.gz"
+      @application_file = System.clean("#{@time}-#{System.db_credentials['database']}-application.tar.gz")
       print "\nZipping application folders..."
       application_temp = System.tarzip_folders(@conf[:backups][:backup_application_folders])
       puts "done\n- Application tarball size: " << application_temp.size.to_s << " B"; print "Backing up application tarball..."

data/lib/backup_management/backup_manager.rb

@@ -11,7 +11,7 @@ class BackupManager
   end
 
   def self.filename
-    "#{System.db_credentials['database']}_ON_#{System.hostname}_backups.yaml"
+    System.clean("#{System.db_credentials['database']}_ON_#{System.hostname}_backups.yaml")
   end
 
   def self.local_filename

data/lib/system.rb

@@ -59,6 +59,14 @@ module System
     cmd += " -h '#{db_credentials['host']}'"    unless db_credentials['host'].nil?
     cmd += " #{db_credentials['database']}"
   end  
+  
+  def self.clean(str)
+    str.gsub!(".", "-dot-")
+    str.gsub!("_", "-")
+    str.gsub!("\n", "")
+    str.gsub!(/[^0-9a-z-_]/i, '')
+    return str
+  end
     
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backup2s3
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Aric Walker
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 -06:00
-default_executable: 
+date: 2011-08-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-s3
@@ -66,7 +65,6 @@ files:
 - lib/backup_management/backup_manager.rb
 - lib/system.rb
 - backup2s3.gemspec
-has_rdoc: true
 homepage: http://github.com/aricwalker/backup2s3
 licenses: []
 
@@ -102,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: backup2s3
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Backup2s3 is a gem that creates, deletes and restores db and application backups.