backup 2.3.1 → 2.3.2.pre

data/lib/backup/configuration/mail.rb

@@ -1,16 +1,10 @@
 module Backup
   module Configuration
     class Mail
-      attr_accessor :attributes
-
-      %w(from to smtp).each do |method|
-        define_method method do |value|
-          attributes[method.to_sym] = value
-        end
-      end
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(from to smtp)
 
       def initialize
-        @attributes = {}
         @smtp_configuration = Backup::Configuration::SMTP.new
       end
 
@@ -23,4 +17,4 @@ module Backup
       end
     end
   end
-end
+end

data/lib/backup/configuration/smtp.rb

@@ -1,19 +1,8 @@
 module Backup
   module Configuration
     class SMTP
-      
-      attr_accessor :attributes 
-      
-      %w(host port username password authentication domain tls).each do |method|
-        define_method method do |value|
-          attributes[method.to_sym] = value
-        end
-      end
-
-      def initialize
-        @attributes = {}
-      end
-      
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(host port username password authentication domain tls)
     end
   end
-end
+end

data/lib/backup/configuration/storage.rb

@@ -1,17 +1,8 @@
 module Backup
   module Configuration
     class Storage
-      attr_accessor :attributes 
-
-      %w(ip user password path access_key_id secret_access_key use_ssl bucket).each do |method|
-        define_method method do |value|
-          attributes[method] = value
-        end
-      end
-
-      def initialize
-        @attributes = {}
-      end
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(ip user password path access_key_id secret_access_key use_ssl bucket)
     end
   end
-end
+end

data/lib/backup/connection/s3.rb

@@ -1,3 +1,5 @@
+require 'aws/s3'
+
 module Backup
   module Connection
     class S3
@@ -82,4 +84,4 @@ module Backup
         
     end
   end 
-end
+end

data/lib/backup/environment/unix.rb

@@ -5,13 +5,13 @@ module Backup
       require 'active_record'
       require 'optparse'
       
-      # Sets BACKUP_PATH equal to /opt/backup
-      BACKUP_PATH = "/opt/backup"
+      # Sets BACKUP_PATH
+      BACKUP_PATH = ENV['BACKUP_PATH'] || "/opt/backup"
       
       # Sets DB_CONNECTION_SETTINGS
       DB_CONNECTION_SETTINGS = {
         :adapter  => "sqlite3",
-        :database => "/opt/backup/backup.sqlite3",
+        :database => "#{BACKUP_PATH}/backup.sqlite3",
         :pool     => 5,
         :timeout  => 5000 
       }
@@ -32,7 +32,7 @@ module Backup
 
   1: Set up some "Backup Settings" inside the configuration file!
 
-    /opt/backup/config/backup.rb
+    #{BACKUP_PATH}/config/backup.rb
 
 
   2: Run the backups!

data/lib/backup/mail/base.rb

@@ -1,3 +1,5 @@
+require 'pony'
+
 module Backup
   module Mail
     class Base
@@ -77,8 +79,12 @@ module Backup
           line.gsub!(':time',      Time.now.strftime("%r"))
           line.gsub!(':adapter',   @backup.procedure.adapter_name.to_s)
           line.gsub!(':location',  bucket || path)
-          line.gsub!(':remote',    bucket ? "Amazon S3" : "the remote server (#{ip})")
           line.gsub!(':backup',    @backup.final_file)
+          case @backup.procedure.storage_name.to_sym
+            when :s3                then line.gsub!(':remote', "on Amazon S3")
+            when :local             then line.gsub!(':remote', "on the local server")
+            when :scp, :sftp, :ftp  then line.gsub!(':remote', "on the remote server (#{ip})")
+          end
           @content ||= String.new
           @content << line
         end
@@ -86,4 +92,4 @@ module Backup
 
     end
   end
-end
+end

data/lib/backup/mail/mail.txt

@@ -1,7 +1,7 @@
-A backup was successfully created for ":trigger"!
+A backup was successfully created for the trigger: ":trigger"!
 
-The backup was created on ":day of :month :year at :time".
+The backup was created on ":day of :month :year at :time", using the ":adapter" adapter.
 
-It has been stored using the ":adapter" adapter, and the file was stored in :location on :remote.
+The Backup was stored in ":location" :remote.
 
 The following backup was stored: ":backup"

data/lib/backup/record/base.rb

@@ -0,0 +1,65 @@
+module Backup
+  module Record
+    class Base < ActiveRecord::Base
+      
+      if DB_CONNECTION_SETTINGS
+        establish_connection(DB_CONNECTION_SETTINGS)
+      end
+      
+      set_table_name 'backup'
+      
+      default_scope :order => 'created_at desc'
+
+      # Callbacks
+      after_save :clean_backups
+      
+      # Attributes
+      attr_accessor :adapter_config, :keep_backups
+      
+      # Receives the options hash and stores it
+      def load_adapter(adapter)
+        self.adapter_config = adapter
+        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']
+        
+        # TODO calculate md5sum of file
+        load_specific_settings(adapter) if respond_to?(:load_specific_settings)
+      end
+      
+      # Destroys all backups for the specified trigger from Remote Server (FTP)
+      def self.destroy_all_backups(procedure, trigger)
+        backups = self.all(:conditions => {:trigger => trigger})
+        unless backups.empty?
+          # Derived classes must implement this method!
+          self.destroy_backups(procedure, backups)
+          
+          puts "\nAll \"#{procedure.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 = self.class.all(:conditions => {:trigger => trigger})
+            backups_to_destroy = backups[keep_backups, backups.size] || []
+            
+            unless backups_to_destroy.empty?
+              # Derived classes must implement this method!
+              self.class.destroy_backups(adapter_config.procedure, backups_to_destroy)
+              
+              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/ftp.rb

@@ -1,41 +1,20 @@
+require 'net/ftp'
+
 module Backup
   module Record
-    class FTP < ActiveRecord::Base
-      
-      if DB_CONNECTION_SETTINGS
-        establish_connection(DB_CONNECTION_SETTINGS)
-      end
-      
-      set_table_name 'backup'
-      default_scope \
-        :order => 'created_at desc',
-        :conditions => {:storage => 'ftp'}
-
-      # Callbacks
-      after_save :clean_backups
+    class FTP < Backup::Record::Base
       
-      # Attributes
-      attr_accessor :adapter_config, :keep_backups, :ip, :user, :password
+      attr_accessor :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']
-        
+      def load_specific_settings(adapter)
         %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?
+      private
+        
+        def self.destroy_backups(procedure, backups)
           ip        = procedure.get_storage_configuration.attributes['ip']
           user      = procedure.get_storage_configuration.attributes['user']
           password  = procedure.get_storage_configuration.attributes['password']
@@ -48,51 +27,13 @@ module Backup
                 ftp.delete(backup.filename)
                 backup.destroy
               rescue
+                puts "Could not find backup #{backup.path}/#{backup.filename}."
                 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
+end

data/lib/backup/record/local.rb

@@ -0,0 +1,26 @@
+module Backup
+  module Record
+    class Local < Backup::Record::Base
+      
+      def load_specific_settings(adapter)
+        self.path = adapter.procedure.get_storage_configuration.attributes['path']
+      end
+      
+      private
+        
+        class << self
+          include Backup::CommandHelper
+        
+          def destroy_backups(procedure, backups)
+            backups.each do |backup|
+              puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
+              run "rm #{File.join(backup.path, backup.filename)}"
+              backup.destroy
+            end
+          end
+        end
+        
+    end
+  end
+end
+

data/lib/backup/record/s3.rb

@@ -1,38 +1,16 @@
+require 'backup/connection/s3'
+
 module Backup
   module Record
-    class S3 < ActiveRecord::Base
+    class S3 < Backup::Record::Base
       
-      if DB_CONNECTION_SETTINGS
-        establish_connection(DB_CONNECTION_SETTINGS)
+      def load_specific_settings(adapter)
+        self.bucket = adapter.procedure.get_storage_configuration.attributes['bucket']
       end
       
-      set_table_name 'backup'
-      default_scope \
-        :order => 'created_at desc',
-        :conditions => {:storage => 's3'}
-
-      # Callbacks
-      after_save :clean_backups
-      
-      # Attributes
-      attr_accessor :adapter_config, :keep_backups
-      
-      # Receives the options hash and stores it
-      # Sets the S3 values
-      def load_adapter(adapter)
-        self.adapter_config = adapter
-        self.storage        = 's3'
-        self.trigger        = adapter.procedure.trigger
-        self.adapter        = adapter.procedure.adapter_name.to_s
-        self.filename       = adapter.final_file
-        self.bucket         = adapter.procedure.get_storage_configuration.attributes['bucket']
-        self.keep_backups   = adapter.procedure.attributes['keep_backups']
-      end
-      
-      # Destroys all backups for the specified trigger from Amazon S3
-      def self.destroy_all_backups(procedure, trigger)
-        backups = Backup::Record::S3.all(:conditions => {:trigger => trigger})        
-        unless backups.empty?
+      private
+        
+        def self.destroy_backups(procedure, backups)
           s3 = Backup::Connection::S3.new
           s3.static_initialize(procedure)
           s3.connect
@@ -41,40 +19,8 @@ module Backup
             s3.destroy(backup.filename, backup.bucket)
             backup.destroy
           end
-          puts "\nAll \"#{trigger}\" backups destroyed.\n\n"
-        end
-      end
-      
-      private
-        
-        # Maintains the backup file amount on S3
-        # 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::S3.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?
-              s3 = Backup::Connection::S3.new(adapter_config)
-              s3.connect
-              backups_to_destroy.each do |backup|
-                puts "\nDestroying backup \"#{backup.filename}\" from bucket \"#{backup.bucket}\"."
-                s3.destroy(backup.filename, backup.bucket)
-                backup.destroy
-              end
-              
-              puts "\nBackup storage for \"#{trigger}\" is limited to #{keep_backups} backups."
-              puts "\nThe #{keep_backups} most recent backups are now stored on S3.\n\n"
-            end
-          end
         end
         
     end
   end
-end
+end

data/lib/backup/record/scp.rb

@@ -1,41 +1,20 @@
+require 'net/scp'
+
 module Backup
   module Record
-    class SCP < ActiveRecord::Base
-
-      if DB_CONNECTION_SETTINGS
-        establish_connection(DB_CONNECTION_SETTINGS)
-      end      
+    class SCP < Backup::Record::Base
 
-      set_table_name 'backup'
-      default_scope \
-        :order => 'created_at desc',
-        :conditions => {:storage => 'scp'}
-      
-      # Callbacks
-      after_save :clean_backups
-      
-      # Attributes
-      attr_accessor :adapter_config, :keep_backups, :ip, :user, :password
+      attr_accessor :ip, :user, :password
       
-      # Receives the options hash and stores it
-      # Sets the SCP values
-      def load_adapter(adapter)
-        self.adapter_config = adapter
-        self.storage        = 'scp'
-        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']
-        
+      def load_specific_settings(adapter)
         %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::SCP.all(:conditions => {:trigger => trigger})        
-        unless backups.empty?
+      private
+        
+        def self.destroy_backups(procedure, backups)
           ip        = procedure.get_storage_configuration.attributes['ip']
           user      = procedure.get_storage_configuration.attributes['user']
           password  = procedure.get_storage_configuration.attributes['password']
@@ -47,42 +26,8 @@ module Backup
               backup.destroy
             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::SCP.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::SSH.start(ip, user, :password => password) do |ssh|
-                backups_to_destroy.each do |backup|
-                  puts "\nDestroying backup \"#{backup.filename}\" from path \"#{backup.path}\"."
-                  ssh.exec("rm #{File.join(backup.path, backup.filename)}")
-                  backup.destroy
-                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
+end