backup 3.5.1 → 3.6.0

data/lib/backup/notifier/base.rb

@@ -3,6 +3,7 @@
 module Backup
   module Notifier
     class Base
+      include Backup::Utilities::Helpers
       include Backup::Configuration::Helpers
 
       ##
@@ -24,7 +25,17 @@ module Backup
       alias :notify_on_failure? :on_failure
 
       ##
-      # Called with super(model) from subclasses
+      # Number of times to retry failed attempts to send notification.
+      # Default: 10
+      attr_accessor :max_retries
+
+      ##
+      # Time in seconds to pause before each retry.
+      # Default: 30
+      attr_accessor :retry_waitsec
+
+      attr_reader :model
+
       def initialize(model)
         @model = model
         load_defaults!
@@ -32,48 +43,68 @@ module Backup
         @on_success = true if on_success.nil?
         @on_warning = true if on_warning.nil?
         @on_failure = true if on_failure.nil?
+        @max_retries    ||= 10
+        @retry_waitsec  ||= 30
       end
 
-      ##
-      # Performs the notification
-      # Takes a flag to indicate that a failure has occured.
-      # (this is only set from Model#perform! in the event of an error)
-      # If this is the case it will set the 'action' to :failure.
-      # Otherwise, it will set the 'action' to either :success or :warning,
-      # depending on whether or not any warnings were sent to the Logger.
-      # It will then invoke the notify! method with the 'action',
-      # but only if the proper on_success, on_warning or on_failure flag is true.
-      def perform!(failure = false)
-        @template  = Backup::Template.new({:model => @model})
-
-        action = false
-        if failure
-          action = :failure if notify_on_failure?
-        else
-          if notify_on_success? || (notify_on_warning? && Logger.has_warnings?)
-            action = Logger.has_warnings? ? :warning : :success
-          end
-        end
+      # This method is called from an ensure block in Model#perform! and must
+      # 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
 
-        if action
-          log!
-          notify!(action)
+        if status
+          Logger.info "Sending notification using #{ notifier_name }..."
+          with_retries { notify!(status) }
         end
+
+      rescue Exception => err
+        Logger.error Errors::NotifierError.wrap(err, "#{ notifier_name } Failed!")
       end
 
       private
 
+      def with_retries
+        retries = 0
+        begin
+          yield
+        rescue StandardError, Timeout::Error => err
+          retries += 1
+          raise if retries > max_retries
+
+          Logger.info Errors::NotifierError.
+              wrap(err, "Retry ##{ retries } of #{ max_retries }.")
+          sleep(retry_waitsec)
+          retry
+        end
+      end
+
       ##
       # Return the notifier name, with Backup namespace removed
       def notifier_name
         self.class.to_s.sub('Backup::', '')
       end
 
-      ##
-      # Logs a message to the console and log file to inform
-      # the client that Backup is notifying about the process
-      def log!
-        Logger.info "#{ notifier_name } started notifying about the process."
+      # For ruby-1.8.7. Both sorted so specs will match.
+      def encode_www_form(enum)
+        if RUBY_VERSION < '1.9'
+          require 'cgi'
+          str = ''
+          enum.to_a.map {|k,v| [k.to_s, v] }.sort.each do |k,v|
+            str << '&' unless str.empty?
+            str << CGI.escape(k) << '=' << CGI.escape(v)
+          end
+          str
+        else
+          URI.encode_www_form(enum.sort)
+        end
       end
 
     end

data/lib/backup/notifier/campfire.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
-require 'httparty'
+require 'excon'
+require 'json'
 
 module Backup
   module Notifier
@@ -18,8 +19,7 @@ module Backup
       attr_accessor :room_id
 
       def initialize(model, &block)
-        super(model)
-
+        super
         instance_eval(&block) if block_given?
       end
 
@@ -27,124 +27,42 @@ module Backup
 
       ##
       # Notify the user of the backup operation results.
+      #
       # `status` indicates one of the following:
       #
       # `:success`
       # : The backup completed successfully.
-      # : Notification will be sent if `on_success` was set to `true`
+      # : Notification will be sent if `on_success` is `true`.
       #
       # `:warning`
-      # : The backup completed successfully, but warnings were logged
-      # : Notification will be sent, including a copy of the current
-      # : backup log, if `on_warning` was set to `true`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       # `:failure`
       # : The backup operation failed.
-      # : Notification will be sent, including the Exception which caused
-      # : the failure, the Exception's backtrace, a copy of the current
-      # : backup log and other information if `on_failure` was set to `true`
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        name = case status
-               when :success then 'Success'
-               when :warning then 'Warning'
-               when :failure then 'Failure'
-               end
-        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
+        message = "#{ tag } #{ model.label } (#{ model.trigger })"
         send_message(message)
       end
 
-      ##
-      # Creates a new Campfire::Interface object and passes in the
-      # campfire clients "room_id", "subdomain" and "api_token". Using this object
-      # the provided "message" will be sent to the desired Campfire chat room
       def send_message(message)
-        room = Interface.room(room_id, subdomain, api_token)
-        room.message(message)
-      end
-
-      ##
-      # The Campfire::Interface acts as the Interface for the Campfire class.
-      # It uses the HTTParty library and the Campfire::Room class to communicate
-      # with the Campfire rooms. HTTParty provides the Campfire::Interface with the methods
-      # necessary to communicate (inside the HTTParty module) such as the class methods:
-      # * post
-      # * base_uri
-      # * basic_auth
-      class Interface
-        include HTTParty
-
-        ##
-        # We communicate using the JSON data format
-        headers 'Content-Type' => 'application/json'
-
-        ##
-        # Instantiates a new Campfire::Room object with
-        # the provided arguments and returns this object
-        def self.room(room_id, subdomain, api_token)
-          Room.new(room_id, subdomain, api_token)
-        end
-      end
-
-      ##
-      # The Campfire::Room acts as a model for an actual room on the Campfire service.
-      # And it uses the Campfire::Interface's (HTTParty) class methods to communicate based
-      # on the provided parameters (room_id, subdomain and api_token)
-      class Room
-
-        ##
-        # Campfire api authentication api_token
-        attr_accessor :api_token
-
-        ##
-        # Campfire account's subdomain
-        attr_accessor :subdomain
-
-        ##
-        # Campfire account's room id
-        attr_accessor :room_id
-
-        ##
-        # Instantiates a new Campfire::Room object and sets all the
-        # necessary arguments (@room_id, @subdomain, @api_token)
-        def initialize(room_id, subdomain, api_token)
-          @room_id   = room_id
-          @subdomain = subdomain
-          @api_token = api_token
-        end
-
-        ##
-        # Wrapper method for the #send_message (private) method
-        def message(message)
-          send_message(message)
-        end
-
-        private
-
-        ##
-        # Takes a "message" as argument, the "type" defaults to "Textmessage".
-        # This method builds up a POST request with the necessary params (serialized to JSON format)
-        # and sends it to the Campfire service in order to submit the message
-        def send_message(message, type = 'Textmessage')
-          post 'speak', :body => MultiJson.encode(
-            { :message => { :body => message, :type => type } }
+        uri = "https://#{ subdomain }.campfirenow.com/room/#{ room_id }/speak.json"
+        options = {
+          :headers  => { 'Content-Type' => 'application/json' },
+          :body     => JSON.dump(
+            { :message => { :body => message, :type => 'Textmessage' } }
           )
-        end
-
-        ##
-        # Builds/sets up the Campfire::Interface attributes and submits
-        # the POST request that was built in the #send_message (private) method
-        def post(action, options = {})
-          Interface.base_uri("https://#{subdomain}.campfirenow.com")
-          Interface.basic_auth(api_token, 'x')
-          Interface.post(room_url_for(action), options)
-        end
-
-        ##
-        # Returns the url for the specified room (in JSON format)
-        def room_url_for(action)
-          "/room/#{room_id}/#{action}.json"
-        end
+        }
+        options.merge!(:user => api_token, :password => 'x') # Basic Auth
+        options.merge!(:expects => 201) # raise error if unsuccessful
+        Excon.post(uri, options)
       end
 
     end

data/lib/backup/notifier/hipchat.rb

@@ -37,55 +37,57 @@ module Backup
       attr_accessor :failure_color
 
       def initialize(model, &block)
-        super(model)
+        super
+        instance_eval(&block) if block_given?
 
         @notify_users   ||= false
         @rooms_notified ||= []
         @success_color  ||= 'yellow'
         @warning_color  ||= 'yellow'
         @failure_color  ||= 'yellow'
-
-        instance_eval(&block) if block_given?
       end
 
       private
 
       ##
       # Notify the user of the backup operation results.
+      #
       # `status` indicates one of the following:
       #
       # `:success`
       # : The backup completed successfully.
-      # : Notification will be sent if `on_success` was set to `true`
+      # : Notification will be sent if `on_success` is `true`.
       #
       # `:warning`
-      # : The backup completed successfully, but warnings were logged
-      # : Notification will be sent, including a copy of the current
-      # : backup log, if `on_warning` was set to `true`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       # `:failure`
       # : The backup operation failed.
-      # : Notification will be sent, including the Exception which caused
-      # : the failure, the Exception's backtrace, a copy of the current
-      # : backup log and other information if `on_failure` was set to `true`
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        name, color = case status
-                      when :success then ['Success', success_color]
-                      when :warning then ['Warning', warning_color]
-                      when :failure then ['Failure', failure_color]
-                      end
-        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        tag, color = case status
+                     when :success then ['[Backup::Success]', success_color]
+                     when :warning then ['[Backup::Warning]', warning_color]
+                     when :failure then ['[Backup::Failure]', failure_color]
+                     end
+        message = "#{ tag } #{ model.label } (#{ model.trigger })"
         send_message(message, color)
       end
 
+      # Hipchat::Client will raise an error if unsuccessful.
       def send_message(msg, color)
         client = HipChat::Client.new(token)
-        Array(rooms_notified).map {|r| r.split(',').map(&:strip) }.flatten.each do |room|
+        rooms_to_notify.each do |room|
           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
+      end
+
     end
   end
 end

data/lib/backup/notifier/mail.rb

@@ -17,11 +17,11 @@ module Backup
       #
       # [:sendmail - ::Mail::Sendmail]
       #   Settings used by this method:
-      #   {#sendmail}, {#sendmail_args}
+      #   {#sendmail_args}
       #
       # [:exim - ::Mail::Exim]
       #   Settings used by this method:
-      #   {#exim}, {#exim_args}
+      #   {#exim_args}
       #
       # [:file - ::Mail::FileDelivery]
       #   Settings used by this method:
@@ -76,13 +76,6 @@ module Backup
       #   Use a +SSL/TLS+ connection.
       attr_accessor :encryption
 
-      attr_deprecate :enable_starttls_auto, :version => '3.2.0',
-                     :message => "Use #encryption instead.\n" +
-                        'e.g. mail.encryption = :starttls',
-                     :action => lambda {|klass, val|
-                       klass.encryption = val ? :starttls : :none
-                     }
-
       ##
       # OpenSSL Verify Mode
       #
@@ -92,52 +85,44 @@ module Backup
       # Use +:none+ for a self-signed and/or wildcard certificate
       attr_accessor :openssl_verify_mode
 
-      ##
-      # Path to `sendmail` (if needed)
-      #
-      # When using the `:sendmail` `delivery_method` option,
-      # this may be used to specify the absolute path to `sendmail`
-      #
-      # Example: '/usr/sbin/sendmail'
-      attr_accessor :sendmail
-
       ##
       # Optional arguments to pass to `sendmail`
       #
-      # Note that this will override the defaults set by the Mail gem (currently: '-i -t')
-      # So, if set here, be sure to set all the arguments you require.
+      # Note that this will override the defaults set by the Mail gem
+      # (currently: '-i'). So, if set here, be sure to set all the arguments
+      # you require.
       #
-      # Example: '-i -t -X/tmp/traffic.log'
+      # Example: '-i -X/tmp/traffic.log'
       attr_accessor :sendmail_args
 
-      ##
-      # Path to `exim` (if needed)
-      #
-      # When using the `:exim` `delivery_method` option,
-      # this may be used to specify the absolute path to `exim`
-      #
-      # Example: '/usr/sbin/exim'
-      attr_accessor :exim
-
       ##
       # Optional arguments to pass to `exim`
       #
-      # Note that this will override the defaults set by the Mail gem (currently: '-i -t')
-      # So, if set here, be sure to set all the arguments you require.
+      # Note that this will override the defaults set by the Mail gem
+      # (currently: '-i -t') So, if set here, be sure to set all the arguments
+      # you require.
       #
       # Example: '-i -t -X/tmp/traffic.log'
       attr_accessor :exim_args
 
       ##
-      # Folder where mail will be kept when using the `:file` `delivery_method` option.
+      # Folder where mail will be kept when using the `:file` `delivery_method`.
       #
       # Default location is '$HOME/Backup/emails'
       attr_accessor :mail_folder
 
-      def initialize(model, &block)
-        super(model)
+      ##
+      # Array of statuses for which the log file should be attached.
+      #
+      # Available statuses are: `:success`, `:warning` and `:failure`.
+      # Default: [:warning, :failure]
+      attr_accessor :send_log_on
 
+      def initialize(model, &block)
+        super
         instance_eval(&block) if block_given?
+
+        @send_log_on ||= [:warning, :failure]
       end
 
       private
@@ -147,42 +132,43 @@ module Backup
       #
       # `status` indicates one of the following:
       #
-      # [:success]
-      #   The backup completed successfully.
-      #   Notification will be sent if `on_success` was set to `true`
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
       #
-      # [:warning]
-      #   The backup completed successfully, but warnings were logged
-      #   Notification will be sent, including a copy of the current
-      #   backup log, if `on_warning` was set to `true`
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent, including a copy of the current
+      # : backup log, if `on_warning` or `on_success` is `true`.
       #
-      # [:failure]
-      #   The backup operation failed.
-      #   Notification will be sent, including the Exception which caused
-      #   the failure, the Exception's backtrace, a copy of the current
-      #   backup log and other information if `on_failure` was set to `true`
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent, including a copy of the current
+      # : backup log, if `on_failure` is `true`.
       #
       def notify!(status)
-        name, send_log =
-            case status
-            when :success then [ 'Success', false ]
-            when :warning then [ 'Warning', true  ]
-            when :failure then [ 'Failure', true  ]
-            end
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
 
         email = new_email
-        email.subject = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
-        email.body    = @template.result('notifier/mail/%s.erb' % status.to_s)
+        email.subject = "#{ tag } #{ model.label } (#{ model.trigger })"
+
+        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)
 
         if send_log
           email.convert_to_multipart
-          email.attachments["#{@model.time}.#{@model.trigger}.log"] = {
+          email.attachments["#{ model.time }.#{ model.trigger }.log"] = {
             :mime_type => 'text/plain;',
             :content   => Logger.messages.map(&:formatted_lines).flatten.join("\n")
           }
         end
 
-        email.deliver!
+        email.deliver! # raise error if unsuccessful
       end
 
       ##
@@ -208,12 +194,12 @@ module Backup
               }
             when 'sendmail'
               opts = {}
-              opts.merge!(:location  => File.expand_path(@sendmail)) if @sendmail
+              opts.merge!(:location  => utility(:sendmail))
               opts.merge!(:arguments => @sendmail_args) if @sendmail_args
               opts
             when 'exim'
               opts = {}
-              opts.merge!(:location  => File.expand_path(@exim)) if @exim
+              opts.merge!(:location  => utility(:exim))
               opts.merge!(:arguments => @exim_args) if @exim_args
               opts
             when 'file'
@@ -232,6 +218,25 @@ module Backup
         email
       end
 
+      attr_deprecate :enable_starttls_auto, :version => '3.2.0',
+                     :message => "Use #encryption instead.\n" +
+                        'e.g. mail.encryption = :starttls',
+                     :action => lambda {|klass, val|
+                       klass.encryption = val ? :starttls : :none
+                     }
+
+      attr_deprecate :sendmail, :version => '3.6.0',
+          :message => 'Use Backup::Utilities.configure instead.',
+          :action => lambda {|klass, val|
+            Utilities.configure { sendmail val }
+          }
+
+      attr_deprecate :exim, :version => '3.6.0',
+          :message => 'Use Backup::Utilities.configure instead.',
+          :action => lambda {|klass, val|
+            Utilities.configure { exim val }
+          }
+
     end
   end
 end