backup 3.0.3.build.0 → 3.0.3

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
+
+          ##
+          # Files/Folders to Sync
+          attr_accessor :folders
+
+          ##
+          # Path to store the synced files/folders to
+          attr_accessor :path
+
+          ##
+          # Flag for mirroring the files/folders
+          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/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

data/lib/backup/database/mysql.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MySQL < 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, :socket
+
+      ##
+      # Tables to skip while dumping the database
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump, tables that aren't specified won't get dumped
+      attr_accessor :only_tables
+
+      ##
+      # Additional "mysqldump" options
+      attr_accessor :additional_options
+
+      ##
+      # Creates a new instance of the MySQL adapter object
+      def initialize(&block)
+        load_defaults!
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block)
+        prepare!
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to skip
+      # during the dumping of the database
+      def tables_to_skip
+        skip_tables.map do |table|
+          "--ignore-table='#{name}.#{table}'"
+        end.join("\s")
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.join("\s")
+      end
+
+      ##
+      # Builds the credentials MySQL 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)}'".gsub('--username', '--user')
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds the MySQL connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port socket].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 MySQL compatible string for the additional options
+      # specified by the user
+      def options
+        additional_options.join("\s")
+      end
+
+      ##
+      # Builds the full mysqldump string based on all attributes
+      def mysqldump
+        "#{ utility(:mysqldump) } #{ credential_options } #{ connectivity_options } " +
+        "#{ options } #{ name } #{ tables_to_dump } #{ tables_to_skip }"
+      end
+
+      ##
+      # Performs the mysqldump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        log!
+        run("#{mysqldump} > '#{File.join(dump_path, name)}.sql'")
+      end
+
+    end
+  end
+end

data/lib/backup/database/postgresql.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class PostgreSQL < 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, :socket
+
+      ##
+      # Tables to skip while dumping the database
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump, tables that aren't specified won't get dumped
+      attr_accessor :only_tables
+
+      ##
+      # Additional "pg_dump" options
+      attr_accessor :additional_options
+
+      ##
+      # Creates a new instance of the PostgreSQL adapter object
+      # Sets the PGPASSWORD environment variable to the password
+      # so it doesn't prompt and hang in the process
+      def initialize(&block)
+        load_defaults!
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block)
+        prepare!
+        ENV['PGPASSWORD'] = password
+      end
+
+      ##
+      # Builds the PostgreSQL syntax for specifying which tables to skip
+      # during the dumping of the database
+      def tables_to_skip
+        skip_tables.map do |table|
+          "--exclude-table='#{table}'"
+        end.join("\s")
+      end
+
+      ##
+      # Builds the PostgreSQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.map do |table|
+          "--table='#{table}'"
+        end.join("\s")
+      end
+
+      ##
+      # Builds the credentials PostgreSQL syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        return '' unless username.is_a?(String) and not username.empty?
+        "--username='#{username}'"
+      end
+
+      ##
+      # Builds the PostgreSQL connectivity options syntax to connect the user
+      # to perform the database dumping process, socket gets gsub'd to host since
+      # that's the option PostgreSQL takes for socket connections as well. In case
+      # both the host and the socket are specified, the socket will take priority over the host
+      def connectivity_options
+        %w[host port socket].map do |option|
+          next if send(option).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          "--#{option}='#{send(option)}'".gsub('--socket=', '--host=')
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds a PostgreSQL compatible string for the additional options
+      # specified by the user
+      def options
+        additional_options.join("\s")
+      end
+
+      ##
+      # Builds the full pgdump string based on all attributes
+      def pgdump
+        "#{ utility(:pg_dump) } #{ credential_options } #{ connectivity_options } " +
+        "#{ options } #{ tables_to_dump } #{ tables_to_skip } #{ name }"
+      end
+
+      ##
+      # Performs the pgdump command and outputs the
+      # data to the specified path based on the 'trigger'
+      # and resets the 'PGPASSWORD' environment variable to nil
+      def perform!
+        log!
+        run("#{pgdump} > '#{File.join(dump_path, name)}.sql'")
+        ENV['PGPASSWORD'] = nil
+      end
+
+    end
+  end
+end