backup 3.0.3.build.0 → 3.0.3

data/lib/backup.rb

@@ -0,0 +1,162 @@
+# encoding: utf-8
+
+require 'fileutils'
+require 'yaml'
+
+##
+# The Backup Ruby Gem
+module Backup
+
+  ##
+  # List the available database, storage, compressor, encryptor and notifier constants.
+  # These are used to dynamically define these constants as classes inside Backup::Finder
+  # to provide a nicer configuration file DSL syntax to the users. Adding existing constants
+  # to the arrays below will enable the user to use a constant instead of a string.
+  # Example, instead of:
+  #  database "MySQL" do |mysql|
+  # You can do:
+  #  database MySQL do |mysql|
+  DATABASES   = ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis']
+  STORAGES    = ['S3', 'CloudFiles', 'Dropbox', 'FTP', 'SFTP', 'SCP', 'RSync']
+  COMPRESSORS = ['Gzip']
+  ENCRYPTORS  = ['OpenSSL', 'GPG']
+  NOTIFIERS   = ['Mail']
+  SYNCERS     = ['RSync']
+
+  ##
+  # Backup's internal paths
+  LIBRARY_PATH       = File.join(File.dirname(__FILE__), 'backup')
+  CONFIGURATION_PATH = File.join(LIBRARY_PATH, 'configuration')
+  STORAGE_PATH       = File.join(LIBRARY_PATH, 'storage')
+  DATABASE_PATH      = File.join(LIBRARY_PATH, 'database')
+  COMPRESSOR_PATH    = File.join(LIBRARY_PATH, 'compressor')
+  ENCRYPTOR_PATH     = File.join(LIBRARY_PATH, 'encryptor')
+  NOTIFIER_PATH      = File.join(LIBRARY_PATH, 'notifier')
+  SYNCER_PATH        = File.join(LIBRARY_PATH, 'syncer')
+
+  ##
+  # Backup's Environment paths
+  PATH               = File.join(ENV['HOME'], 'Backup')
+  DATA_PATH          = File.join(ENV['HOME'], 'Backup', 'data')
+  CONFIG_FILE        = File.join(ENV['HOME'], 'Backup', 'config.rb')
+  LOG_PATH           = File.join(ENV['HOME'], 'Backup', 'log')
+  TMP_PATH           = File.join(ENV['HOME'], 'Backup', '.tmp')
+
+  ##
+  # Autoload Backup base files
+  autoload :Model,   File.join(LIBRARY_PATH, 'model')
+  autoload :Archive, File.join(LIBRARY_PATH, 'archive')
+  autoload :CLI,     File.join(LIBRARY_PATH, 'cli')
+  autoload :Finder,  File.join(LIBRARY_PATH, 'finder')
+  autoload :Logger,  File.join(LIBRARY_PATH, 'logger')
+  autoload :Version, File.join(LIBRARY_PATH, 'version')
+
+  ##
+  # Autoload Backup configuration files
+  module Configuration
+    autoload :Base,     File.join(CONFIGURATION_PATH, 'base')
+    autoload :Helpers,  File.join(CONFIGURATION_PATH, 'helpers')
+
+    module Notifier
+      autoload :Base, File.join(CONFIGURATION_PATH, 'notifier', 'base')
+      autoload :Mail, File.join(CONFIGURATION_PATH, 'notifier', 'mail')
+    end
+
+    module Encryptor
+      autoload :Base,    File.join(CONFIGURATION_PATH, 'encryptor', 'base')
+      autoload :OpenSSL, File.join(CONFIGURATION_PATH, 'encryptor', 'open_ssl')
+      autoload :GPG,     File.join(CONFIGURATION_PATH, 'encryptor', 'gpg')
+    end
+
+    module Compressor
+      autoload :Base, File.join(CONFIGURATION_PATH, 'compressor', 'base')
+      autoload :Gzip, File.join(CONFIGURATION_PATH, 'compressor', 'gzip')
+    end
+
+    module Storage
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'storage', 'base')
+      autoload :S3,         File.join(CONFIGURATION_PATH, 'storage', 's3')
+      autoload :CloudFiles, File.join(CONFIGURATION_PATH, 'storage', 'cloudfiles')
+      autoload :Dropbox,    File.join(CONFIGURATION_PATH, 'storage', 'dropbox')
+      autoload :FTP,        File.join(CONFIGURATION_PATH, 'storage', 'ftp')
+      autoload :SFTP,       File.join(CONFIGURATION_PATH, 'storage', 'sftp')
+      autoload :SCP,        File.join(CONFIGURATION_PATH, 'storage', 'scp')
+      autoload :RSync,      File.join(CONFIGURATION_PATH, 'storage', 'rsync')
+    end
+
+    module Syncer
+      autoload :RSync, File.join(CONFIGURATION_PATH, 'syncer', 'rsync')
+    end
+
+    module Database
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'database', 'base')
+      autoload :MySQL,      File.join(CONFIGURATION_PATH, 'database', 'mysql')
+      autoload :PostgreSQL, File.join(CONFIGURATION_PATH, 'database', 'postgresql')
+      autoload :MongoDB,    File.join(CONFIGURATION_PATH, 'database', 'mongodb')
+      autoload :Redis,      File.join(CONFIGURATION_PATH, 'database', 'redis')
+    end
+  end
+
+  ##
+  # Autoload Backup storage files
+  module Storage
+    autoload :Base,       File.join(STORAGE_PATH, 'base')
+    autoload :Object,     File.join(STORAGE_PATH, 'object')
+    autoload :S3,         File.join(STORAGE_PATH, 's3')
+    autoload :CloudFiles, File.join(STORAGE_PATH, 'cloudfiles')
+    autoload :Dropbox,    File.join(STORAGE_PATH, 'dropbox')
+    autoload :FTP,        File.join(STORAGE_PATH, 'ftp')
+    autoload :SFTP,       File.join(STORAGE_PATH, 'sftp')
+    autoload :SCP,        File.join(STORAGE_PATH, 'scp')
+    autoload :RSync,      File.join(STORAGE_PATH, 'rsync')
+  end
+
+  ##
+  # Autoload Backup syncer files
+  module Syncer
+    autoload :RSync, File.join(SYNCER_PATH, 'rsync')
+  end
+
+  ##
+  # Autoload Backup database files
+  module Database
+    autoload :Base,       File.join(DATABASE_PATH, 'base')
+    autoload :MySQL,      File.join(DATABASE_PATH, 'mysql')
+    autoload :PostgreSQL, File.join(DATABASE_PATH, 'postgresql')
+    autoload :MongoDB,    File.join(DATABASE_PATH, 'mongodb')
+    autoload :Redis,      File.join(DATABASE_PATH, 'redis')
+  end
+
+  ##
+  # Autoload compressor files
+  module Compressor
+    autoload :Base, File.join(COMPRESSOR_PATH, 'base')
+    autoload :Gzip, File.join(COMPRESSOR_PATH, 'gzip')
+  end
+
+  ##
+  # Autoload encryptor files
+  module Encryptor
+    autoload :Base,    File.join(ENCRYPTOR_PATH, 'base')
+    autoload :OpenSSL, File.join(ENCRYPTOR_PATH, 'open_ssl')
+    autoload :GPG,     File.join(ENCRYPTOR_PATH, 'gpg')
+  end
+
+  ##
+  # Autoload notification files
+  module Notifier
+    autoload :Base,   File.join(NOTIFIER_PATH, 'base')
+    autoload :Binder, File.join(NOTIFIER_PATH, 'binder')
+    autoload :Mail,   File.join(NOTIFIER_PATH, 'mail')
+  end
+
+  ##
+  # Dynamically defines all the available database, storage, compressor, encryptor and notifier
+  # classes inside Backup::Finder to improve the DSL for the configuration file
+  (DATABASES + STORAGES + COMPRESSORS + ENCRYPTORS + NOTIFIERS + SYNCERS).each do |constant|
+    unless Backup::Finder.const_defined?(constant)
+      Backup::Finder.const_set(constant, Class.new)
+    end
+  end
+
+end

data/lib/backup/archive.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module Backup
+  class Archive
+    include Backup::CLI
+
+    ##
+    # Stores the name of the archive
+    attr_accessor :name
+
+    ##
+    # Stores an array of different paths/files to store
+    attr_accessor :paths
+
+    ##
+    # Stores the path to the archive directory
+    attr_accessor :archive_path
+
+    ##
+    # Takes the name of the archive and the configuration block
+    def initialize(name, &block)
+      @name         = name.to_sym
+      @paths        = Array.new
+      @archive_path = File.join(TMP_PATH, TRIGGER, 'archive')
+
+      instance_eval(&block)
+    end
+
+    ##
+    # Adds new paths to the @paths instance variable array
+    def add(path)
+      @paths << path
+    end
+
+    ##
+    # Archives all the provided paths in to a single .tar file
+    # and places that .tar file in the folder which later will be packaged
+    def perform!
+      mkdir(archive_path)
+      Logger.message("#{ self.class } started packaging and archiving #{ paths.map { |path| "\"#{path}\""}.join(", ") }.")
+      run("#{ utility(:tar) } -c #{ paths_to_package } 1> '#{ File.join(archive_path, "#{name}.tar") }' 2> /dev/null")
+    end
+
+  private
+
+    ##
+    # Returns a "tar-ready" string of all the specified paths combined
+    def paths_to_package
+      paths.map do |path|
+        "'#{path}'"
+      end.join("\s")
+    end
+  end
+end

data/lib/backup/cli.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+module Backup
+  module CLI
+
+    ##
+    # Wrapper method for %x[] to run CL commands
+    # through a ruby method. This helps with test coverage and
+    # improves readability
+    def run(command)
+      %x[#{command}]
+    end
+
+    ##
+    # Wrapper method for FileUtils.mkdir_p to create directories
+    # through a ruby method. This helps with test coverage and
+    # improves readability
+    def mkdir(path)
+      FileUtils.mkdir_p(path)
+    end
+
+    ##
+    # Wrapper for the FileUtils.rm_rf to remove files and folders
+    # through a ruby method. This helps with test coverage and
+    # improves readability
+    def rm(path)
+      FileUtils.rm_rf(path)
+    end
+
+    ##
+    # Tries to find the full path of the specified utility. If the full
+    # path is found, it'll return that. Otherwise it'll just return the
+    # name of the utility. If the 'utility_path' is defined, it'll check
+    # to see if it isn't an empty string, and if it isn't, it'll go ahead and
+    # always use that path rather than auto-detecting it
+    def utility(name)
+      if respond_to?(:utility_path)
+        if utility_path.is_a?(String) and not utility_path.empty?
+          return utility_path
+        end
+      end
+
+      if path = %x[which #{name}].chomp and not path.empty?
+        return path
+      end
+      name
+    end
+
+  end
+end

data/lib/backup/compressor/base.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Base
+      include Backup::CLI
+      include Backup::Configuration::Helpers
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that Backup is compressing the archive
+      def log!
+        Backup::Logger.message "#{ self.class } started compressing the archive."
+      end
+    end
+  end
+end

data/lib/backup/compressor/gzip.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Gzip < Base
+
+      ##
+      # Tells Backup::Compressor::Gzip to compress
+      # better rather than faster when set to true
+      attr_writer :best
+
+      ##
+      # Tells Backup::Compressor::Gzip to compress
+      # faster rather than better when set to true
+      attr_writer :fast
+
+      ##
+      # Creates a new instance of Backup::Compressor::Gzip and
+      # configures it to either compress faster or better
+      def initialize(&block)
+        load_defaults!
+
+        @best ||= false
+        @fast ||= false
+
+        instance_eval(&block) if block_given?
+      end
+
+      ##
+      # Performs the compression of the packages backup file
+      def perform!
+        log!
+        run("#{ utility(:gzip) } #{ options } '#{ Backup::Model.file }'")
+        Backup::Model.extension += '.gz'
+      end
+
+    private
+
+      ##
+      # Combines the provided options and returns a gzip options string
+      def options
+        (best + fast).join("\s")
+      end
+
+      ##
+      # Returns the gzip option syntax for compressing
+      # better when @best is set to true
+      def best
+        return ['--best'] if @best; []
+      end
+
+      ##
+      # Returns the gzip option syntax for compressing
+      # faster when @fast is set to true
+      def fast
+        return ['--fast'] if @fast; []
+      end
+
+    end
+  end
+end

data/lib/backup/configuration/base.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    class Base
+      extend Backup::Configuration::Helpers
+
+      ##
+      # Allows for global configuration through block-notation
+      def self.defaults
+        yield self
+      end
+    end
+  end
+end

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

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

data/lib/backup/configuration/compressor/gzip.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Gzip < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Gzip to compress
+          # better rather than faster when set to true
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Gzip to compress
+          # faster rather than better when set to true
+          attr_accessor :fast
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class Base < Backup::Configuration::Base
+        class << self
+
+          ##
+          # Allows the user to specify the path to a "dump" utility
+          # in case it cannot be auto-detected by Backup
+          attr_accessor :utility_path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/database/mongodb.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class MongoDB < Base
+        class << self
+
+          ##
+          # 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
+
+        end
+      end
+    end
+  end
+end