backup 3.0.19 → 3.0.20

data/lib/backup/compressor/base.rb

@@ -3,14 +3,14 @@
 module Backup
   module Compressor
     class Base
-      include Backup::CLI
+      include Backup::CLI::Helpers
       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."
+        Logger.message "#{ self.class } started compressing the archive."
       end
     end
   end

data/lib/backup/compressor/pbzip2.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Pbzip2 < Base
+
+      ##
+      # Tells Backup::Compressor::Pbzip2 to compress
+      # better (-9) rather than faster when set to true
+      attr_writer :best
+
+      ##
+      # Tells Backup::Compressor::Pbzip2 to compress
+      # faster (-1) rather than better when set to true
+      attr_writer :fast
+
+      ##
+      # Tells Backup::Compressor::Pbzip2 how many processors
+      # use, by default autodetect is used
+      attr_writer :processors
+
+      ##
+      # Creates a new instance of Backup::Compressor::Pbzip2 and
+      # configures it to either compress faster or better
+      # bzip2 compresses by default with -9 (best compression)
+      # and lower block sizes don't make things significantly faster
+      # (according to official bzip2 docs)
+      def initialize(&block)
+        load_defaults!
+
+        @best       ||= false
+        @fast       ||= false
+        @processors ||= nil
+
+        instance_eval(&block) if block_given?
+      end
+
+      ##
+      # Performs the compression of the packages backup file
+      def perform!
+        log!
+        run("#{ utility(:pbzip2) } #{ options } '#{ Backup::Model.file }'")
+        Backup::Model.extension += '.bz2'
+      end
+
+    private
+
+      ##
+      # Combines the provided options and returns a pbzip2 options string
+      def options
+        (best + fast + processors).join("\s")
+      end
+
+      ##
+      # Returns the pbzip2 option syntax for compressing
+      # setting @best to true is redundant, as pbzip2 compresses best by default
+      def best
+        return ['--best'] if @best; []
+      end
+
+      ##
+      # Returns the pbzip2 option syntax for compressing
+      # (not significantly) faster when @fast is set to true
+      def fast
+        return ['--fast'] if @fast; []
+      end
+
+      ##
+      # Returns the pbzip2 option syntax for compressing
+      # using given count of cpus
+      def processors
+        return ['-p' + @processors.to_s] if @processors; []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Pbzip2 < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Pbzip2 to compress
+          # better (-9) which is bzip2 default anyway
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Pbzip2 to compress
+          # 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
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class Riak < Base
+        class << self
+
+          ##
+          # Name is the name of the backup
+          attr_accessor :name
+
+          ##
+          # Node is the node from which to perform the backup.
+          attr_accessor :node
+
+          ##
+          # Cookie is the Erlang cookie/shared secret used to connect to the node.
+          attr_accessor :cookie
+
+        end
+      end
+    end
+  end
+end

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

@@ -10,6 +10,12 @@ 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
+          # on.
+          attr_accessor :password_file
 
           ##
           # Determines whether the 'base64' should be used or not

data/lib/backup/configuration/helpers.rb

@@ -8,21 +8,13 @@ module Backup
       # Finds all the object's getter methods and checks the global
       # 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!(options = {})
+      def load_defaults!
         c                  = self.class.name.split('::')
         configuration      = Backup::Configuration.const_get(c[1]).const_get(c[2])
-        options[:except] ||= []
-        options[:only]   ||= []
 
         getter_methods.each do |attribute|
           if configuration.respond_to?(attribute)
-            if options[:only].any? and options[:only].include?(attribute)
-              self.send("#{attribute}=", configuration.send(attribute))
-            elsif options[:except].any? and !options[:except].include?(attribute)
-              self.send("#{attribute}=", configuration.send(attribute))
-            elsif options[:only].empty? and options[:except].empty?
-              self.send("#{attribute}=", configuration.send(attribute))
-            end
+            self.send("#{attribute}=", configuration.send(attribute))
           end
         end
       end
@@ -36,7 +28,7 @@ module Backup
       end
 
       ##
-      # Returns an array of the setter methods (as String)
+      # Returns an Array of the setter methods (as String)
       def setter_methods
         methods.map do |method|
           method = method.to_s
@@ -45,14 +37,9 @@ module Backup
       end
 
       ##
-      # Returns an array of getter methods (as Array)
+      # Returns an Array of getter methods (as String)
       def getter_methods
-        methods.map do |method|
-          method = method.to_s
-          if method =~ /^\w(\w|\d|\_)+\=$/ and method != 'taguri='
-            method.sub('=','')
-          end
-        end.compact
+        setter_methods.map {|method| method.sub('=','') }
       end
 
     end

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

@@ -11,6 +11,11 @@ module Backup
           # when a backup process ends without raising any exceptions
           attr_writer :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
+
           ##
           # When set to true, the user will be notified by email
           # when a backup process raises an exception before finishing
@@ -26,6 +31,14 @@ module Backup
           @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

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

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Hipchat < Base
+        class << self
+
+          # From
+          # Name that appears in Hipchat
+          attr_accessor :from
+
+          # Hipchat API Token
+          # The token to interact with Hipchat
+          attr_accessor :token
+
+          # Rooms
+          # Rooms that you want to post notifications to
+          attr_accessor :rooms_notified
+
+          # Success Color
+          # The background color of a success message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+          attr_accessor :success_color
+
+          # Warning Color
+          # The background color of a success message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+          attr_accessor :warning_color
+
+          # Failure Color
+          # The background color of an error message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+          attr_accessor :failure_color
+
+          # Notify Users
+          # (bool) Notify users in the room
+          attr_accessor :notify_users
+        end
+      end
+    end
+  end
+end
+

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

@@ -6,6 +6,25 @@ module Backup
       class Mail < Base
         class << self
 
+          ##
+          # Mail delivery method to be used by the Mail gem.
+          # Supported methods:
+          #
+          # `:smtp` [::Mail::SMTP] (default)
+          # : Settings used only by this method:
+          # : `address`, `port`, `domain`, `user_name`, `password`
+          # : `authentication`, `enable_starttls_auto`, `openssl_verify_mode`
+          #
+          # `:sendmail` [::Mail::Sendmail]
+          # : Settings used only by this method:
+          # : `sendmail`, `sendmail_args`
+          #
+          # `:file` [::Mail::FileDelivery]
+          # : Settings used only by this method:
+          # : `mail_folder`
+          #
+          attr_accessor :delivery_method
+
           ##
           # Sender and Receiver email addresses
           # Examples:
@@ -50,6 +69,25 @@ module Backup
           # Example: none - Only use this option for a self-signed and/or wildcard certificate
           attr_accessor :openssl_verify_mode
 
+          ##
+          # When using the `:sendmail` `delivery_method` option,
+          # this may be used to specify the absolute path to `sendmail` (if needed)
+          # Example: '/usr/sbin/sendmail'
+          attr_accessor :sendmail
+
+          ##
+          # Optional arguments to pass to `sendmail`
+          # Note that this will override the defaults set by the Mail gem (currently: '-i -t')
+          # So, if set here, be sure to set all the arguments you require.
+          # Example: '-i -t -X/tmp/traffic.log'
+          attr_accessor :sendmail_args
+
+          ##
+          # Folder where mail will be kept when using the `:file` `delivery_method` option.
+          # Default location is '$HOME/backup-mails'
+          # Example: '/tmp/test-mails'
+          attr_accessor :mail_folder
+
         end
       end
     end

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

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Prowl < Base
+        class << self
+
+          ##
+          # Application name
+          # Tell something like your server name. Example: "Server1 Backup"
+          attr_accessor :application
+
+          ##
+          # API-Key
+          # Create a Prowl account and request an API key on prowlapp.com.
+          attr_accessor :api_key
+
+        end
+      end
+    end
+  end
+end

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

@@ -10,6 +10,10 @@ module Backup
           # Rackspace Cloud Files Credentials
           attr_accessor :api_key, :username, :auth_url
 
+          ##
+          # Rackspace Service Net (Allows for LAN-based transfers to avoid charges and improve performance)
+          attr_accessor :servicenet
+
           ##
           # Rackspace Cloud Files container name and path
           attr_accessor :container, :path

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

@@ -22,19 +22,23 @@ module Backup
           # DEPRECATED METHODS #############################################
 
           def email
-            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email is deprecated and will be removed at some point."
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email\n" +
+                "  is deprecated and will be removed at some point."
           end
 
           def email=(value)
-            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email= is deprecated and will be removed at some point."
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.email=\n" +
+                "  is deprecated and will be removed at some point."
           end
 
           def password
-            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password is deprecated and will be removed at some point."
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password\n" +
+                "  is deprecated and will be removed at some point."
           end
 
           def password=(value)
-            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password= is deprecated and will be removed at some point."
+            Logger.warn "[DEPRECATED] Backup::Configuration::Storage::Dropbox.password=\n" +
+                "  is deprecated and will be removed at some point."
           end
 
         end

data/lib/backup/database/base.rb

@@ -3,7 +3,7 @@
 module Backup
   module Database
     class Base
-      include Backup::CLI
+      include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
 
       ##
@@ -15,6 +15,14 @@ module Backup
       # in case it cannot be auto-detected by Backup
       attr_accessor :utility_path
 
+      ##
+      # Super method for all child (database) objects. Every database object's #perform!
+      # method should call #super before anything else to prepare
+      def perform!
+        prepare!
+        log!
+      end
+
       ##
       # Defines the @dump_path and ensures it exists by creating it
       def prepare!
@@ -26,7 +34,7 @@ module Backup
       # 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 "#{self.class} started dumping and archiving '#{ name }'."
       end
     end
   end

data/lib/backup/database/mongodb.rb

@@ -43,7 +43,6 @@ module Backup
         @lock               ||= false
 
         instance_eval(&block)
-        prepare!
       end
 
       ##
@@ -112,20 +111,18 @@ module Backup
       # collections to dump, it'll loop through the array of collections and invoke the
       # 'mongodump' command once per collection
       def perform!
-        log!
-
-        begin
-          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
+        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
       end
 
       ##
@@ -145,9 +142,9 @@ module Backup
       end
 
       ##
-      # Builds the full mongo string based on all attributes
-      def mongo_shell
-        [utility(:mongo), database, credential_options, connectivity_options, ipv6].join(' ')
+      # 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
       end
 
       ##
@@ -157,7 +154,7 @@ module Backup
       def lock_database
         lock_command = <<-EOS
           echo 'use admin
-          db.runCommand({"fsync" : 1, "lock" : 1})' | #{mongo_shell}
+          db.runCommand({"fsync" : 1, "lock" : 1})' | #{ "#{ utility(:mongo) } #{ mongo_uri }" }
         EOS
 
         run(lock_command)
@@ -168,7 +165,7 @@ module Backup
       def unlock_database
         unlock_command = <<-EOS
           echo 'use admin
-          db.$cmd.sys.unlock.findOne()' | #{mongo_shell}
+          db.$cmd.sys.unlock.findOne()' | #{ "#{ utility(:mongo) } #{ mongo_uri }" }
         EOS
 
         run(unlock_command)