backedup 5.0.0.beta.3

data/lib/backup/notifier/mail.rb

@@ -0,0 +1,232 @@
+require "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 by this method:
+      #   {#address}, {#port}, {#domain}, {#user_name}, {#password},
+      #   {#authentication}, {#encryption}, {#openssl_verify_mode}
+      #
+      # [:sendmail - ::Mail::Sendmail]
+      #   Settings used by this method:
+      #   {#sendmail_args}
+      #
+      # [:exim - ::Mail::Exim]
+      #   Settings used by this method:
+      #   {#exim_args}
+      #
+      # [:file - ::Mail::FileDelivery]
+      #   Settings used by this method:
+      #   {#mail_folder}
+      #
+      attr_accessor :delivery_method
+
+      ##
+      # 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
+
+      ##
+      # SMTP Server Address
+      attr_accessor :address
+
+      ##
+      # SMTP Server Port
+      attr_accessor :port
+
+      ##
+      # Your domain (if applicable)
+      attr_accessor :domain
+
+      ##
+      # SMTP Server Username (sender email's credentials)
+      attr_accessor :user_name
+
+      ##
+      # SMTP Server Password (sender email's credentials)
+      attr_accessor :password
+
+      ##
+      # Authentication type
+      #
+      # Acceptable values: +:plain+, +:login+, +:cram_md5+
+      attr_accessor :authentication
+
+      ##
+      # Set the method of encryption to be used for the +SMTP+ connection.
+      #
+      # [:starttls (default)]
+      #   Use +STARTTLS+ to upgrade the connection to a +SSL/TLS+ connection.
+      #
+      # [:tls or :ssl]
+      #   Use a +SSL/TLS+ connection.
+      #
+      # [:none]
+      #   No encryption will be used.
+      attr_accessor :encryption
+
+      ##
+      # OpenSSL Verify Mode
+      #
+      # Valid modes: +:none+, +:peer+, +:client_once+, +:fail_if_no_peer_cert+
+      # See +OpenSSL::SSL+ for details.
+      #
+      # Use +:none+ for a self-signed and/or wildcard certificate
+      attr_accessor :openssl_verify_mode
+
+      ##
+      # Optional arguments to pass to `sendmail`
+      #
+      # 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 -X/tmp/traffic.log'
+      attr_accessor :sendmail_args
+
+      ##
+      # 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`.
+      #
+      # Default location is '$HOME/Backup/emails'
+      attr_accessor :mail_folder
+
+      ##
+      # 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]
+        @encryption  ||= :starttls
+      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, 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 = new_email
+        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(sprintf("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
+
+        email.deliver! # raise error if unsuccessful
+      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"
+            opts = {
+              address: @address,
+              port: @port,
+              user_name: @user_name,
+              password: @password,
+              authentication: @authentication,
+              enable_starttls_auto: @encryption == :starttls,
+              openssl_verify_mode: @openssl_verify_mode,
+              ssl: @encryption == :ssl,
+              tls: @encryption == :tls
+            }
+
+            # Don't override default domain setting if domain not applicable.
+            # ref https://github.com/mikel/mail/blob/2.6.3/lib/mail/network/delivery_methods/smtp.rb#L82
+            opts[:domain] = @domain if @domain
+            opts
+          when "sendmail"
+            opts = {}
+            opts[:location] = utility(:sendmail)
+            opts[:arguments] = @sendmail_args if @sendmail_args
+            opts
+          when "exim"
+            opts = {}
+            opts[:location] = utility(:exim)
+            opts[: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
+
+        email = ::Mail.new
+        email.delivery_method method.to_sym, options
+        email.to       = to
+        email.from     = from
+        email.cc       = cc
+        email.bcc      = bcc
+        email.reply_to = reply_to
+        email
+      end
+    end
+  end
+end

data/lib/backup/notifier/nagios.rb

@@ -0,0 +1,65 @@
+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,79 @@
+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 @@
+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 |m, _|
+            "#{m.label} (#{m.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[:expects] = 200 # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+    end
+  end
+end

data/lib/backup/notifier/pushover.rb

@@ -0,0 +1,71 @@
+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[:expects] = 200 # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+    end
+  end
+end

data/lib/backup/notifier/ses.rb

@@ -0,0 +1,123 @@
+require "aws-sdk"
+require "mail"
+
+module Backup
+  module Notifier
+    class Ses < Base
+      ##
+      # Amazon Simple Email Service (SES) Credentials
+      attr_accessor :access_key_id, :secret_access_key, :use_iam_profile
+
+      ##
+      # 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
+        credentials = if use_iam_profile
+                        Aws::InstanceProfileCredentials.new
+                      else
+                        Aws::Credentials.new(access_key_id, secret_access_key)
+                      end
+
+        Aws::SES::Client.new(
+          region: region,
+          credentials: credentials
+        )
+      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))
+
+        # By default, the `mail` gem doesn't include BCC in raw output, which is
+        # needed for SES to send to those addresses.
+        email[:bcc].include_in_headers = true
+
+        send_log = send_log_on.include?(status)
+        template = Backup::Template.new(model: model, send_log: send_log)
+        email.body = template.result(sprintf("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
+
+        send_opts = {
+          raw_message: {
+            data: email.to_s
+          }
+        }
+
+        if email.respond_to?(:destinations)
+          send_opts[:destinations] = email.destinations
+        end
+
+        client.send_raw_email(send_opts)
+      end
+    end
+  end
+end