backup 4.4.1 → 5.0.0.beta.3

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,43 +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'
-              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.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
@@ -229,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

data/lib/backup/notifier/nagios.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Notifier
     class Nagios < Base
-
       ##
       # Host of Nagios server to notify on backup completion.
       attr_accessor :nagios_host
@@ -30,8 +27,8 @@ module Backup
 
         @nagios_host  ||= Config.hostname
         @nagios_port  ||= 5667
-        @send_nsca_cfg||= "/etc/nagios/send_nsca.cfg"
-        @service_name ||= "Backup #{ model.trigger }"
+        @send_nsca_cfg ||= "/etc/nagios/send_nsca.cfg"
+        @service_name ||= "Backup #{model.trigger}"
         @service_host ||= Config.hostname
       end
 
@@ -55,15 +52,14 @@ 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)
-        cmd = "#{ utility(:send_nsca) } -H '#{ nagios_host }' -p '#{ nagios_port }' -c '#{ send_nsca_cfg }'"
+        cmd = "#{utility(:send_nsca)} -H '#{nagios_host}' -p '#{nagios_port}' -c '#{send_nsca_cfg}'"
         msg = [service_host, service_name, model.exit_status, message].join("\t")
-        run("echo '#{ msg }' | #{ cmd }")
+        run("echo '#{msg}' | #{cmd}")
       end
-
     end
   end
 end

data/lib/backup/notifier/pagerduty.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'pagerduty'
+require "pagerduty"
 
 module Backup
   module Notifier
     class PagerDuty < Base
-
       ##
       # PagerDuty Service API Key. Should be a 32 character hex string.
       attr_accessor :service_key
@@ -46,15 +44,15 @@ module Backup
         incident_description = "Backup - #{model.label}"
         incident_key = "backup/#{model.trigger}"
         incident_details = {
-          :incident_key => incident_key,
-          :details => {
-            :trigger => model.trigger,
-            :label => model.label,
-            :started_at => model.started_at,
-            :finished_at => model.finished_at,
-            :duration => model.duration,
-            :status => status,
-            :exception => model.exception
+          incident_key: incident_key,
+          details: {
+            trigger: model.trigger,
+            label: model.label,
+            started_at: model.started_at,
+            finished_at: model.finished_at,
+            duration: model.duration,
+            status: status,
+            exception: model.exception
           }
         }
 

data/lib/backup/notifier/prowl.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'uri'
+require "uri"
 
 module Backup
   module Notifier
     class Prowl < Base
-
       ##
       # Application name
       # Tell something like your server name. Example: "Server1 Backup"
@@ -16,10 +14,13 @@ module Backup
       attr_accessor :api_key
 
       def initialize(model, &block)
-        @message = lambda do |model, data|
-          "#{ model.label } (#{ model.trigger })"
-        end
+        @message =
+          lambda do |m, _|
+            "#{m.label} (#{m.trigger})"
+          end
+
         super
+
         instance_eval(&block) if block_given?
       end
 
@@ -47,22 +48,21 @@ module Backup
       end
 
       def send_message(status)
-        uri = 'https://api.prowlapp.com/publicapi/add'
+        uri = "https://api.prowlapp.com/publicapi/add"
         status_data = status_data_for(status)
         data = {
-          :application  => application,
-          :apikey       => api_key,
-          :event        => status_data[:message],
-          :description  => message.call(model, :status => status_data)
+          application: application,
+          apikey: api_key,
+          event: status_data[:message],
+          description: message.call(model, status: status_data)
         }
         options = {
-          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
-          :body     => URI.encode_www_form(data)
+          headers: { "Content-Type" => "application/x-www-form-urlencoded" },
+          body: URI.encode_www_form(data)
         }
-        options.merge!(:expects => 200) # raise error if unsuccessful
+        options[:expects] = 200 # raise error if unsuccessful
         Excon.post(uri, options)
       end
-
     end
   end
 end

data/lib/backup/notifier/pushover.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'uri'
+require "uri"
 
 module Backup
   module Notifier
     class Pushover < Base
-
       ##
       # The API User Token
       attr_accessor :user
@@ -51,24 +49,23 @@ 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://api.pushover.net/1/messages.json'
-        data = { :user => user, :token => token, :message => message }
+        uri = "https://api.pushover.net/1/messages.json"
+        data = { user: user, token: token, message: message }
         [:device, :title, :priority].each do |param|
           val = send(param)
           data.merge!(param => val) if val
         end
         options = {
-          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
-          :body     => URI.encode_www_form(data)
+          headers: { "Content-Type" => "application/x-www-form-urlencoded" },
+          body: URI.encode_www_form(data)
         }
-        options.merge!(:expects => 200) # raise error if unsuccessful
+        options[:expects] = 200 # raise error if unsuccessful
         Excon.post(uri, options)
       end
-
     end
   end
 end

data/lib/backup/notifier/ses.rb

@@ -1,13 +1,12 @@
-# encoding: utf-8
-require 'aws/ses'
+require "aws-sdk"
+require "mail"
 
 module Backup
   module Notifier
     class Ses < Base
-
       ##
       # Amazon Simple Email Service (SES) Credentials
-      attr_accessor :access_key_id, :secret_access_key
+      attr_accessor :access_key_id, :secret_access_key, :use_iam_profile
 
       ##
       # SES Region
@@ -37,7 +36,7 @@ module Backup
         super
         instance_eval(&block) if block_given?
 
-        @region ||= 'eu-west-1'
+        @region ||= "eu-west-1"
         @send_log_on ||= [:warning, :failure]
       end
 
@@ -51,10 +50,15 @@ module Backup
       private
 
       def client
-        AWS::SES::Base.new(
-          :access_key_id => access_key_id,
-          :secret_access_key => secret_access_key,
-          :server => "email.#{region}.amazonaws.com"
+        credentials = if use_iam_profile
+                        Aws::InstanceProfileCredentials.new
+                      else
+                        Aws::Credentials.new(access_key_id, secret_access_key)
+                      end
+
+        Aws::SES::Client.new(
+          region: region,
+          credentials: credentials
         )
       end
 
@@ -84,21 +88,35 @@ module Backup
         email.cc       = cc
         email.bcc      = bcc
         email.reply_to = reply_to
-        email.subject  = message.call(model, :status => status_data_for(status))
+        email.subject  = message.call(model, status: status_data_for(status))
+
+        # By default, the `mail` gem doesn't include BCC in raw output, which is
+        # needed for SES to send to those addresses.
+        email[:bcc].include_in_headers = true
 
         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
+
+        send_opts = {
+          raw_message: {
+            data: email.to_s
           }
+        }
+
+        if email.respond_to?(:destinations)
+          send_opts[:destinations] = email.destinations
         end
 
-        client.send_raw_email(email)
+        client.send_raw_email(send_opts)
       end
     end
   end

data/lib/backup/notifier/slack.rb

@@ -1,11 +1,9 @@
-# encoding: utf-8
-require 'uri'
-require 'json'
+require "uri"
+require "json"
 
 module Backup
   module Notifier
     class Slack < Base
-
       ##
       # The incoming webhook url
       attr_accessor :webhook_url
@@ -38,7 +36,7 @@ module Backup
         instance_eval(&block) if block_given?
 
         @send_log_on ||= [:warning, :failure]
-        @icon_emoji  ||= ':floppy_disk:'
+        @icon_emoji  ||= ":floppy_disk:"
       end
 
       private
@@ -62,8 +60,8 @@ module Backup
       #
       def notify!(status)
         data = {
-          :text => message.call(model, :status => status_data_for(status)),
-          :attachments => [attachment(status)]
+          text: message.call(model, status: status_data_for(status)),
+          attachments: [attachment(status)]
         }
         [:channel, :username, :icon_emoji].each do |param|
           val = send(param)
@@ -71,43 +69,43 @@ module Backup
         end
 
         options = {
-          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
-          :body     => URI.encode_www_form(:payload => JSON.dump(data))
+          headers: { "Content-Type" => "application/x-www-form-urlencoded" },
+          body: URI.encode_www_form(payload: JSON.dump(data))
         }
-        options.merge!(:expects => 200) # raise error if unsuccessful
+        options[:expects] = 200 # raise error if unsuccessful
         Excon.post(uri, options)
       end
 
       def attachment(status)
         {
-          :fallback => "#{title(status)} - Job: #{model.label} (#{model.trigger})",
-          :text     => title(status),
-          :color    => color(status),
-          :fields   => [
+          fallback: "#{title(status)} - Job: #{model.label} (#{model.trigger})",
+          text: title(status),
+          color: color(status),
+          fields: [
             {
-              :title => "Job",
-              :value => "#{model.label} (#{model.trigger})",
-              :short => false
+              title: "Job",
+              value: "#{model.label} (#{model.trigger})",
+              short: false
             },
             {
-              :title => "Started",
-              :value => model.started_at,
-              :short => true
+              title: "Started",
+              value: model.started_at,
+              short: true
             },
             {
-              :title => "Finished",
-              :value => model.finished_at,
-              :short => true
+              title: "Finished",
+              value: model.finished_at,
+              short: true
             },
             {
-              :title => "Duration",
-              :value => model.duration,
-              :short => true
+              title: "Duration",
+              value: model.duration,
+              short: true
             },
             {
-              :title => "Version",
-              :value => "Backup v#{Backup::VERSION}\nRuby: #{RUBY_DESCRIPTION}",
-              :short => false
+              title: "Version",
+              value: "Backup v#{Backup::VERSION}\nRuby: #{RUBY_DESCRIPTION}",
+              short: false
             },
             log_field(status)
           ].compact
@@ -116,27 +114,28 @@ module Backup
 
       def log_field(status)
         send_log = send_log_on.include?(status)
+        return unless send_log
 
-        return {
-          :title => "Detailed Backup Log",
-          :value => Logger.messages.map(&:formatted_lines).flatten.join("\n"),
-          :short => false,
-        } if send_log
+        {
+          title: "Detailed Backup Log",
+          value: Logger.messages.map(&:formatted_lines).flatten.join("\n"),
+          short: false
+        }
       end
 
       def color(status)
         case status
-        when :success then 'good'
-        when :failure then 'danger'
-        when :warning then 'warning'
+        when :success then "good"
+        when :failure then "danger"
+        when :warning then "warning"
         end
       end
 
       def title(status)
         case status
-        when :success then 'Backup Completed Successfully!'
-        when :failure then 'Backup Failed!'
-        when :warning then 'Backup Completed Successfully (with Warnings)!'
+        when :success then "Backup Completed Successfully!"
+        when :failure then "Backup Failed!"
+        when :warning then "Backup Completed Successfully (with Warnings)!"
         end
       end
 

data/lib/backup/notifier/twitter.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require 'twitter'
+require "twitter"
 
 module Backup
   module Notifier
     class Twitter < Base
-
       ##
       # Twitter consumer key credentials
       attr_accessor :consumer_key, :consumer_secret
@@ -38,7 +36,7 @@ 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
 
       # Twitter::Client will raise an error if unsuccessful.
@@ -52,7 +50,6 @@ module Backup
 
         client.update(message)
       end
-
     end
   end
 end

data/lib/backup/notifier/zabbix.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Notifier
     class Zabbix < Base
-
       attr_accessor :zabbix_host
 
       attr_accessor :zabbix_port
@@ -19,10 +16,10 @@ module Backup
         instance_eval(&block) if block_given?
 
         @zabbix_host  ||= Config.hostname
-        @zabbix_port  ||= 10051
-        @service_name ||= "Backup #{ model.trigger }"
+        @zabbix_port  ||= 10_051
+        @service_name ||= "Backup #{model.trigger}"
         @service_host ||= Config.hostname
-        @item_key     ||= 'backup_status'
+        @item_key     ||= "backup_status"
       end
 
       private
@@ -45,18 +42,18 @@ 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)
         msg = [service_host, service_name, model.exit_status, message].join("\t")
-        cmd = "#{ utility(:zabbix_sender) }" +
-              " -z '#{ zabbix_host }'" +
-              " -p '#{ zabbix_port }'" +
-              " -s #{ service_host }"  +
-              " -k #{ item_key }"      +
-              " -o '#{ msg }'"
-        run("echo '#{ msg }' | #{ cmd }")
+        cmd = utility(:zabbix_sender).to_s +
+          " -z '#{zabbix_host}'" \
+          " -p '#{zabbix_port}'" \
+          " -s #{service_host}"  \
+          " -k #{item_key}"      \
+          " -o '#{msg}'"
+        run("echo '#{msg}' | #{cmd}")
       end
     end
   end

data/lib/backup/package.rb

@@ -1,8 +1,5 @@
-# encoding: utf-8
-
 module Backup
   class Package
-
     ##
     # The time when the backup initiated (in format: 2011.02.20.03.29.59)
     attr_accessor :time
@@ -29,8 +26,8 @@ module Backup
 
     def initialize(model)
       @trigger = model.trigger
-      @extension = 'tar'
-      @chunk_suffixes = Array.new
+      @extension = "tar"
+      @chunk_suffixes = []
       @no_cycle = false
       @version = VERSION
     end
@@ -39,17 +36,16 @@ module Backup
       if chunk_suffixes.empty?
         [basename]
       else
-        chunk_suffixes.map {|suffix| "#{ basename }-#{ suffix }" }
+        chunk_suffixes.map { |suffix| "#{basename}-#{suffix}" }
       end
     end
 
     def basename
-      "#{ trigger }.#{ extension }"
+      "#{trigger}.#{extension}"
     end
 
     def time_as_object
-      Time.strptime(time, '%Y.%m.%d.%H.%M.%S')
+      Time.strptime(time, "%Y.%m.%d.%H.%M.%S")
     end
-
   end
 end