backup 3.0.20 → 3.0.21

data/lib/backup/notifier/base.rb

@@ -5,14 +5,6 @@ module Backup
     class Base
       include Backup::Configuration::Helpers
 
-      ##
-      # Container for the Model object
-      attr_accessor :model
-
-      ##
-      # Contains the Backup::Template object
-      attr_accessor :template
-
       ##
       # When set to true, the user will be notified by email
       # when a backup process ends without raising any exceptions
@@ -32,33 +24,35 @@ module Backup
       alias :notify_on_failure? :on_failure
 
       ##
-      # Super method #initialize for all child classes
-      def initialize(&block)
+      # Called with super(model) from subclasses
+      def initialize(model)
+        @model = model
         load_defaults!
 
-        instance_eval(&block) if block_given?
-
-        set_defaults!
+        @on_success = true if on_success.nil?
+        @on_warning = true if on_warning.nil?
+        @on_failure = true if on_failure.nil?
       end
 
       ##
       # Performs the notification
-      # Takes an exception object that might've been created if an exception occurred.
-      # If this is the case it'll invoke notify_failure!(exception), otherwise, if no
-      # error was raised, it'll go ahead and notify_success!
-      #
-      # If'll only perform these if on_success is true or on_failure is true
-      def perform!(model, exception = false)
-        @model     = model
-        @template  = Backup::Template.new({:model => model, :exception => exception})
+      # 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 exception.eql?(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
-        else
-          action = :failure if notify_on_failure?
         end
 
         if action
@@ -67,11 +61,19 @@ module Backup
         end
       end
 
+      private
+
+      ##
+      # 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.message "#{ self.class } started notifying about the process."
+        Logger.message "#{ notifier_name } started notifying about the process."
       end
 
     end

data/lib/backup/notifier/campfire.rb

@@ -30,15 +30,13 @@ module Backup
       # Campfire account's room id
       attr_accessor :room_id
 
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done, put it above the super(model, exception)
-      def perform!(model, exception = false)
-        super(model, exception)
+      def initialize(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
       # Notify the user of the backup operation results.
@@ -65,14 +63,10 @@ module Backup
                when :warning then 'Warning'
                when :failure then 'Failure'
                end
-        message = "[Backup::%s] #{model.label} (#{model.trigger})" % name
+        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
         send_message(message)
       end
 
-      ##
-      # nothing to do
-      def set_defaults!; end
-
       ##
       # Creates a new Campfire::Interface object and passes in the
       # campfire clients "room_id", "subdomain" and "api_token". Using this object
@@ -138,7 +132,7 @@ module Backup
           send_message(message)
         end
 
-      private
+        private
 
         ##
         # Takes a "message" as argument, the "type" defaults to "Textmessage".

data/lib/backup/notifier/hipchat.rb

@@ -26,39 +26,38 @@ module Backup
       attr_accessor :rooms_notified
 
       ##
-      # The background color of a success message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+      # Notify users in the room
+      attr_accessor :notify_users
+
+      ##
+      # The background color of a success message.
+      # One of :yellow, :red, :green, :purple, or :random. (default: yellow)
       attr_accessor :success_color
 
       ##
-      # The background color of a warning message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+      # The background color of a warning message.
+      # One of :yellow, :red, :green, :purple, or :random. (default: yellow)
       attr_accessor :warning_color
 
       ##
-      # The background color of an error message. One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+      # The background color of an error message.
+      # One of :yellow, :red, :green, :purple, or :random. (default: yellow)
       attr_accessor :failure_color
 
-      ##
-      # Notify users in the room
-      attr_accessor :notify_users
-
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done, put it above the super(model, exception)
-      def perform!(model, exception = false)
-        @rooms_notified = [rooms_notified].flatten
-        super(model, exception)
-      end
+      def initialize(model, &block)
+        super(model)
 
-    private
+        @notify_users   ||= false
+        @rooms_notified ||= []
+        @success_color  ||= 'yellow'
+        @warning_color  ||= 'yellow'
+        @failure_color  ||= 'yellow'
 
-      def send_message(msg, color, notify)
-        client = HipChat::Client.new(token)
-        rooms_notified.each do |room|
-          client[room].send(from, msg, :color => color, :notify => notify)
-        end
+        instance_eval(&block) if block_given?
       end
 
+      private
+
       ##
       # Notify the user of the backup operation results.
       # `status` indicates one of the following:
@@ -84,16 +83,17 @@ module Backup
                       when :warning then ['Warning', warning_color]
                       when :failure then ['Failure', failure_color]
                       end
-        message = "[Backup::%s] #{model.label} (#{model.trigger})" % name
-        send_message(message, color, notify_users)
+        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        send_message(message, color)
       end
 
-      def set_defaults!
-        @success_color ||= 'yellow'
-        @warning_color ||= 'yellow'
-        @failure_color ||= 'yellow'
-        @notify_users  ||= false
+      def send_message(msg, color)
+        client = HipChat::Client.new(token)
+        [rooms_notified].flatten.each do |room|
+          client[room].send(from, msg, :color => color, :notify => notify_users)
+        end
       end
+
     end
   end
 end

data/lib/backup/notifier/mail.rb

@@ -8,10 +8,6 @@ module Backup
   module Notifier
     class Mail < Base
 
-      ##
-      # Container for the Mail object
-      attr_reader :mail
-
       ##
       # Mail delivery method to be used by the Mail gem.
       # Supported methods:
@@ -94,15 +90,13 @@ module Backup
       # Example: '/tmp/test-mails'
       attr_accessor :mail_folder
 
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done, put it above the super(model, exception)
-      def perform!(model, exception = false)
-        super(model, exception)
+      def initialize(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
       # Notify the user of the backup operation results.
@@ -130,27 +124,31 @@ module Backup
             when :warning then [ 'Warning', true  ]
             when :failure then [ 'Failure', true  ]
             end
-        mail.subject = "[Backup::%s] #{model.label} (#{model.trigger})" % name
-        mail.body    = template.result('notifier/mail/%s.erb' % status.to_s)
+
+        email = new_email
+        email.subject = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        email.body    = @template.result('notifier/mail/%s.erb' % status.to_s)
+
         if send_log
-          mail.convert_to_multipart
-          mail.attachments["#{model.time}.#{model.trigger}.log"] = {
+          email.convert_to_multipart
+          email.attachments["#{@model.time}.#{@model.trigger}.log"] = {
             :mime_type => 'text/plain;',
             :content   => Logger.messages.join("\n")
           }
         end
-        mail.deliver!
+
+        email.deliver!
       end
 
       ##
       # Configures the Mail gem by setting the defaults.
-      # Instantiates the @mail object with the @to and @from attributes
-      def set_defaults!
-        @delivery_method = %w{ smtp sendmail file test }.
+      # Creates and returns a new email, based on the @delivery_method used.
+      def new_email
+        method = %w{ smtp sendmail file test }.
             index(@delivery_method.to_s) ? @delivery_method.to_s : 'smtp'
 
         options =
-            case @delivery_method
+            case method
             when 'smtp'
               { :address              => @address,
                 :port                 => @port,
@@ -166,19 +164,19 @@ module Backup
               opts.merge!(:arguments => @sendmail_args) if @sendmail_args
               opts
             when 'file'
-              @mail_folder ||= "#{ENV['HOME']}/Backup/emails"
+              @mail_folder ||= File.join(Config.root_path, 'emails')
               { :location => File.expand_path(@mail_folder) }
             when 'test' then {}
             end
 
-        method = @delivery_method.to_sym
         ::Mail.defaults do
-          delivery_method method, options
+          delivery_method method.to_sym, options
         end
 
-        @mail      = ::Mail.new
-        @mail.from = @from
-        @mail.to   = @to
+        email = ::Mail.new
+        email.to   = @to
+        email.from = @from
+        email
       end
 
     end

data/lib/backup/notifier/presently.rb

@@ -6,10 +6,6 @@ module Backup
   module Notifier
     class Presently < Base
 
-      ##
-      # Container for the Presently Client object
-      attr_accessor :presently_client
-
       ##
       # Presently subdomain
       attr_accessor :subdomain
@@ -22,16 +18,13 @@ module Backup
       # Group id
       attr_accessor :group_id
 
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done,
-      # put it above the super(model, exception)
-      def perform!(model, exception = false)
-        super(model, exception)
+      def initialize(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
       # Notify the user of the backup operation results.
@@ -58,14 +51,13 @@ module Backup
                when :warning then 'Warning'
                when :failure then 'Failure'
                end
-        message = "[Backup::%s] #{model.label} (#{model.trigger})" % name
-        presently_client.update(message)
+        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        send_message(message)
       end
 
-      ##
-      # Create a default Presently::Client object
-      def set_defaults!
-        @presently_client = Client.new(subdomain, user_name, password, group_id)
+      def send_message(message)
+        client = Client.new(subdomain, user_name, password, group_id)
+        client.update(message)
       end
 
       class Client

data/lib/backup/notifier/prowl.rb

@@ -8,10 +8,6 @@ module Backup
   module Notifier
     class Prowl < Base
 
-      ##
-      # Container for the Twitter Client object
-      attr_accessor :prowl_client
-
       ##
       # Application name
       # Tell something like your server name. Example: "Server1 Backup"
@@ -22,15 +18,13 @@ module Backup
       # Create a Prowl account and request an API key on prowlapp.com.
       attr_accessor :api_key
 
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done, put it above the super(model, exception)
-      def perform!(model, exception = false)
-        super(model, exception)
+      def initialize(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
       # Notify the user of the backup operation results.
@@ -58,14 +52,12 @@ module Backup
                when :failure then 'Failure'
                end
         message = '[Backup::%s]' % name
-        prowl_client.notify(message, "#{model.label} (#{model.trigger})")
+        send_message(message)
       end
 
-      ##
-      # Configures the Prowler object by passing in the @api_key and the
-      # @application. Instantiates and sets the @prowl_client object
-      def set_defaults!
-        @prowl_client = Prowler.new(:application => application, :api_key => api_key)
+      def send_message(message)
+        client = Prowler.new(:application => application, :api_key => api_key)
+        client.notify(message, "#{@model.label} (#{@model.trigger})")
       end
 
     end

data/lib/backup/notifier/twitter.rb

@@ -8,10 +8,6 @@ module Backup
   module Notifier
     class Twitter < Base
 
-      ##
-      # Container for the Twitter Client object
-      attr_accessor :twitter_client
-
       ##
       # Twitter consumer key credentials
       attr_accessor :consumer_key, :consumer_secret
@@ -20,15 +16,13 @@ module Backup
       # OAuth credentials
       attr_accessor :oauth_token, :oauth_token_secret
 
-      ##
-      # Performs the notification
-      # Extends from super class. Must call super(model, exception).
-      # If any pre-configuration needs to be done, put it above the super(model, exception)
-      def perform!(model, exception = false)
-        super(model, exception)
+      def initialize(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
       end
 
-    private
+      private
 
       ##
       # Notify the user of the backup operation results.
@@ -55,21 +49,20 @@ module Backup
                when :warning then 'Warning'
                when :failure then 'Failure'
                end
-        message = "[Backup::%s] #{model.label} (#{model.trigger})" % name
-        twitter_client.update(message)
+        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
+        send_message(message)
       end
 
-      ##
-      # Configures the Twitter object by passing in the @consumer_key, @consumer_secret
-      # @oauth_token and @oauth_token_secret. Instantiates and sets the @twitter_client object
-      def set_defaults!
+      def send_message(message)
         ::Twitter.configure do |config|
           config.consumer_key       = @consumer_key
           config.consumer_secret    = @consumer_secret
           config.oauth_token        = @oauth_token
           config.oauth_token_secret = @oauth_token_secret
         end
-        @twitter_client = ::Twitter::Client.new
+
+        client = ::Twitter::Client.new
+        client.update(message)
       end
 
     end