backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/storage/qiniu.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'qiniu'
+require "qiniu"
 
 module Backup
   module Storage
@@ -18,18 +17,19 @@ module Backup
       def initialize(model, storage_id = nil)
         super
 
-        @path ||= 'backups'
+        @path ||= "backups"
 
         check_configuration
         config_credentials
       end
 
       private
+
       def transfer!
         package.filenames.each do |filename|
           src = File.join(Config.tmp_path, filename)
           dest = File.join(remote_path, filename)
-          Logger.info "Storing '#{ dest }'..."
+          Logger.info "Storing '#{dest}'..."
 
           ::Qiniu.upload_file(uptoken: ::Qiniu.generate_upload_token,
                               bucket: bucket,
@@ -41,7 +41,7 @@ module Backup
       # Called by the Cycler.
       # Any error raised will be logged as a warning.
       def remove!(package)
-        Logger.info "Removing backup package dated #{ package.time }..."
+        Logger.info "Removing backup package dated #{package.time}..."
         remote_path = remote_path_for(package)
         package.filenames.each do |filename|
           ::Qiniu.delete(bucket, File.join(remote_path, filename))
@@ -49,11 +49,11 @@ module Backup
       end
 
       def check_configuration
-         required = %w{ access_key secret_key bucket }
+        required = %w[access_key secret_key bucket]
 
-        raise Error, <<-EOS if required.map {|name| send(name) }.any?(&:nil?)
+        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
       end
 

data/lib/backup/storage/rsync.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Storage
     class RSync < Base
@@ -133,7 +131,7 @@ module Backup
         @mode ||= :ssh
         @port ||= mode == :rsync_daemon ? 873 : 22
         @compress ||= false
-        @path ||= '~/backups'
+        @path ||= "~/backups"
       end
 
       private
@@ -143,10 +141,10 @@ module Backup
         create_remote_path
 
         package.filenames.each do |filename|
-          src = "'#{ File.join(Config.tmp_path, filename) }'"
-          dest = "#{ host_options }'#{ File.join(remote_path, filename) }'"
-          Logger.info "Syncing to #{ dest }..."
-          run("#{ rsync_command } #{ src } #{ dest }")
+          src = "'#{File.join(Config.tmp_path, filename)}'"
+          dest = "#{host_options}'#{File.join(remote_path, filename)}'"
+          Logger.info "Syncing to #{dest}..."
+          run("#{rsync_command} #{src} #{dest}")
         end
       ensure
         remove_password_file
@@ -159,7 +157,7 @@ module Backup
       def remote_path
         @remote_path ||= begin
           if host
-            path.sub(/^~\//, '').sub(/\/$/, '')
+            path.sub(/^~\//, "").sub(/\/$/, "")
           else
             File.expand_path(path)
           end
@@ -176,8 +174,9 @@ module Backup
       # module name that must define a path on the remote that already exists.
       def create_remote_path
         if host
-          run("#{ utility(:ssh) } #{ ssh_transport_args } #{ host } " +
-                  %Q["mkdir -p '#{ remote_path }'"]) if mode == :ssh
+          return unless mode == :ssh
+          run "#{utility(:ssh)} #{ssh_transport_args} #{host} " +
+            %("mkdir -p '#{remote_path}'")
         else
           FileUtils.mkdir_p(remote_path)
         end
@@ -186,55 +185,55 @@ module Backup
       def host_options
         @host_options ||= begin
           if !host
-            ''
+            ""
           elsif mode == :ssh
-            "#{ host }:"
+            "#{host}:"
           else
-            user = "#{ rsync_user }@" if rsync_user
-            "#{ user }#{ host }::"
+            user = "#{rsync_user}@" if rsync_user
+            "#{user}#{host}::"
           end
         end
       end
 
       def rsync_command
         @rsync_command ||= begin
-          cmd = utility(:rsync) << ' --archive' <<
-              " #{ Array(additional_rsync_options).join(' ') }".rstrip
+          cmd = utility(:rsync) << " --archive" <<
+            " #{Array(additional_rsync_options).join(" ")}".rstrip
           cmd << compress_option << password_option << transport_options if host
           cmd
         end
       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 host && 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
@@ -242,7 +241,6 @@ module Backup
       def remove_password_file
         @password_file.delete if @password_file
       end
-
     end
   end
 end

data/lib/backup/storage/s3.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'backup/cloud_io/s3'
+require "backup/cloud_io/s3"
 
 module Backup
   module Storage
@@ -75,10 +74,10 @@ module Backup
         @chunk_size     ||= 5 # MiB
         @max_retries    ||= 10
         @retry_waitsec  ||= 30
-        @path           ||= 'backups'
+        @path           ||= "backups"
         @storage_class  ||= :standard
 
-        @path = @path.sub(/^\//, '')
+        @path = @path.sub(/^\//, "")
 
         check_configuration
       end
@@ -87,17 +86,17 @@ 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,
-          :region             => region,
-          :bucket             => bucket,
-          :encryption         => encryption,
-          :storage_class      => storage_class,
-          :max_retries        => max_retries,
-          :retry_waitsec      => retry_waitsec,
-          :chunk_size         => chunk_size,
-          :fog_options        => fog_options
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key,
+          use_iam_profile: use_iam_profile,
+          region: region,
+          bucket: bucket,
+          encryption: encryption,
+          storage_class: storage_class,
+          max_retries: max_retries,
+          retry_waitsec: retry_waitsec,
+          chunk_size: chunk_size,
+          fog_options: fog_options
         )
       end
 
@@ -105,7 +104,7 @@ module Backup
         package.filenames.each do |filename|
           src = File.join(Config.tmp_path, filename)
           dest = File.join(remote_path, filename)
-          Logger.info "Storing '#{ bucket }/#{ dest }'..."
+          Logger.info "Storing '#{bucket}/#{dest}'..."
           cloud_io.upload(src, dest)
         end
       end
@@ -113,25 +112,26 @@ module Backup
       # Called by the Cycler.
       # Any error raised will be logged as a warning.
       def remove!(package)
-        Logger.info "Removing backup package dated #{ package.time }..."
+        Logger.info "Removing backup package dated #{package.time}..."
 
         remote_path = remote_path_for(package)
         objects = cloud_io.objects(remote_path)
 
-        raise Error, "Package at '#{ remote_path }' not found" if objects.empty?
+        raise Error, "Package at '#{remote_path}' not found" if objects.empty?
 
         cloud_io.delete(objects)
       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 chunk_size > 0 && !chunk_size.between?(5, 5120)
@@ -139,18 +139,17 @@ module Backup
           #chunk_size must be between 5 and 5120 (or 0 to disable multipart)
         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', 'STANDARD_IA', 'REDUCED_REDUNDANCY']
+        classes = ["STANDARD", "STANDARD_IA", "REDUCED_REDUNDANCY"]
         raise Error, <<-EOS unless classes.include?(storage_class.to_s.upcase)
           Configuration Error
           #storage_class must be :standard or :standard_ia or :reduced_redundancy
         EOS
       end
-
     end
   end
 end

data/lib/backup/storage/scp.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'net/scp'
+require "net/scp"
 
 module Backup
   module Storage
@@ -19,27 +18,27 @@ module Backup
         super
 
         @port ||= 22
-        @path ||= 'backups'
+        @path ||= "backups"
         @ssh_options ||= {}
-        path.sub!(/^~\//, '')
+        path.sub!(/^~\//, "")
       end
 
       private
 
       def connection
         Net::SSH.start(
-          ip, username, { :password => password, :port => port }.merge(ssh_options)
-        ) {|ssh| yield ssh }
+          ip, username, { password: password, port: port }.merge(ssh_options)
+        ) { |ssh| yield ssh }
       end
 
       def transfer!
         connection do |ssh|
-          ssh.exec!("mkdir -p '#{ remote_path }'")
+          ssh.exec!("mkdir -p '#{remote_path}'")
 
           package.filenames.each do |filename|
             src = File.join(Config.tmp_path, filename)
             dest = File.join(remote_path, filename)
-            Logger.info "Storing '#{ ip }:#{ dest }'..."
+            Logger.info "Storing '#{ip}:#{dest}'..."
             ssh.scp.upload!(src, dest)
           end
         end
@@ -48,20 +47,19 @@ module Backup
       # Called by the Cycler.
       # Any error raised will be logged as a warning.
       def remove!(package)
-        Logger.info "Removing backup package dated #{ package.time }..."
+        Logger.info "Removing backup package dated #{package.time}..."
 
         errors = []
         connection do |ssh|
-          ssh.exec!("rm -r '#{ remote_path_for(package) }'") do |ch, stream, data|
+          ssh.exec!("rm -r '#{remote_path_for(package)}'") do |_, stream, data|
             errors << data if stream == :stderr
           end
         end
         unless errors.empty?
           raise Error, "Net::SSH reported the following errors:\n" +
-              errors.join("\n")
+            errors.join("\n")
         end
       end
-
     end
   end
 end

data/lib/backup/storage/sftp.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'net/sftp'
+require "net/sftp"
 
 module Backup
   module Storage
@@ -19,16 +18,16 @@ module Backup
 
         @ssh_options ||= {}
         @port        ||= 22
-        @path        ||= 'backups'
-        path.sub!(/^~\//, '')
+        @path        ||= "backups"
+        path.sub!(/^~\//, "")
       end
 
       private
 
       def connection
         Net::SFTP.start(
-          ip, username, { :password => password, :port => port }.merge(ssh_options)
-        ) {|sftp| yield sftp }
+          ip, username, { password: password, port: port }.merge(ssh_options)
+        ) { |sftp| yield sftp }
       end
 
       def transfer!
@@ -38,7 +37,7 @@ module Backup
           package.filenames.each do |filename|
             src = File.join(Config.tmp_path, filename)
             dest = File.join(remote_path, filename)
-            Logger.info "Storing '#{ ip }:#{ dest }'..."
+            Logger.info "Storing '#{ip}:#{dest}'..."
             sftp.upload!(src, dest)
           end
         end
@@ -47,7 +46,7 @@ module Backup
       # Called by the Cycler.
       # Any error raised will be logged as a warning.
       def remove!(package)
-        Logger.info "Removing backup package dated #{ package.time }..."
+        Logger.info "Removing backup package dated #{package.time}..."
 
         remote_path = remote_path_for(package)
         connection do |sftp|
@@ -68,15 +67,14 @@ module Backup
       # Net::SFTP raises an exception when the directory it's trying to create
       # already exists, so we have rescue it
       def create_remote_path(sftp)
-        path_parts = Array.new
-        remote_path.split('/').each do |path_part|
+        path_parts = []
+        remote_path.split("/").each do |path_part|
           path_parts << path_part
           begin
-            sftp.mkdir!(path_parts.join('/'))
+            sftp.mkdir!(path_parts.join("/"))
           rescue Net::SFTP::StatusException; end
         end
       end
-
     end
   end
 end

data/lib/backup/syncer/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     class Base
@@ -53,18 +51,17 @@ module Backup
       private
 
       def syncer_name
-        @syncer_name ||= self.class.to_s.sub('Backup::', '') +
-            (syncer_id ? " (#{ syncer_id })" : '')
+        @syncer_name ||= self.class.to_s.sub("Backup::", "") +
+          (syncer_id ? " (#{syncer_id})" : "")
       end
 
       def log!(action)
         msg = case action
-              when :started then 'Started...'
-              when :finished then 'Finished!'
+              when :started then "Started..."
+              when :finished then "Finished!"
               end
-        Logger.info "#{ syncer_name } #{ msg }"
+        Logger.info "#{syncer_name} #{msg}"
       end
-
     end
   end
 end

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module Cloud
@@ -34,8 +32,8 @@ module Backup
           @max_retries    ||= 10
           @retry_waitsec  ||= 30
 
-          @path ||= 'backups'
-          @path = path.sub(/^\//, '')
+          @path ||= "backups"
+          @path = path.sub(/^\//, "")
         end
 
         def perform!
@@ -45,14 +43,14 @@ module Backup
           @skipped_count = 0
           @orphans = thread_count > 0 ? Queue.new : []
 
-          directories.each {|dir| sync_directory(dir) }
+          directories.each { |dir| sync_directory(dir) }
           orphans_result = process_orphans
 
           Logger.info "\nSummary:"
-          Logger.info "\s\sTransferred Files: #{ @transfer_count }"
-          Logger.info "\s\s#{ orphans_result }"
-          Logger.info "\s\sUnchanged Files: #{ @unchanged_count }"
-          Logger.warn "\s\sSkipped Files: #{ @skipped_count }" if @skipped_count > 0
+          Logger.info "\s\sTransferred Files: #{@transfer_count}"
+          Logger.info "\s\s#{orphans_result}"
+          Logger.info "\s\sUnchanged Files: #{@unchanged_count}"
+          Logger.warn "\s\sSkipped Files: #{@skipped_count}" if @skipped_count > 0
           log!(:finished)
         end
 
@@ -61,18 +59,18 @@ module Backup
         def sync_directory(dir)
           remote_base = path.empty? ? File.basename(dir) :
                                       File.join(path, File.basename(dir))
-          Logger.info "Gathering remote data for '#{ remote_base }'..."
+          Logger.info "Gathering remote data for '#{remote_base}'..."
           remote_files = get_remote_files(remote_base)
 
-          Logger.info("Gathering local data for '#{ File.expand_path(dir) }'...")
+          Logger.info("Gathering local data for '#{File.expand_path(dir)}'...")
           local_files = LocalFile.find(dir, excludes)
 
           relative_paths = (local_files.keys | remote_files.keys).sort
           if relative_paths.empty?
-            Logger.info 'No local or remote files found'
+            Logger.info "No local or remote files found"
           else
-            Logger.info 'Syncing...'
-            sync_block = Proc.new do |relative_path|
+            Logger.info "Syncing..."
+            sync_block = proc do |relative_path|
               local_file  = local_files[relative_path]
               remote_md5  = remote_files[relative_path]
               remote_path = File.join(remote_base, relative_path)
@@ -91,8 +89,8 @@ module Backup
           queue = Queue.new
           queue << relative_paths.shift until relative_paths.empty?
           num_threads = [thread_count, queue.size].min
-          Logger.info "\s\sUsing #{ num_threads } Threads"
-          threads = num_threads.times.map do
+          Logger.info "\s\sUsing #{num_threads} Threads"
+          threads = Array.new(num_threads) do
             Thread.new do
               loop do
                 path = queue.shift(true) rescue nil
@@ -103,7 +101,7 @@ module Backup
 
           # abort if any thread raises an exception
           while threads.any?(&:alive?)
-            if threads.any? {|thr| thr.status.nil? }
+            if threads.any? { |thr| thr.status.nil? }
               threads.each(&:kill)
               Thread.pass while threads.any?(&:alive?)
               break
@@ -122,13 +120,13 @@ module Backup
             if local_file.md5 == remote_md5
               MUTEX.synchronize { @unchanged_count += 1 }
             else
-              Logger.info("\s\s[transferring] '#{ remote_path }'")
+              Logger.info("\s\s[transferring] '#{remote_path}'")
               begin
                 cloud_io.upload(local_file.path, remote_path)
                 MUTEX.synchronize { @transfer_count += 1 }
               rescue CloudIO::FileSizeError => err
                 MUTEX.synchronize { @skipped_count += 1 }
-                Logger.warn Error.wrap(err, "Skipping '#{ remote_path }'")
+                Logger.warn Error.wrap(err, "Skipping '#{remote_path}'")
               rescue => err
                 Logger.error(err)
                 raise Error, <<-EOS
@@ -145,34 +143,33 @@ module Backup
 
         def process_orphans
           if @orphans.empty?
-            return mirror ? 'Deleted Files: 0' : 'Orphaned Files: 0'
+            return mirror ? "Deleted Files: 0" : "Orphaned Files: 0"
           end
 
           if @orphans.is_a?(Queue)
-            @orphans = @orphans.size.times.map { @orphans.shift }
+            @orphans = Array.new(@orphans.size) { @orphans.shift }
           end
 
           if mirror
-            Logger.info @orphans.map {|path|
-              "\s\s[removing] '#{ path }'"
+            Logger.info @orphans.map { |path|
+              "\s\s[removing] '#{path}'"
             }.join("\n")
 
             begin
               cloud_io.delete(@orphans)
-              "Deleted Files: #{ @orphans.count }"
+              "Deleted Files: #{@orphans.count}"
             rescue => err
-              Logger.warn Error.wrap(err, 'Delete Operation Failed')
-              "Attempted to Delete: #{ @orphans.count } " +
+              Logger.warn Error.wrap(err, "Delete Operation Failed")
+              "Attempted to Delete: #{@orphans.count} " \
               "(See log messages for actual results)"
             end
           else
-            Logger.info @orphans.map {|path|
-              "\s\s[orphaned] '#{ path }'"
+            Logger.info @orphans.map { |path|
+              "\s\s[orphaned] '#{path}'"
             }.join("\n")
-            "Orphaned Files: #{ @orphans.count }"
+            "Orphaned Files: #{@orphans.count}"
           end
         end
-
       end
     end
   end

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'backup/cloud_io/cloud_files'
+require "backup/cloud_io/cloud_files"
 
 module Backup
   module Syncer
@@ -45,38 +44,37 @@ module Backup
 
         def cloud_io
           @cloud_io ||= CloudIO::CloudFiles.new(
-            :username           => username,
-            :api_key            => api_key,
-            :auth_url           => auth_url,
-            :region             => region,
-            :servicenet         => servicenet,
-            :container          => container,
-            :max_retries        => max_retries,
-            :retry_waitsec      => retry_waitsec,
+            username: username,
+            api_key: api_key,
+            auth_url: auth_url,
+            region: region,
+            servicenet: servicenet,
+            container: container,
+            max_retries: max_retries,
+            retry_waitsec: retry_waitsec,
             # Syncer can not use SLOs.
-            :segments_container => nil,
-            :segment_size       => 0,
-            :fog_options        => fog_options
+            segments_container: nil,
+            segment_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.name.sub(remote_base + '/', '')
+            relative_path = object.name.sub(remote_base + "/", "")
             hash[relative_path] = object.hash
           end
           hash
         end
 
         def check_configuration
-          required = %w{ username api_key container }
-          raise Error, <<-EOS if required.map {|name| send(name) }.any?(&:nil?)
+          required = %w[username api_key container]
+          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
         end
-
       end # class Cloudfiles < Base
     end # module Cloud
   end