hubot-github-event-announcer/src/event-manager.coffee

Announces GitHub webhook events

util = require 'util'

# Public: Manages receiving and announcing GitHub events.
class EventManager
  # Public: Initializes a manager for the given Robot.
  #
  # * `robot` Hubot to work with to handle events.
  constructor: (@robot) ->

  # Public: Announces the event.
  #
  # * `event` Event to announce.
  # * `announce` {Function} to announce messages that accepts:
  #   * `room` Room {String} to announce the event to.
  #   * `message` Message {String} to use to announce the event.
  announceEvent: (event, announce) ->
    try
      formatters = @getFormatters()
      return unless formatters[event.type] or process.env.HUBOT_GITHUB_EVENT_ANNOUNCE_UNHANDLED

      formatter = formatters[event.type] ? formatters.unhandled
      message = formatter(event)

      if message
        announce(event.room, message)
      else
        @robot.logger.info "Formatter for #{event.type} event refused to format:
          #{util.inspect(event)}"

    catch err
      if process.env.HUBOT_GITHUB_EVENT_ANNOUNCE_EXCEPTIONS
        announce event.room, """
          Exception occurred while formatting #{event.type} event

          #{util.inspect(err)}
          """

      @robot.emit 'error', err, "Exception occurred while formatting #{event.type} event"

  # Public: Receives the GitHub event webhook request.
  #
  # * `req` {Request} of the webhook.
  # * `emit` {Function} to emit events that accepts:
  #   * `event` {Object} consisting of:
  #     * `data` Event data
  #     * `id` Event ID
  #     * `room` Room to announce the event to.
  #     * `signature` Signature validating the event.
  #     * `type` Type of the event.
  receiveHook: (req, emit) ->
    event =
      data: req.body
      id: req.get('X-Github-Delivery')
      room: req.query.room ? process.env.HUBOT_GITHUB_EVENT_DEFAULT_ROOM
      signature: req.get('X-Github-Signature')
      type: req.get('X-Github-Event')

    @robot.logger.info "Received event: #{util.inspect(event)}"
    emit(event)

  # Private: Gets the list of event formatters.
  #
  # Returns an {Object} of event names mapped to their formatter.
  getFormatters: ->
    require './formatters/all'

module.exports = EventManager