backup 4.4.1 → 5.0.0.beta.1

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

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