backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/syncer/cloud/local_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'digest/md5'
+require "digest/md5"
 
 module Backup
   module Syncer
@@ -9,7 +8,6 @@ module Backup
         attr_accessor :md5
 
         class << self
-
           # Returns a Hash of LocalFile objects for each file within +dir+,
           # except those matching any of the +excludes+.
           # Hash keys are the file's path relative to +dir+.
@@ -17,7 +15,7 @@ module Backup
             dir = File.expand_path(dir)
             hash = {}
             find_md5(dir, excludes).each do |file|
-              hash[file.path.sub(dir + '/', '')] = file
+              hash[file.path.sub(dir + "/", "")] = file
             end
             hash
           end
@@ -27,7 +25,7 @@ module Backup
           def new(*args)
             file = super
             if file.invalid?
-              Logger.warn("\s\s[skipping] #{ file.path }\n" +
+              Logger.warn("\s\s[skipping] #{file.path}\n" \
                           "\s\sPath Contains Invalid UTF-8 byte sequences")
               file = nil
             end
@@ -39,7 +37,7 @@ module Backup
           # Returns an Array of file paths and their md5 hashes.
           def find_md5(dir, excludes)
             found = []
-            (Dir.entries(dir) - %w{. ..}).map {|e| File.join(dir, e) }.each do |path|
+            (Dir.entries(dir) - %w[. ..]).map { |e| File.join(dir, e) }.each do |path|
               if File.directory?(path)
                 unless exclude?(excludes, path)
                   found += find_md5(path, excludes)
@@ -85,7 +83,7 @@ module Backup
         def sanitize(str)
           str.each_char.map do |char|
             begin
-              char.unpack('U')
+              char.unpack("U")
               char
             rescue
               @invalid = true
@@ -93,7 +91,6 @@ module Backup
             end
           end.join
         end
-
       end
     end
   end

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'backup/cloud_io/s3'
+require "backup/cloud_io/s3"
 
 module Backup
   module Syncer
@@ -57,53 +56,53 @@ module Backup
 
         def cloud_io
           @cloud_io ||= CloudIO::S3.new(
-            :access_key_id      => access_key_id,
-            :secret_access_key  => secret_access_key,
-            :use_iam_profile    => use_iam_profile,
-            :bucket             => bucket,
-            :region             => region,
-            :encryption         => encryption,
-            :storage_class      => storage_class,
-            :max_retries        => max_retries,
-            :retry_waitsec      => retry_waitsec,
+            access_key_id: access_key_id,
+            secret_access_key: secret_access_key,
+            use_iam_profile: use_iam_profile,
+            bucket: bucket,
+            region: region,
+            encryption: encryption,
+            storage_class: storage_class,
+            max_retries: max_retries,
+            retry_waitsec: retry_waitsec,
             # Syncer can not use multipart upload.
-            :chunk_size         => 0,
-            :fog_options        => fog_options
+            chunk_size: 0,
+            fog_options: fog_options
           )
         end
 
         def get_remote_files(remote_base)
           hash = {}
           cloud_io.objects(remote_base).each do |object|
-            relative_path = object.key.sub(remote_base + '/', '')
+            relative_path = object.key.sub(remote_base + "/", "")
             hash[relative_path] = object.etag
           end
           hash
         end
 
         def check_configuration
-          if use_iam_profile
-            required = %w{ bucket }
-          else
-            required = %w{ access_key_id secret_access_key bucket }
-          end
-          raise Error, <<-EOS if required.map {|name| send(name) }.any?(&:nil?)
+          required =
+            if use_iam_profile
+              %w[bucket]
+            else
+              %w[access_key_id secret_access_key bucket]
+            end
+          raise Error, <<-EOS if required.map { |name| send(name) }.any?(&:nil?)
             Configuration Error
-            #{ required.map {|name| "##{ name }"}.join(', ') } are all required
+            #{required.map { |name| "##{name}" }.join(", ")} are all required
           EOS
 
-          raise Error, <<-EOS if encryption && encryption.to_s.upcase != 'AES256'
+          raise Error, <<-EOS if encryption && encryption.to_s.upcase != "AES256"
             Configuration Error
             #encryption must be :aes256 or nil
           EOS
 
-          classes = ['STANDARD', 'REDUCED_REDUNDANCY']
+          classes = ["STANDARD", "REDUCED_REDUNDANCY"]
           raise Error, <<-EOS unless classes.include?(storage_class.to_s.upcase)
             Configuration Error
             #storage_class must be :standard or :reduced_redundancy
           EOS
         end
-
       end # Class S3 < Base
     end # module Cloud
   end

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

@@ -1,10 +1,7 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Base < Syncer::Base
-
         ##
         # Additional String or Array of options for the rsync cli
         attr_accessor :additional_rsync_options
@@ -14,7 +11,7 @@ module Backup
           super
           instance_eval(&block) if block_given?
 
-          @path ||= '~/backups'
+          @path ||= "~/backups"
           @archive = @archive.nil? ? true : @archive
         end
 
@@ -24,19 +21,19 @@ module Backup
         # Common base command for Local/Push/Pull
         def rsync_command
           utility(:rsync) << archive_option << mirror_option << exclude_option <<
-              " #{ Array(additional_rsync_options).join(' ') }".rstrip
+            " #{Array(additional_rsync_options).join(" ")}".rstrip
         end
 
         def mirror_option
-          mirror ? ' --delete' : ''
+          mirror ? " --delete" : ""
         end
 
         def archive_option
-          archive ? ' --archive' : ''
+          archive ? " --archive" : ""
         end
 
         def exclude_option
-          excludes.map {|pattern| " --exclude='#{ pattern }'" }.join
+          excludes.map { |pattern| " --exclude='#{pattern}'" }.join
         end
 
         ##
@@ -45,9 +42,8 @@ module Backup
         # each path, as we don't want rsync's "trailing / on source directories"
         # behavior. This method is used by RSync::Local and RSync::Push.
         def paths_to_push
-          directories.map {|dir| "'#{ File.expand_path(dir) }'" }.join(' ')
+          directories.map { |dir| "'#{File.expand_path(dir)}'" }.join(" ")
         end
-
       end
     end
   end

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

@@ -1,15 +1,12 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Local < Base
-
         def perform!
           log!(:started)
 
           create_dest_path!
-          run("#{ rsync_command } #{ paths_to_push } '#{ dest_path }'")
+          run("#{rsync_command} #{paths_to_push} '#{dest_path}'")
 
           log!(:finished)
         end
@@ -24,7 +21,6 @@ module Backup
         def create_dest_path!
           FileUtils.mkdir_p dest_path
         end
-
       end
     end
   end

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

@@ -1,17 +1,14 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Pull < Push
-
         def perform!
           log!(:started)
           write_password_file!
 
           create_dest_path!
-          run("#{ rsync_command } #{ host_options }#{ paths_to_pull } " +
-              "'#{ dest_path }'")
+          run("#{rsync_command} #{host_options}#{paths_to_pull} " \
+              "'#{dest_path}'")
 
           log!(:finished)
         ensure
@@ -30,10 +27,10 @@ module Backup
         # Also remove any trailing `/`, since we don't want rsync's
         # "trailing / on source directories" behavior.
         def paths_to_pull
-          sep = mode == :ssh ? ':' : '::'
-          directories.map {|dir|
-            "#{ sep }'#{ dir.sub(/^~\//, '').sub(/\/$/, '') }'"
-          }.join(' ').sub(/^#{ sep }/, '')
+          sep = mode == :ssh ? ":" : "::"
+          directories.map do |dir|
+            "#{sep}'#{dir.sub(/^~\//, "").sub(/\/$/, "")}'"
+          end.join(" ").sub(/^#{ sep }/, "")
         end
 
         # Expand path, since this is local and shell-quoted.
@@ -44,7 +41,6 @@ module Backup
         def create_dest_path!
           FileUtils.mkdir_p dest_path
         end
-
       end
     end
   end

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

@@ -1,10 +1,7 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Push < Base
-
         ##
         # Mode of operation
         #
@@ -114,8 +111,8 @@ module Backup
           write_password_file!
 
           create_dest_path!
-          run("#{ rsync_command } #{ paths_to_push } " +
-              "#{ host_options }'#{ dest_path }'")
+          run("#{rsync_command} #{paths_to_push} " \
+              "#{host_options}'#{dest_path}'")
 
           log!(:finished)
         ensure
@@ -128,7 +125,7 @@ module Backup
         # Remove any preceeding '~/', since this is on the remote,
         # and remove any trailing `/`.
         def dest_path
-          @dest_path ||= path.sub(/^~\//, '').sub(/\/$/, '')
+          @dest_path ||= path.sub(/^~\//, "").sub(/\/$/, "")
         end
 
         ##
@@ -137,10 +134,10 @@ module Backup
         # call 'mkdir' without the '-p' option. This is only applicable in :ssh
         # mode, and only used if the path would require this.
         def create_dest_path!
-          return unless mode == :ssh && dest_path.index('/').to_i > 0
+          return unless mode == :ssh && dest_path.index("/").to_i > 0
 
-          run "#{ utility(:ssh) } #{ ssh_transport_args } #{ host } " +
-                 %Q["mkdir -p '#{ dest_path }'"]
+          run "#{utility(:ssh)} #{ssh_transport_args} #{host} " +
+            %("mkdir -p '#{dest_path}'")
         end
 
         ##
@@ -148,10 +145,10 @@ module Backup
         # For Pull, this will prepend the first path in #paths_to_pull.
         def host_options
           if mode == :ssh
-            "#{ host }:"
+            "#{host}:"
           else
-            user = "#{ rsync_user }@" if rsync_user
-            "#{ user }#{ host }::"
+            user = "#{rsync_user}@" if rsync_user
+            "#{user}#{host}::"
           end
         end
 
@@ -162,35 +159,35 @@ module Backup
         end
 
         def compress_option
-          compress ? ' --compress' : ''
+          compress ? " --compress" : ""
         end
 
         def password_option
-          return '' if mode == :ssh
+          return "" if mode == :ssh
 
           path = @password_file ? @password_file.path : rsync_password_file
-          path ? " --password-file='#{ File.expand_path(path) }'" : ''
+          path ? " --password-file='#{File.expand_path(path)}'" : ""
         end
 
         def transport_options
           if mode == :rsync_daemon
-            " --port #{ port }"
+            " --port #{port}"
           else
-            %Q[ -e "#{ utility(:ssh) } #{ ssh_transport_args }"]
+            %( -e "#{utility(:ssh)} #{ssh_transport_args}")
           end
         end
 
         def ssh_transport_args
-          args = "-p #{ port } "
-          args << "-l #{ ssh_user } " if ssh_user
-          args << Array(additional_ssh_options).join(' ')
+          args = "-p #{port} "
+          args << "-l #{ssh_user} " if ssh_user
+          args << Array(additional_ssh_options).join(" ")
           args.rstrip
         end
 
         def write_password_file!
           return unless rsync_password && mode != :ssh
 
-          @password_file = Tempfile.new('backup-rsync-password')
+          @password_file = Tempfile.new("backup-rsync-password")
           @password_file.write(rsync_password)
           @password_file.close
         end
@@ -198,7 +195,6 @@ module Backup
         def remove_password_file!
           @password_file.delete if @password_file
         end
-
       end
     end
   end

data/lib/backup/template.rb

@@ -1,10 +1,7 @@
-# encoding: utf-8
-
-require 'erb'
+require "erb"
 
 module Backup
   class Template
-
     # Holds a binding object. Nil if not provided.
     attr_accessor :binding
 
@@ -12,13 +9,12 @@ module Backup
     # Creates a new instance of the Backup::Template class
     # and optionally takes an argument that can be either a binding object, a Hash or nil
     def initialize(object = nil)
-      if object.is_a?(Binding)
-        @binding = object
-      elsif object.is_a?(Hash)
-        @binding = Backup::Binder.new(object).get_binding
-      else
-        @binding = nil
-      end
+      @binding =
+        if object.is_a?(Binding)
+          object
+        elsif object.is_a?(Hash)
+          Backup::Binder.new(object).get_binding
+        end
     end
 
     ##
@@ -30,10 +26,10 @@ module Backup
     ##
     # Returns a String object containing the contents of the file (in the context of the binding if any)
     def result(file)
-      ERB.new(file_contents(file), nil, '<>').result(binding)
+      ERB.new(file_contents(file), nil, "<>").result(binding)
     end
 
-  private
+    private
 
     ##
     # Reads and returns the contents of the provided file path,
@@ -41,6 +37,5 @@ module Backup
     def file_contents(file)
       File.read(File.join(Backup::TEMPLATE_PATH, file))
     end
-
   end
 end

data/lib/backup/utilities.rb

@@ -1,11 +1,8 @@
-# encoding: utf-8
-
 module Backup
   module Utilities
     class Error < Backup::Error; end
 
-    UTILITY = {}
-    NAMES = %w{
+    UTILITIES_NAMES = %w[
       tar cat split sudo chown hostname
       gzip bzip2
       mongo mongodump mysqldump innobackupex
@@ -15,34 +12,38 @@ module Backup
       sendmail exim
       send_nsca
       zabbix_sender
-    }
-
-    module DSL
-      class << self
-        ##
-        # Allow users to set the path for all utilities in the .configure block.
-        #
-        # Utility names with dashes ('redis-cli') will be set using method calls
-        # with an underscore ('redis_cli').
-        NAMES.each do |name|
-          define_method name.gsub('-', '_'), lambda {|val|
-            path = File.expand_path(val)
-            unless File.executable?(path)
-              raise Utilities::Error, <<-EOS
-                The path given for '#{ name }' was not found or not executable.
-                Path was: #{ path }
-              EOS
-            end
-            UTILITY[name] = path
-          }
-        end
+    ].freeze
+
+    # @api private
+    class DSL
+      def initialize(utils)
+        @utilities = utils
+      end
+
+      # Helper methods to allow users to set the path for all utilities in the
+      # .configure block.
+      #
+      # Utility names with dashes (`redis-cli`) will be set using method calls
+      # with an underscore (`redis_cli`).
+      UTILITIES_NAMES.each do |util_name|
+        define_method util_name.tr("-", "_") do |raw_path|
+          path = File.expand_path(raw_path)
+
+          unless File.executable?(path)
+            raise Utilities::Error, <<-EOS
+              The path given for '#{util_name}' was not found or not executable.
+              Path was: #{path}
+            EOS
+          end
 
-        ##
-        # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
-        def tar_dist(val)
-          Utilities.tar_dist(val)
+          @utilities.utilities[util_name] = path
         end
       end
+
+      # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
+      def tar_dist(val)
+        Utilities.tar_dist(val)
+      end
     end
 
     class << self
@@ -102,7 +103,7 @@ module Backup
       # These paths may be set using absolute paths, or relative to the
       # working directory when Backup is run.
       def configure(&block)
-        DSL.instance_eval(&block)
+        DSL.new(self).instance_eval(&block)
       end
 
       def tar_dist(val)
@@ -112,7 +113,11 @@ module Backup
 
       def gnu_tar?
         return @gnu_tar unless @gnu_tar.nil?
-        @gnu_tar = !!run("#{ utility(:tar) } --version").match(/GNU/)
+        @gnu_tar = !!run("#{utility(:tar)} --version").match(/GNU/)
+      end
+
+      def utilities
+        @utilities ||= {}
       end
 
       private
@@ -122,17 +127,17 @@ module Backup
       # Raises an error if utility can not be found in the system's $PATH
       def utility(name)
         name = name.to_s.strip
-        raise Error, 'Utility Name Empty' if name.empty?
+        raise Error, "Utility Name Empty" if name.empty?
 
-        UTILITY[name] ||= %x[which '#{ name }' 2>/dev/null].chomp
-        raise Error, <<-EOS if UTILITY[name].empty?
-          Could not locate '#{ name }'.
+        utilities[name] ||= `which '#{name}' 2>/dev/null`.chomp
+        raise Error, <<-EOS if utilities[name].empty?
+          Could not locate '#{name}'.
           Make sure the specified utility is installed
           and available in your system's $PATH, or specify it's location
           in your 'config.rb' file using Backup::Utilities.configure
         EOS
 
-        UTILITY[name].dup
+        utilities[name].dup
       end
 
       ##
@@ -140,21 +145,21 @@ module Backup
       # This is only used to simplify log messages.
       def command_name(command)
         parts = []
-        command = command.split(' ')
-        command.shift while command[0].to_s.include?('=')
-        parts << command.shift.split('/')[-1]
-        if parts[0] == 'sudo'
+        command = command.split(" ")
+        command.shift while command[0].to_s.include?("=")
+        parts << command.shift.split("/")[-1]
+        if parts[0] == "sudo"
           until command.empty?
             part = command.shift
-            if part.include?('/')
-              parts << part.split('/')[-1]
+            if part.include?("/")
+              parts << part.split("/")[-1]
               break
             else
               parts << part
             end
           end
         end
-        parts.join(' ')
+        parts.join(" ")
       end
 
       ##
@@ -169,43 +174,41 @@ module Backup
       # Returns STDOUT
       def run(command)
         name = command_name(command)
-        Logger.info "Running system utility '#{ name }'..."
+        Logger.info "Running system utility '#{name}'..."
 
         begin
-          out, err = '', ''
-          ps = Open4.popen4(command) do |pid, stdin, stdout, stderr|
+          out = ""
+          err = ""
+          ps = Open4.popen4(command) do |_pid, stdin, stdout, stderr|
             stdin.close
-            out, err = stdout.read.strip, stderr.read.strip
+            out = stdout.read.strip
+            err = stderr.read.strip
           end
         rescue Exception => e
-          raise Error.wrap(e, "Failed to execute '#{ name }'")
+          raise Error.wrap(e, "Failed to execute '#{name}'")
         end
 
-        if ps.success?
-          unless out.empty?
-            Logger.info(
-              out.lines.map {|line| "#{ name }:STDOUT: #{ line }" }.join
-            )
-          end
-
-          unless err.empty?
-            Logger.warn(
-              err.lines.map {|line| "#{ name }:STDERR: #{ line }" }.join
-            )
-          end
-
-          return out
-        else
+        unless ps.success?
           raise Error, <<-EOS
-            '#{ name }' failed with exit status: #{ ps.exitstatus }
-            STDOUT Messages: #{ out.empty? ? 'None' : "\n#{ out }" }
-            STDERR Messages: #{ err.empty? ? 'None' : "\n#{ err }" }
+            '#{name}' failed with exit status: #{ps.exitstatus}
+            STDOUT Messages: #{out.empty? ? "None" : "\n#{out}"}
+            STDERR Messages: #{err.empty? ? "None" : "\n#{err}"}
           EOS
         end
+
+        unless out.empty?
+          Logger.info(out.lines.map { |line| "#{name}:STDOUT: #{line}" }.join)
+        end
+
+        unless err.empty?
+          Logger.warn(err.lines.map { |line| "#{name}:STDERR: #{line}" }.join)
+        end
+
+        out
       end
 
       def reset!
-        UTILITY.clear
+        utilities.clear
         @gnu_tar = nil
       end
     end
@@ -214,11 +217,17 @@ module Backup
     # while allowing them to be stubbed in spec_helper for all specs.
     module Helpers
       [:utility, :command_name, :run].each do |name|
-        define_method name, lambda {|arg| Utilities.send(name, arg) }
+        define_method name do |arg|
+          Utilities.send(name, arg)
+        end
         private name
       end
+
       private
-      def gnu_tar?; Utilities.gnu_tar?; end
+
+      def gnu_tar?
+        Utilities.gnu_tar?
+      end
     end
   end
 end

data/lib/backup/version.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
-  VERSION = '4.4.1'
+  VERSION = "5.0.0.beta.3"
 end