backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/packager.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Packager
     class Error < Backup::Error; end
@@ -22,7 +20,7 @@ module Backup
           Logger.info "Packaging Complete!"
         else
           raise Error, "Failed to Create Backup Package\n" +
-              @pipeline.error_messages
+            @pipeline.error_messages
         end
       end
 
@@ -43,8 +41,8 @@ module Backup
         # or the Splitter (if no Encryptor), or through `cat` into the final
         # output file if neither are configured.
         @pipeline.add(
-          "#{ utility(:tar) } -cf - " +
-          "-C '#{ Config.tmp_path }' '#{ @package.trigger }'",
+          "#{utility(:tar)} -cf - " \
+          "-C '#{Config.tmp_path}' '#{@package.trigger}'",
           tar_success_codes
         )
 
@@ -75,26 +73,27 @@ module Backup
         #
         # If no Splitter was configured, the final file output will be
         # piped through `cat` into the final output file.
-        if @splitter
-          stack << lambda do
-            @splitter.split_with do |command|
-              @pipeline << command
+        stack <<
+          if @splitter
+            lambda do
+              @splitter.split_with do |command|
+                @pipeline << command
+                stack.shift.call
+              end
+            end
+          else
+            lambda do
+              outfile = File.join(Config.tmp_path, @package.basename)
+              @pipeline << "#{utility(:cat)} > #{outfile}"
               stack.shift.call
             end
           end
-        else
-          stack << lambda do
-            outfile = File.join(Config.tmp_path, @package.basename)
-            @pipeline << "#{ utility(:cat) } > #{ outfile }"
-            stack.shift.call
-          end
-        end
 
         ##
         # Last Proc to be called runs the Pipeline the procedure built.
         # Once complete, the call stack will unwind back through the
         # preceeding Procs in the stack (if any)
-        stack << lambda { @pipeline.run }
+        stack << -> { @pipeline.run }
 
         stack.shift
       end

data/lib/backup/pipeline.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Pipeline
     class Error < Backup::Error; end
@@ -12,7 +10,7 @@ module Backup
       @commands = []
       @success_codes = []
       @errors = []
-      @stderr = ''
+      @stderr = ""
     end
 
     ##
@@ -51,22 +49,21 @@ module Backup
     # Use `#success?` to determine if all commands in the pipeline succeeded.
     # If `#success?` returns `false`, use `#error_messages` to get an error report.
     def run
-      Open4.popen4(pipeline) do |pid, stdin, stdout, stderr|
-        pipestatus = stdout.read.gsub("\n", '').split(':').sort
+      Open4.popen4(pipeline) do |_pid, _stdin, stdout, stderr|
+        pipestatus = stdout.read.delete("\n").split(":").sort
         pipestatus.each do |status|
-          index, exitstatus = status.split('|').map(&:to_i)
-          unless @success_codes[index].include?(exitstatus)
-            command = command_name(@commands[index])
-            @errors << SystemCallError.new(
-              "'#{ command }' returned exit code: #{ exitstatus }", exitstatus
-            )
-          end
+          index, exitstatus = status.split("|").map(&:to_i)
+          next if @success_codes[index].include?(exitstatus)
+          command = command_name(@commands[index])
+          @errors << SystemCallError.new(
+            "'#{command}' returned exit code: #{exitstatus}", exitstatus
+          )
         end
         @stderr = stderr.read.strip
       end
       Logger.warn(stderr_messages) if success? && stderr_messages
     rescue Exception => err
-      raise Error.wrap(err, 'Pipeline failed to execute')
+      raise Error.wrap(err, "Pipeline failed to execute")
     end
 
     def success?
@@ -78,9 +75,9 @@ module Backup
     # from the commands in the pipeline (if any), along with the SystemCallError
     # (Errno) message for each command which had a non-zero exit status.
     def error_messages
-      @error_messages ||= (stderr_messages || '') +
-          "The following system errors were returned:\n" +
-          @errors.map {|err| "#{ err.class }: #{ err.message }" }.join("\n")
+      @error_messages ||= (stderr_messages || "") +
+        "The following system errors were returned:\n" +
+        @errors.map { |err| "#{err.class}: #{err.message}" }.join("\n")
     end
 
     private
@@ -106,19 +103,18 @@ module Backup
     def pipeline
       parts = []
       @commands.each_with_index do |command, index|
-        parts << %Q[{ #{ command } 2>&4 ; echo "#{ index }|$?:" >&3 ; }]
+        parts << %({ #{command} 2>&4 ; echo "#{index}|$?:" >&3 ; })
       end
-      %Q[{ #{ parts.join(' | ') } } 3>&1 1>&2 4>&2]
+      %({ #{parts.join(" | ")} } 3>&1 1>&2 4>&2)
     end
 
     def stderr_messages
-      @stderr_messages ||= @stderr.empty? ? false : <<-EOS.gsub(/^ +/, '  ')
+      @stderr_messages ||= @stderr.empty? ? false : <<-EOS.gsub(/^ +/, "  ")
         Pipeline STDERR Messages:
         (Note: may be interleaved if multiple commands returned error messages)
 
-        #{ @stderr }
+        #{@stderr}
       EOS
     end
-
   end
 end

data/lib/backup/splitter.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Splitter
     include Utilities::Helpers
@@ -21,8 +19,8 @@ module Backup
     # Once the packaging procedure is complete, it will return and
     # @package.chunk_suffixes will be set based on the resulting files.
     def split_with
-      Logger.info "Splitter configured with a chunk size of #{ chunk_size }MB " +
-                  "and suffix length of #{ suffix_length }."
+      Logger.info "Splitter configured with a chunk size of #{chunk_size}MB " \
+                  "and suffix length of #{suffix_length}."
       yield split_command
       after_packaging
     end
@@ -34,8 +32,8 @@ module Backup
     # multiple files, based on @chunk_size and @suffix_length, using the full
     # path to the final @package.basename, plus a '-' separator as the `prefix`.
     def split_command
-      "#{ utility(:split) } -a #{ suffix_length } -b #{ chunk_size }m - " +
-          "'#{ File.join(Config.tmp_path, package.basename + '-') }'"
+      "#{utility(:split)} -a #{suffix_length} -b #{chunk_size}m - " \
+          "'#{File.join(Config.tmp_path, package.basename + "-")}'"
     end
 
     ##
@@ -47,10 +45,10 @@ module Backup
     # remove the suffix from the filename.
     def after_packaging
       suffixes = chunk_suffixes
-      first_suffix = 'a' * suffix_length
+      first_suffix = "a" * suffix_length
       if suffixes == [first_suffix]
         FileUtils.mv(
-          File.join(Config.tmp_path, "#{ package.basename }-#{ first_suffix }"),
+          File.join(Config.tmp_path, "#{package.basename}-#{first_suffix}"),
           File.join(Config.tmp_path, package.basename)
         )
       else
@@ -62,15 +60,14 @@ module Backup
     # Returns an array of suffixes for each chunk, in alphabetical order.
     # For example: [aa, ab, ac, ad, ae] or [aaa, aab, aac aad]
     def chunk_suffixes
-      chunks.map {|chunk| File.extname(chunk).split('-').last }.sort
+      chunks.map { |chunk| File.extname(chunk).split("-").last }.sort
     end
 
     ##
     # Returns an array of full paths to the backup chunks.
     # Chunks are sorted in alphabetical order.
     def chunks
-      Dir[File.join(Config.tmp_path, package.basename + '-*')].sort
+      Dir[File.join(Config.tmp_path, package.basename + "-*")].sort
     end
-
   end
 end

data/lib/backup/storage/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Storage
     class Base
@@ -34,19 +32,19 @@ module Backup
       def initialize(model, storage_id = nil, &block)
         @model = model
         @package = model.package
-        @storage_id = storage_id.to_s.gsub(/\W/, '_') if storage_id
+        @storage_id = storage_id.to_s.gsub(/\W/, "_") if storage_id
 
         load_defaults!
         instance_eval(&block) if block_given?
       end
 
       def perform!
-        Logger.info "#{ storage_name } Started..."
+        Logger.info "#{storage_name} Started..."
         transfer!
         if respond_to?(:cycle!, true) && (keep.to_i > 0 || keep.is_a?(Time))
           cycle!
         end
-        Logger.info "#{ storage_name } Finished!"
+        Logger.info "#{storage_name} Finished!"
       end
 
       private
@@ -60,10 +58,9 @@ module Backup
       alias :remote_path_for :remote_path
 
       def storage_name
-        @storage_name ||= self.class.to_s.sub('Backup::', '') +
-            (storage_id ? " (#{ storage_id })" : '')
+        @storage_name ||= self.class.to_s.sub("Backup::", "") +
+          (storage_id ? " (#{storage_id})" : "")
       end
-
     end
   end
 end

data/lib/backup/storage/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 Storage
@@ -79,8 +78,8 @@ module Backup
         @max_retries        ||= 10
         @retry_waitsec      ||= 30
 
-        @path ||= 'backups'
-        path.sub!(/^\//, '')
+        @path ||= "backups"
+        path.sub!(/^\//, "")
 
         check_configuration
       end
@@ -89,18 +88,18 @@ 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,
-          :segments_container => segments_container,
-          :segment_size       => segment_size,
-          :days_to_keep       => days_to_keep,
-          :max_retries        => max_retries,
-          :retry_waitsec      => retry_waitsec,
-          :fog_options        => fog_options
+          username: username,
+          api_key: api_key,
+          auth_url: auth_url,
+          region: region,
+          servicenet: servicenet,
+          container: container,
+          segments_container: segments_container,
+          segment_size: segment_size,
+          days_to_keep: days_to_keep,
+          max_retries: max_retries,
+          retry_waitsec: retry_waitsec,
+          fog_options: fog_options
         )
       end
 
@@ -108,7 +107,7 @@ module Backup
         package.filenames.each do |filename|
           src = File.join(Config.tmp_path, filename)
           dest = File.join(remote_path, filename)
-          Logger.info "Storing '#{ container }/#{ dest }'..."
+          Logger.info "Storing '#{container}/#{dest}'..."
           cloud_io.upload(src, dest)
         end
 
@@ -118,12 +117,12 @@ 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?
 
         slo_objects, objects = objects.partition(&:slo?)
         cloud_io.delete_slo(slo_objects)
@@ -131,10 +130,10 @@ module Backup
       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
 
         raise Error, <<-EOS if segment_size > 0 && segments_container.to_s.empty?
@@ -152,7 +151,6 @@ module Backup
           #segment_size is too large (max 5120)
         EOS
       end
-
     end
   end
 end

data/lib/backup/storage/cycler.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Storage
     module Cycler
@@ -11,7 +9,7 @@ module Backup
       # and will remove any old package file(s) when the storage limit
       # set by #keep is exceeded.
       def cycle!
-        Logger.info 'Cycling Started...'
+        Logger.info "Cycling Started..."
 
         packages = yaml_load.unshift(package)
         cycled_packages = []
@@ -32,24 +30,22 @@ module Backup
       end
 
       def delete_package(package)
-        begin
-          remove!(package) unless package.no_cycle
-        rescue => err
-          Logger.warn Error.wrap(err, <<-EOS)
+        remove!(package) unless package.no_cycle
+      rescue => err
+        Logger.warn Error.wrap(err, <<-EOS)
             There was a problem removing the following package:
             Trigger: #{package.trigger} :: Dated: #{package.time}
-            Package included the following #{ package.filenames.count } file(s):
-            #{ package.filenames.join("\n") }
+            Package included the following #{package.filenames.count} file(s):
+            #{package.filenames.join("\n")}
           EOS
-        end
       end
 
       # Returns path to the YAML data file.
       def yaml_file
         @yaml_file ||= begin
-          filename = self.class.to_s.split('::').last
-          filename << "-#{ storage_id }" if storage_id
-          File.join(Config.data_path, package.trigger, "#{ filename }.yml")
+          filename = self.class.to_s.split("::").last
+          filename << "-#{storage_id}" if storage_id
+          File.join(Config.data_path, package.trigger, "#{filename}.yml")
         end
       end
 
@@ -65,11 +61,10 @@ module Backup
       # Stores the given package objects to the YAML data file.
       def yaml_save(packages)
         FileUtils.mkdir_p(File.dirname(yaml_file))
-        File.open(yaml_file, 'w') do |file|
+        File.open(yaml_file, "w") do |file|
           file.write(packages.to_yaml)
         end
       end
-
     end
   end
 end

data/lib/backup/storage/dropbox.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'dropbox_sdk'
+require "dropbox_sdk"
 
 module Backup
   module Storage
@@ -50,13 +49,13 @@ module Backup
       def initialize(model, storage_id = nil)
         super
 
-        @path           ||= 'backups'
-        @cache_path     ||= '.cache'
+        @path           ||= "backups"
+        @cache_path     ||= ".cache"
         @access_type    ||= :app_folder
         @chunk_size     ||= 4 # MiB
         @max_retries    ||= 10
         @retry_waitsec  ||= 30
-        path.sub!(/^\//, '')
+        path.sub!(/^\//, "")
       end
 
       private
@@ -81,9 +80,8 @@ module Backup
 
         # will raise an error if session not authorized
         @connection = DropboxClient.new(session, access_type)
-
       rescue => err
-        raise Error.wrap(err, 'Authorization Failed')
+        raise Error.wrap(err, "Authorization Failed")
       end
 
       ##
@@ -94,7 +92,6 @@ module Backup
           begin
             session = DropboxSession.deserialize(File.read(cached_file))
             Logger.info "Session data loaded from cache!"
-
           rescue => err
             Logger.warn Error.wrap(err, <<-EOS)
               Could not read session data from cache.
@@ -113,10 +110,10 @@ module Backup
         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}'..."
 
           uploader = nil
-          File.open(src, 'r') do |file|
+          File.open(src, "r") do |file|
             uploader = connection.get_chunked_uploader(file, file.stat.size)
             while uploader.offset < uploader.total_size
               with_retries do
@@ -129,9 +126,8 @@ module Backup
             uploader.finish(dest)
           end
         end
-
       rescue => err
-        raise Error.wrap(err, 'Upload Failed!')
+        raise Error.wrap(err, "Upload Failed!")
       end
 
       def with_retries
@@ -142,7 +138,7 @@ module Backup
           retries += 1
           raise if retries > max_retries
 
-          Logger.info Error.wrap(err, "Retry ##{ retries } of #{ max_retries }.")
+          Logger.info Error.wrap(err, "Retry ##{retries} of #{max_retries}.")
           sleep(retry_waitsec)
           retry
         end
@@ -151,13 +147,13 @@ 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}..."
 
         connection.file_delete(remote_path_for(package))
       end
 
       def cached_file
-        path = cache_path.start_with?('/') ?
+        path = cache_path.start_with?("/") ?
                cache_path : File.join(Config.root_path, cache_path)
         File.join(path, api_key + api_secret)
       end
@@ -175,7 +171,7 @@ module Backup
       # Create a new session, write a serialized version of it to the
       # .cache directory, and return the session object
       def create_write_and_return_new_session!
-        require 'timeout'
+        require "timeout"
 
         session = DropboxSession.new(api_key, api_secret)
 
@@ -183,12 +179,12 @@ module Backup
         session.get_request_token
 
         template = Backup::Template.new(
-          {:session => session, :cached_file => cached_file}
+          session: session, cached_file: cached_file
         )
         template.render("storage/dropbox/authorization_url.erb")
 
         # wait for user to hit 'return' to continue
-        Timeout::timeout(180) { STDIN.gets }
+        Timeout.timeout(180) { STDIN.gets }
 
         # this will raise an error if the user did not
         # visit the authorization_url and grant access
@@ -202,11 +198,9 @@ module Backup
         template.render("storage/dropbox/cache_file_written.erb")
 
         session
-
       rescue => err
-        raise Error.wrap(err, 'Could not create or authenticate a new session')
+        raise Error.wrap(err, "Could not create or authenticate a new session")
       end
-
     end
   end
 end

data/lib/backup/storage/ftp.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'net/ftp'
+require "net/ftp"
 
 module Backup
   module Storage
@@ -31,10 +30,10 @@ module Backup
         super
 
         @port         ||= 21
-        @path         ||= 'backups'
+        @path         ||= "backups"
         @passive_mode ||= false
         @timeout      ||= nil
-        path.sub!(/^~\//, '')
+        path.sub!(/^~\//, "")
       end
 
       private
@@ -51,6 +50,12 @@ module Backup
           Net::FTP.send(:remove_const, :FTP_PORT)
         end; Net::FTP.send(:const_set, :FTP_PORT, port)
 
+        # Ensure default passive mode to false.
+        # Note: The default passive setting changed between Ruby 2.2 and 2.3
+        if Net::FTP.respond_to?(:default_passive=)
+          Net::FTP.default_passive = false
+        end
+
         Net::FTP.open(ip, username, password) do |ftp|
           if timeout
             ftp.open_timeout = timeout
@@ -68,7 +73,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}'..."
             ftp.put(src, dest)
           end
         end
@@ -77,7 +82,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 |ftp|
@@ -98,15 +103,14 @@ module Backup
       # Net::FTP raises an exception when the directory it's trying to create
       # already exists, so we have rescue it
       def create_remote_path(ftp)
-        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
-            ftp.mkdir(path_parts.join('/'))
+            ftp.mkdir(path_parts.join("/"))
           rescue Net::FTPPermError; end
         end
       end
-
     end
   end
 end

data/lib/backup/storage/local.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Storage
     class Local < Base
@@ -9,7 +7,7 @@ module Backup
       def initialize(model, storage_id = nil)
         super
 
-        @path ||= '~/backups'
+        @path ||= "~/backups"
       end
 
       private
@@ -21,7 +19,7 @@ module Backup
         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}'..."
 
           FileUtils.send(transfer_method, src, dest)
         end
@@ -30,7 +28,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}..."
 
         FileUtils.rm_r(remote_path_for(package))
       end
@@ -50,15 +48,14 @@ module Backup
         else
           Logger.warn Error.new(<<-EOS)
             Local File Copy Warning!
-            The final backup file(s) for '#{ model.label }' (#{ model.trigger })
-            will be *copied* to '#{ remote_path }'
+            The final backup file(s) for '#{model.label}' (#{model.trigger})
+            will be *copied* to '#{remote_path}'
             To avoid this, when using more than one Storage, the 'Local' Storage
             should be added *last* so the files may be *moved* to their destination.
           EOS
           false
         end
       end
-
     end
   end
 end