backup 3.0.2 → 3.0.3.build.0

data/lib/backup/finder.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  class Finder
-    attr_accessor :trigger, :config
-
-    ##
-    # Initializes a new Backup::Finder object
-    # and stores the path to the configuration file
-    def initialize(trigger, config)
-      @trigger = trigger.to_sym
-      @config  = config
-    end
-
-    ##
-    # Tries to find and load the configuration file and return the proper
-    # backup model configuration (specified by the 'trigger')
-    def find
-      unless File.exist?(config)
-        puts "Could not find a configuration file in '#{config}'."; exit
-      end
-
-      ##
-      # Loads the backup configuration file
-      instance_eval(File.read(config))
-
-      ##
-      # Iterates through all the instantiated backup models and returns
-      # the one that matches the specified 'trigger'
-      Backup::Model.all.each do |model|
-        if model.trigger.eql?(trigger)
-          return Backup::Model.current = model
-        end
-      end
-
-      puts "Could not find trigger '#{trigger}' in '#{config}'."; exit
-    end
-  end
-end

data/lib/backup/logger.rb

@@ -1,80 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  class Logger
-
-    ##
-    # Outputs a messages to the console and writes it to the backup.log
-    def self.message(string)
-      puts    loggify(:message, string, :green)
-      to_file loggify(:message, string)
-    end
-
-    ##
-    # Outputs an error to the console and writes it to the backup.log
-    def self.error(string)
-      puts    loggify(:error, string, :red)
-      to_file loggify(:error, string)
-    end
-
-    ##
-    # Outputs a notice to the console and writes it to the backup.log
-    def self.warn(string)
-      puts    loggify(:warning, string, :yellow)
-      to_file loggify(:warning, string)
-    end
-
-    ##
-    # Returns the time in [YYYY/MM/DD HH:MM:SS] format
-    def self.time
-      Time.now.strftime("%Y/%m/%d %H:%M:%S")
-    end
-
-    ##
-    # Builds the string in a log format with the date/time, the type (colorized)
-    # based on whether it's a message, notice or error, and the message itself.
-    # ANSI color codes are only used in the console, and are not written to the log
-    # since it doesn't do anything and just adds more unnecessary bloat to the log file
-    def self.loggify(type, string, color = false)
-      return "[#{time}][#{type}] #{string}" unless color
-      "[#{time}][#{send(color, type)}] #{string}"
-    end
-
-    ##
-    # Writes (appends) a string to the backup.log file
-    def self.to_file(string)
-      File.open(File.join(LOG_PATH, 'backup.log'), 'a') do |file|
-        file.write("#{string}\n")
-      end
-    end
-
-    ##
-    # Invokes the #colorize method with the provided string
-    # and the color code "32" (for green)
-    def self.green(string)
-      colorize(string, 32)
-    end
-
-    ##
-    # Invokes the #colorize method with the provided string
-    # and the color code "33" (for yellow)
-    def self.yellow(string)
-      colorize(string, 33)
-    end
-
-    ##
-    # Invokes the #colorize method the with provided string
-    # and the color code "31" (for red)
-    def self.red(string)
-      colorize(string, 31)
-    end
-
-    ##
-    # Wraps the provided string in colorizing tags to provide
-    # easier to view output to the client
-    def self.colorize(string, code)
-      "\e[#{code}m#{string}\e[0m"
-    end
-
-  end
-end

data/lib/backup/model.rb

@@ -1,249 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  class Model
-    include Backup::CLI
-
-    ##
-    # The trigger is used as an identifier for
-    # initializing the backup process
-    attr_accessor :trigger
-
-    ##
-    # The label is used for a more friendly user output
-    attr_accessor :label
-
-    ##
-    # The databases attribute holds an array of database objects
-    attr_accessor :databases
-
-    ##
-    # The archives attr_accessor holds an array of archive objects
-    attr_accessor :archives
-
-    ##
-    # The encryptors attr_accessor holds an array of encryptor objects
-    attr_accessor :encryptors
-
-    ##
-    # The compressors attr_accessor holds an array of compressor objects
-    attr_accessor :compressors
-
-    ##
-    # The notifiers attr_accessor holds an array of notifier objects
-    attr_accessor :notifiers
-
-    ##
-    # The storages attribute holds an array of storage objects
-    attr_accessor :storages
-
-    ##
-    # The time when the backup initiated (in format: 2011.02.20.03.29.59)
-    attr_accessor :time
-
-    class << self
-      ##
-      # The Backup::Model.all class method keeps track of all the models
-      # that have been instantiated. It returns the @all class variable,
-      # which contains an array of all the models
-      attr_accessor :all
-
-      ##
-      # Contains the current file extension (this changes from time to time after a file
-      # gets compressed or encrypted so we can keep track of the correct file when new
-      # extensions get appended to the current file name)
-      attr_accessor :extension
-
-      ##
-      # Contains the currently-in-use model. This attribute should get set by Backup::Finder.
-      # Use Backup::Model.current to retrieve the actual data of the model
-      attr_accessor :current
-
-      ##
-      # Returns the full path to the current file (including the current extension).
-      # To just return the filename and extension without the path, use File.basename(Backup::Model.file)
-      def file
-        File.join(TMP_PATH, "#{ TIME }.#{ TRIGGER }.#{ Backup::Model.extension }")
-      end
-
-      ##
-      # Returns the temporary trigger path of the current model
-      # e.g. /Users/Michael/tmp/backup/my_trigger
-      def tmp_path
-        File.join(TMP_PATH, TRIGGER)
-      end
-    end
-
-    ##
-    # Accessible through "Backup::Model.all", it stores an array of Backup::Model instances.
-    # Everytime a new Backup::Model gets instantiated it gets pushed into this array
-    @all = Array.new
-
-    ##
-    # Contains the current file extension (should change after each compression or encryption)
-    @extension = 'tar'
-
-    ##
-    # Takes a trigger, label and the configuration block and instantiates the model.
-    # The TIME (time of execution) gets stored in the @time attribute.
-    # After the instance has evaluated the configuration block and properly set the
-    # configuration for the model, it will append the newly created "model" instance
-    # to the @all class variable (Array) so it can be accessed by Backup::Finder
-    # and any other location
-    def initialize(trigger, label, &block)
-      @trigger     = trigger
-      @label       = label
-      @time        = TIME
-
-      @databases   = Array.new
-      @archives    = Array.new
-      @encryptors  = Array.new
-      @compressors = Array.new
-      @storages    = Array.new
-      @notifiers   = Array.new
-
-      instance_eval(&block)
-      Backup::Model.all << self
-    end
-
-    ##
-    # Adds a database to the array of databases
-    # to dump during the backup process
-    def database(database, &block)
-      @databases << Backup::Database.const_get(
-        last_constant(database)
-      ).new(&block)
-    end
-
-    ##
-    # Adds an archive to the array of archives
-    # to store during the backup process
-    def archive(name, &block)
-      @archives << Backup::Archive.new(name, &block)
-    end
-
-    ##
-    # Adds an encryptor to the array of encryptors
-    # to use during the backup process
-    def encrypt_with(name, &block)
-      @encryptors << Backup::Encryptor.const_get(
-        last_constant(name)
-      ).new(&block)
-    end
-
-    ##
-    # Adds a compressor to the array of compressors
-    # to use during the backup process
-    def compress_with(name, &block)
-      @compressors << Backup::Compressor.const_get(
-        last_constant(name)
-      ).new(&block)
-    end
-
-    ##
-    # Adds a notifier to the array of notifiers
-    # to use during the backup process
-    def notify_by(name, &block)
-      @notifiers << Backup::Notifier.const_get(
-        last_constant(name)
-      ).new(&block)
-    end
-
-    ##
-    # Adds a storage method to the array of storage
-    # methods to use during the backup process
-    def store_with(storage, &block)
-      @storages << Backup::Storage.const_get(
-        last_constant(storage)
-      ).new(&block)
-    end
-
-    ##
-    # Performs the backup process
-    ##
-    # [Databases]
-    # Runs all (if any) database objects to dump the databases
-    ##
-    # [Archives]
-    # Runs all (if any) archive objects to package all their
-    # paths in to a single tar file and places it in the backup folder
-    ##
-    # [Package]
-    # After all the database dumps and archives are placed inside
-    # the folder, it'll make a single .tar package (archive) out of it
-    ##
-    # [Encryption]
-    # Optionally encrypts the packaged file with one or more encryptors
-    ##
-    # [Compression]
-    # Optionally compresses the packaged file with one or more compressors
-    ##
-    # [Storages]
-    # Runs all (if any) storage objects to store the backups to remote locations
-    # and (if configured) it'll cycle the files on the remote location to limit the
-    # amount of backups stored on each individual location
-    ##
-    # [Notifiers]
-    # Runs all (if any) notifier objects when a backup proces finished with or without
-    # any errors.
-    ##
-    # [Cleaning]
-    # After the whole backup process finishes, it'll go ahead and remove any temporary
-    # file that it produced. If an exception(error) is raised during this process which
-    # breaks the process, it'll always ensure it removes the temporary files regardless
-    # to avoid mass consumption of storage space on the machine
-    def perform!
-      begin
-        databases.each   { |d| d.perform! }
-        archives.each    { |a| a.perform! }
-        package!
-        compressors.each { |c| c.perform! }
-        encryptors.each  { |e| e.perform! }
-        storages.each    { |s| s.perform! }
-        notifiers.each   { |n| n.perform!(self) }
-        clean!
-      rescue Exception => exception
-        clean!
-        notifiers.each   { |n| n.perform!(self, exception) }
-        show_exception!(exception)
-      end
-    end
-
-  private
-
-    ##
-    # After all the databases and archives have been dumped and sorted,
-    # these files will be bundled in to a .tar archive (uncompressed) so it
-    # becomes a single (transferrable) packaged file.
-    def package!
-      Logger.message "Backup started packaging everything to a single archive file."
-      run("#{ utility(:tar) } -c -C '#{ TMP_PATH }' '#{ TRIGGER }' > '#{ File.join(TMP_PATH, "#{TIME}.#{TRIGGER}.tar") }'")
-    end
-
-    ##
-    # Cleans up the temporary files that were created after the backup process finishes
-    def clean!
-      Logger.message "Backup started cleaning up the temporary files."
-      run("#{ utility(:rm) } -rf '#{ File.join(TMP_PATH, TRIGGER) }' '#{ File.join(TMP_PATH, "#{TIME}.#{TRIGGER}.#{Backup::Model.extension}") }'")
-    end
-
-    ##
-    # Returns the string representation of the last value of a nested constant
-    # example:
-    #  Backup::Model::MySQL
-    # becomes and returns:
-    #  "MySQL"
-    def last_constant(constant)
-      constant.to_s.split("::").last
-    end
-
-    ##
-    # Formats an exception
-    def show_exception!(exception)
-      puts ("=" * 75) + "\nException that got raised:\n#{exception}\n" + ("=" * 75) + "\n" + exception.backtrace.join("\n")
-      puts ("=" * 75) + "\n\nYou are running Backup version \"#{Backup::Version.current}\" and Ruby version \"#{ENV['RUBY_VERSION']}\".\n"
-      puts "If you've setup a \"Notification\" in your configuration file, the above error will have been sent."
-    end
-
-  end
-end

data/lib/backup/notifier/base.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  module Notifier
-    class Base
-      include Backup::Configuration::Helpers
-
-      ##
-      # When set to true, the user will be notified by email
-      # when a backup process ends without raising any exceptions
-      attr_accessor :on_success
-      alias :notify_on_success? :on_success
-
-      ##
-      # When set to true, the user will be notified by email
-      # when a backup process raises an exception before finishing
-      attr_accessor :on_failure
-      alias :notify_on_failure? :on_failure
-
-      ##
-      # Logs a message to the console and log file to inform
-      # the client that Backup is notifying about the process
-      def log!
-        Logger.message "#{ self.class } started notifying about the process."
-      end
-
-    end
-  end
-end

data/lib/backup/notifier/binder.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  module Notifier
-    class Binder
-
-      ##
-      # Shortcut to create a new instance of a binder, setting
-      # the instance variables using a Hash of key/values and getting
-      # the instance's binding. This returns the binding of the new Binder instance
-      def self.bind(key_and_values = {})
-        Binder.new(key_and_values).get_binding
-      end
-
-      ##
-      # Creates a new Backup::Notifier::Binder instance. Loops through the provided
-      # Hash to set instance variables
-      def initialize(key_and_values)
-        key_and_values.each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
-      end
-
-      ##
-      # Returns the binding (needs a wrapper method because #binding is a private method)
-      def get_binding
-        binding
-      end
-
-    end
-  end
-end

data/lib/backup/notifier/mail.rb

@@ -1,141 +0,0 @@
-# encoding: utf-8
-
-##
-# Only load the Mail gem and Erb library when using Mail notifications
-require 'mail'
-require 'erb'
-
-module Backup
-  module Notifier
-    class Mail < Base
-
-      ##
-      # Container for the Mail object
-      attr_accessor :mail
-
-      ##
-      # Container for the Model object
-      attr_accessor :model
-
-      ##
-      # 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
-
-      ##
-      # Instantiates a new Backup::Notifier::Mail object
-      def initialize(&block)
-        load_defaults!
-
-        instance_eval(&block) if block_given?
-
-        set_defaults!
-      end
-
-      ##
-      # Performs the notification
-      # Takes an exception object that might've been created if an exception occurred.
-      # If this is the case it'll invoke notify_failure!(exception), otherwise, if no
-      # error was raised, it'll go ahead and notify_success!
-      #
-      # If'll only perform these if on_success is true or on_failure is true
-      def perform!(model, exception = false)
-        @model = model
-
-        if notify_on_success? and exception.eql?(false)
-          log!
-          notify_success!
-        elsif notify_on_failure? and not exception.eql?(false)
-          log!
-          notify_failure!(exception)
-        end
-      end
-
-    private
-
-      ##
-      # Sends an email informing the user that the backup operation
-      # proceeded without any errors
-      def notify_success!
-        mail[:subject] = "[Backup::Succeeded] #{model.label} (#{model.trigger})"
-        mail[:body]    = read_template('notify_success', Binder.bind(:model => @model))
-        mail.deliver!
-      end
-
-      ##
-      # Sends an email informing the user that the backup operation
-      # raised an exception and will send the user the error details
-      def notify_failure!(exception)
-        mail[:subject] = "[Backup::Failed] #{model.label} (#{model.trigger})"
-        mail[:body]    = read_template('notify_failure', Binder.bind(:model => @model, :exception => exception))
-        mail.deliver!
-      end
-
-      ##
-      # Configures the Mail gem by setting the defaults.
-      # Instantiates the @mail object with the @to and @from attributes
-      def set_defaults!
-        defaults = {
-          :address              => @address,
-          :port                 => @port,
-          :domain               => @domain,
-          :user_name            => @user_name,
-          :password             => @password,
-          :authentication       => @authentication,
-          :enable_starttls_auto => @enable_starttls_auto
-        }
-
-        ::Mail.defaults do
-          delivery_method :smtp, defaults
-        end
-
-        @mail        = ::Mail.new
-        @mail[:from] = @from
-        @mail[:to]   = @to
-      end
-
-      ##
-      # Returns the path to the templates, appended by the passed in argument
-      def read_template(file, binder)
-        ERB.new(File.read(
-          File.join( File.dirname(__FILE__), "templates", "#{file}.erb" )
-        )).result(binder)
-      end
-
-    end
-  end
-end