backup 4.4.1 → 5.0.0.beta.1

data/lib/backup/database/openldap.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class OpenLDAP < Base
@@ -33,11 +31,11 @@ module Backup
         super
         instance_eval(&block) if block_given?
 
-        @name             ||= 'ldap_backup'
+        @name             ||= "ldap_backup"
         @use_sudo         ||= false
-        @slapcat_args     ||= Array.new
+        @slapcat_args     ||= []
         @slapcat_utility  ||= utility(:slapcat)
-        @slapcat_conf     ||= '/etc/ldap/slapd.d'
+        @slapcat_conf     ||= "/etc/ldap/slapd.d"
       end
 
       ##
@@ -47,7 +45,7 @@ module Backup
         super
 
         pipeline = Pipeline.new
-        dump_ext = 'ldif'
+        dump_ext = "ldif"
 
         pipeline << slapcat
         if @model.compressor
@@ -57,8 +55,8 @@ module Backup
           end
         end
 
-        pipeline << "#{ utility(: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?
@@ -73,7 +71,7 @@ module Backup
       ##
       # Builds the full slapcat string based on all attributes
       def slapcat
-        command = "#{ slapcat_utility } #{ slapcat_conf_option } #{ slapcat_conf } #{ user_options }"
+        command = "#{slapcat_utility} #{slapcat_conf_option} #{slapcat_conf} #{user_options}"
         command.prepend("sudo ") if use_sudo
         command
       end
@@ -88,7 +86,7 @@ module Backup
       # Builds a compatible string for the additional options
       # specified by the user
       def user_options
-        slapcat_args.join(' ')
+        slapcat_args.join(" ")
       end
     end
   end

data/lib/backup/database/postgresql.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class PostgreSQL < Base
@@ -53,17 +51,19 @@ module Backup
         super
 
         pipeline = Pipeline.new
-        dump_ext = 'sql'
+        dump_ext = "sql"
 
         pipeline << (dump_all? ? pgdumpall : pgdump)
 
-        model.compressor.compress_with do |command, ext|
-          pipeline << command
-          dump_ext << ext
-        end if model.compressor
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
 
-        pipeline << "#{ utility(: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?
@@ -74,60 +74,59 @@ module Backup
       end
 
       def pgdump
-        "#{ password_option }" +
-        "#{ sudo_option }" +
-        "#{ utility(:pg_dump) } #{ username_option } #{ connectivity_options } " +
-        "#{ user_options } #{ tables_to_dump } #{ tables_to_skip } #{ name }"
+        password_option.to_s +
+          sudo_option.to_s +
+          "#{utility(:pg_dump)} #{username_option} #{connectivity_options} " \
+          "#{user_options} #{tables_to_dump} #{tables_to_skip} #{name}"
       end
 
       def pgdumpall
-        "#{ password_option }" +
-        "#{ sudo_option }" +
-        "#{ utility(:pg_dumpall) } #{ username_option } " +
-        "#{ connectivity_options } #{ user_options }"
+        password_option.to_s +
+          sudo_option.to_s +
+          "#{utility(:pg_dumpall)} #{username_option} " \
+          "#{connectivity_options} #{user_options}"
       end
 
       def password_option
-        "PGPASSWORD=#{ Shellwords.escape(password) } " if password
+        "PGPASSWORD=#{Shellwords.escape(password)} " if password
       end
 
       def sudo_option
-        "#{ utility(:sudo) } -n -H -u #{ sudo_user } " if sudo_user
+        "#{utility(:sudo)} -n -H -u #{sudo_user} " if sudo_user
       end
 
       def username_option
-        "--username=#{ Shellwords.escape(username) }" if username
+        "--username=#{Shellwords.escape(username)}" if username
       end
 
       def connectivity_options
-        return "--host='#{ socket }'" if socket
+        return "--host='#{socket}'" if socket
 
         opts = []
-        opts << "--host='#{ host }'" if host
-        opts << "--port='#{ port }'" if port
-        opts.join(' ')
+        opts << "--host='#{host}'" if host
+        opts << "--port='#{port}'" if port
+        opts.join(" ")
       end
 
       def user_options
-        Array(additional_options).join(' ')
+        Array(additional_options).join(" ")
       end
 
       def tables_to_dump
         Array(only_tables).map do |table|
-          "--table='#{ table }'"
-        end.join(' ')
+          "--table='#{table}'"
+        end.join(" ")
       end
 
       def tables_to_skip
         Array(skip_tables).map do |table|
-          "--exclude-table='#{ table }'"
-        end.join(' ')
+          "--exclude-table='#{table}'"
+        end.join(" ")
       end
 
       def dump_all?
         name == :all
       end
-
     end
   end
 end

data/lib/backup/database/redis.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class Redis < Base
@@ -59,12 +57,10 @@ module Backup
 
         @mode ||= :copy
 
-        unless MODES.include?(mode)
-          raise Error, "'#{ mode }' is not a valid mode"
-        end
+        raise Error, "'#{mode}' is not a valid mode" unless MODES.include?(mode)
 
         if mode == :copy && rdb_path.nil?
-          raise Error, '`rdb_path` must be set when `mode` is :copy'
+          raise Error, "`rdb_path` must be set when `mode` is :copy"
         end
       end
 
@@ -96,17 +92,19 @@ module Backup
 
       def sync!
         pipeline = Pipeline.new
-        dump_ext = 'rdb'
+        dump_ext = "rdb"
 
-        pipeline << "#{ redis_cli_cmd } --rdb -"
+        pipeline << "#{redis_cli_cmd} --rdb -"
 
-        model.compressor.compress_with do |command, ext|
-          pipeline << command
-          dump_ext << ext
-        end if model.compressor
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
 
-        pipeline << "#{ utility(:cat) } > " +
-            "'#{ File.join(dump_path, dump_filename) }.#{ dump_ext }'"
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
 
         pipeline.run
 
@@ -116,17 +114,16 @@ module Backup
       end
 
       def save!
-        resp = run("#{ redis_cli_cmd } SAVE")
+        resp = run("#{redis_cli_cmd} SAVE")
         unless resp =~ /OK$/
           raise Error, <<-EOS
             Failed to invoke the `SAVE` command
-            Response was: #{ resp }
+            Response was: #{resp}
           EOS
         end
-
       rescue Error
         if resp =~ /save already in progress/
-          unless (attempts ||= '0').next! == '5'
+          unless (attempts ||= "0").next! == "5"
             sleep 5
             retry
           end
@@ -138,14 +135,14 @@ module Backup
         unless File.exist?(rdb_path)
           raise Error, <<-EOS
             Redis database dump not found
-            `rdb_path` was '#{ rdb_path }'
+            `rdb_path` was '#{rdb_path}'
           EOS
         end
 
-        dst_path = File.join(dump_path, dump_filename + '.rdb')
+        dst_path = File.join(dump_path, dump_filename + ".rdb")
         if model.compressor
           model.compressor.compress_with do |command, ext|
-            run("#{ command } -c '#{ rdb_path }' > '#{ dst_path + ext }'")
+            run("#{command} -c '#{rdb_path}' > '#{dst_path + ext}'")
           end
         else
           FileUtils.cp(rdb_path, dst_path)
@@ -153,27 +150,27 @@ module Backup
       end
 
       def redis_cli_cmd
-        "#{ utility('redis-cli') } #{ password_option } " +
-        "#{ connectivity_options } #{ user_options }"
+        "#{utility("redis-cli")} #{password_option} " \
+          "#{connectivity_options} #{user_options}"
       end
 
       def password_option
-        "-a '#{ password }'" if password
+        return unless password
+        "-a '#{password}'"
       end
 
       def connectivity_options
-        return "-s '#{ socket }'" if socket
+        return "-s '#{socket}'" if socket
 
         opts = []
-        opts << "-h '#{ host }'" if host
-        opts << "-p '#{ port }'" if port
-        opts.join(' ')
+        opts << "-h '#{host}'" if host
+        opts << "-p '#{port}'" if port
+        opts.join(" ")
       end
 
       def user_options
-        Array(additional_options).join(' ')
+        Array(additional_options).join(" ")
       end
-
     end
   end
 end

data/lib/backup/database/riak.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class Riak < Base
-
       ##
       # Node is the node from which to perform the backup.
       # Default: riak@127.0.0.1
@@ -23,9 +20,9 @@ module Backup
         super
         instance_eval(&block) if block_given?
 
-        @node   ||= 'riak@127.0.0.1'
-        @cookie ||= 'riak'
-        @user   ||= 'riak'
+        @node   ||= "riak@127.0.0.1"
+        @cookie ||= "riak"
+        @user   ||= "riak"
       end
 
       ##
@@ -38,14 +35,16 @@ module Backup
 
         dump_file = File.join(dump_path, dump_filename)
         with_riak_owned_dump_path do
-          run("#{ riakadmin } backup #{ node } #{ cookie } '#{ dump_file }' node")
+          run("#{riakadmin} backup #{node} #{cookie} '#{dump_file}' node")
         end
 
-        model.compressor.compress_with do |command, ext|
-          dump_file << "-#{ node }" # `riak-admin` appends `node` to the filename.
-          run("#{ command } -c '#{ dump_file }' > '#{ dump_file + ext }'")
-          FileUtils.rm_f(dump_file)
-        end if model.compressor
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            dump_file << "-#{node}" # `riak-admin` appends `node` to the filename.
+            run("#{command} -c '#{dump_file}' > '#{dump_file + ext}'")
+            FileUtils.rm_f(dump_file)
+          end
+        end
 
         log!(:finished)
       end
@@ -61,22 +60,20 @@ module Backup
       # the user running Backup, since the absence of the execute bit on their
       # home directory would deny +user+ access.
       def with_riak_owned_dump_path
-        run("#{ utility(:sudo) } -n #{ utility(:chown) } " +
-            "#{ user } '#{ dump_path }'")
+        run "#{utility(:sudo)} -n #{utility(:chown)} #{user} '#{dump_path}'"
         yield
       ensure
         # reclaim ownership
-        run("#{ utility(:sudo) } -n #{ utility(:chown) } -R " +
-            "#{ Config.user } '#{ dump_path }'")
+        run "#{utility(:sudo)} -n #{utility(:chown)} -R " \
+          "#{Config.user} '#{dump_path}'"
       end
 
       ##
       # `riak-admin` must be run as the riak +user+.
       # It will do this itself, but without `-n` and emits a message on STDERR.
       def riakadmin
-        "#{ utility(:sudo) } -n -u #{ user } #{ utility('riak-admin') }"
+        "#{utility(:sudo)} -n -u #{user} #{utility("riak-admin")}"
       end
-
     end
   end
 end

data/lib/backup/database/sqlite.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class SQLite < Base
@@ -28,10 +26,10 @@ module Backup
       def perform!
         super
 
-        dump = "echo '.dump' | #{ sqlitedump_utility } #{ path }"
+        dump = "echo '.dump' | #{sqlitedump_utility} #{path}"
 
         pipeline = Pipeline.new
-        dump_ext = 'sql'
+        dump_ext = "sql"
 
         pipeline << dump
         if model.compressor
@@ -41,7 +39,7 @@ module Backup
           end
         end
 
-        pipeline << "cat > '#{ File.join( dump_path , dump_filename) }.#{ dump_ext }'"
+        pipeline << "cat > '#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
 
         pipeline.run
 
@@ -49,7 +47,7 @@ module Backup
           log!(:finished)
         else
           raise Error,
-            "#{ database_name } Dump Failed!\n" + pipeline.error_messages
+            "#{database_name} Dump Failed!\n" + pipeline.error_messages
         end
       end
     end

data/lib/backup/encryptor/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Encryptor
     class Base
@@ -15,14 +13,14 @@ module Backup
       ##
       # Return the encryptor name, with Backup namespace removed
       def encryptor_name
-        self.class.to_s.sub('Backup::', '')
+        self.class.to_s.sub("Backup::", "")
       end
 
       ##
       # Logs a message to the console and log file to inform
       # the client that Backup is encrypting the archive
       def log!
-        Logger.info "Using #{ encryptor_name } to encrypt the archive."
+        Logger.info "Using #{encryptor_name} to encrypt the archive."
       end
     end
   end

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