backup 4.3.0 → 5.0.0.beta.3

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.
       #
@@ -23,6 +20,7 @@ module Backup
       #
       # %l - Model label
       # %t - Model trigger
+      # %d - Backup duration (HH:MM:SS)
       # %s - Status (success/failure/warning)
       # %v - Status verb (succeeded/failed/succeeded with warnings)
       #
@@ -73,6 +71,8 @@ module Backup
                     model.label
                   when "t"
                     model.trigger.to_s
+                  when "d"
+                    model.duration
                   when "v"
                     status_verb(status)
                   when "s"

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
@@ -18,6 +16,10 @@ module Backup
       # Who the notification should appear from
       attr_accessor :from
 
+      ##
+      # Custom server URL
+      attr_accessor :server_url
+
       ##
       # The rooms that should be notified
       attr_accessor :rooms_notified
@@ -47,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
@@ -74,24 +76,26 @@ 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
 
       def client_options
-        { api_version: @api_version }
+        { api_version: @api_version }.tap do |h|
+          h[:server_url] = server_url if server_url
+        end
       end
 
       # Hipchat::Client will raise an error if unsuccessful.
       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)
@@ -102,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

data/lib/backup/notifier/mail.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'mail'
+require "mail"
 
 module Backup
   module Notifier
     class Mail < Base
-
       ##
       # Mail delivery method to be used by the Mail gem.
       #
@@ -161,17 +159,17 @@ module Backup
       #
       def notify!(status)
         email = new_email
-        email.subject = message.call(model, :status => status_data_for(status))
+        email.subject = message.call(model, status: status_data_for(status))
 
         send_log = send_log_on.include?(status)
-        template = Backup::Template.new({ :model => model, :send_log => send_log })
-        email.body = template.result('notifier/mail/%s.erb' % status.to_s)
+        template = Backup::Template.new(model: model, send_log: send_log)
+        email.body = template.result(sprintf("notifier/mail/%s.erb", status.to_s))
 
         if send_log
           email.convert_to_multipart
-          email.attachments["#{ model.time }.#{ model.trigger }.log"] = {
-            :mime_type => 'text/plain;',
-            :content   => Logger.messages.map(&:formatted_lines).flatten.join("\n")
+          email.attachments["#{model.time}.#{model.trigger}.log"] = {
+            mime_type: "text/plain;",
+            content: Logger.messages.map(&:formatted_lines).flatten.join("\n")
           }
         end
 
@@ -182,38 +180,43 @@ module Backup
       # Configures the Mail gem by setting the defaults.
       # Creates and returns a new email, based on the @delivery_method used.
       def new_email
-        method = %w{ smtp sendmail exim file test }.
-            index(@delivery_method.to_s) ? @delivery_method.to_s : 'smtp'
+        method = %w[smtp sendmail exim file test]
+          .index(@delivery_method.to_s) ? @delivery_method.to_s : "smtp"
 
         options =
-            case method
-            when 'smtp'
-              { :address              => @address,
-                :port                 => @port,
-                :domain               => @domain,
-                :user_name            => @user_name,
-                :password             => @password,
-                :authentication       => @authentication,
-                :enable_starttls_auto => @encryption == :starttls,
-                :openssl_verify_mode  => @openssl_verify_mode,
-                :ssl                  => @encryption == :ssl,
-                :tls                  => @encryption == :tls
-              }
-            when 'sendmail'
-              opts = {}
-              opts.merge!(:location  => utility(:sendmail))
-              opts.merge!(:arguments => @sendmail_args) if @sendmail_args
-              opts
-            when 'exim'
-              opts = {}
-              opts.merge!(:location  => utility(:exim))
-              opts.merge!(:arguments => @exim_args) if @exim_args
-              opts
-            when 'file'
-              @mail_folder ||= File.join(Config.root_path, 'emails')
-              { :location => File.expand_path(@mail_folder) }
-            when 'test' then {}
-            end
+          case method
+          when "smtp"
+            opts = {
+              address: @address,
+              port: @port,
+              user_name: @user_name,
+              password: @password,
+              authentication: @authentication,
+              enable_starttls_auto: @encryption == :starttls,
+              openssl_verify_mode: @openssl_verify_mode,
+              ssl: @encryption == :ssl,
+              tls: @encryption == :tls
+            }
+
+            # Don't override default domain setting if domain not applicable.
+            # ref https://github.com/mikel/mail/blob/2.6.3/lib/mail/network/delivery_methods/smtp.rb#L82
+            opts[:domain] = @domain if @domain
+            opts
+          when "sendmail"
+            opts = {}
+            opts[:location] = utility(:sendmail)
+            opts[:arguments] = @sendmail_args if @sendmail_args
+            opts
+          when "exim"
+            opts = {}
+            opts[:location] = utility(:exim)
+            opts[:arguments] = @exim_args if @exim_args
+            opts
+          when "file"
+            @mail_folder ||= File.join(Config.root_path, "emails")
+            { location: File.expand_path(@mail_folder) }
+          when "test" then {}
+          end
 
         email = ::Mail.new
         email.delivery_method method.to_sym, options
@@ -224,21 +227,6 @@ module Backup
         email.reply_to = reply_to
         email
       end
-
-    end
-  end
-end
-
-# Patch mail v2.5.4 Exim delivery method
-# https://github.com/backup/backup/issues/446
-# https://github.com/mikel/mail/pull/546
-module Mail
-  class Exim
-    def self.call(path, arguments, destinations, encoded_message)
-      popen "#{path} #{arguments}" do |io|
-        io.puts encoded_message.to_lf
-        io.flush
-      end
     end
   end
 end