backup 4.3.0 → 5.0.0.beta.3

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

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