backup-agoddard 3.0.27

data/lib/backup/notifier/base.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Base
+      include Backup::Configuration::Helpers
+
+      ##
+      # When set to true, the user will be notified by email
+      # when a backup process ends without raising any exceptions
+      attr_accessor :on_success
+      alias :notify_on_success? :on_success
+
+      ##
+      # When set to true, the user will be notified by email
+      # when a backup process is successful, but has warnings
+      attr_accessor :on_warning
+      alias :notify_on_warning? :on_warning
+
+      ##
+      # When set to true, the user will be notified by email
+      # when a backup process raises an exception before finishing
+      attr_accessor :on_failure
+      alias :notify_on_failure? :on_failure
+
+      ##
+      # Called with super(model) from subclasses
+      def initialize(model)
+        @model = model
+        load_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 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
+
+        if action
+          log!
+          notify!(action)
+        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 "#{ notifier_name } started notifying about the process."
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/campfire.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+
+##
+# Load the HTTParty library from the gem
+Backup::Dependency.load('httparty')
+
+module Backup
+  module Notifier
+    class Campfire < Base
+
+      ##
+      # Campfire api authentication token
+      attr_accessor :api_token
+
+      ##
+      # Campfire account's subdomain
+      attr_accessor :subdomain
+
+      ##
+      # Campfire account's room id
+      attr_accessor :room_id
+
+      def initialize(model, &block)
+        super(model)
+
+        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`
+      #
+      # `: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`
+      #
+      # `: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`
+      #
+      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
+        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 } }
+          )
+        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
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/hipchat.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+# Load the HipChat library from the gem
+Backup::Dependency.load('hipchat')
+
+module Backup
+  module Notifier
+    class Hipchat < Base
+
+      ##
+      # The Hipchat API token
+      attr_accessor :token
+
+      ##
+      # Who the notification should appear from
+      attr_accessor :from
+
+      ##
+      # The rooms that should be notified
+      attr_accessor :rooms_notified
+
+      ##
+      # 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)
+      attr_accessor :warning_color
+
+      ##
+      # The background color of an error message.
+      # One of :yellow, :red, :green, :purple, or :random. (default: yellow)
+      attr_accessor :failure_color
+
+      def initialize(model, &block)
+        super(model)
+
+        @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`
+      #
+      # `: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`
+      #
+      # `: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`
+      #
+      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
+        send_message(message, color)
+      end
+
+      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

@@ -0,0 +1,206 @@
+# encoding: utf-8
+
+##
+# Only load the Mail gem when using Mail notifications
+Backup::Dependency.load('mail')
+
+module Backup
+  module Notifier
+    class Mail < Base
+
+      ##
+      # Mail delivery method to be used by the Mail gem.
+      # Supported methods:
+      #
+      # `:smtp` [::Mail::SMTP] (default)
+      # : Settings used only by this method:
+      # : `address`, `port`, `domain`, `user_name`, `password`
+      # : `authentication`, `enable_starttls_auto`, `openssl_verify_mode`
+      #
+      # `:sendmail` [::Mail::Sendmail]
+      # : Settings used only by this method:
+      # : `sendmail`, `sendmail_args`
+      #
+      # `:exim` [::Mail::Exim]
+      # : Settings used only by this method:
+      # : `exim`, `exim_args`
+      #
+      # `:file` [::Mail::FileDelivery]
+      # : Settings used only by this method:
+      # : `mail_folder`
+      #
+      attr_accessor :delivery_method
+
+      ##
+      # Sender and Receiver email addresses
+      # Examples:
+      #  sender   - my.email.address@gmail.com
+      #  receiver - your.email.address@gmail.com
+      attr_accessor :from, :to
+
+      ##
+      # The address to use
+      # Example: smtp.gmail.com
+      attr_accessor :address
+
+      ##
+      # The port to connect to
+      # Example: 587
+      attr_accessor :port
+
+      ##
+      # Your domain (if applicable)
+      # Example: mydomain.com
+      attr_accessor :domain
+
+      ##
+      # Username and Password (sender email's credentials)
+      # Examples:
+      #  user_name - meskyanichi
+      #  password  - my_secret_password
+      attr_accessor :user_name, :password
+
+      ##
+      # Authentication type
+      # Example: plain
+      attr_accessor :authentication
+
+      ##
+      # Automatically set TLS
+      # Example: true
+      attr_accessor :enable_starttls_auto
+
+      ##
+      # OpenSSL Verify Mode
+      # Example: none - Only use this option for a self-signed and/or wildcard certificate
+      attr_accessor :openssl_verify_mode
+
+      ##
+      # When using the `:sendmail` `delivery_method` option,
+      # this may be used to specify the absolute path to `sendmail` (if needed)
+      # 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.
+      # Example: '-i -t -X/tmp/traffic.log'
+      attr_accessor :sendmail_args
+
+      ##
+      # When using the `:exim` `delivery_method` option,
+      # this may be used to specify the absolute path to `exim` (if needed)
+      # 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.
+      # Example: '-i -t -X/tmp/traffic.log'
+      attr_accessor :exim_args
+
+      ##
+      # Folder where mail will be kept when using the `:file` `delivery_method` option.
+      # Default location is '$HOME/Backup/emails'
+      # Example: '/tmp/test-mails'
+      attr_accessor :mail_folder
+
+      def initialize(model, &block)
+        super(model)
+
+        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`
+      #
+      # `: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`
+      #
+      # `: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`
+      #
+      def notify!(status)
+        name, send_log =
+            case status
+            when :success then [ 'Success', false ]
+            when :warning then [ 'Warning', true  ]
+            when :failure then [ 'Failure', true  ]
+            end
+
+        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
+          email.convert_to_multipart
+          email.attachments["#{@model.time}.#{@model.trigger}.log"] = {
+            :mime_type => 'text/plain;',
+            :content   => Logger.messages.join("\n")
+          }
+        end
+
+        email.deliver!
+      end
+
+      ##
+      # 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'
+
+        options =
+            case method
+            when 'smtp'
+              { :address              => @address,
+                :port                 => @port,
+                :domain               => @domain,
+                :user_name            => @user_name,
+                :password             => @password,
+                :authentication       => @authentication,
+                :enable_starttls_auto => @enable_starttls_auto,
+                :openssl_verify_mode  => @openssl_verify_mode }
+            when 'sendmail'
+              opts = {}
+              opts.merge!(:location  => File.expand_path(@sendmail)) if @sendmail
+              opts.merge!(:arguments => @sendmail_args) if @sendmail_args
+              opts
+            when 'exim'
+              opts = {}
+              opts.merge!(:location  => File.expand_path(@exim)) if @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
+
+        ::Mail.defaults do
+          delivery_method method.to_sym, options
+        end
+
+        email = ::Mail.new
+        email.to   = @to
+        email.from = @from
+        email
+      end
+
+    end
+  end
+end