backup2s3 0.2.1 → 0.2.2

data/Manifest

@@ -8,6 +8,7 @@ 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

data/README

@@ -5,7 +5,7 @@ SETUP:
 
   
   2. Add the below code to config/environment.rb
-  config.gem "backup2s3", :version => ">= 0.1.0"
+  config.gem "backup2s3", :version => ">= 0.2.1"
 
 
   3. Run the generator in your application root directory
@@ -17,13 +17,36 @@ SETUP:
 
 USAGE:
 
-  Backup tasks
+  2. Get started.
 
-    rake backup2s3:backup:create  - Creates a backup and moves it to S3
-    rake backup2s3:backup:delete  - Deletes the specific backup
-    rake backup2s3:backup:list    - Lists all backups that are currently on S3
-    rake backup2s3:backup:restore - Restores a specific backup
+      Backup tasks
 
-  Some handy tasks
+        Create -- Creates a backup and moves it to S3
+               -- comment - Add notes here to mark specific backups (optional)
 
-    rake backup2s3:statistics     - Shows you the size of your DB
+          rake backup2s3:backup:create
+          rake backup2s3:backup:create  comment='put notes about backup here if needed'
+
+
+        Delete  -- Deletes the specific backup
+                -- id - Backup to delete, backup ids will be found using List
+
+          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)
+
+          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
+
+          rake backup2s3:backup:restore id='20100913180541'
+
+      Some handy tasks
+
+        rake backup2s3:statistics     - Shows you the size of your DB

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('backup2s3', '0.2.1') do |p|
+Echoe.new('backup2s3', '0.2.2') 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,27 +2,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup2s3}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aric Walker"]
-  s.date = %q{2010-04-18}
+  s.date = %q{2010-09-13}
   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/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/backup2s3.rb", "lib/backup_management/backup.rb", "lib/backup_management/backup_manager.rb", "lib/system.rb", "backup2s3.gemspec"]
+  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.homepage = %q{http://github.com/aricwalker/backup2s3}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backup2s3", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{backup2s3}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<aws-s3>, [">= 0.6.2"])
     else
       s.add_dependency(%q<aws-s3>, [">= 0.6.2"])

data/generators/backup2s3/backup2s3_generator.rb

@@ -27,11 +27,32 @@ class Backup2s3Generator < Rails::Generator::Base
     2. Get started.
 
       Backup tasks
-      
-        rake backup2s3:backup:create  - Creates a backup and moves it to S3
-        rake backup2s3:backup:delete  - Deletes the specific backup
-        rake backup2s3:backup:list    - Lists all backups that are currently on S3
-        rake backup2s3:backup:restore - Restores a specific backup
+
+        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'
+
+
+        Delete  -- Deletes the specific backup
+                -- id - Backup to delete, backup ids will be found using List
+
+          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)
+
+          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
+
+          rake backup2s3:backup:restore id='20100913180541'
 
       Some handy tasks
 

data/generators/backup2s3/templates/backup2s3.yml

@@ -1,4 +1,10 @@
 #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:
   :max_number_of_backups: 5
   :backup_database: true
@@ -7,6 +13,7 @@
     - lib
 
 :adapter:
+  :type: S3Adapter
   :access_key_id: XXXXXXXXXXXXXXXXXXXX
   :secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   :use_ssl: true

data/lib/adapters/s3_adapter.rb

@@ -1,5 +1,6 @@
 require 'aws/s3'
 
+
 class Adapters::S3Adapter
   include System
 
@@ -10,7 +11,11 @@ class Adapters::S3Adapter
 
   def ensure_connected
     return if @connected    
-    AWS::S3::Base.establish_connection!(@config)
+    AWS::S3::Base.establish_connection!(
+      :access_key_id     => @config[:access_key_id],
+      :secret_access_key => @config[:secret_access_key],      
+      :use_ssl           => @config[:use_ssl]      
+    )
     AWS::S3::Bucket.create(bucket)
     @connected = true
   end
@@ -62,4 +67,6 @@ class Adapters::S3Adapter
     return str
   end
   
-end
+end
+
+

data/lib/adapters/s3cmd_adapter.rb

@@ -0,0 +1,62 @@
+
+class Adapters::S3cmdAdapter
+  include System
+
+  def initialize(config)
+    @config = config
+    @connected = false
+  end
+
+  def ensure_connected
+    return if @connected
+    System.run("s3cmd mb s3://#{bucket}")
+    @connected = true
+  end
+
+  def store(file_name, file)
+    ensure_connected
+    System.run("s3cmd put #{file.path} s3://#{bucket}/#{file_name}")
+  end
+
+  def fetch(file_name)
+    ensure_connected
+    file = Tempfile.new("temp")
+    System.run("s3cmd get --force s3://#{bucket}/#{file_name} #{file.path}")
+    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
+      System.run("s3cmd del s3://#{bucket}/#{file_name}")
+    rescue
+      raise "Could not delete #{file_name}."
+    end
+  end
+
+  private
+
+  def bucket
+    @bucket ||= clean("#{ActiveRecord::Base.connection.current_database.to_str.downcase}-ON-#{System.hostname.downcase}")
+  end
+
+  def clean(str)
+    str.gsub!(".", "-dot-")
+    str.gsub!("_", "-")
+    str.gsub!("\n", "")
+    return str
+  end
+
+end
+
+

data/lib/backup2s3.rb

@@ -85,9 +85,13 @@ class Backup2s3
     if backup.nil? then
       puts "Backup with ID #{backup_id} does not exist."
       return
-    end    
-    begin @adapter.delete(backup.application_file) rescue puts "Could not delete #{backup.application_file}!" end
-    begin @adapter.delete(backup.database_file) rescue puts "Could not delete #{backup.database_file}!" end
+    end
+    if !backup.application_file.empty?
+      begin @adapter.delete(backup.application_file) rescue puts "Could not delete #{backup.application_file}!" end
+    end
+    if !backup.database_file.empty?
+      begin @adapter.delete(backup.database_file) rescue puts "Could not delete #{backup.database_file}!" end
+    end
     puts (@backup_manager.delete_backup(backup) ?
         "Backup with ID #{backup.time} was successfully deleted." :
         "Warning: Backup with ID #{backup.time} was not found and therefore not deleted.")
@@ -107,7 +111,7 @@ class Backup2s3
     System.unzip_file(application_file)
     puts "done\n"
 
-    print "\nRetrieving datbase dump_file..."
+    print "\nRetrieving database dump_file..."
     dump_file = @adapter.fetch(backup.database_file)
     puts "done";
 
@@ -122,8 +126,13 @@ class Backup2s3
   end
 
   # Creates instance of class used to interface with S3
-  def load_adapter    
-    @adapter = Adapters::S3Adapter.new(@conf[:adapter])
+  def load_adapter
+    begin
+      adapter = "Adapters::#{@conf[:adapter][:type]}".constantize
+    rescue
+      adapter = Adapters::S3Adapter
+    end
+    @adapter = adapter.new(@conf[:adapter])
   end
 
   def load_backup_manager

data/lib/system.rb

@@ -20,9 +20,9 @@ module System
   def self.tarzip_folders(folders)
     application_tar = Tempfile.new("app")
     if folders.is_a?(Array)      
-      cmd = "tar --dereference -czf #{application_tar.path} #{folders.join(" ")}"
+      cmd = "tar --dereference -czpf #{application_tar.path} #{folders.join(" ")}"
     elsif folders.is_a?(String)
-      cmd = "tar --dereference -czf #{application_tar.path} #{folders}"
+      cmd = "tar --dereference -czpf #{application_tar.path} #{folders}"
     end
     run(cmd)
     return application_tar

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backup2s3
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Aric Walker
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-18 00:00:00 -06:00
+date: 2010-09-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-s3
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         - 6
@@ -41,6 +44,7 @@ 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
@@ -56,6 +60,7 @@ files:
 - 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
@@ -76,16 +81,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
       segments: 
       - 1
       - 2
@@ -93,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: backup2s3
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Backup2s3 is a gem that creates, deletes and restores db and application backups.