cm-backup 1.0.0

data/lib/backup/notifier/nagios.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Nagios < Base
+
+      ##
+      # Host of Nagios server to notify on backup completion.
+      attr_accessor :nagios_host
+
+      ##
+      # Port of Nagios server to notify on backup completion.
+      attr_accessor :nagios_port
+
+      ##
+      # Nagios nrpe configuration file.
+      attr_accessor :send_nsca_cfg
+
+      ##
+      # Name of the Nagios service for the backup check.
+      attr_accessor :service_name
+
+      ##
+      # Host name in Nagios for the backup check.
+      attr_accessor :service_host
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @nagios_host  ||= Config.hostname
+        @nagios_port  ||= 5667
+        @send_nsca_cfg||= "/etc/nagios/send_nsca.cfg"
+        @service_name ||= "Backup #{ model.trigger }"
+        @service_host ||= Config.hostname
+      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` is `true`.
+      #
+      # `:warning`
+      # : 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 if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(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 }'"
+        msg = [service_host, service_name, model.exit_status, message].join("\t")
+        run("echo '#{ msg }' | #{ cmd }")
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/pagerduty.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require 'pagerduty'
+
+module Backup
+  module Notifier
+    class PagerDuty < Base
+
+      ##
+      # PagerDuty Service API Key. Should be a 32 character hex string.
+      attr_accessor :service_key
+
+      ##
+      # Determines if a backup with a warning should resolve an incident rather
+      # than trigger one.
+      #
+      # Defaults to false.
+      attr_accessor :resolve_on_warning
+
+      def initialize(mode, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @resolve_on_warning ||= false
+      end
+
+      private
+
+      ##
+      # Trigger or resolve a PagerDuty incident for this model
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : The incident will be resolved if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : An incident will be triggered if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : An incident will be triggered if `on_failure` is `true`.
+      #
+      def notify!(status)
+        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
+          }
+        }
+
+        event_type = case status
+                     when :success then :resolve
+                     when :warning then resolve_on_warning ? :resolve : :trigger
+                     when :failure then :trigger
+                     end
+
+        case event_type
+        when :trigger
+          pagerduty.trigger(incident_description, incident_details)
+        when :resolve
+          incident = pagerduty.get_incident(incident_key)
+          incident.resolve(incident_description, incident_details)
+        end
+      end
+
+      def pagerduty
+        @pagerduty ||= Pagerduty.new(service_key)
+      end
+    end
+  end
+end

data/lib/backup/notifier/prowl.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require 'uri'
+
+module Backup
+  module Notifier
+    class Prowl < Base
+
+      ##
+      # Application name
+      # Tell something like your server name. Example: "Server1 Backup"
+      attr_accessor :application
+
+      ##
+      # API-Key
+      # Create a Prowl account and request an API key on prowlapp.com.
+      attr_accessor :api_key
+
+      def initialize(model, &block)
+        @message = lambda do |model, data|
+          "#{ model.label } (#{ model.trigger })"
+        end
+        super
+        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` is `true`.
+      #
+      # `:warning`
+      # : 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 if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        send_message(status)
+      end
+
+      def send_message(status)
+        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)
+        }
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => URI.encode_www_form(data)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/pushover.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require 'uri'
+
+module Backup
+  module Notifier
+    class Pushover < Base
+
+      ##
+      # The API User Token
+      attr_accessor :user
+
+      ##
+      # The API Application Token
+      attr_accessor :token
+
+      ##
+      # The user's device identifier to sent the message directly to,
+      # rather than all of the user's devices
+      attr_accessor :device
+
+      ##
+      # The message title
+      attr_accessor :title
+
+      ##
+      # The priority of the notification
+      attr_accessor :priority
+
+      def initialize(model, &block)
+        super
+        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` is `true`.
+      #
+      # `:warning`
+      # : 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 if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(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 }
+        [: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)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/ses.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require 'aws/ses'
+
+module Backup
+  module Notifier
+    class Ses < Base
+
+      ##
+      # Amazon Simple Email Service (SES) Credentials
+      attr_accessor :access_key_id, :secret_access_key
+
+      ##
+      # SES Region
+      attr_accessor :region
+
+      ##
+      # Sender Email Address
+      attr_accessor :from
+
+      ##
+      # Receiver Email Address
+      attr_accessor :to
+
+      ##
+      # CC receiver Email Address
+      attr_accessor :cc
+
+      ##
+      # BCC receiver Email Address
+      attr_accessor :bcc
+
+      ##
+      # Set reply to email address
+      attr_accessor :reply_to
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @region ||= 'eu-west-1'
+        @send_log_on ||= [:warning, :failure]
+      end
+
+      ##
+      # 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
+
+      private
+
+      def client
+        AWS::SES::Base.new(
+          :access_key_id => access_key_id,
+          :secret_access_key => secret_access_key,
+          :server => "email.#{region}.amazonaws.com"
+        )
+      end
+
+      ##
+      # 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` 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` or `on_success` is `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)
+        email = ::Mail.new
+        email.to       = to
+        email.from     = from
+        email.cc       = cc
+        email.bcc      = bcc
+        email.reply_to = reply_to
+        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)
+
+        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")
+          }
+        end
+
+        client.send_raw_email(email)
+      end
+    end
+  end
+end

data/lib/backup/notifier/slack.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+require 'uri'
+require 'json'
+
+module Backup
+  module Notifier
+    class Slack < Base
+
+      ##
+      # The incoming webhook url
+      attr_accessor :webhook_url
+
+      ##
+      # The channel to send messages to
+      attr_accessor :channel
+
+      ##
+      # The username to display along with the notification
+      attr_accessor :username
+
+      ##
+      # The emoji icon to display along with the notification
+      #
+      # See http://www.emoji-cheat-sheet.com for a list of icons.
+      #
+      # Default: :floppy_disk:
+      attr_accessor :icon_emoji
+
+      ##
+      # 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]
+        @icon_emoji  ||= ':floppy_disk:'
+      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` is `true`.
+      #
+      # `:warning`
+      # : 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 if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        data = {
+          :text => message.call(model, :status => status_data_for(status)),
+          :attachments => [attachment(status)]
+        }
+        [:channel, :username, :icon_emoji].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(:payload => JSON.dump(data))
+        }
+        options.merge!(: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   => [
+            {
+              :title => "Job",
+              :value => "#{model.label} (#{model.trigger})",
+              :short => false
+            },
+            {
+              :title => "Started",
+              :value => model.started_at,
+              :short => true
+            },
+            {
+              :title => "Finished",
+              :value => model.finished_at,
+              :short => true
+            },
+            {
+              :title => "Duration",
+              :value => model.duration,
+              :short => true
+            },
+            {
+              :title => "Version",
+              :value => "Backup v#{Backup::VERSION}\nRuby: #{RUBY_DESCRIPTION}",
+              :short => false
+            },
+            log_field(status)
+          ].compact
+        }
+      end
+
+      def log_field(status)
+        send_log = send_log_on.include?(status)
+
+        return {
+          :title => "Detailed Backup Log",
+          :value => Logger.messages.map(&:formatted_lines).flatten.join("\n"),
+          :short => false,
+        } if send_log
+      end
+
+      def color(status)
+        case status
+        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)!'
+        end
+      end
+
+      def uri
+        @uri ||= webhook_url
+      end
+    end
+  end
+end