backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/encryptor/gpg.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Encryptor
     ##
@@ -104,7 +102,7 @@ module Backup
       attr_reader :mode
       def mode=(mode)
         @mode = mode.to_sym
-        raise Error, "'#{ @mode }' is not a valid mode." unless MODES.include?(@mode)
+        raise Error, "'#{@mode}' is not a valid mode." unless MODES.include?(@mode)
       end
 
       ##
@@ -411,11 +409,10 @@ module Backup
         prepare
 
         if mode_options.empty?
-          raise Error, "Encryption could not be performed for mode '#{ mode }'"
+          raise Error, "Encryption could not be performed for mode '#{mode}'"
         end
 
-        yield "#{ utility(:gpg) } #{ base_options } #{ mode_options }", '.gpg'
-
+        yield "#{utility(:gpg)} #{base_options} #{mode_options}", ".gpg"
       ensure
         cleanup
       end
@@ -426,7 +423,7 @@ module Backup
       # Remove any temporary directories and reset all instance variables.
       #
       def prepare
-        FileUtils.rm_rf(@tempdirs, :secure => true) if @tempdirs
+        FileUtils.rm_rf(@tempdirs, secure: true) if @tempdirs
         @tempdirs = []
         @base_options = nil
         @mode_options = nil
@@ -444,12 +441,12 @@ module Backup
       #
       def base_options
         @base_options ||= begin
-          opts = ['--no-tty']
+          opts = ["--no-tty"]
           path = setup_gpg_homedir
-          opts << "--homedir '#{ path }'" if path
+          opts << "--homedir '#{path}'" if path
           path = setup_gpg_config
-          opts << "--options '#{ path }'" if path
-          opts.join(' ')
+          opts << "--options '#{path}'" if path
+          opts.join(" ")
         end
       end
 
@@ -470,18 +467,17 @@ module Backup
         path = File.expand_path(gpg_homedir)
         FileUtils.mkdir_p(path)
         FileUtils.chown(Config.user, nil, path)
-        FileUtils.chmod(0700, path)
+        FileUtils.chmod(0o700, path)
 
-        unless %w{ pubring.gpg secring.gpg trustdb.gpg }.
-            all? {|name| File.exist? File.join(path, name) }
-          run("#{ utility(:gpg) } --homedir '#{ path }' -K 2>&1 >/dev/null")
+        unless %w[pubring.gpg secring.gpg trustdb.gpg]
+            .all? { |name| File.exist? File.join(path, name) }
+          run("#{utility(:gpg)} --homedir '#{path}' -K 2>&1 >/dev/null")
         end
 
         path
-
       rescue => err
-        raise Error.wrap(
-            err, "Failed to create or set permissions for #gpg_homedir")
+        raise Error.wrap \
+          err, "Failed to create or set permissions for #gpg_homedir"
       end
 
       ##
@@ -501,16 +497,15 @@ module Backup
       def setup_gpg_config
         return false unless gpg_config
 
-        dir = Dir.mktmpdir('backup-gpg_config', Config.tmp_path)
+        dir = Dir.mktmpdir("backup-gpg_config", Config.tmp_path)
         @tempdirs << dir
-        file = Tempfile.open('backup-gpg_config', dir)
-        file.write gpg_config.gsub(/^[[:blank:]]+/, '')
+        file = Tempfile.open("backup-gpg_config", dir)
+        file.write gpg_config.gsub(/^[[:blank:]]+/, "")
         file.close
 
         check_gpg_config(file.path)
 
         file.path
-
       rescue => err
         cleanup
         raise Error.wrap(err, "Error creating temporary file for #gpg_config.")
@@ -524,7 +519,7 @@ module Backup
       #
       def check_gpg_config(path)
         ret = run(
-          "#{ utility(:gpg) } --options '#{ path }' --gpgconf-test 2>&1"
+          "#{utility(:gpg)} --options '#{path}' --gpgconf-test 2>&1"
         ).chomp
         raise ret unless ret.empty?
       end
@@ -537,7 +532,7 @@ module Backup
         @mode_options ||= begin
           s_opts = symmetric_options if mode != :asymmetric
           a_opts = asymmetric_options if mode != :symmetric
-          [s_opts, a_opts].compact.join(' ')
+          [s_opts, a_opts].compact.join(" ")
         end
       end
 
@@ -555,7 +550,7 @@ module Backup
         end
 
         if path && File.exist?(path)
-          "-c --passphrase-file '#{ path }'"
+          "-c --passphrase-file '#{path}'"
         else
           Logger.warn("Symmetric encryption options could not be set.")
           nil
@@ -570,14 +565,13 @@ module Backup
       def setup_passphrase_file
         return false if passphrase.to_s.empty?
 
-        dir = Dir.mktmpdir('backup-gpg_passphrase', Config.tmp_path)
+        dir = Dir.mktmpdir("backup-gpg_passphrase", Config.tmp_path)
         @tempdirs << dir
-        file = Tempfile.open('backup-gpg_passphrase', dir)
+        file = Tempfile.open("backup-gpg_passphrase", dir)
         file.write passphrase.to_s
         file.close
 
         file.path
-
       rescue => err
         Logger.warn Error.wrap(err, "Error creating temporary passphrase file.")
         false
@@ -595,7 +589,7 @@ module Backup
         else
           # skip trust database checks
           "-e --trust-model always " +
-              user_recipients.map {|r| "-r '#{ r }'" }.join(' ')
+            user_recipients.map { |r| "-r '#{r}'" }.join(" ")
         end
       end
 
@@ -622,9 +616,8 @@ module Backup
                 # will log a warning and return nil if the import fails
                 import_key(identifier, key)
               else
-                Logger.warn(
-                  "No public key was found in #keys for '#{ identifier }'"
-                )
+                Logger.warn \
+                  "No public key was found in #keys for '#{identifier}'"
                 nil
               end
             end
@@ -640,10 +633,11 @@ module Backup
       def user_keys
         @user_keys ||= begin
           _keys = keys || {}
-          ret = Hash[_keys.map {|k,v| [clean_identifier(k), v] }]
-          Logger.warn(
-            "Duplicate public key identifiers were detected in #keys."
-          ) if ret.keys.count != _keys.keys.count
+          ret = Hash[_keys.map { |k, v| [clean_identifier(k), v] }]
+          if ret.keys.count != _keys.keys.count
+            Logger.warn \
+              "Duplicate public key identifiers were detected in #keys."
+          end
           ret
         end
       end
@@ -654,8 +648,8 @@ module Backup
       # and wrap email addresses in <> to perform exact matching.
       #
       def clean_identifier(str)
-        str = str.to_s.gsub(/[[:blank:]]+/, '')
-        str =~ /@/ ? "<#{ str.gsub(/(<|>)/,'') }>" : str.upcase
+        str = str.to_s.gsub(/[[:blank:]]+/, "")
+        str =~ /@/ ? "<#{str.gsub(/(<|>)/, "")}>" : str.upcase
       end
 
       ##
@@ -664,22 +658,20 @@ module Backup
       # Note that errors raised by Cli::Helpers#run may also be rescued here.
       #
       def import_key(identifier, key)
-        file = Tempfile.open('backup-gpg_import', Config.tmp_path)
-        file.write(key.gsub(/^[[:blank:]]+/, ''))
+        file = Tempfile.open("backup-gpg_import", Config.tmp_path)
+        file.write(key.gsub(/^[[:blank:]]+/, ""))
         file.close
-        ret = run(
-          "#{ utility(:gpg) } #{ base_options } " +
-          "--keyid-format 0xlong --import '#{ file.path }' 2>&1"
-        )
+        ret = run "#{utility(:gpg)} #{base_options} " \
+          "--keyid-format 0xlong --import '#{file.path}' 2>&1"
         file.delete
 
         keyid = ret.match(/ 0x(\w{16})/).to_a[1]
-        raise "GPG Returned:\n#{ ret.gsub(/^\s*/, '  ') }" unless keyid
+        raise "GPG Returned:\n#{ret.gsub(/^\s*/, "  ")}" unless keyid
         keyid
-
       rescue => err
         Logger.warn Error.wrap(
-            err, "Public key import failed for '#{ identifier }'")
+          err, "Public key import failed for '#{identifier}'"
+        )
         nil
       end
 
@@ -691,20 +683,17 @@ module Backup
       def system_identifiers
         @system_identifiers ||= begin
           skip_key = false
-          data = run(
-            "#{ utility(:gpg) } #{ base_options } " +
+          data = run "#{utility(:gpg)} #{base_options} " \
             "--with-colons --fixed-list-mode --fingerprint"
-          )
           data.lines.map do |line|
             line.strip!
 
             # process public key record
             if line =~ /^pub:/
-              validity, keyid, capabilities =
-                  line.split(':').values_at(1, 4, 11)
+              validity, keyid, capabilities = line.split(":").values_at(1, 4, 11)
               # skip keys marked as revoked ('r'), expired ('e'),
               # invalid ('i') or disabled ('D')
-              if validity[0,1] =~ /(r|e|i)/ || capabilities =~ /D/
+              if validity[0, 1] =~ /(r|e|i)/ || capabilities =~ /D/
                 skip_key = true
                 next nil
               else
@@ -714,26 +703,28 @@ module Backup
               end
             else
               # wait for the next valid public key record
-              next nil if skip_key
+              next if skip_key
 
               # process UID records for the current public key
               if line =~ /^uid:/
-                validity, userid = line.split(':').values_at(1, 9)
+                validity, userid = line.split(":").values_at(1, 9)
                 # skip records marked as revoked ('r'), expired ('e')
                 # or invalid ('i')
                 if validity !~ /(r|e|i)/
                   # return the last email found in user id string,
                   # since this includes user supplied comments.
                   # return nil if no email found.
-                  email, str = nil, userid
+                  email = nil
+                  str = userid
                   while match = str.match(/<.+?@.+?>/)
-                    email, str = match[0], match.post_match
+                    email = match[0]
+                    str = match.post_match
                   end
                   next email
                 end
               # return public key's fingerprint
               elsif line =~ /^fpr:/
-                next line.split(':')[9]
+                next line.split(":")[9]
               end
 
               nil # ignore any other lines
@@ -741,7 +732,6 @@ module Backup
           end.flatten.compact
         end
       end
-
     end
   end
 end

data/lib/backup/encryptor/open_ssl.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Encryptor
     class OpenSSL < Base
-
       ##
       # The password that'll be used to encrypt the backup. This
       # password will be required to decrypt the backup later on.
@@ -42,7 +39,7 @@ module Backup
       # so that any clean-up may be performed after the yield.
       def encrypt_with
         log!
-        yield "#{ utility(:openssl) } #{ options }", '.enc'
+        yield "#{utility(:openssl)} #{options}", ".enc"
       end
 
       private
@@ -59,19 +56,19 @@ module Backup
       # Always sets a password option, if even no password is given,
       # but will prefer the password_file option if both are given.
       def options
-        opts = ['aes-256-cbc']
-        opts << '-base64' if @base64
-        opts << '-salt'   if @salt
+        opts = ["aes-256-cbc"]
+        opts << "-base64" if @base64
+        opts << "-salt"   if @salt
 
-        if @password_file.to_s.empty?
-          opts << "-k #{Shellwords.escape(@password)}"
-        else
-          opts << "-pass file:#{@password_file}"
-        end
+        opts <<
+          if @password_file.to_s.empty?
+            "-k #{Shellwords.escape(@password)}"
+          else
+            "-pass file:#{@password_file}"
+          end
 
-        opts.join(' ')
+        opts.join(" ")
       end
-
     end
   end
 end

data/lib/backup/errors.rb

@@ -1,29 +1,25 @@
-# encoding: utf-8
-
 module Backup
-
   # Provides cascading errors with formatted messages.
   # See the specs for details.
   module NestedExceptions
-
     def self.included(klass)
-      klass.extend Module.new {
+      klass.extend(Module.new do
         def wrap(wrapped_exception, msg = nil)
           new(msg, wrapped_exception)
         end
-      }
+      end)
     end
 
     def initialize(obj = nil, wrapped_exception = nil)
       @wrapped_exception = wrapped_exception
-      msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s).
-            gsub(/^ */, '  ').strip
-      msg = clean_name(self.class.name) + (msg.empty? ? '' : ": #{ msg }")
+      msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s)
+        .gsub(/^ */, "  ").strip
+      msg = clean_name(self.class.name) + (msg.empty? ? "" : ": #{msg}")
 
       if wrapped_exception
         msg << "\n--- Wrapped Exception ---\n"
         class_name = clean_name(wrapped_exception.class.name)
-        msg << class_name + ': ' unless
+        msg << class_name + ": " unless
             wrapped_exception.message.start_with? class_name
         msg << wrapped_exception.message
       end
@@ -43,9 +39,8 @@ module Backup
     private
 
     def clean_name(name)
-      name.sub(/^Backup::/, '')
+      name.sub(/^Backup::/, "")
     end
-
   end
 
   class Error < StandardError

data/lib/backup/logger/console.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Console
@@ -30,22 +28,21 @@ module Backup
       end
 
       COLORS = {
-        :info   => "\e[32m%s\e[0m", # green
-        :warn   => "\e[33m%s\e[0m", # yellow
-        :error  => "\e[31m%s\e[0m"  # red
+        info: "\e[32m%s\e[0m", # green
+        warn: "\e[33m%s\e[0m", # yellow
+        error: "\e[31m%s\e[0m" # red
       }
 
-      def initialize(options = nil)
+      def initialize(_options = nil)
         $stdout.sync = $stderr.sync = true
       end
 
       def log(message)
         io = message.level == :info ? $stdout : $stderr
         lines = message.formatted_lines
-        lines.map! {|line| COLORS[message.level] % line } if io.tty?
+        lines.map! { |line| COLORS[message.level] % line } if io.tty?
         io.puts lines
       end
-
     end
   end
 end

data/lib/backup/logger/fog_adapter.rb

@@ -1,14 +1,11 @@
-# encoding: utf-8
-
 # require only the logger
-require 'formatador'
-require 'fog/core/logger'
+require "formatador"
+require "fog/core/logger"
 
 module Backup
   class Logger
     module FogAdapter
       class << self
-
         # Logged as :info so these won't generate warnings.
         # This is mostly to keep STDOUT clean and to provide
         # supplemental messages for our own warnings.
@@ -20,7 +17,6 @@ module Backup
         def tty?
           false
         end
-
       end
     end
   end

data/lib/backup/logger/logfile.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Logfile
@@ -60,7 +58,7 @@ module Backup
 
         def initialize
           @enabled = true
-          @log_path = ''
+          @log_path = ""
           @max_bytes = 500_000
         end
 
@@ -84,7 +82,7 @@ module Backup
       end
 
       def log(message)
-        File.open(@logfile, 'a') {|f| f.puts message.formatted_lines }
+        File.open(@logfile, "a") { |f| f.puts message.formatted_lines }
       end
 
       private
@@ -95,17 +93,17 @@ module Backup
       def setup_logfile
         # strip any trailing '/' in case the user supplied this as part of
         # an absolute path, so we can match it against File.expand_path()
-        path = @options.log_path.chomp('/')
+        path = @options.log_path.chomp("/")
         if path.empty?
-          path = File.join(Backup::Config.root_path, 'log')
+          path = File.join(Backup::Config.root_path, "log")
         elsif path != File.expand_path(path)
           path = File.join(Backup::Config.root_path, path)
         end
         FileUtils.mkdir_p(path)
-        log_file = @options.log_file || 'backup.log'
+        log_file = @options.log_file || "backup.log"
         path = File.join(path, log_file)
         if File.exist?(path) && !File.writable?(path)
-          raise Error, "Log File at '#{ path }' is not writable"
+          raise Error, "Log File at '#{path}' is not writable"
         end
         path
       end
@@ -116,16 +114,16 @@ module Backup
         return unless File.exist?(@logfile)
 
         if File.stat(@logfile).size > @options.max_bytes
-          FileUtils.cp(@logfile, @logfile + '~')
-          File.open(@logfile + '~', 'r') do |io_in|
-            File.open(@logfile, 'w') do |io_out|
+          FileUtils.cp(@logfile, @logfile + "~")
+          File.open(@logfile + "~", "r") do |io_in|
+            File.open(@logfile, "w") do |io_out|
               io_in.seek(-@options.max_bytes, IO::SEEK_END) && io_in.gets
               while line = io_in.gets
                 io_out.puts line
               end
             end
           end
-          FileUtils.rm_f(@logfile + '~')
+          FileUtils.rm_f(@logfile + "~")
         end
       end
     end

data/lib/backup/logger/syslog.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Syslog
@@ -81,7 +79,7 @@ module Backup
 
         def initialize
           @enabled = false
-          @ident = 'backup'
+          @ident = "backup"
           @options = ::Syslog::LOG_PID
           @facility = ::Syslog::LOG_LOCAL0
           @info = ::Syslog::LOG_INFO
@@ -108,7 +106,7 @@ module Backup
       def log(message)
         level = @options.send(message.level)
         ::Syslog.open(@options.ident, @options.options, @options.facility) do |s|
-          message.lines.each {|line| s.log(level, '%s', line) }
+          message.lines.each { |line| s.log(level, "%s", line) }
         end
       end
     end

data/lib/backup/logger.rb

@@ -1,13 +1,10 @@
-# encoding: utf-8
-
-require 'backup/logger/console'
-require 'backup/logger/logfile'
-require 'backup/logger/syslog'
-require 'backup/logger/fog_adapter'
+require "backup/logger/console"
+require "backup/logger/logfile"
+require "backup/logger/syslog"
+require "backup/logger/fog_adapter"
 
 module Backup
   class Logger
-
     class Config
       class Logger < Struct.new(:class, :options)
         def enabled?
@@ -44,22 +41,22 @@ module Backup
       #   [YYYY/MM/DD HH:MM:SS][level] message line text
       def formatted_lines
         timestamp = time.strftime("%Y/%m/%d %H:%M:%S")
-        lines.map {|line| "[#{ timestamp }][#{ level }] #{ line }" }
+        lines.map { |line| "[#{timestamp}][#{level}] #{line}" }
       end
 
       def matches?(ignores)
         text = lines.join("\n")
-        ignores.any? {|obj|
+        ignores.any? do |obj|
           obj.is_a?(Regexp) ? text.match(obj) : text.include?(obj)
-        }
+        end
       end
     end
 
     class << self
       extend Forwardable
       def_delegators :logger,
-          :start!, :abort!, :info, :warn, :error,
-          :messages, :has_warnings?, :has_errors?
+        :start!, :abort!, :info, :warn, :error,
+        :messages, :has_warnings?, :has_errors?
 
       ##
       # Allows the Logger to be configured.
@@ -137,9 +134,9 @@ module Backup
     # Sends a message to the Logger using the specified log level.
     # +obj+ may be any Object that responds to #to_s (i.e. an Exception)
     [:info, :warn, :error].each do |level|
-      define_method level, lambda {|obj|
+      define_method level do |obj|
         MUTEX.synchronize { log(obj, level) }
-      }
+      end
     end
 
     ##
@@ -169,7 +166,7 @@ module Backup
         @loggers << logger.class.new(logger.options) if logger.enabled?
       end
       messages.each do |message|
-        @loggers.each {|logger| logger.log(message) }
+        @loggers.each { |logger| logger.log(message) }
       end
     end
 
@@ -187,13 +184,14 @@ module Backup
     def log(obj, level)
       message = Message.new(Time.now.utc, level, obj.to_s.split("\n"))
 
-      message.level = :info if message.level == :warn &&
-          message.matches?(@config.ignores)
+      if message.level == :warn && message.matches?(@config.ignores)
+        message.level = :info
+      end
       @has_warnings ||= message.level == :warn
       @has_errors   ||= message.level == :error
 
       messages << message
-      @loggers.each {|logger| logger.log(message) }
+      @loggers.each { |logger| logger.log(message) }
     end
   end
 end