backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/model.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Model
     class Error < Backup::Error; end
@@ -18,11 +16,11 @@ module Backup
       # Return an Array of Models matching the given +trigger+.
       def find_by_trigger(trigger)
         trigger = trigger.to_s
-        if trigger.include?('*')
+        if trigger.include?("*")
           regex = /^#{ trigger.gsub('*', '(.*)') }$/
-          all.select {|model| regex =~ model.trigger }
+          all.select { |model| regex =~ model.trigger }
         else
-          all.select {|model| trigger == model.trigger }
+          all.select { |model| trigger == model.trigger }
         end
       end
 
@@ -128,7 +126,7 @@ module Backup
 
       # trigger all defined databases to generate their #dump_filename
       # so warnings may be logged if `backup perform --check` is used
-      databases.each {|db| db.send(:dump_filename) }
+      databases.each { |db| db.send(:dump_filename) }
 
       Model.all << self
     end
@@ -142,15 +140,15 @@ module Backup
     ##
     # Adds an Database. Multiple Databases may be added to the model.
     def database(name, database_id = nil, &block)
-      @databases << get_class_from_scope(Database, name).
-          new(self, database_id, &block)
+      @databases << get_class_from_scope(Database, name)
+        .new(self, database_id, &block)
     end
 
     ##
     # Adds an Storage. Multiple Storages may be added to the model.
     def store_with(name, storage_id = nil, &block)
-      @storages << get_class_from_scope(Storage, name).
-          new(self, storage_id, &block)
+      @storages << get_class_from_scope(Storage, name)
+        .new(self, storage_id, &block)
     end
 
     ##
@@ -270,14 +268,11 @@ module Backup
       end
 
       syncers.each(&:perform!)
-
     rescue Interrupt
       @interrupted = true
       raise
-
     rescue Exception => err
       @exception = err
-
     ensure
       unless @interrupted
         set_exit_status
@@ -302,8 +297,8 @@ module Backup
     def procedures
       return [] unless databases.any? || archives.any?
 
-      [lambda { prepare! }, databases, archives,
-       lambda { package! }, lambda { store! }, lambda { clean! }]
+      [-> { prepare! }, databases, archives,
+       -> { package! }, -> { store! }, -> { clean! }]
     end
 
     ##
@@ -341,8 +336,8 @@ module Backup
 
       if first_exception
         other_exceptions.each do |exception|
-         Logger.error exception.to_s
-         Logger.error exception.backtrace.join('\n')
+          Logger.error exception.to_s
+          Logger.error exception.backtrace.join('\n')
         end
         raise first_exception
       else
@@ -375,8 +370,8 @@ module Backup
     #
     def get_class_from_scope(scope, name)
       klass = scope
-      name = name.to_s.sub(/^Backup::Config::DSL::/, '')
-      name.split('::').each do |chunk|
+      name = name.to_s.sub(/^Backup::Config::DSL::/, "")
+      name.split("::").each do |chunk|
         klass = klass.const_get(chunk)
       end
       klass
@@ -385,11 +380,12 @@ module Backup
     ##
     # Sets or updates the model's #exit_status.
     def set_exit_status
-      @exit_status = if exception
-        exception.is_a?(StandardError) ? 2 : 3
-      else
-        Logger.has_warnings? ? 1 : 0
-      end
+      @exit_status =
+        if exception
+          exception.is_a?(StandardError) ? 2 : 3
+        else
+          Logger.has_warnings? ? 1 : 0
+        end
     end
 
     ##
@@ -401,14 +397,13 @@ module Backup
     def before_hook
       return unless before
 
-      Logger.info 'Before Hook Starting...'
+      Logger.info "Before Hook Starting..."
       before.call
-      Logger.info 'Before Hook Finished.'
-
+      Logger.info "Before Hook Finished."
     rescue Exception => err
       @before_hook_failed = true
       ex = err.is_a?(StandardError) ? Error : FatalError
-      raise ex.wrap(err, 'Before Hook Failed!')
+      raise ex.wrap(err, "Before Hook Failed!")
     end
 
     ##
@@ -418,16 +413,15 @@ module Backup
     def after_hook
       return unless after && !@before_hook_failed
 
-      Logger.info 'After Hook Starting...'
+      Logger.info "After Hook Starting..."
       after.call(exit_status)
-      Logger.info 'After Hook Finished.'
+      Logger.info "After Hook Finished."
 
       set_exit_status # in case hook logged warnings
-
     rescue Exception => err
       fatal = !err.is_a?(StandardError)
       ex = fatal ? FatalError : Error
-      Logger.error ex.wrap(err, 'After Hook Failed!')
+      Logger.error ex.wrap(err, "After Hook Failed!")
       # upgrade exit_status if needed
       (@exit_status = fatal ? 3 : 2) unless exit_status == 3
     end
@@ -440,24 +434,24 @@ module Backup
     def log!(action)
       case action
       when :started
-        Logger.info "Performing Backup for '#{ label } (#{ trigger })'!\n" +
-            "[ backup #{ VERSION } : #{ RUBY_DESCRIPTION } ]"
+        Logger.info "Performing Backup for '#{label} (#{trigger})'!\n" \
+            "[ backup #{VERSION} : #{RUBY_DESCRIPTION} ]"
 
       when :finished
         if exit_status > 1
           ex = exit_status == 2 ? Error : FatalError
-          err = ex.wrap(exception, "Backup for #{ label } (#{ trigger }) Failed!")
+          err = ex.wrap(exception, "Backup for #{label} (#{trigger}) Failed!")
           Logger.error err
           Logger.error "\nBacktrace:\n\s\s" + err.backtrace.join("\n\s\s") + "\n\n"
 
           Cleaner.warnings(self)
         else
-          msg = "Backup for '#{ label } (#{ trigger })' "
+          msg = "Backup for '#{label} (#{trigger})' "
           if exit_status == 1
-            msg << "Completed Successfully (with Warnings) in #{ duration }"
+            msg << "Completed Successfully (with Warnings) in #{duration}"
             Logger.warn msg
           else
-            msg << "Completed Successfully in #{ duration }"
+            msg << "Completed Successfully in #{duration}"
             Logger.info msg
           end
         end
@@ -472,8 +466,7 @@ module Backup
       remainder = duration - (hours * 3600)
       minutes   = remainder / 60
       seconds   = remainder - (minutes * 60)
-      '%02d:%02d:%02d' % [hours, minutes, seconds]
+      sprintf "%02d:%02d:%02d", hours, minutes, seconds
     end
-
   end
 end

data/lib/backup/notifier/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Notifier
     class Error < Backup::Error; end
@@ -56,8 +54,8 @@ module Backup
         @on_failure = true if on_failure.nil?
         @max_retries    ||= 10
         @retry_waitsec  ||= 30
-        @message        ||= lambda do |model, data|
-          "[#{ data[:status][:message] }] #{ model.label } (#{ model.trigger })"
+        @message        ||= lambda do |m, data|
+          "[#{data[:status][:message]}] #{m.label} (#{m.trigger})"
         end
       end
 
@@ -65,22 +63,22 @@ module Backup
       # not raise any exceptions. However, each Notifier's #notify! method
       # should raise an exception if the request fails so it may be retried.
       def perform!
-        status = case model.exit_status
-                 when 0
-                   :success if notify_on_success?
-                 when 1
-                   :warning if notify_on_success? || notify_on_warning?
-                 else
-                   :failure if notify_on_failure?
-                 end
+        status =
+          case model.exit_status
+          when 0
+            :success if notify_on_success?
+          when 1
+            :warning if notify_on_success? || notify_on_warning?
+          else
+            :failure if notify_on_failure?
+          end
 
         if status
-          Logger.info "Sending notification using #{ notifier_name }..."
+          Logger.info "Sending notification using #{notifier_name}..."
           with_retries { notify!(status) }
         end
-
       rescue Exception => err
-        Logger.error Error.wrap(err, "#{ notifier_name } Failed!")
+        Logger.error Error.wrap(err, "#{notifier_name} Failed!")
       end
 
       private
@@ -93,7 +91,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
@@ -102,24 +100,24 @@ module Backup
       ##
       # Return the notifier name, with Backup namespace removed
       def notifier_name
-        self.class.to_s.sub('Backup::', '')
+        self.class.to_s.sub("Backup::", "")
       end
 
       ##
       # Return status data for message creation
       def status_data_for(status)
         {
-          :success => {
-            :message => 'Backup::Success',
-            :key => :success
+          success: {
+            message: "Backup::Success",
+            key: :success
           },
-          :warning => {
-            :message => 'Backup::Warning',
-            :key => :warning
+          warning: {
+            message: "Backup::Warning",
+            key: :warning
           },
-          :failure => {
-            :message => 'Backup::Failure',
-            :key => :failure
+          failure: {
+            message: "Backup::Failure",
+            key: :failure
           }
         }[status]
       end

data/lib/backup/notifier/campfire.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'json'
+require "json"
 
 module Backup
   module Notifier
     class Campfire < Base
-
       ##
       # Campfire api authentication token
       attr_accessor :api_token
@@ -42,22 +40,22 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        send_message(message.call(model, :status => status_data_for(status)))
+        send_message(message.call(model, status: status_data_for(status)))
       end
 
       def send_message(message)
-        uri = "https://#{ subdomain }.campfirenow.com/room/#{ room_id }/speak.json"
+        uri = "https://#{subdomain}.campfirenow.com/room/#{room_id}/speak.json"
         options = {
-          :headers  => { 'Content-Type' => 'application/json' },
-          :body     => JSON.dump(
-            { :message => { :body => message, :type => 'Textmessage' } }
+          headers: { "Content-Type" => "application/json" },
+          body: JSON.dump(
+            message: { body: message, type: "Textmessage" }
           )
         }
-        options.merge!(:user => api_token, :password => 'x') # Basic Auth
-        options.merge!(:expects => 201) # raise error if unsuccessful
+        options[:user] = api_token
+        options[:password] = "x" # Basic Auth
+        options[:expects] = 201 # raise error if unsuccessful
         Excon.post(uri, options)
       end
-
     end
   end
 end

data/lib/backup/notifier/command.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Notifier
     class Command < Base
-
       ##
       # Command to execute.
       #

data/lib/backup/notifier/datadog.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'dogapi'
+require "dogapi"
 
 module Backup
   module Notifier
     class DataDog < Base
-
       ##
       # The DataDog API key
       attr_accessor :api_key
@@ -14,9 +12,9 @@ module Backup
       attr_accessor :title
 
       attr_deprecate :text,
-        :version => '4.2',
-        :message => 'Please use the `message` attribute. For more information '\
-          'see https://github.com/backup/backup/pull/698'
+        version: "4.2",
+        message: "Please use the `message` attribute. For more information "\
+          "see https://github.com/backup/backup/pull/698"
 
       ##
       # The timestamp for the event
@@ -49,7 +47,7 @@ module Backup
       def initialize(model, &block)
         super
         instance_eval(&block) if block_given?
-        @title ||= "Backup #{ model.label }"
+        @title ||= "Backup #{model.label}"
       end
 
       private
@@ -72,7 +70,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        msg = message.call(model, :status => status_data_for(status))
+        msg = message.call(model, status: status_data_for(status))
 
         hash = { alert_type: default_alert_type(status) }
         hash.store(:msg_title,        @title)
@@ -96,12 +94,11 @@ module Backup
       # set alert type
       def default_alert_type(status)
         case status
-        when :success then 'success'
-        when :warning then 'warning'
-        when :failure then 'error'
+        when :success then "success"
+        when :warning then "warning"
+        when :failure then "error"
         end
       end
-
     end
   end
 end

data/lib/backup/notifier/flowdock.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'flowdock'
+require "flowdock"
 
 module Backup
   module Notifier
     class FlowDock < Base
-
       ##
       # The Flowdock API token
       attr_accessor :token
@@ -68,36 +66,34 @@ module Backup
       # Flowdock::Client will raise an error if unsuccessful.
       def send_message(msg)
         client = Flowdock::Flow.new(
-          :api_token => token, :source => source,
-          :from => {:name => from_name, :address => from_email }
+          api_token: token, source: source,
+          from: { name: from_name, address: from_email }
         )
 
-        client.push_to_team_inbox(:subject => subject,
-                                  :content => msg,
-                                  :tags => tags,
-                                  :link => link )
+        client.push_to_team_inbox(subject: subject,
+                                  content: msg,
+                                  tags: tags,
+                                  link: link)
       end
 
       # set related tags
       def default_tags(status)
         case status
-        when :success then ['#BackupSuccess']
-        when :warning then ['#BackupWarning']
-        when :failure then ['#BackupFailure']
+        when :success then ["#BackupSuccess"]
+        when :warning then ["#BackupWarning"]
+        when :failure then ["#BackupFailure"]
         end
       end
 
-
-      #set default source
+      # set default source
       def default_source
-        "Backup #{ model.label }"
+        "Backup #{model.label}"
       end
 
       # set default subject
       def default_subject
-        'Backup Notification'
+        "Backup Notification"
       end
-
     end
   end
 end

data/lib/backup/notifier/hipchat.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'hipchat'
+require "hipchat"
 
 module Backup
   module Notifier
     class Hipchat < Base
-
       ##
       # The Hipchat API token
       attr_accessor :token
@@ -51,10 +49,10 @@ module Backup
 
         @notify_users   ||= false
         @rooms_notified ||= []
-        @success_color  ||= 'yellow'
-        @warning_color  ||= 'yellow'
-        @failure_color  ||= 'yellow'
-        @api_version    ||= 'v1'
+        @success_color  ||= "yellow"
+        @warning_color  ||= "yellow"
+        @failure_color  ||= "yellow"
+        @api_version    ||= "v1"
       end
 
       private
@@ -78,7 +76,7 @@ module Backup
       #
       def notify!(status)
         status_data = status_data_for(status)
-        msg = message.call(model, :status => status_data)
+        msg = message.call(model, status: status_data)
         send_message(msg, status_data[:color])
       end
 
@@ -92,12 +90,12 @@ module Backup
       def send_message(msg, color)
         client = HipChat::Client.new(token, client_options)
         rooms_to_notify.each do |room|
-          client[room].send(from, msg, :color => color, :notify => notify_users)
+          client[room].send(from, msg, color: color, notify: notify_users)
         end
       end
 
       def rooms_to_notify
-        Array(rooms_notified).map {|r| r.split(',').map(&:strip) }.flatten
+        Array(rooms_notified).map { |r| r.split(",").map(&:strip) }.flatten
       end
 
       def status_data_for(status)
@@ -108,9 +106,9 @@ module Backup
 
       def status_color_for(status)
         {
-          :success => success_color,
-          :warning => warning_color,
-          :failure => failure_color
+          success: success_color,
+          warning: warning_color,
+          failure: failure_color
         }[status]
       end
     end

data/lib/backup/notifier/http_post.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'uri'
+require "uri"
 
 module Backup
   module Notifier
     class HttpPost < Base
-
       ##
       # URI to post notification to.
       #
@@ -95,23 +93,22 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        msg = message.call(model, :status => status_data_for(status))
+        msg = message.call(model, status: status_data_for(status))
 
         opts = {
-          :headers => { 'User-Agent' => "Backup/#{ VERSION }" }.
-              merge(headers).reject {|k,v| v.nil? }.
-              merge('Content-Type' => 'application/x-www-form-urlencoded'),
-          :body => URI.encode_www_form({ 'message' => msg }.
-              merge(params).reject {|k,v| v.nil? }.
-              merge('status' => status.to_s)),
-          :expects => success_codes # raise error if unsuccessful
+          headers: { "User-Agent" => "Backup/#{VERSION}" }
+            .merge(headers).reject { |_, value| value.nil? }
+            .merge("Content-Type" => "application/x-www-form-urlencoded"),
+          body: URI.encode_www_form({ "message" => msg }
+              .merge(params).reject { |_, value| value.nil? }
+              .merge("status" => status.to_s)),
+          expects: success_codes # raise error if unsuccessful
         }
-        opts.merge!(:ssl_verify_peer => ssl_verify_peer) unless ssl_verify_peer.nil?
-        opts.merge!(:ssl_ca_file => ssl_ca_file) if ssl_ca_file
+        opts[:ssl_verify_peer] = ssl_verify_peer unless ssl_verify_peer.nil?
+        opts[:ssl_ca_file] = ssl_ca_file if ssl_ca_file
 
         Excon.post(uri, opts)
       end
-
     end
   end
 end