backup 4.4.1 → 5.0.0.beta.1

data/lib/backup/cloud_io/s3.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
-require 'backup/cloud_io/base'
-require 'fog'
-require 'digest/md5'
-require 'base64'
-require 'stringio'
+require "backup/cloud_io/base"
+require "fog"
+require "digest/md5"
+require "base64"
+require "stringio"
 
 module Backup
   module CloudIO
@@ -14,8 +13,8 @@ module Backup
       MAX_MULTIPART_SIZE  = 1024**4 * 5   # 5 TiB
 
       attr_reader :access_key_id, :secret_access_key, :use_iam_profile,
-                  :region, :bucket, :chunk_size, :encryption, :storage_class,
-                  :fog_options
+        :region, :bucket, :chunk_size, :encryption, :storage_class,
+        :fog_options
 
       def initialize(options = {})
         super
@@ -39,9 +38,9 @@ module Backup
         if chunk_bytes > 0 && file_size > chunk_bytes
           raise FileSizeError, <<-EOS if file_size > MAX_MULTIPART_SIZE
             File Too Large
-            File: #{ src }
-            Size: #{ file_size }
-            Max Multipart Upload Size is #{ MAX_MULTIPART_SIZE } (5 TiB)
+            File: #{src}
+            Size: #{file_size}
+            Max Multipart Upload Size is #{MAX_MULTIPART_SIZE} (5 TiB)
           EOS
 
           chunk_bytes = adjusted_chunk_bytes(chunk_bytes, file_size)
@@ -51,9 +50,9 @@ module Backup
         else
           raise FileSizeError, <<-EOS if file_size > MAX_FILE_SIZE
             File Too Large
-            File: #{ src }
-            Size: #{ file_size }
-            Max File Size is #{ MAX_FILE_SIZE } (5 GiB)
+            File: #{src}
+            Size: #{file_size}
+            Max File Size is #{MAX_FILE_SIZE} (5 GiB)
           EOS
 
           put_object(src, dest)
@@ -68,15 +67,15 @@ module Backup
       def objects(prefix)
         objects = []
         resp = nil
-        prefix = prefix.chomp('/')
-        opts = { 'prefix' => prefix + '/' }
+        prefix = prefix.chomp("/")
+        opts = { "prefix" => prefix + "/" }
 
-        while resp.nil? || resp.body['IsTruncated']
-          opts.merge!('marker' => objects.last.key) unless objects.empty?
-          with_retries("GET '#{ bucket }/#{ prefix }/*'") do
+        while resp.nil? || resp.body["IsTruncated"]
+          opts["marker"] = objects.last.key unless objects.empty?
+          with_retries("GET '#{bucket}/#{prefix}/*'") do
             resp = connection.get_bucket(bucket, opts)
           end
-          resp.body['Contents'].each do |obj_data|
+          resp.body["Contents"].each do |obj_data|
             objects << Object.new(self, obj_data)
           end
         end
@@ -87,7 +86,7 @@ module Backup
       # Used by Object to fetch metadata if needed.
       def head_object(object)
         resp = nil
-        with_retries("HEAD '#{ bucket }/#{ object.key }'") do
+        with_retries("HEAD '#{bucket}/#{object.key}'") do
           resp = connection.head_object(bucket, object.key)
         end
         resp
@@ -102,18 +101,18 @@ module Backup
         keys = Array(objects_or_keys).dup
         keys.map!(&:key) if keys.first.is_a?(Object)
 
-        opts = { :quiet => true } # only report Errors in DeleteResult
+        opts = { quiet: true } # only report Errors in DeleteResult
         until keys.empty?
-          _keys = keys.slice!(0, 1000)
-          with_retries('DELETE Multiple Objects') do
-            resp = connection.delete_multiple_objects(bucket, _keys, opts.dup)
-            unless resp.body['DeleteResult'].empty?
-              errors = resp.body['DeleteResult'].map do |result|
-                error = result['Error']
-                "Failed to delete: #{ error['Key'] }\n" +
-                "Reason: #{ error['Code'] }: #{ error['Message'] }"
+          keys_partial = keys.slice!(0, 1000)
+          with_retries("DELETE Multiple Objects") do
+            resp = connection.delete_multiple_objects(bucket, keys_partial, opts.dup)
+            unless resp.body["DeleteResult"].empty?
+              errors = resp.body["DeleteResult"].map do |result|
+                error = result["Error"]
+                "Failed to delete: #{error["Key"]}\n" \
+                  "Reason: #{error["Code"]}: #{error["Message"]}"
               end.join("\n")
-              raise Error, "The server returned the following:\n#{ errors }"
+              raise Error, "The server returned the following:\n#{errors}"
             end
           end
         end
@@ -122,41 +121,40 @@ module Backup
       private
 
       def connection
-        @connection ||= begin
-          opts = { :provider => 'AWS', :region => region }
-          if use_iam_profile
-            opts.merge!(:use_iam_profile => true)
-          else
-            opts.merge!(
-              :aws_access_key_id      => access_key_id,
-              :aws_secret_access_key  => secret_access_key
-            )
+        @connection ||=
+          begin
+            opts = { provider: "AWS", region: region }
+            if use_iam_profile
+              opts[:use_iam_profile] = true
+            else
+              opts[:aws_access_key_id] = access_key_id
+              opts[:aws_secret_access_key] = secret_access_key
+            end
+            opts.merge!(fog_options || {})
+            conn = Fog::Storage.new(opts)
+            conn.sync_clock
+            conn
           end
-          opts.merge!(fog_options || {})
-          conn = Fog::Storage.new(opts)
-          conn.sync_clock
-          conn
-        end
       end
 
       def put_object(src, dest)
         md5 = Base64.encode64(Digest::MD5.file(src).digest).chomp
-        options = headers.merge('Content-MD5' => md5)
-        with_retries("PUT '#{ bucket }/#{ dest }'") do
-          File.open(src, 'r') do |file|
+        options = headers.merge("Content-MD5" => md5)
+        with_retries("PUT '#{bucket}/#{dest}'") do
+          File.open(src, "r") do |file|
             connection.put_object(bucket, dest, file, options)
           end
         end
       end
 
       def initiate_multipart(dest)
-        Logger.info "\s\sInitiate Multipart '#{ bucket }/#{ dest }'"
+        Logger.info "\s\sInitiate Multipart '#{bucket}/#{dest}'"
 
         resp = nil
-        with_retries("POST '#{ bucket }/#{ dest }' (Initiate)") do
+        with_retries("POST '#{bucket}/#{dest}' (Initiate)") do
           resp = connection.initiate_multipart_upload(bucket, dest, headers)
         end
-        resp.body['UploadId']
+        resp.body["UploadId"]
       end
 
       # Each part's MD5 is sent to verify the transfer.
@@ -164,26 +162,26 @@ module Backup
       # once the multipart upload is completed.
       def upload_parts(src, dest, upload_id, chunk_bytes, file_size)
         total_parts = (file_size / chunk_bytes.to_f).ceil
-        progress = (0.1..0.9).step(0.1).map {|n| (total_parts * n).floor }
-        Logger.info "\s\sUploading #{ total_parts } Parts..."
+        progress = (0.1..0.9).step(0.1).map { |n| (total_parts * n).floor }
+        Logger.info "\s\sUploading #{total_parts} Parts..."
 
         parts = []
-        File.open(src, 'r') do |file|
+        File.open(src, "r") do |file|
           part_number = 0
           while data = file.read(chunk_bytes)
             part_number += 1
             md5 = Base64.encode64(Digest::MD5.digest(data)).chomp
 
-            with_retries("PUT '#{ bucket }/#{ dest }' Part ##{ part_number }") do
+            with_retries("PUT '#{bucket}/#{dest}' Part ##{part_number}") do
               resp = connection.upload_part(
                 bucket, dest, upload_id, part_number, StringIO.new(data),
-                { 'Content-MD5' => md5 }
+                "Content-MD5" => md5
               )
-              parts << resp.headers['ETag']
+              parts << resp.headers["ETag"]
             end
 
             if i = progress.rindex(part_number)
-              Logger.info "\s\s...#{ i + 1 }0% Complete..."
+              Logger.info "\s\s...#{i + 1}0% Complete..."
             end
           end
         end
@@ -191,13 +189,13 @@ module Backup
       end
 
       def complete_multipart(dest, upload_id, parts)
-        Logger.info "\s\sComplete Multipart '#{ bucket }/#{ dest }'"
+        Logger.info "\s\sComplete Multipart '#{bucket}/#{dest}'"
 
-        with_retries("POST '#{ bucket }/#{ dest }' (Complete)") do
+        with_retries("POST '#{bucket}/#{dest}' (Complete)") do
           resp = connection.complete_multipart_upload(bucket, dest, upload_id, parts)
-          raise Error, <<-EOS if resp.body['Code']
+          raise Error, <<-EOS if resp.body["Code"]
             The server returned the following error:
-            #{ resp.body['Code'] }: #{ resp.body['Message'] }
+            #{resp.body["Code"]}: #{resp.body["Message"]}
           EOS
         end
       end
@@ -206,14 +204,10 @@ module Backup
         headers = {}
 
         enc = encryption.to_s.upcase
-        headers.merge!(
-          { 'x-amz-server-side-encryption' => enc}
-        ) unless enc.empty?
+        headers["x-amz-server-side-encryption"] = enc unless enc.empty?
 
         sc = storage_class.to_s.upcase
-        headers.merge!(
-          { 'x-amz-storage-class' => sc }
-        ) unless sc.empty? || sc == 'STANDARD'
+        headers["x-amz-storage-class"] = sc unless sc.empty? || sc == "STANDARD"
 
         headers
       end
@@ -225,10 +219,10 @@ module Backup
         mb += 1 until file_size / (1024**2 * mb).to_f <= 10_000
         Logger.warn Error.new(<<-EOS)
           Chunk Size Adjusted
-          Your original #chunk_size of #{ orig_mb } MiB has been adjusted
-          to #{ mb } MiB in order to satisfy the limit of 10,000 chunks.
+          Your original #chunk_size of #{orig_mb} MiB has been adjusted
+          to #{mb} MiB in order to satisfy the limit of 10,000 chunks.
           To enforce your chosen #chunk_size, you should use the Splitter.
-          e.g. split_into_chunks_of #{ mb * 10_000 } (#chunk_size * 10_000)
+          e.g. split_into_chunks_of #{mb * 10_000} (#chunk_size * 10_000)
         EOS
         1024**2 * mb
       end
@@ -238,14 +232,14 @@ module Backup
 
         def initialize(cloud_io, data)
           @cloud_io = cloud_io
-          @key  = data['Key']
-          @etag = data['ETag']
-          @storage_class = data['StorageClass']
+          @key  = data["Key"]
+          @etag = data["ETag"]
+          @storage_class = data["StorageClass"]
         end
 
         # currently 'AES256' or nil
         def encryption
-          metadata['x-amz-server-side-encryption']
+          metadata["x-amz-server-side-encryption"]
         end
 
         private
@@ -254,7 +248,6 @@ module Backup
           @metadata ||= @cloud_io.head_object(self).headers
         end
       end
-
     end
   end
 end

data/lib/backup/compressor/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Compressor
     class Base
@@ -18,18 +16,17 @@ module Backup
       ##
       # Return the compressor name, with Backup namespace removed
       def compressor_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 using the compressor
       def log!
-        Logger.info "Using #{ compressor_name } for compression.\n" +
-          "  Command: '#{ @cmd }'\n" +
-          "  Ext: '#{ @ext }'"
+        Logger.info "Using #{compressor_name} for compression.\n" \
+          "  Command: '#{@cmd}'\n" \
+          "  Ext: '#{@ext}'"
       end
-
     end
   end
 end

data/lib/backup/compressor/bzip2.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Compressor
     class Bzip2 < Base
-
       ##
       # Specify the level of compression to use.
       #
@@ -24,16 +21,15 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        @cmd = "#{ utility(:bzip2) }#{ options }"
-        @ext = '.bz2'
+        @cmd = "#{utility(:bzip2)}#{options}"
+        @ext = ".bz2"
       end
 
       private
 
       def options
-        " -#{ @level }" if @level
+        " -#{@level}" if @level
       end
-
     end
   end
 end

data/lib/backup/compressor/custom.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Compressor
     class Custom < Base
-
       ##
       # Specify the system command to invoke a compressor,
       # including any command-line arguments.
@@ -36,9 +33,9 @@ module Backup
       # Return the command line using the full path.
       # Ensures the command exists and is executable.
       def set_cmd
-        parts = @command.to_s.split(' ')
+        parts = @command.to_s.split(" ")
         parts[0] = utility(parts[0])
-        parts.join(' ')
+        parts.join(" ")
       end
 
       ##
@@ -47,7 +44,6 @@ module Backup
       def set_ext
         @extension.to_s.strip
       end
-
     end
   end
 end

data/lib/backup/compressor/gzip.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Compressor
     class Gzip < Base
@@ -35,8 +33,8 @@ module Backup
       # Determine if +--rsyncable+ is supported and cache the result.
       def self.has_rsyncable?
         return @has_rsyncable unless @has_rsyncable.nil?
-        cmd = "#{ utility(:gzip) } --rsyncable --version >/dev/null 2>&1; echo $?"
-        @has_rsyncable = %x[#{ cmd }].chomp == '0'
+        cmd = "#{utility(:gzip)} --rsyncable --version >/dev/null 2>&1; echo $?"
+        @has_rsyncable = `#{cmd}`.chomp == "0"
       end
 
       ##
@@ -49,26 +47,27 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        @cmd = "#{ utility(:gzip) }#{ options }"
-        @ext = '.gz'
+        @cmd = "#{utility(:gzip)}#{options}"
+        @ext = ".gz"
       end
 
       private
 
       def options
-        opts = ''
-        opts << " -#{ @level }" if @level
-        if self.class.has_rsyncable?
-          opts << ' --rsyncable'
-        else
-          Logger.warn Error.new(<<-EOS)
-            'rsyncable' option ignored.
-            Your system's 'gzip' does not support the `--rsyncable` option.
-          EOS
-        end if @rsyncable
+        opts = ""
+        opts << " -#{@level}" if @level
+        if @rsyncable
+          if self.class.has_rsyncable?
+            opts << " --rsyncable"
+          else
+            Logger.warn Error.new(<<-EOS)
+              'rsyncable' option ignored.
+              Your system's 'gzip' does not support the `--rsyncable` option.
+            EOS
+          end
+        end
         opts
       end
-
     end
   end
 end

data/lib/backup/config.rb

@@ -1,15 +1,14 @@
-# encoding: utf-8
-require 'backup/config/dsl'
-require 'backup/config/helpers'
+require "backup/config/dsl"
+require "backup/config/helpers"
 
 module Backup
   module Config
     class Error < Backup::Error; end
 
     DEFAULTS = {
-      :config_file  => 'config.rb',
-      :data_path    => '.data',
-      :tmp_path     => '.tmp'
+      config_file: "config.rb",
+      data_path: ".data",
+      tmp_path: ".tmp"
     }
 
     class << self
@@ -19,20 +18,20 @@ module Backup
 
       # Loads the user's +config.rb+ and all model files.
       def load(options = {})
-        update(options)  # from the command line
+        update(options) # from the command line
 
         unless File.exist?(config_file)
           raise Error, "Could not find configuration file: '#{config_file}'."
         end
 
         config = File.read(config_file)
-        version = Backup::VERSION.split('.').first
+        version = Backup::VERSION.split(".").first
         unless config =~ /^# Backup v#{ version }\.x Configuration$/
           raise Error, <<-EOS
             Invalid Configuration File
-            The configuration file at '#{ config_file }'
-            does not appear to be a Backup v#{ version }.x configuration file.
-            If you have upgraded to v#{ version }.x from a previous version,
+            The configuration file at '#{config_file}'
+            does not appear to be a Backup v#{version}.x configuration file.
+            If you have upgraded to v#{version}.x from a previous version,
             you need to upgrade your configuration file.
             Please see the instructions for upgrading in the Backup documentation.
           EOS
@@ -44,7 +43,7 @@ module Backup
         update(dsl._config_options)  # from config.rb
         update(options)              # command line takes precedence
 
-        Dir[File.join(File.dirname(config_file), 'models', '*.rb')].each do |model|
+        Dir[File.join(File.dirname(config_file), "models", "*.rb")].each do |model|
           dsl.instance_eval(File.read(model), model)
         end
       end
@@ -79,7 +78,7 @@ module Backup
           raise Error, <<-EOS
             Root Path Not Found
             When specifying a --root-path, the path must exist.
-            Path was: #{ path }
+            Path was: #{path}
           EOS
         end
         @root_path = path
@@ -88,7 +87,7 @@ module Backup
       def set_path_variable(name, path, ending, root_path)
         # 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 = path.to_s.sub(/\/\s*$/, '').lstrip
+        path = path.to_s.sub(/\/\s*$/, "").lstrip
         new_path = false
         # If no path is given, the variable will not be set/updated
         # unless a root_path was given. In which case the value will
@@ -108,12 +107,12 @@ module Backup
       end
 
       def reset!
-        @user      = ENV['USER'] || Etc.getpwuid.name
-        @root_path = File.join(File.expand_path(ENV['HOME'] || ''), 'Backup')
-        update(:root_path => @root_path)
+        @user      = ENV["USER"] || Etc.getpwuid.name
+        @root_path = File.join(File.expand_path(ENV["HOME"] || ""), "Backup")
+        update(root_path: @root_path)
       end
     end
 
-    reset!  # set defaults on load
+    reset! # set defaults on load
   end
 end