module Agents class HipchatAgent < Agent include FormConfigurable cannot_be_scheduled! cannot_create_events! gem_dependency_check { defined?(HipChat) } description <<-MD The Hipchat Agent sends messages to a Hipchat Room #{'## Include `hipchat` in your Gemfile to use this Agent!' if dependencies_missing?} To authenticate you need to set the `auth_token`, you can get one at your Hipchat Group Admin page which you can find here: `https://`yoursubdomain`.hipchat.com/admin/api` Change the `room_name` to the name of the room you want to send notifications to. You can provide a `username` and a `message`. If you want to use mentions change `format` to "text" ([details](https://www.hipchat.com/docs/api/method/rooms/message)). If you want your message to notify the room members change `notify` to "True". Modify the background color of your message via the `color` attribute (one of "yellow", "red", "green", "purple", "gray", or "random") Have a look at the [Wiki](https://github.com/cantino/huginn/wiki/Formatting-Events-using-Liquid) to learn more about liquid templating. MD def default_options { 'auth_token' => '', 'room_name' => '', 'username' => "Huginn", 'message' => "Hello from Huginn!", 'notify' => false, 'color' => 'yellow', 'format' => 'html' } end form_configurable :auth_token, roles: :validatable form_configurable :room_name, roles: :completable form_configurable :username form_configurable :message, type: :text form_configurable :notify, type: :boolean form_configurable :color, type: :array, values: ['yellow', 'red', 'green', 'purple', 'gray', 'random'] form_configurable :format, type: :array, values: ['html', 'text'] def validate_auth_token client.rooms true rescue HipChat::UnknownResponseCode return false end def complete_room_name client.rooms.collect { |room| {text: room.name, id: room.name} } end def validate_options errors.add(:base, "you need to specify a hipchat auth_token or provide a credential named hipchat_auth_token") unless options['auth_token'].present? || credential('hipchat_auth_token').present? errors.add(:base, "you need to specify a room_name or a room_name_path") if options['room_name'].blank? && options['room_name_path'].blank? end def working? (last_receive_at.present? && last_error_log_at.nil?) || (last_receive_at.present? && last_error_log_at.present? && last_receive_at > last_error_log_at) end def receive(incoming_events) incoming_events.each do |event| mo = interpolated(event) client[mo[:room_name]].send(mo[:username][0..14], mo[:message], notify: boolify(mo[:notify]), color: mo[:color], message_format: mo[:format].presence || 'html' ) end end private def client @client ||= HipChat::Client.new(interpolated[:auth_token].presence || credential('hipchat_auth_token')) end end end