backup 3.0.2 → 3.0.3.build.0

data/lib/backup/archive.rb

@@ -1,54 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,61 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-# 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

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

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

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

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

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

@@ -1,35 +0,0 @@
-# encoding: utf-8
-
-module Backup
-  module Configuration
-    module Database
-      class Redis < Base
-        class << self
-
-          ##
-          # Name of and path to the database that needs to get dumped
-          attr_accessor :name, :path
-
-          ##
-          # Credentials for the specified database
-          attr_accessor :password
-
-          ##
-          # Determines whether Backup should invoke the SAVE command through
-          # the 'redis-cli' utility to persist the most recent data before
-          # copying over the dump file
-          attr_accessor :invoke_save
-
-          ##
-          # Connectivity options
-          attr_accessor :host, :port, :socket
-
-          ##
-          # Additional "redis-cli" options
-          attr_accessor :additional_options
-
-        end
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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