backup-bouchard 4.4.1

data/lib/backup/notifier/hipchat.rb

@@ -0,0 +1,116 @@
+require "hipchat"
+
+module Backup
+  module Notifier
+    class Hipchat < Base
+      ##
+      # The Hipchat API token
+      attr_accessor :token
+
+      ##
+      # The Hipchat API version
+      # Either 'v1' or 'v2' (default is 'v1')
+      attr_accessor :api_version
+
+      ##
+      # Who the notification should appear from
+      attr_accessor :from
+
+      ##
+      # Custom server URL
+      attr_accessor :server_url
+
+      ##
+      # 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
+        instance_eval(&block) if block_given?
+
+        @notify_users   ||= false
+        @rooms_notified ||= []
+        @success_color  ||= "yellow"
+        @warning_color  ||= "yellow"
+        @failure_color  ||= "yellow"
+        @api_version    ||= "v1"
+      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)
+        status_data = status_data_for(status)
+        msg = message.call(model, status: status_data)
+        send_message(msg, status_data[:color])
+      end
+
+      def client_options
+        { api_version: @api_version }.tap do |h|
+          h[:server_url] = server_url if server_url
+        end
+      end
+
+      # Hipchat::Client will raise an error if unsuccessful.
+      def send_message(msg, color)
+        client = HipChat::Client.new(token, client_options)
+        rooms_to_notify.each do |room|
+          client[room].send(from, msg, color: color, notify: notify_users)
+        end
+      end
+
+      def rooms_to_notify
+        Array(rooms_notified).map { |r| r.split(",").map(&:strip) }.flatten
+      end
+
+      def status_data_for(status)
+        data = super(status)
+        data[:color] = status_color_for(status)
+        data
+      end
+
+      def status_color_for(status)
+        {
+          success: success_color,
+          warning: warning_color,
+          failure: failure_color
+        }[status]
+      end
+    end
+  end
+end

data/lib/backup/notifier/http_post.rb

@@ -0,0 +1,114 @@
+require "uri"
+
+module Backup
+  module Notifier
+    class HttpPost < Base
+      ##
+      # URI to post notification to.
+      #
+      # URI scheme may be `http` or `https`.
+      #
+      # If Basic Authentication is needed, supply the `user:password` in the URI.
+      # e.g. 'https://user:pass@www.example.com/path'
+      #
+      # Port may also be supplied.
+      # e.g. 'http://www.example.com:8080/path'
+      attr_accessor :uri
+
+      ##
+      # Hash of additional HTTP headers to send.
+      #
+      # This notifier sets the following headers:
+      # { 'User-Agent'   => "Backup/#{ Backup::VERSION }",
+      #   'Content-Type' => 'x-www-form-urlencoded' }
+      #
+      # 'Content-Type' may not be changed.
+      # 'User-Agent' may be overridden or omitted by setting it to +nil+.
+      # e.g. { 'Authorization' => 'my_auth_info', 'User-Agent' => nil }
+      attr_accessor :headers
+
+      ##
+      # Hash of additional POST parameters to send.
+      #
+      # This notifier will set two parameters:
+      # { 'status'  => 'success|warning|failure',
+      #   'message' => '[Backup::(Success|Warning|Failure)] label (trigger)' }
+      #
+      # 'status' may not be changed.
+      # 'message' may be overridden or omitted by setting a +nil+ value.
+      # e.g. { 'auth_token' => 'my_token', 'message' => nil }
+      attr_accessor :params
+
+      ##
+      # Successful HTTP Status Code(s) that should be returned.
+      #
+      # This may be a single code or an Array of acceptable codes.
+      # e.g. [200, 201, 204]
+      #
+      # If any other response code is returned, the request will be retried
+      # using `max_retries` and `retry_waitsec`.
+      #
+      # Default: 200
+      attr_accessor :success_codes
+
+      ##
+      # Verify the server's certificate when using SSL.
+      #
+      # This will default to +true+ for most systems.
+      # It may be forced by setting to +true+, or disabled by setting to +false+.
+      attr_accessor :ssl_verify_peer
+
+      ##
+      # Path to a +cacert.pem+ file to use for +ssl_verify_peer+.
+      #
+      # This is provided (via Excon), but may be specified if needed.
+      attr_accessor :ssl_ca_file
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @headers ||= {}
+        @params  ||= {}
+        @success_codes ||= 200
+      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)
+        msg = message.call(model, status: status_data_for(status))
+
+        opts = {
+          headers: { "User-Agent" => "Backup/#{VERSION}" }
+            .merge(headers).reject { |_, value| value.nil? }
+            .merge("Content-Type" => "application/x-www-form-urlencoded"),
+          body: URI.encode_www_form({ "message" => msg }
+              .merge(params).reject { |_, value| value.nil? }
+              .merge("status" => status.to_s)),
+          expects: success_codes # raise error if unsuccessful
+        }
+        opts[:ssl_verify_peer] = ssl_verify_peer unless ssl_verify_peer.nil?
+        opts[:ssl_ca_file] = ssl_ca_file if ssl_ca_file
+
+        Excon.post(uri, opts)
+      end
+    end
+  end
+end

data/lib/backup/notifier/mail.rb

@@ -0,0 +1,246 @@
+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
+
+# Patch mail v2.5.4 Exim delivery method
+# https://github.com/backup/backup/issues/446
+# https://github.com/mikel/mail/pull/546
+module Mail
+  class Exim
+    def self.call(path, arguments, _destinations, encoded_message)
+      popen "#{path} #{arguments}" do |io|
+        io.puts encoded_message.to_lf
+        io.flush
+      end
+    end
+  end
+end