backup 2.4.5.1 → 3.0.0.build.0

data/lib/backup/configuration/encryptor/base.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Encryptor
+      class Base < Backup::Configuration::Base
+      end
+    end
+  end
+end

data/lib/backup/configuration/encryptor/gpg.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Encryptor
+      class GPG < Base
+        class << self
+
+          ##
+          # The GPG Public key that'll be used to encrypt the backup
+          attr_accessor :key
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/encryptor/open_ssl.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Encryptor
+      class OpenSSL < Base
+        class << self
+
+          ##
+          # The password that'll be used to encrypt the backup. This
+          # password will be required to decrypt the backup later on.
+          attr_accessor :password
+
+          ##
+          # Determines whether the 'base64' should be used or not
+          attr_accessor :base64
+
+          ##
+          # Determines whether the 'salt' flag should be used
+          attr_accessor :salt
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/helpers.rb

@@ -1,24 +1,54 @@
+# encoding: utf-8
+
 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
+
+      ##
+      # Finds all the object's getter methods and checks the global
+      # configuration for these methods, if they respond then they will
+      # assign the object's attribute(s) to that particular global configuration's attribute
+      def load_defaults!
+        c             = self.class.name.split('::')
+        configuration = Backup::Configuration.const_get(c[1]).const_get(c[2])
+
+        getter_methods.each do |attribute|
+          if configuration.respond_to?(attribute)
+            unless configuration.send(attribute).nil?
+              self.send("#{attribute}=", configuration.send(attribute))
+            end
+          end
+        end
       end
-      
-      # A helper method for the config/mail.rb configuration file
-      # Takes a block containing the mail options
-      def notifier_settings(&block)
-        @mail_configuration = Backup::Configuration::Mail.new
-        @mail_configuration.instance_eval &block
+
+      ##
+      # Clears all the defaults that may have been set by the user
+      def clear_defaults!
+        setter_methods.each do |method|
+          self.send(method, nil)
+        end
       end
-      
+
+      ##
+      # Returns an array of the setter methods (as String)
+      def setter_methods
+        methods.map do |method|
+          method = method.to_s
+          method if method =~ /^\w(\w|\d|\_)+\=$/ and method != 'taguri='
+        end.compact
+      end
+
+      ##
+      # Returns an array of getter methods (as Array)
+      def getter_methods
+        methods.map do |method|
+          method = method.to_s
+          if method =~ /^\w(\w|\d|\_)+\=$/ and method != 'taguri='
+            method.sub('=','')
+          end
+        end.compact
+      end
+
     end
   end
-end
+end

data/lib/backup/configuration/notifier/base.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Base < Backup::Configuration::Base
+        class << self
+
+          ##
+          # When set to true, the user will be notified by email
+          # when a backup process ends without raising any exceptions
+          attr_writer :on_success
+
+          ##
+          # When set to true, the user will be notified by email
+          # when a backup process raises an exception before finishing
+          attr_writer :on_failure
+
+        end
+
+        ##
+        # When @on_success is nil it means it hasn't been defined
+        # and will then default to true
+        def self.on_success
+          return true if @on_success.nil?
+          @on_success
+        end
+
+        ##
+        # When @on_failure is nil it means it hasn't been defined
+        # and will then default to true
+        def self.on_failure
+          return true if @on_failure.nil?
+          @on_failure
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/notifier/mail.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Mail < Base
+        class << self
+
+          ##
+          # Sender and Receiver email addresses
+          # Examples:
+          #  sender   - my.email.address@gmail.com
+          #  receiver - your.email.address@gmail.com
+          attr_accessor :from, :to
+
+          ##
+          # The address to use
+          # Example: smtp.gmail.com
+          attr_accessor :address
+
+          ##
+          # The port to connect to
+          # Example: 587
+          attr_accessor :port
+
+          ##
+          # Your domain (if applicable)
+          # Example: mydomain.com
+          attr_accessor :domain
+
+          ##
+          # Username and Password (sender email's credentials)
+          # Examples:
+          #  user_name - meskyanichi
+          #  password  - my_secret_password
+          attr_accessor :user_name, :password
+
+          ##
+          # Authentication type
+          # Example: plain
+          attr_accessor :authentication
+
+          ##
+          # Automatically set TLS
+          # Example: true
+          attr_accessor :enable_starttls_auto
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/base.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class Base < Backup::Configuration::Base
+        class << self
+
+          ##
+          # Sets the limit to how many backups to keep in the remote location.
+          # If the limit exceeds it will remove the oldest backup to make room for the newest
+          attr_accessor :keep
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/cloudfiles.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class CloudFiles < Base
+        class << self
+
+          ##
+          # Rackspace Cloud Files Credentials
+          attr_accessor :api_key, :username
+
+          ##
+          # Rackspace Cloud Files container name and path
+          attr_accessor :container, :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/dropbox.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class Dropbox < Base
+        class << self
+
+          ##
+          # Dropbox user credentials
+          attr_accessor :email, :password
+
+          ##
+          # Dropbox API credentials
+          attr_accessor :api_key, :api_secret
+
+          ##
+          # Path to where the backups will be stored
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/ftp.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class FTP < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and FTP port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/rsync.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class RSync < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SSH port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/s3.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class S3 < Base
+        class << self
+
+          ##
+          # Amazon Simple Storage Service (S3) Credentials
+          attr_accessor :access_key_id, :secret_access_key
+
+          ##
+          # Amazon S3 bucket name and path
+          attr_accessor :bucket, :path
+
+          ##
+          # Region of the specified S3 bucket
+          attr_accessor :region
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/scp.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class SCP < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SCP port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/sftp.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class SFTP < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SFTP port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/database/base.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class Base
+      include Backup::CLI
+      include Backup::Configuration::Helpers
+
+      ##
+      # Contains the path to where the database should be dumped
+      attr_accessor :dump_path
+
+      ##
+      # Allows the user to specify the path to a "dump" utility
+      # in case it cannot be auto-detected by Backup
+      attr_accessor :utility_path
+
+      ##
+      # Defines the @dump_path and ensures it exists by creating it
+      def prepare!
+        @dump_path = File.join(TMP_PATH, TRIGGER, self.class.name.split('::').last)
+        mkdir(dump_path)
+      end
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that Backup is dumping the database
+      def log!
+        Logger.message("#{ self.class } started dumping and archiving \"#{ name }\".")
+      end
+    end
+  end
+end