backup/backup

View on GitHub
lib/backup/notifier/hipchat.rb

Summary

Maintainability
A
35 mins
Test Coverage
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