backup 3.0.23 → 3.0.24

data/lib/backup/configuration/store.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'ostruct'
+
+module Backup
+  module Configuration
+    class Store < OpenStruct
+
+      ##
+      # Returns an Array of all attribute method names
+      # that default values were set for.
+      def _attributes
+        @table.keys
+      end
+
+      ##
+      # Used only within the specs
+      def reset!
+        @table.clear
+      end
+
+    end
+  end
+end

data/lib/backup/database/base.rb

@@ -6,12 +6,6 @@ module Backup
       include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
 
-      ##
-      # 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 *

data/lib/backup/database/mongodb.rb

@@ -32,6 +32,9 @@ module Backup
       # Path to the mongodump utility (optional)
       attr_accessor :mongodump_utility
 
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :mongodump_utility
+
       ##
       # Path to the mongo utility (optional)
       attr_accessor :mongo_utility
@@ -52,12 +55,6 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        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
@@ -117,18 +114,37 @@ module Backup
       def package!
         return unless @model.compressor
 
+        pipeline  = Pipeline.new
         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'
 
+        Logger.message(
+          "#{ database_name } started compressing and packaging:\n" +
+          "  '#{ @dump_path }'"
+        )
+
+        pipeline << "#{ utility(:tar) } -cf - -C '#{ base_dir }' '#{ dump_dir }'"
         @model.compressor.compress_with do |command, ext|
-          run("#{ utility(:tar) } -cf - " +
-              "-C '#{ base_dir }' '#{ dump_dir }'" +
-              " | #{ command } > #{ outfile + ext }")
+          pipeline << command
+          outfile << ext
+        end
+        pipeline << "cat > #{ outfile }"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message(
+            "#{ database_name } completed compressing and packaging:\n" +
+            "  '#{ outfile }'"
+          )
+          FileUtils.rm_rf(@dump_path)
+        else
+          raise Errors::Database::PipelineError,
+            "#{ database_name } Failed to create compressed dump package:\n" +
+            "'#{ outfile }'\n" +
+            pipeline.error_messages
         end
-
-        FileUtils.rm_rf(@dump_path)
       end
 
       ##

data/lib/backup/database/mysql.rb

@@ -33,6 +33,9 @@ module Backup
       # Path to mysqldump utility (optional)
       attr_accessor :mysqldump_utility
 
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :mysqldump_utility
+
       ##
       # Creates a new instance of the MySQL adapter object
       def initialize(model, &block)
@@ -45,13 +48,6 @@ module Backup
         instance_eval(&block) if block_given?
 
         @name ||= :all
-
-        if @utility_path
-          Logger.warn "[DEPRECATED] " +
-            "Database::MySQL#utility_path has been deprecated.\n" +
-            "  Use Database::MySQL#mysqldump_utility instead."
-          @mysqldump_utility ||= @utility_path
-        end
         @mysqldump_utility ||= utility(:mysqldump)
       end
 
@@ -61,18 +57,26 @@ module Backup
       def perform!
         super
 
+        pipeline = Pipeline.new
         dump_ext = 'sql'
-        dump_cmd = "#{ mysqldump }"
 
+        pipeline << mysqldump
         if @model.compressor
           @model.compressor.compress_with do |command, ext|
-            dump_cmd << " | #{command}"
+            pipeline << command
             dump_ext << ext
           end
         end
-
-        dump_cmd << " > '#{ File.join(@dump_path, dump_filename) }.#{ dump_ext }'"
-        run(dump_cmd)
+        pipeline << "cat > '#{ File.join(@dump_path, dump_filename) }.#{ dump_ext }'"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message "#{ database_name } Complete!"
+        else
+          raise Errors::Database::PipelineError,
+              "#{ database_name } Dump Failed!\n" +
+              pipeline.error_messages
+        end
       end
 
       private
@@ -137,8 +141,9 @@ module Backup
       # during the dumping of the database
       def tables_to_skip
         skip_tables.map do |table|
-          "--ignore-table='#{name}.#{table}'"
-        end.join(' ') unless dump_all?
+          table = (dump_all? || table['.']) ? table : "#{ name }.#{ table }"
+          "--ignore-table='#{ table }'"
+        end.join(' ')
       end
 
       ##

data/lib/backup/database/postgresql.rb

@@ -32,6 +32,9 @@ module Backup
       # Path to pg_dump utility (optional)
       attr_accessor :pg_dump_utility
 
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :pg_dump_utility
+
       ##
       # Creates a new instance of the PostgreSQL adapter object
       # Sets the PGPASSWORD environment variable to the password
@@ -45,12 +48,6 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        if @utility_path
-          Logger.warn "[DEPRECATED] " +
-            "Database::PostgreSQL#utility_path has been deprecated.\n" +
-            "  Use Database::PostgreSQL#pg_dump_utility instead."
-          @pg_dump_utility ||= @utility_path
-        end
         @pg_dump_utility ||= utility(:pg_dump)
       end
 
@@ -60,18 +57,26 @@ module Backup
       def perform!
         super
 
+        pipeline = Pipeline.new
         dump_ext = 'sql'
-        dump_cmd = "#{ pgdump }"
 
+        pipeline << pgdump
         if @model.compressor
           @model.compressor.compress_with do |command, ext|
-            dump_cmd << " | #{command}"
+            pipeline << command
             dump_ext << ext
           end
         end
-
-        dump_cmd << " > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
-        run(dump_cmd)
+        pipeline << "cat > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message "#{ database_name } Complete!"
+        else
+          raise Errors::Database::PipelineError,
+              "#{ database_name } Dump Failed!\n" +
+              pipeline.error_messages
+        end
       end
 
       ##

data/lib/backup/database/redis.rb

@@ -12,16 +12,16 @@ module Backup
       # Credentials for the specified database
       attr_accessor :password
 
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
       ##
       # 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
@@ -30,6 +30,9 @@ module Backup
       # Path to the redis-cli utility (optional)
       attr_accessor :redis_cli_utility
 
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :redis_cli_utility
+
       ##
       # Creates a new instance of the Redis database object
       def initialize(model, &block)
@@ -40,13 +43,6 @@ module Backup
         instance_eval(&block) if block_given?
 
         @name ||= 'dump'
-
-        if @utility_path
-          Logger.warn "[DEPRECATED] " +
-            "Database::Redis#utility_path has been deprecated.\n" +
-            "  Use Database::Redis#redis_cli_utility instead."
-          @redis_cli_utility ||= @utility_path
-        end
         @redis_cli_utility ||= utility('redis-cli')
       end
 

data/lib/backup/database/riak.rb

@@ -20,6 +20,9 @@ module Backup
       # Path to riak-admin utility (optional)
       attr_accessor :riak_admin_utility
 
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :riak_admin_utility
+
       ##
       # Creates a new instance of the Riak adapter object
       def initialize(model, &block)
@@ -27,12 +30,6 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        if @utility_path
-          Logger.warn "[DEPRECATED] " +
-            "Database::Riak#utility_path has been deprecated.\n" +
-            "  Use Database::Riak#riak_admin_utility instead."
-          @riak_admin_utility ||= @utility_path
-        end
         @riak_admin_utility ||= utility('riak-admin')
       end
 

data/lib/backup/dependency.rb

@@ -17,13 +17,13 @@ module Backup
       {
         'fog' => {
           :require => 'fog',
-          :version => '>= 0.11.0',
+          :version => '~> 1.1.0',
           :for     => 'Amazon S3, Rackspace Cloud Files (S3, CloudFiles Storages)'
         },
 
         'dropbox-sdk' => {
           :require => 'dropbox_sdk',
-          :version => '~> 1.1.0',
+          :version => '~> 1.2.0',
           :for     => 'Dropbox Web Service (Dropbox Storage)'
         },
 
@@ -41,13 +41,13 @@ module Backup
 
         'net-ssh' => {
           :require => 'net/ssh',
-          :version => '~> 2.1.4',
+          :version => '~> 2.3.0',
           :for     => 'SSH Protocol (SSH Storage)'
         },
 
         'mail' => {
           :require => 'mail',
-          :version => '>= 2.4.0',
+          :version => '~> 2.4.0',
           :for     => 'Sending Emails (Mail Notifier)'
         },
 
@@ -59,16 +59,10 @@ module Backup
 
         'httparty' => {
           :require => 'httparty',
-          :version => '~> 0.7.4',
+          :version => '~> 0.8.1',
           :for     => 'Sending Http Updates'
         },
 
-        'json' => {
-          :require => 'json',
-          :version => '~> 1.5.1',
-          :for     => 'Parsing JSON for HTTParty'
-        },
-
         'prowler' => {
           :require => 'prowler',
           :version => '>= 1.3.1',

data/lib/backup/model.rb

@@ -125,16 +125,25 @@ module Backup
     # methods to use during the backup process
     def sync_with(name, &block)
       ##
-      # Warn user of DSL change from 'RSync' to 'RSync::Local'
-      if name.to_s == 'Backup::Config::RSync'
+      # Warn user of DSL changes
+      case name.to_s
+      when 'Backup::Config::RSync'
         Logger.warn Errors::ConfigError.new(<<-EOS)
           Configuration Update Needed for Syncer::RSync
           The RSync Syncer has been split into three separate modules:
           RSync::Local, RSync::Push and RSync::Pull
-          Please update your configuration for your local RSync Syncer
-          from 'sync_with RSync do ...' to 'sync_with RSync::Local do ...'
+          Please update your configuration.
+          i.e. 'sync_with RSync' is now 'sync_with RSync::Push'
         EOS
-        name = Backup::Config::RSync::Local
+        name = 'RSync::Push'
+      when /(Backup::Config::S3|Backup::Config::CloudFiles)/
+        syncer = $1.split('::')[2]
+        Logger.warn Errors::ConfigError.new(<<-EOS)
+          Configuration Update Needed for '#{ syncer }' Syncer.
+          This Syncer is now referenced as Cloud::#{ syncer }
+          i.e. 'sync_with #{ syncer }' is now 'sync_with Cloud::#{ syncer }'
+        EOS
+        name = "Cloud::#{ syncer }"
       end
       @syncers << get_class_from_scope(Syncer, name).new(&block)
     end

data/lib/backup/notifier/campfire.rb

@@ -1,15 +1,5 @@
 # encoding: utf-8
 
-##
-# If the Ruby version of this process is 1.8.x or less
-# then use the JSON gem. Otherwise if the current process is running
-# Ruby 1.9.x or later then it is built in and we can load it from the Ruby core lib
-if RUBY_VERSION < '1.9.0'
-  Backup::Dependency.load('json')
-else
-  require 'json'
-end
-
 ##
 # Load the HTTParty library from the gem
 Backup::Dependency.load('httparty')
@@ -139,12 +129,9 @@ module Backup
         # This method builds up a POST request with the necessary params (serialized to JSON format)
         # and sends it to the Campfire service in order to submit the message
         def send_message(message, type = 'Textmessage')
-          post 'speak', :body => {
-            :message => {
-              :body => message,
-              :type => type
-            }
-          }.to_json
+          post 'speak', :body => MultiJson.encode(
+            { :message => { :body => message, :type => type } }
+          )
         end
 
         ##

data/lib/backup/notifier/hipchat.rb

@@ -1,12 +1,6 @@
 # encoding: utf-8
 
-if RUBY_VERSION < '1.9.0'
-  Backup::Dependency.load('json')
-else
-  require 'json'
-end
-
-# Load HTTParty
+# Load the HipChat library from the gem
 Backup::Dependency.load('hipchat')
 
 module Backup

data/lib/backup/notifier/mail.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 ##
-# Only load the Mail gem and Erb library when using Mail notifications
+# Only load the Mail gem when using Mail notifications
 Backup::Dependency.load('mail')
 
 module Backup

data/lib/backup/packager.rb

@@ -11,17 +11,25 @@ module Backup
         @package   = model.package
         @encryptor = model.encryptor
         @splitter  = model.splitter
+        @pipeline  = Pipeline.new
 
         Logger.message "Packaging the backup files..."
         procedure.call
-        Logger.message "Packaging Complete!"
+
+        if @pipeline.success?
+          Logger.message "Packaging Complete!"
+        else
+          raise Errors::Packager::PipelineError,
+              "Failed to Create Backup Package\n" +
+              @pipeline.error_messages
+        end
       end
 
       private
 
       ##
-      # Builds a chain of nested Procs which assemble and execute
-      # the final command to package the backup.
+      # Builds a chain of nested Procs which adds each command to a Pipeline
+      # needed to package the final command to package the backup.
       # This is done so that the Encryptor and Splitter have the ability
       # to perform actions before and after the final command is executed.
       # No Encryptors currently utilize this, however the Splitter does.
@@ -31,20 +39,21 @@ module Backup
         ##
         # Initial `tar` command to package the temporary backup folder.
         # The command's output will then be either piped to the Encryptor
-        # or the Splitter (if no Encryptor), or redirected into the final
+        # or the Splitter (if no Encryptor), or through `cat` into the final
         # output file if neither are configured.
-        @package_command = "#{ utility(:tar) } -cf - " +
+        @pipeline << "#{ utility(:tar) } -cf - " +
             "-C '#{ Config.tmp_path }' '#{ @package.trigger }'"
 
         ##
         # If an Encryptor was configured, it will be called first
-        # to amend the command to be piped through the encryption utility.
-        # It's output will then be either piped into a Splitter, or sent
-        # directly to the final output file.
+        # to add the encryption utility command to be piped through,
+        # and amend the final package extension.
+        # It's output will then be either piped into a Splitter,
+        # or through `cat` into the final output file.
         if @encryptor
           stack << lambda do
             @encryptor.encrypt_with do |command, ext|
-              @package_command << " | #{command}"
+              @pipeline << command
               @package.extension << ext
               stack.shift.call
             end
@@ -52,35 +61,36 @@ module Backup
         end
 
         ##
-        # If a Splitter was configured, the command will be piped through
-        # the `split` command. Once the Proc executing the final command
-        # has completed and returns back to the Splitter, it will check the
-        # final output files to determine if the backup was indeed split.
+        # If a Splitter was configured, the `split` utility command will be
+        # added to the Pipeline to split the final output into multiple files.
+        # Once the Proc executing the Pipeline has completed and returns back
+        # to the Splitter, it will check the final output files to determine
+        # if the backup was indeed split.
         # If so, it will set the package's chunk_suffixes. If not, it will
         # remove the '-aa' suffix from the only file created by `split`.
         #
-        # If no Splitter was configured, the command output will be
-        # redirected directly into the final output file.
+        # If no Splitter was configured, the final file output will be
+        # piped through `cat` into the final output file.
         if @splitter
           stack << lambda do
             @splitter.split_with do |command|
-              @package_command << " | #{command}"
+              @pipeline << command
               stack.shift.call
             end
           end
         else
           stack << lambda do
             outfile = File.join(Config.tmp_path, @package.basename)
-            @package_command << " > #{ outfile }"
+            @pipeline << "cat > #{ outfile }"
             stack.shift.call
           end
         end
 
         ##
-        # Last Proc to be called runs the command the procedure built.
+        # Last Proc to be called runs the Pipeline the procedure built.
         # Once complete, the call stack will unwind back through the
         # preceeding Procs in the stack (if any)
-        stack << lambda { run(@package_command) }
+        stack << lambda { @pipeline.run }
 
         stack.shift
       end