backup 3.0.27 → 3.1.0

data/lib/backup/compressor/base.rb

@@ -3,7 +3,7 @@
 module Backup
   module Compressor
     class Base
-      include Backup::CLI::Helpers
+      include Backup::Utilities::Helpers
       include Backup::Configuration::Helpers
 
       ##
@@ -25,7 +25,7 @@ module Backup
       # Logs a message to the console and log file to inform
       # the client that Backup is using the compressor
       def log!
-        Logger.message "Using #{ compressor_name } for compression.\n" +
+        Logger.info "Using #{ compressor_name } for compression.\n" +
           "  Command: '#{ @cmd }'\n" +
           "  Ext: '#{ @ext }'"
       end

data/lib/backup/compressor/gzip.rb

@@ -3,6 +3,7 @@
 module Backup
   module Compressor
     class Gzip < Base
+      extend Utilities::Helpers
 
       ##
       # Specify the level of compression to use.
@@ -26,12 +27,35 @@ module Backup
                        klass.level = 9 if val
                      }
 
+      ##
+      # Use the `--rsyncable` option with `gzip`.
+      #
+      # This option directs `gzip` to compress data using an algorithm that
+      # allows `rsync` to efficiently detect changes. This is especially useful
+      # when used to compress `Archive` or `Database` backups that will be
+      # stored using Backup's `RSync` Storage option.
+      #
+      # The `--rsyncable` option is only available on patched versions of `gzip`.
+      # While most distributions apply this patch, this option may not be
+      # available on your system. If it's not available, Backup will log a
+      # warning and continue to use the compressor without this option.
+      attr_accessor :rsyncable
+
+      ##
+      # Determine if +--rsyncable+ is supported and cache the result.
+      def self.has_rsyncable?
+        return @has_rsyncable unless @has_rsyncable.nil?
+        cmd = "#{ utility(:gzip) } --rsyncable --version >/dev/null 2>&1; echo $?"
+        @has_rsyncable = %x[#{ cmd }].chomp == '0'
+      end
+
       ##
       # Creates a new instance of Backup::Compressor::Gzip
       def initialize(&block)
         load_defaults!
 
         @level ||= false
+        @rsyncable ||= false
 
         instance_eval(&block) if block_given?
 
@@ -42,7 +66,17 @@ module Backup
       private
 
       def options
-        " -#{ @level }" if @level
+        opts = ''
+        opts << " -#{ @level }" if @level
+        if self.class.has_rsyncable?
+          opts << ' --rsyncable'
+        else
+          Logger.warn Errors::Compressor::Gzip::RsyncableError.new(<<-EOS)
+            'rsyncable' option ignored.
+            Your system's 'gzip' does not support the `--rsyncable` option.
+          EOS
+        end if @rsyncable
+        opts
       end
 
     end

data/lib/backup/config.rb

@@ -5,14 +5,13 @@ module Backup
     DEFAULTS = {
       :config_file  => 'config.rb',
       :data_path    => 'data',
-      :log_path     => 'log',
       :cache_path   => '.cache',
       :tmp_path     => '.tmp'
     }
 
     class << self
       attr_reader :user, :root_path, :config_file,
-                  :data_path, :log_path, :cache_path, :tmp_path
+                  :data_path, :cache_path, :tmp_path
 
       ##
       # Setup required paths based on the given options

data/lib/backup/database/base.rb

@@ -3,7 +3,7 @@
 module Backup
   module Database
     class Base
-      include Backup::CLI::Helpers
+      include Backup::Utilities::Helpers
       include Backup::Configuration::Helpers
 
       ##
@@ -46,7 +46,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 "#{ database_name } started dumping and archiving '#{ name }'."
+        Logger.info "#{ database_name } started dumping and archiving '#{ name }'."
       end
     end
   end

data/lib/backup/database/mongodb.rb

@@ -121,7 +121,7 @@ module Backup
         timestamp = Time.now.to_i.to_s[-5, 5]
         outfile   = @dump_path + '-' + timestamp + '.tar'
 
-        Logger.message(
+        Logger.info(
           "#{ database_name } started compressing and packaging:\n" +
           "  '#{ @dump_path }'"
         )
@@ -131,11 +131,11 @@ module Backup
           pipeline << command
           outfile << ext
         end
-        pipeline << "cat > #{ outfile }"
 
+        pipeline << "#{ utility(:cat) } > #{ outfile }"
         pipeline.run
         if pipeline.success?
-          Logger.message(
+          Logger.info(
             "#{ database_name } completed compressing and packaging:\n" +
             "  '#{ outfile }'"
           )

data/lib/backup/database/mysql.rb

@@ -68,11 +68,12 @@ module Backup
             dump_ext << ext
           end
         end
-        pipeline << "cat > '#{ File.join(@dump_path, dump_filename) }.#{ dump_ext }'"
 
+        pipeline << "#{ utility(:cat) } > " +
+            "'#{ File.join(@dump_path, dump_filename) }.#{ dump_ext }'"
         pipeline.run
         if pipeline.success?
-          Logger.message "#{ database_name } Complete!"
+          Logger.info "#{ database_name } Complete!"
         else
           raise Errors::Database::PipelineError,
               "#{ database_name } Dump Failed!\n" +

data/lib/backup/database/postgresql.rb

@@ -68,11 +68,12 @@ module Backup
             dump_ext << ext
           end
         end
-        pipeline << "cat > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
 
+        pipeline << "#{ utility(:cat) } > " +
+            "'#{ File.join(@dump_path, name) }.#{ dump_ext }'"
         pipeline.run
         if pipeline.success?
-          Logger.message "#{ database_name } Complete!"
+          Logger.info "#{ database_name } Complete!"
         else
           raise Errors::Database::PipelineError,
               "#{ database_name } Dump Failed!\n" +

data/lib/backup/database/riak.rb

@@ -20,6 +20,14 @@ module Backup
       # Path to riak-admin utility (optional)
       attr_accessor :riak_admin_utility
 
+      ##
+      # Username for the riak instance (optional)
+      attr_accessor :user
+
+      ##
+      # Group for the riak instance (optional)
+      attr_accessor :group
+
       attr_deprecate :utility_path, :version => '3.0.21',
           :message => 'Use Riak#riak_admin_utility instead.',
           :action => lambda {|klass, val| klass.riak_admin_utility = val }
@@ -32,22 +40,27 @@ module Backup
         instance_eval(&block) if block_given?
 
         @riak_admin_utility ||= utility('riak-admin')
+        @user               ||= 'riak'
+        @group              ||= 'riak'
       end
 
       ##
-      # Performs the riak-admin command and outputs the
-      # data to the specified path based on the 'trigger'
+      # Performs the `riak-admin` command which creates a single dump file in
+      # @dump_path based on the `name` and `node`.
+      #
+      # `riak-admin` will append the `node` to the filename.
+      # i.e. <tmp_path>/<trigger>/databases/Riak/<name>-<node>
       def perform!
         super
-        # have to make riak the owner since the riak-admin tool runs
-        # as the riak user in a default setup.
-        FileUtils.chown_R('riak', 'riak', @dump_path)
+        # ensure riak-admin user has permissions to write backup file
+        FileUtils.chown_R(@user, @group, @dump_path)
 
         backup_file = File.join(@dump_path, name)
         run("#{ riakadmin } #{ backup_file } node")
 
         if @model.compressor
           @model.compressor.compress_with do |command, ext|
+            backup_file << "-#{ node }"
             run("#{ command } -c #{ backup_file } > #{ backup_file + ext }")
             FileUtils.rm_f(backup_file)
           end

data/lib/backup/dependency.rb

@@ -1,108 +1,159 @@
 # encoding: utf-8
 
 module Backup
-
   ##
   # A little self-contained gem manager for Backup.
-  # Rather than specifying hard dependencies in the gemspec, forcing users
-  # to install gems they do not want/need, Backup will notify them when a gem
-  # has not been installed, or when the gem's version is incorrect, and provide the
-  # command to install the gem. These dependencies are dynamically loaded in the Gemfile
+  # Rather than specifying hard dependencies in the gemspec, forcing users to
+  # install gems they do not want/need, Backup will notify them when a gem has
+  # not been installed, or version is incorrect, and provide the command to
+  # install the gem. These dependencies are dynamically loaded in the Gemfile.
   class Dependency
+    DEPENDENCIES = {
+      'fog' => {
+        :require => 'fog',
+        :version => '~> 1.4',
+        :for     => 'Amazon S3, Rackspace Cloud Files (S3, CloudFiles Storages)',
+        :dependencies  => ['net-ssh', 'net-scp']
+      },
+
+      'dropbox-sdk' => {
+        :require => 'dropbox_sdk',
+        :version => '~> 1.5.0',
+        :for     => 'Dropbox Web Service (Dropbox Storage)'
+      },
+
+      'net-sftp' => {
+        :require => 'net/sftp',
+        :version => ['>= 2.0.0', '<= 2.0.5'],
+        :for     => 'SFTP Protocol (SFTP Storage)',
+        :dependencies  => 'net-ssh'
+      },
+
+      'net-scp' => {
+        :require => 'net/scp',
+        :version => ['>= 1.0.0', '<= 1.0.4'],
+        :for     => 'SCP Protocol (SCP Storage)',
+        :dependencies  => 'net-ssh'
+      },
+
+      'net-ssh' => {
+        :require => 'net/ssh',
+        :version => ['>= 2.3.0', '<= 2.5.2'],
+        :for     => 'SSH Protocol (SSH Storage)'
+      },
+
+      'mail' => {
+        :require => 'mail',
+        :version => '~> 2.5.0',
+        :for     => 'Sending Emails (Mail Notifier)'
+      },
+
+      'twitter' => {
+        :require => 'twitter',
+        :version => '~> 4.0',
+        :for     => 'Sending Twitter Updates (Twitter Notifier)'
+      },
 
-    ##
-    # Returns a hash of dependencies that Backup requires
-    # in order to run every available feature
-    def self.all
-      {
-        'fog' => {
-          :require => 'fog',
-          :version => '~> 1.4.0',
-          :for     => 'Amazon S3, Rackspace Cloud Files (S3, CloudFiles Storages)'
-        },
-
-        'dropbox-sdk' => {
-          :require => 'dropbox_sdk',
-          :version => '~> 1.2.0',
-          :for     => 'Dropbox Web Service (Dropbox Storage)'
-        },
-
-        'net-sftp' => {
-          :require => 'net/sftp',
-          :version => '~> 2.0.5',
-          :for     => 'SFTP Protocol (SFTP Storage)'
-        },
-
-        'net-scp' => {
-          :require => 'net/scp',
-          :version => '~> 1.0.4',
-          :for     => 'SCP Protocol (SCP Storage)'
-        },
-
-        'net-ssh' => {
-          :require => 'net/ssh',
-          :version => '~> 2.3.0',
-          :for     => 'SSH Protocol (SSH Storage)'
-        },
-
-        'mail' => {
-          :require => 'mail',
-          :version => '~> 2.4.0',
-          :for     => 'Sending Emails (Mail Notifier)'
-        },
-
-        'twitter' => {
-          :require => 'twitter',
-          :version => '>= 1.7.1',
-          :for     => 'Sending Twitter Updates (Twitter Notifier)'
-        },
-
-        'httparty' => {
-          :require => 'httparty',
-          :version => '~> 0.8.1',
-          :for     => 'Sending Http Updates'
-        },
-
-        'prowler' => {
-          :require => 'prowler',
-          :version => '>= 1.3.1',
-          :for     => 'Sending iOS push notifications (Prowl Notifier)'
-        },
-
-        'hipchat' => {
-          :require => 'hipchat',
-          :version => '~> 0.4.1',
-          :for => 'Sending notifications to Hipchat'
-        },
-
-        'parallel' => {
-          :require => 'parallel',
-          :version => '~> 0.5.12',
-          :for => 'Adding concurrency to Cloud-based syncers.'
-        }
+      'httparty' => {
+        :require => 'httparty',
+        :version => '~> 0.10.2',
+        :for     => 'Sending Http Updates (Campfire Notifier)'
+      },
+
+      'prowler' => {
+        :require => 'prowler',
+        :version => '~> 1.3.1',
+        :for     => 'Sending iOS push notifications (Prowl Notifier)'
+      },
+
+      'hipchat' => {
+        :require => 'hipchat',
+        :version => '~> 0.7.0',
+        :for     => 'Sending notifications to Hipchat'
+      },
+
+      'parallel' => {
+        :require => 'parallel',
+        :version => '~> 0.6.0',
+        :for     => 'Adding concurrency to Cloud-based syncers.'
       }
+    }
+
+    class << self
+      def all
+        @all ||= []
+      end
+
+      def find(name)
+        all.select {|dep| dep.name == name }.first
+      end
+
+      def load(name)
+        find(name).load!
+      end
+    end
+
+    attr_reader :name, :require_as, :used_for, :requirements
+
+    def initialize(name, options = {})
+      @name = name
+      @require_as     = options[:require]
+      @requirements   = Array(options[:version])
+      @dependencies   = Array(options[:dependencies])
+      @used_for       = options[:for]
+    end
+
+    # dependencies should be defined in the order
+    # they should be installed or loaded.
+    def dependencies
+      @dependencies.map {|name| self.class.find(name) }
+    end
+
+    def load!
+      dependencies.each(&:load!)
+
+      gem(name, *requirements)
+      require require_as
+    rescue LoadError
+      raise Errors::Dependency::LoadError, <<-EOS
+        Dependency Missing
+        Gem Name: #{ name }
+        Used for: #{ used_for }
+
+        To install the gem, issue the following command:
+        > backup dependencies --install #{ name }
+        Please try again after installing the missing dependency.
+      EOS
+    end
+
+    def installed?
+      Gem::Specification.find_by_name(name, *requirements)
+      true
+    rescue LoadError
+      false
     end
 
-    ##
-    # Attempts to load the specified gem (by name and version).
-    # If the gem with the correct version cannot be found, it'll display a message
-    # to the user with instructions on how to install the required gem
-    def self.load(name)
-      begin
-        gem(name, all[name][:version])
-        require(all[name][:require])
-      rescue LoadError
-        Logger.error Errors::Dependency::LoadError.new(<<-EOS)
-          Dependency missing
-          Dependency required for:
-          #{all[name][:for]}
-          To install the gem, issue the following command:
-          > gem install #{name} -v '#{all[name][:version]}'
-          Please try again after installing the missing dependency.
-        EOS
-        exit 1
+    # If multiple version requirements are defined, this tries to find the
+    # version that matches them all. Otherwise, it will fallback to installing
+    # based on the last requirement. This should only be called from the CLI
+    # for `backup dependencies --install <name>`.
+    def install!
+      version = nil
+      if requirements.count > 1
+        begin
+          require 'rubygems/dependency_installer'
+          inst = Gem::DependencyInstaller.new
+          spec, _ = inst.find_spec_by_name_and_version(name, *requirements).first
+          version = spec.version
+        rescue
+        end
       end
+      version ||= requirements.last
+      command = "gem install --no-ri --no-rdoc #{ name } -v '#{ version }'"
+      puts "\nLaunching `#{ command }`"
+      exec command
     end
 
+    DEPENDENCIES.each {|name, options| all << new(name, options) }
   end
 end