alg-backup 3.0.10

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/notifier/twitter.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Twitter < Base
+        class << self
+
+          ##
+          # Twitter consumer key credentials
+          attr_accessor :consumer_key, :consumer_secret
+
+          ##
+          # OAuth credentials
+          attr_accessor :oauth_token, :oauth_token_secret
+
+        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,29 @@
+# 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
+
+          ##
+          # Dropbox connection timeout
+          attr_accessor :timeout
+
+        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/configuration/syncer/rsync.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      class RSync < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SSH port
+          attr_accessor :ip
+
+          ##
+          # The SSH port to connect to
+          attr_accessor :port
+
+          ##
+          # Directories to sync
+          attr_accessor :directories
+
+          ##
+          # Path to store the synced files/directories to
+          attr_accessor :path
+
+          ##
+          # Flag for mirroring the files/directories
+          attr_accessor :mirror
+
+          ##
+          # Flag for compressing (only compresses for the transfer)
+          attr_accessor :compress
+
+          ##
+          # Additional options for the rsync cli
+          attr_accessor :additional_options
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      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 to sync to
+          attr_accessor :bucket, :path
+
+          ##
+          # Directories to sync
+          attr_accessor :directories
+
+          ##
+          # Flag to enable mirroring
+          attr_accessor :mirror
+
+          ##
+          # Additional options for the s3sync cli
+          attr_accessor :additional_options
+
+        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

data/lib/backup/database/mongodb.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MongoDB < Base
+
+      ##
+      # Name of the database that needs to get dumped
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port
+
+      ##
+      # IPv6 support (disabled by default)
+      attr_accessor :ipv6
+
+      ##
+      # Collections to dump, collections that aren't specified won't get dumped
+      attr_accessor :only_collections
+
+      ##
+      # Additional "mongodump" options
+      attr_accessor :additional_options
+
+      ##
+      # Creates a new instance of the MongoDB database object
+      def initialize(&block)
+        load_defaults!
+
+        @only_collections   ||= Array.new
+        @additional_options ||= Array.new
+        @ipv6               ||= false
+
+        instance_eval(&block)
+        prepare!
+      end
+
+      ##
+      # Builds the MongoDB credentials syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        %w[username password].map do |option|
+          next if send(option).nil? or send(option).empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds the MongoDB connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port].map do |option|
+          next if send(option).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          "--#{option}='#{send(option)}'"
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds a MongoDB compatible string for the
+      # additional options specified by the user
+      def additional_options
+        @additional_options.join("\s")
+      end
+
+      ##
+      # Returns an array of collections to dump
+      def collections_to_dump
+        @only_collections
+      end
+
+      ##
+      # Returns the MongoDB database selector syntax
+      def database
+        "--db='#{ name }'"
+      end
+
+      ##
+      # Returns the mongodump syntax for enabling ipv6
+      def ipv6
+        @ipv6.eql?(true) ? '--ipv6' : ''
+      end
+
+      ##
+      # Returns the MongoDB syntax for determining where to output all the database dumps,
+      # e.g. ~/Backup/.tmp/MongoDB/<databases here>/<database collections>
+      def dump_directory
+        "--out='#{ dump_path }'"
+      end
+
+      ##
+      # Builds the full mongodump string based on all attributes
+      def mongodump
+        "#{ utility(:mongodump) } #{ database } #{ credential_options } " +
+        "#{ connectivity_options } #{ ipv6 } #{ additional_options } #{ dump_directory }"
+      end
+
+      ##
+      # Performs the mongodump command and outputs the data to the
+      # specified path based on the 'trigger'. If the user hasn't specified any
+      # specific collections to dump, it'll dump everything. If the user has specified
+      # collections to dump, it'll loop through the array of collections and invoke the
+      # 'mongodump' command once per collection
+      def perform!
+        log!
+
+        if collections_to_dump.is_a?(Array) and not collections_to_dump.empty?
+          specific_collection_dump!
+        else
+          dump!
+        end
+      end
+
+      ##
+      # Builds and runs the mongodump command
+      def dump!
+        run(mongodump)
+      end
+
+      ##
+      # For each collection in the @only_collections array, it'll
+      # build the whole 'mongodump' command, append the '--collection' option,
+      # and run the command built command
+      def specific_collection_dump!
+        collections_to_dump.each do |collection|
+          run("#{mongodump} --collection='#{collection}'")
+        end
+      end
+
+    end
+  end
+end