backup-ssh 4.1.10

data/lib/backup/notifier/prowl.rb

@@ -0,0 +1,69 @@
+# 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)
+        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)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
+        send_message(tag)
+      end
+
+      def send_message(message)
+        uri = 'https://api.prowlapp.com/publicapi/add'
+        data = {
+          :application  => application,
+          :apikey       => api_key,
+          :event        => message,
+          :description  => "#{ model.label } (#{ model.trigger })"
+        }
+        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,80 @@
+# 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)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :failure then '[Backup::Failure]'
+              when :warning then '[Backup::Warning]'
+              end
+        message = "#{ tag } #{ model.label } (#{ model.trigger })"
+        send_message(message)
+      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,94 @@
+# 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
+
+      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)
+        tag = case status
+                when :success then '[Backup::Success]'
+                when :warning then '[Backup::Warning]'
+                when :failure then '[Backup::Failure]'
+              end
+
+        email = ::Mail.new(:to => to, :from => from)
+        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"] = {
+            :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,154 @@
+# 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)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :failure then '[Backup::Failure]'
+              when :warning then '[Backup::Warning]'
+              end
+        message = "#{ tag } #{ model.label } (#{ model.trigger })"
+
+        data = { :text => message }
+        [:channel, :username, :icon_emoji].each do |param|
+          val = send(param)
+          data.merge!(param => val) if val
+        end
+
+        data.merge!(:attachments => [attachment(status)])
+
+        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

data/lib/backup/notifier/twitter.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'twitter'
+
+module Backup
+  module Notifier
+    class Twitter < Base
+
+      ##
+      # Twitter consumer key credentials
+      attr_accessor :consumer_key, :consumer_secret
+
+      ##
+      # OAuth credentials
+      attr_accessor :oauth_token, :oauth_token_secret
+
+      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)
+        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 }) (@ #{ model.time })"
+        send_message(message)
+      end
+
+      # Twitter::Client will raise an error if unsuccessful.
+      def send_message(message)
+        client = ::Twitter::REST::Client.new do |config|
+          config.consumer_key        = @consumer_key
+          config.consumer_secret     = @consumer_secret
+          config.access_token        = @oauth_token
+          config.access_token_secret = @oauth_token_secret
+        end
+
+        client.update(message)
+      end
+
+    end
+  end
+end