backup 2.1.2 → 2.2.0

data/lib/backup/configuration/adapter.rb

@@ -1,9 +1,10 @@
 module Backup
   module Configuration
     class Adapter
+      
       attr_accessor :attributes 
       
-      %w(files user password database).each do |method|
+      %w(files user password database skip_tables commands).each do |method|
         define_method method do |value|
           attributes[method] = value
         end
@@ -11,7 +12,17 @@ module Backup
 
       def initialize
         @attributes = {}
+        @options    = Backup::Configuration::AdapterOptions.new
+      end
+
+      def options(&block)
+        @options.instance_eval &block
       end
+      
+      def get_options
+        @options
+      end
+
     end
   end
 end

data/lib/backup/configuration/adapter_options.rb

@@ -0,0 +1,19 @@
+module Backup
+  module Configuration
+    class AdapterOptions
+      
+      attr_accessor :attributes 
+      
+      %w(host port socket).each do |method|
+        define_method method do |value|
+          attributes[method] = value
+        end
+      end
+
+      def initialize
+        @attributes = {}
+      end
+      
+    end
+  end
+end

data/lib/backup/configuration/helpers.rb

@@ -1,12 +1,17 @@
 module Backup
   module Configuration
     module Helpers
+      
+      # A helper method for the config/backup.rb configuration file
+      # Expects a trigger in argument one (STRING)
+      # Expects a block of settings
       def backup(trigger, &block)
         backup = Backup::Configuration::Base.new(trigger)
         backup.instance_eval &block
         @backup_procedures ||= Array.new
         @backup_procedures << backup
       end
+      
     end
   end
 end

data/lib/backup/record/ftp.rb

@@ -0,0 +1,94 @@
+module Backup
+  module Record
+    class FTP < ActiveRecord::Base
+
+      set_table_name 'backup'
+      default_scope \
+        :order => 'created_at desc',
+        :conditions => {:storage => 'ftp'}
+
+      # Callbacks
+      after_save :clean_backups
+      
+      # Attributes
+      attr_accessor :adapter_config, :keep_backups, :ip, :user, :password
+      
+      # Receives the options hash and stores it
+      # Sets the FTP values
+      def load_adapter(adapter)
+        self.adapter_config = adapter
+        self.storage        = 'ftp'
+        self.trigger        = adapter.procedure.trigger
+        self.adapter        = adapter.procedure.adapter_name.to_s
+        self.filename       = adapter.final_file
+        self.keep_backups   = adapter.procedure.attributes['keep_backups']
+        
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+      end
+      
+      # Destroys all backups for the specified trigger from Remote Server (FTP)
+      def self.destroy_all_backups(procedure, trigger)
+        backups = Backup::Record::FTP.all(:conditions => {:trigger => trigger})        
+        unless backups.empty?
+          ip        = procedure.get_storage_configuration.attributes['ip']
+          user      = procedure.get_storage_configuration.attributes['user']
+          password  = procedure.get_storage_configuration.attributes['password']
+
+          Net::FTP.open(ip, user, password) do |ftp|
+            backups.each do |backup|
+              puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+              begin
+                ftp.chdir(backup.path)
+                ftp.delete(backup.filename)
+                backup.destroy
+              rescue
+                backup.destroy
+              end
+            end
+          end
+          
+         puts "\nAll \"#{trigger}\" backups destroyed.\n\n"
+        end
+      end
+      
+      private
+        
+        # Maintains the backup file amount on the remote server
+        # This is invoked after a successful record save 
+        # This deletes the oldest files when the backup limit has been exceeded
+        def clean_backups
+          if keep_backups.is_a?(Integer)
+            backups = Backup::Record::FTP.all(:conditions => {:trigger => trigger})
+            backups_to_destroy = Array.new
+            backups.each_with_index do |backup, index|
+              if index >= keep_backups then
+                backups_to_destroy << backup
+              end
+            end
+            
+            unless backups_to_destroy.empty?
+              Net::FTP.open(ip, user, password) do |ftp|
+                backups_to_destroy.each do |backup|
+                  puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+                  begin
+                    ftp.chdir(backup.path)
+                    ftp.delete(backup.filename)
+                    backup.destroy
+                  rescue
+                    puts "Could not find backup #{backup.path}/#{backup.filename}.."
+                    backup.destroy
+                  end
+                end
+              end
+              
+              puts "\nBackup storage for \"#{trigger}\" is limited to #{keep_backups} backups."
+              puts "\nThe #{keep_backups} most recent backups are now stored on the remote server.\n\n"
+            end
+          end
+        end
+        
+    end
+  end
+end

data/lib/backup/record/s3.rb

@@ -64,10 +64,8 @@ module Backup
             end
             
             unless backups_to_destroy.empty?
-              
               # Create a new Amazon S3 Object
               s3 = Backup::Connection::S3.new(adapter_config)
-            
               # Connect to Amazon S3 with provided credentials
               s3.connect
             

data/lib/backup/record/sftp.rb

@@ -0,0 +1,92 @@
+module Backup
+  module Record
+    class SFTP < ActiveRecord::Base
+
+      set_table_name 'backup'
+      default_scope \
+        :order => 'created_at desc',
+        :conditions => {:storage => 'sftp'}
+
+      # Callbacks
+      after_save :clean_backups
+      
+      # Attributes
+      attr_accessor :adapter_config, :keep_backups, :ip, :user, :password
+      
+      # Receives the options hash and stores it
+      # Sets the SCP values
+      def load_adapter(adapter)
+        self.adapter_config = adapter
+        self.storage        = 'sftp'
+        self.trigger        = adapter.procedure.trigger
+        self.adapter        = adapter.procedure.adapter_name.to_s
+        self.filename       = adapter.final_file
+        self.keep_backups   = adapter.procedure.attributes['keep_backups']
+        
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+      end
+      
+      # Destroys all backups for the specified trigger from Remote Server (SCP)
+      def self.destroy_all_backups(procedure, trigger)
+        backups = Backup::Record::SFTP.all(:conditions => {:trigger => trigger})        
+        unless backups.empty?
+          ip        = procedure.get_storage_configuration.attributes['ip']
+          user      = procedure.get_storage_configuration.attributes['user']
+          password  = procedure.get_storage_configuration.attributes['password']
+          
+          Net::SFTP.start(ip, user, :password => password) do |sftp|
+            backups.each do |backup|
+              puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+              begin
+                sftp.remove!(File.join(backup.path, backup.filename))
+                backup.destroy
+              rescue
+                backup.destroy
+              end
+            end
+          end
+          
+         puts "\nAll \"#{trigger}\" backups destroyed.\n\n"
+        end
+      end
+      
+      private
+        
+        # Maintains the backup file amount on the remote server
+        # This is invoked after a successful record save 
+        # This deletes the oldest files when the backup limit has been exceeded
+        def clean_backups
+          if keep_backups.is_a?(Integer)
+            backups = Backup::Record::SFTP.all(:conditions => {:trigger => trigger})
+            backups_to_destroy = Array.new
+            backups.each_with_index do |backup, index|
+              if index >= keep_backups then
+                backups_to_destroy << backup
+              end
+            end
+            
+            unless backups_to_destroy.empty?
+              Net::SFTP.start(ip, user, :password => password) do |sftp|
+                backups_to_destroy.each do |backup|
+                  puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+                  begin
+                    sftp.remove!(File.join(backup.path, backup.filename))
+                    backup.destroy
+                  rescue
+                    puts "Could not find backup #{backup.path}/#{backup.filename}.."
+                    backup.destroy
+                  end
+                end
+              end
+              
+              puts "\nBackup storage for \"#{trigger}\" is limited to #{keep_backups} backups."
+              puts "\nThe #{keep_backups} most recent backups are now stored on the remote server.\n\n"
+            end
+          end
+        end
+        
+    end
+  end
+end

data/lib/backup/storage/ftp.rb

@@ -0,0 +1,34 @@
+module Backup
+  module Storage
+    class FTP
+      
+      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
+      
+      # Stores the backup file on the remote server using FTP
+      def initialize(adapter)
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+        
+        final_file = adapter.final_file
+        tmp_path   = adapter.tmp_path
+        
+        Net::FTP.open(ip, user, password) do |ftp|
+          begin
+            ftp.chdir(path)
+          rescue
+            raise "Could not find or access \"#{path}\" on \"#{ip}\", please ensure this directory exists and is accessible by the user \"#{user}\"."
+          end
+          
+          begin
+            puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
+            ftp.putbinaryfile(File.join(tmp_path, final_file).gsub('\ ', ' '), File.join(path, final_file))
+          rescue
+            raise "Could not save file to backup server. Is the \"#{path}\" directory writable?"
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/backup/storage/s3.rb

@@ -2,7 +2,7 @@ module Backup
   module Storage
     class S3
       
-      # Stores the file on the remote server using S3
+      # Stores the backup file on the remote server using S3
       def initialize(adapter)
         s3 = Backup::Connection::S3.new(adapter)
         s3.connect

data/lib/backup/storage/scp.rb

@@ -4,7 +4,7 @@ module Backup
       
       attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
       
-      # Stores the file on the remote server using SCP
+      # Stores the backup file on the remote server using SCP
       def initialize(adapter)
         %w(ip user password path).each do |method|
           send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])

data/lib/backup/storage/sftp.rb

@@ -0,0 +1,28 @@
+module Backup
+  module Storage
+    class SFTP
+      
+      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
+      
+      # Stores the backup file on the remote server using SFTP
+      def initialize(adapter)
+        %w(ip user password path).each do |method|
+          send(:"#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+        end
+        
+        final_file = adapter.final_file
+        tmp_path   = adapter.tmp_path
+        
+        Net::SFTP.start(ip, user, :password => password) do |sftp|
+          begin
+            puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
+            sftp.upload!(File.join(tmp_path, final_file).gsub('\ ', ' '), File.join(path, final_file))
+          rescue
+            raise "Could not find \"#{path}\" on \"#{ip}\", please ensure this directory exists."
+          end
+        end
+      end
+      
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 +01:00
+date: 2009-12-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,17 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.2
     version: 
-description: "\n                          Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way\n                          to configure and run backups of your MySQL database (soon PostgreSQL and possibly more) and Archives (any files or folders)\n                          to \"Amazon S3\" or \"any remotely accessible server using SCP\". Backup handles: Compression, Archiving, Encryption and Backup Cleaning.\n                        "
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.4
+    version: 
+description: "\n                        Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your\n                        MySQL/PostgreSQL databases (and practically even any other database you can dump through the command line). It can also make backups of your archives (any files or folders).\n                        All backups can be transferred to either \"Amazon S3\" or \"any remotely accessible server using the SCP, SFTP or FTP transfer methods\".\n                        Backup handles: Compression, Archiving, Encryption and Backup Cleaning.\n                        "
 email: meskyan@gmail.com
 executables: []
 
@@ -50,12 +60,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - backup.gemspec
@@ -66,18 +77,25 @@ files:
 - lib/backup.rb
 - lib/backup/adapters/archive.rb
 - lib/backup/adapters/base.rb
+- lib/backup/adapters/custom.rb
 - lib/backup/adapters/mysql.rb
+- lib/backup/adapters/postgresql.rb
 - lib/backup/configuration/adapter.rb
+- lib/backup/configuration/adapter_options.rb
 - lib/backup/configuration/base.rb
 - lib/backup/configuration/helpers.rb
 - lib/backup/configuration/storage.rb
 - lib/backup/connection/s3.rb
+- lib/backup/record/ftp.rb
 - lib/backup/record/s3.rb
 - lib/backup/record/scp.rb
+- lib/backup/record/sftp.rb
+- lib/backup/storage/ftp.rb
 - lib/backup/storage/s3.rb
 - lib/backup/storage/scp.rb
+- lib/backup/storage/sftp.rb
 has_rdoc: true
-homepage: ""
+homepage: http://final-creation.com/open-source
 licenses: []
 
 post_install_message: 

data/README.rdoc

@@ -1,222 +0,0 @@
-= Backup
-
-== A Backup Ruby Gem for Rails
-
-Backup is a Ruby Gem, written specifically for Ruby on Rails applications. This gem offers a quick and easy way to configure and run backups of your
-MySQL database (soon PostgreSQL and possibly more) and Archives (any files or folders) to "Amazon S3" or "any remotely accessible server using SCP".
-Backup handles: Compression, Archiving, Encryption and Backup Cleaning.
-
-== Backup just updated to version 2.1.0!
-
-This was a major update (read below) and a lot of stuff has changed since version 1.x.x!
-Notable changes:
-* Should be a lot more backwards compatible with every update I do.
-* Does not depend on the separate local SQLite3 file any longer.
-* Will provide a db migration file for your Rails Application to store backup record data in. 
-* Does not use YAML files to do configuration any longer.
-* Uses a SINGLE ruby file for "all" configuration (config/backup.rb) using elegant block notations!
-* Uses a SINGLE rake task to handle the initialization of any backup setting.
-* Can now configure an unlimited amount of customizable backup settings and run them each "individually"!
-* HIGHLY IMPROVED USABILITY!
-
-== TO ANYONE RUNNING BACKUP VERSION 2.0.0! PLEASE READ!
-
-I would like to ask you to install the latest version of Backup, as 2.0.0 has some issues.
-A few things that were left unchanged in 2.0.0 have been changed in 2.1.0 and I have updated the Wiki page "Getting Started"
-based on the 2.1.0 release (and later releases) to get everyone up and running!
-
-==== If you have Backup version 2.0.0 installed, please do the following:
-
-  sudo gem uninstall backup -v 2.0.0
-  sudo gem install backup
-
-And have a quick read through the "Getting Started" Wiki page to see how to setup Backup as of 2.1.0!
-
-=== Refer to the Getting Started page to get up and running incredibly fast with Backup 2!
-http://wiki.github.com/meskyanichi/backup/getting-started
-
-
-==== 100% Rewrite!
-This was a 100% rewrite of the gem. So if you discover any issues with it, please report them here so I can fix them as soon as possible!
-http://github.com/meskyanichi/backup/issues
-
-==== Coded Quickly!
-I've been going all hardcore on this one, building it in a very small amount of time compared to the first version. As far as I can see it fully works,
-but it is of course likely that you or anyone else might encounter some issues. Please report them if you do.
-
-==== Updated The Wiki Quickly!
-So when I finished crafting the Backup Gem, I immediately started working on the Wiki and, as for the gem, updated it very quickly on a late sunday night.
-I will come back to the Wiki and see if I can improve it even more next weekend when I have more time. I just wanted to get the essentials built in and I think it worked out pretty nicely regardless. If you have any questions though, don't bother asking!
-
-==== More to come!
-Yes, Backup currently supports the most used backup adapters: MySQL and Archive(Files, Folders).
-It Archives, Compresses, Encrypts and cleans up old backups if needed.
-
-I do have plans for adding the PostgreSQL and Custom adapter for version 2 as well very soon!
-If there are requests for more/other adapters, I'm all ears! Enjoy.
-
-
-== (Current) Backup's Capabilities
-More to be added!
-
-=== Storage Methods
-
-- Amazon (S3)
-- Remote Server (SCP)
-
-
-=== Adapters
-
-- MySQL
-- Archive (Any physical files/folders)
-
-(More will be added later, such as PostgreSQL and Custom)
-
-
-=== Archiving
-
-==== Backup supports Archiving.
-When you use the Archive adapter to backup a bunch of files and folders, backup will archive and compress these all together.
- 
-
-=== Encryption
-
-==== Backup supports a simple form of encryption.
-This is optional. All adapters support encryption. This is very simple to enable. Just add the following method inside on of your backup settings
-and it will encrypt it with the specified password:
-
-  encrypt_with_password "mypassword"
-
-
-=== Backup Cleaning
-
-==== Backup supports backup cleaning.
-Backup Cleaning (which is optional) enables you to specify the amount of backups that may be stored on either Amazon S3 or a Remote Server. If you for example tell backup to limit the amount of backups by 20, when the 21st backup gets pushed to the storage location, the oldest version will automatically be destroyed.
-
-The idea behind this is to not flood either your backup server, which might resort in possible lack of hard disk space. Another good reason to utilize this would be for Amazon. Although Amazon S3 is extremely cheap, when backing up 1-2GB of MySQL dumps twice a day, it can become quite expensive if you never remove old ones.
-
-To enable this you simply call the following method inside the desired "backup setting":
-
-  keep_backups 20
-  
-  
-=== Quick Example of a Single Backup Setting inside the Backup Configuration File
-
-  backup 'mysql-backup-s3' do
-  
-    adapter :mysql do
-      user      'user'
-      password  'password'
-      database  'database'
-    end
-  
-    storage :s3 do
-      access_key_id     'access_key_id'
-      secret_access_key 'secret_access_key'
-      bucket            '/bucket/backups/mysql/'
-    end
-  
-    keep_backups 25
-    encrypt_with_password 'password'
-  
-  end
-  
-The (backup 'mysql-backup-s3' do) is what I call a "backup setting". The first argument of the block is the so called "trigger".
-
-  backup 'mysql-backup-s3' do
-    # Configuration Here
-  end
-  
-This acts as an "identifier" for the "backup setting". The (above) "backup setting" is all pretty straightforward.
-So now that we've set up a "backup setting", we can run it using a rake task, like so:
-
-  rake backup:run trigger="mysql-backup-s3"
-
-==== That's it, the MySQL database has been "backed up" to Amazon S3. It has been dumped, compressed and encrypted with password.
-Note: You can add as many "backup setting" blocks as you want inside the "config/backup.rb" configuration file and invoke each of them by their own "trigger". This means you can have as many backup setups as you want, which "don't" all run simultaneously when you initialize a backup.
-
-==== Runs the backup setting with the trigger "backup-logs"
-  rake backup:run trigger="backup-logs"
-
-==== Runs the backup setting with the trigger "backup-mysql"
-  rake backup:run trigger="backup-mysql"
-
-==== Runs the backup setting with the trigger "backup-assets"
-  rake backup:run trigger="backup-assets"
-
-etc. etc. etc. etc. etc. etc...
-
-
-
-== Interested in trying out Backup?
-
-=== Check out the following Wiki pages to get up and running:
-
-=== Getting started
-
-http://wiki.github.com/meskyanichi/backup/getting-started
-
-
-=== Backup Configuration File (All Adapters, Storage Methods and Options)
-
-http://wiki.github.com/meskyanichi/backup/configuration-file
-
-
-=== Rake Tasks
-
-http://wiki.github.com/meskyanichi/backup/rake-tasks
-
-
-=== Automatic Backups
-
-http://wiki.github.com/meskyanichi/backup/automatic-backups
-
-
-=== Capistrano Recipes
-
-http://wiki.github.com/meskyanichi/backup/capistrano-recipes
-
-
-=== Capistrano, Whenever!
-
-http://wiki.github.com/meskyanichi/backup/capistrano-whenever
-
-
-=== Understanding "The Backup Database"
-
-http://wiki.github.com/meskyanichi/backup/the-backup-database
-
-
-=== Trouble Shooting
-
-http://wiki.github.com/meskyanichi/backup/troubleshooting
-
-
-=== Requirements
-
-http://wiki.github.com/meskyanichi/backup/requirements
-
-
-=== Resources
-
-http://wiki.github.com/meskyanichi/backup/resources
-
-
-=== Requests
-
-If anyone has any requests, please send me a message!
-
-
-=== Suggestions?
-
-Send me a message! Fork the project!
-
-
-=== Found a Bug?
-
-http://github.com/meskyanichi/backup/issues
-
-
-=== Copyright
-
-Copyright (c) 2009 Michael van Rooijen | Final Creation. (http://final-creation.com/) See LICENSE for details.