backup 3.0.20 → 3.0.21

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

@@ -3,8 +3,7 @@
 module Backup
   module Configuration
     module Compressor
-      class Base < Backup::Configuration::Base
-      end
+      class Base < Configuration::Base; end
     end
   end
 end

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

@@ -16,10 +16,10 @@ module Backup
           # faster (-1) (but not significantly faster)
           attr_accessor :fast
 
-          ##                                                                                                                                                                         
-          # Tells Backup::Compressor::Pbzip2 how many processors                                                                                                                     
-          # use, by default autodetect is used                                                                                                                                       
-          attr_writer :processors
+          ##
+          # Tells Backup::Compressor::Pbzip2 how many processors
+          # use, by default autodetect is used
+          attr_accessor :processors
 
         end
       end

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

@@ -3,12 +3,13 @@
 module Backup
   module Configuration
     module Database
-      class Base < Backup::Configuration::Base
+      class Base < Configuration::Base
         class << self
 
           ##
           # Allows the user to specify the path to a "dump" utility
           # in case it cannot be auto-detected by Backup
+          # [DEPRECATED] - use <utility_name>_utility methods
           attr_accessor :utility_path
 
         end

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

@@ -30,6 +30,14 @@ module Backup
           # Additional "mongodump" options
           attr_accessor :additional_options
 
+          ##
+          # Path to the mongodump utility (optional)
+          attr_accessor :mongodump_utility
+
+          ##
+          # Path to the mongo utility (optional)
+          attr_accessor :mongo_utility
+
           ##
           # 'lock' dump meaning wrapping mongodump with fsync & lock
           attr_accessor :lock

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

@@ -30,6 +30,10 @@ module Backup
           # Additional "mysqldump" options
           attr_accessor :additional_options
 
+          ##
+          # Path to mysqldump utility (optional)
+          attr_accessor :mysqldump_utility
+
         end
       end
     end

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

@@ -30,6 +30,10 @@ module Backup
           # Additional "pg_dump" options
           attr_accessor :additional_options
 
+          ##
+          # Path to pg_dump utility (optional)
+          attr_accessor :pg_dump_utility
+
         end
       end
     end

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

@@ -28,6 +28,10 @@ module Backup
           # Additional "redis-cli" options
           attr_accessor :additional_options
 
+          ##
+          # Path to the redis-cli utility (optional)
+          attr_accessor :redis_cli_utility
+
         end
       end
     end

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

@@ -18,8 +18,12 @@ module Backup
           # Cookie is the Erlang cookie/shared secret used to connect to the node.
           attr_accessor :cookie
 
+          ##
+          # Path to riak-admin utility (optional)
+          attr_accessor :riak_admin_utility
+
         end
       end
     end
   end
-end
+end

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

@@ -3,8 +3,7 @@
 module Backup
   module Configuration
     module Encryptor
-      class Base < Backup::Configuration::Base
-      end
+      class Base < Configuration::Base; end
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Backup
           # The password that'll be used to encrypt the backup. This
           # password will be required to decrypt the backup later on.
           attr_accessor :password
-          
+
           ##
           # The password file used for encrypting the backup.  This
           # password file will be required to decrypt the backup later

data/lib/backup/configuration/helpers.rb

@@ -9,8 +9,11 @@ module Backup
       # configuration for these methods, if they respond then they will
       # assign the object's attribute(s) to that particular global configuration's attribute
       def load_defaults!
-        c                  = self.class.name.split('::')
-        configuration      = Backup::Configuration.const_get(c[1]).const_get(c[2])
+        module_names  = self.class.name.split('::')[1..-1]
+        configuration = Backup::Configuration
+        module_names.each do |module_name|
+          configuration = configuration.const_get(module_name)
+        end
 
         getter_methods.each do |attribute|
           if configuration.respond_to?(attribute)
@@ -27,6 +30,8 @@ module Backup
         end
       end
 
+      private
+
       ##
       # Returns an Array of the setter methods (as String)
       def setter_methods

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

@@ -3,49 +3,25 @@
 module Backup
   module Configuration
     module Notifier
-      class Base < Backup::Configuration::Base
+      class Base < 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
+          attr_accessor :on_success
 
           ##
           # When set to true, the user will be notified by email
           # when a backup process ends successfully, but logged warnings
-          attr_writer :on_warning
+          attr_accessor :on_warning
 
           ##
           # When set to true, the user will be notified by email
           # when a backup process raises an exception before finishing
-          attr_writer :on_failure
+          attr_accessor :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_success is nil it means it hasn't been defined
-        # and will then default to true
-        def self.on_warning
-          return true if @on_warning.nil?
-          @on_warning
-        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

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

@@ -3,7 +3,7 @@
 module Backup
   module Configuration
     module Storage
-      class Base < Backup::Configuration::Base
+      class Base < Configuration::Base
         class << self
 
           ##

data/lib/backup/configuration/storage/dropbox.rb

@@ -11,16 +11,26 @@ module Backup
           attr_accessor :api_key, :api_secret
 
           ##
-          # Path to where the backups will be stored
-          attr_accessor :path
+          # Dropbox Access Type
+          # Valid values are:
+          #   :app_folder (default)
+          #   :dropbox (full access)
+          attr_accessor :access_type
 
           ##
-          # Dropbox connection timeout
-          attr_accessor :timeout
+          # Path to where the backups will be stored
+          attr_accessor :path
 
 
           # DEPRECATED METHODS #############################################
 
+          # Deprecated as of v3.0.21 - for move to official 'dropbox-sdk' gem (v1.1)
+          attr_reader :timeout
+          def timeout=(value)
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.timeout=\n" +
+                "  is deprecated and will be removed at some point."
+          end
+
           def email
             Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email\n" +
                 "  is deprecated and will be removed at some point."

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

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

data/lib/backup/configuration/syncer/rsync/base.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Base < Syncer::Base
+          class << self
+
+            ##
+            # Path to store the synced files/directories to
+            attr_accessor :path
+
+            ##
+            # Flag for mirroring the files/directories
+            attr_accessor :mirror
+
+            ##
+            # Additional options for the rsync cli
+            attr_accessor :additional_options
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/backup/configuration/syncer/rsync/local.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Local < Base; end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/rsync/pull.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Pull < Push; end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/rsync/push.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Push < 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
+
+            ##
+            # Flag for compressing (only compresses for the transfer)
+            attr_accessor :compress
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,10 +14,6 @@ module Backup
           # 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

data/lib/backup/database/base.rb

@@ -6,15 +6,20 @@ module Backup
       include Backup::CLI::Helpers
       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
+      # [DEPRECATED] - use each subclass' <utility_name>_utility method
       attr_accessor :utility_path
 
+      ##
+      # Creates a new instance of the MongoDB database object
+      # * Called using super(model) from subclasses *
+      def initialize(model)
+        @model = model
+        load_defaults!
+      end
+
       ##
       # Super method for all child (database) objects. Every database object's #perform!
       # method should call #super before anything else to prepare
@@ -23,18 +28,31 @@ module Backup
         log!
       end
 
+      private
+
       ##
       # 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)
+        @dump_path = File.join(
+          Config.tmp_path,
+          @model.trigger,
+          'databases',
+          self.class.name.split('::').last
+        )
+        FileUtils.mkdir_p(@dump_path)
+      end
+
+      ##
+      # Return the database name, with Backup namespace removed
+      def database_name
+        self.class.to_s.sub('Backup::', '')
       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 }'."
+        Logger.message "#{ database_name } started dumping and archiving '#{ name }'."
       end
     end
   end

data/lib/backup/database/mongodb.rb

@@ -28,123 +28,153 @@ module Backup
       # Additional "mongodump" options
       attr_accessor :additional_options
 
+      ##
+      # Path to the mongodump utility (optional)
+      attr_accessor :mongodump_utility
+
+      ##
+      # Path to the mongo utility (optional)
+      attr_accessor :mongo_utility
+
       ##
       # 'lock' dump meaning wrapping mongodump with fsync & lock
       attr_accessor :lock
 
       ##
       # Creates a new instance of the MongoDB database object
-      def initialize(&block)
-        load_defaults!
+      def initialize(model, &block)
+        super(model)
 
         @only_collections   ||= Array.new
         @additional_options ||= Array.new
         @ipv6               ||= false
         @lock               ||= false
 
-        instance_eval(&block)
-      end
+        instance_eval(&block) if block_given?
 
-      ##
-      # 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")
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::MongoDB#utility_path has been deprecated.\n" +
+            "  Use Database::MongoDB#mongodump_utility instead."
+          @mongodump_utility ||= @utility_path
+        end
+        @mongodump_utility  ||= utility(:mongodump)
+        @mongo_utility      ||= utility(:mongo)
       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")
+      # 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!
+        super
+
+        lock_database if @lock
+        @only_collections.empty? ? dump! : specific_collection_dump!
+
+      rescue => err
+        raise Errors::Database::MongoDBError.wrap(err, 'Database Dump Failed!')
+      ensure
+        unlock_database if @lock
+        package! unless err
       end
 
+      private
+
       ##
-      # Builds a MongoDB compatible string for the
-      # additional options specified by the user
-      def additional_options
-        @additional_options.join("\s")
+      # Builds and runs the mongodump command
+      def dump!
+        run(mongodump)
       end
 
       ##
-      # Returns an array of collections to dump
-      def collections_to_dump
-        @only_collections
+      # 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!
+        @only_collections.each do |collection|
+          run("#{mongodump} --collection='#{collection}'")
+        end
       end
 
       ##
-      # Returns the MongoDB database selector syntax
-      def database
-        "--db='#{ name }'"
+      # Builds the full mongodump string based on all attributes
+      def mongodump
+        "#{ mongodump_utility } #{ database } #{ credential_options } " +
+        "#{ connectivity_options } #{ ipv6_option } #{ user_options } #{ dump_directory }"
       end
 
       ##
-      # Returns the mongodump syntax for enabling ipv6
-      def ipv6
-        @ipv6.eql?(true) ? '--ipv6' : ''
+      # If a compressor is configured, packages the dump_path into a
+      # single compressed tar archive, then removes the dump_path.
+      # e.g.
+      #   if the database was dumped to:
+      #     ~/Backup/.tmp/databases/MongoDB/
+      #   then it will be packaged into:
+      #     ~/Backup/.tmp/databases/MongoDB-<timestamp>.tar.gz
+      def package!
+        return unless @model.compressor
+
+        base_dir  = File.dirname(@dump_path)
+        dump_dir  = File.basename(@dump_path)
+        timestamp = Time.now.to_i.to_s[-5, 5]
+        outfile   = @dump_path + '-' + timestamp + '.tar'
+
+        @model.compressor.compress_with do |command, ext|
+          run("#{ utility(:tar) } -cf - " +
+              "-C '#{ base_dir }' '#{ dump_dir }'" +
+              " | #{ command } > #{ outfile + ext }")
+        end
+
+        FileUtils.rm_rf(@dump_path)
       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 }'"
+      # Returns the MongoDB database selector syntax
+      def database
+        "--db='#{ name }'" if name
       end
 
       ##
-      # Builds the full mongodump string based on all attributes
-      def mongodump
-        "#{ utility(:mongodump) } #{ database } #{ credential_options } " +
-        "#{ connectivity_options } #{ ipv6 } #{ additional_options } #{ dump_directory }"
+      # 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).to_s.empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join(' ')
       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!
-        super
-
-        lock_database if @lock.eql?(true)
-        if collections_to_dump.is_a?(Array) and not collections_to_dump.empty?
-          specific_collection_dump!
-        else
-          dump!
-        end
-        unlock_database if @lock.eql?(true)
-      rescue => exception
-        unlock_database if @lock.eql?(true)
-        raise exception
+      # 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).to_s.empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join(' ')
       end
 
       ##
-      # Builds and runs the mongodump command
-      def dump!
-        run(mongodump)
+      # Returns the mongodump syntax for enabling ipv6
+      def ipv6_option
+        @ipv6 ? '--ipv6' : ''
       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
+      # Builds a MongoDB compatible string for the
+      # additional options specified by the user
+      def user_options
+        @additional_options.join(' ')
       end
 
       ##
-      # Builds a Mongo URI based on the provided attributes
-      def mongo_uri
-        ["#{ host }:#{ port }#{ name.is_a?(String) && !name.empty? ? "/#{ name }" : "" }", credential_options, ipv6].join(' ').strip
+      # Returns the MongoDB syntax for determining where to output all the database dumps,
+      # e.g. ~/Backup/.tmp/databases/MongoDB/<databases here>/<database collections>
+      def dump_directory
+        "--out='#{ @dump_path }'"
       end
 
       ##
@@ -152,9 +182,9 @@ module Backup
       # and ensure no 'write operations' are performed during the
       # dump process
       def lock_database
-        lock_command = <<-EOS
+        lock_command = <<-EOS.gsub(/^ +/, ' ')
           echo 'use admin
-          db.runCommand({"fsync" : 1, "lock" : 1})' | #{ "#{ utility(:mongo) } #{ mongo_uri }" }
+          db.runCommand({"fsync" : 1, "lock" : 1})' | #{ "#{ mongo_utility } #{ mongo_uri }" }
         EOS
 
         run(lock_command)
@@ -163,14 +193,21 @@ module Backup
       ##
       # Unlocks the (locked) database
       def unlock_database
-        unlock_command = <<-EOS
+        unlock_command = <<-EOS.gsub(/^ +/, ' ')
           echo 'use admin
-          db.$cmd.sys.unlock.findOne()' | #{ "#{ utility(:mongo) } #{ mongo_uri }" }
+          db.$cmd.sys.unlock.findOne()' | #{ "#{ mongo_utility } #{ mongo_uri }" }
         EOS
 
         run(unlock_command)
       end
 
+      ##
+      # Builds a Mongo URI based on the provided attributes
+      def mongo_uri
+        ["#{ host }:#{ port }#{ ('/' + name) if name }",
+         credential_options, ipv6_option].join(' ').strip
+      end
+
     end
   end
 end