hubot-async/src/response.coffee

A simple helpful robot for your Company

class Response
  # Public: Responses are sent to matching listeners. Messages know about the
  # content and user that made the original message, and how to reply back to
  # them.
  #
  # robot   - A Robot instance.
  # message - A Message instance.
  # match   - A Match object from the successful Regex match.
  constructor: (@robot, @message, @match) ->
    @envelope =
      room: @message.room
      user: @message.user
      message: @message

  # Public: Posts a message back to the chat source
  #
  # strings - One or more strings to be posted. The order of these strings
  #           should be kept intact.
  #
  # Returns nothing.
  send: (strings...) ->
    @runWithMiddleware("send", { plaintext: true }, strings...)

  # Public: Posts an emote back to the chat source
  #
  # strings - One or more strings to be posted. The order of these strings
  #           should be kept intact.
  #
  # Returns nothing.
  emote: (strings...) ->
    @runWithMiddleware("emote", { plaintext: true }, strings...)

  # Public: Posts a message mentioning the current user.
  #
  # strings - One or more strings to be posted. The order of these strings
  #           should be kept intact.
  #
  # Returns nothing.
  reply: (strings...) ->
    @runWithMiddleware("reply", { plaintext: true }, strings...)

  # Public: Posts a topic changing message
  #
  # strings - One or more strings to set as the topic of the
  #           room the bot is in.
  #
  # Returns nothing.
  topic: (strings...) ->
    @runWithMiddleware("topic", { plaintext: true }, strings...)

  # Public: Play a sound in the chat source
  #
  # strings - One or more strings to be posted as sounds to play. The order of
  #           these strings should be kept intact.
  #
  # Returns nothing
  play: (strings...) ->
    @runWithMiddleware("play", strings...)

  # Public: Posts a message in an unlogged room
  #
  # strings - One or more strings to be posted. The order of these strings
  #           should be kept intact.
  #
  # Returns promise - resolves with context when middleware completes
  locked: (strings...) ->
    @runWithMiddleware("locked", { plaintext: true }, strings...)

  # Private: Call with a method for the given strings using response
  # middleware.
  runWithMiddleware: (methodName, opts, strings...) ->
    callback = undefined
    copy = strings.slice(0)
    if typeof(copy[copy.length - 1]) == 'function'
      callback = copy.pop()
    context = {response: @, strings: copy, method: methodName}
    context.plaintext = true if opts.plaintext?
    responseMiddlewareDone = ->
    runAdapterSend = (_, done) =>
      result = context.strings
      result.push(callback) if callback?
      @robot.adapter[methodName](@envelope, result...)
      done()
    @robot.middleware.response.execute context,
                                       runAdapterSend,
                                       responseMiddlewareDone

  # Public: Picks a random item from the given items.
  #
  # items - An Array of items.
  #
  # Returns a random item.
  random: (items) ->
    items[ Math.floor(Math.random() * items.length) ]

  # Public: Tell the message to stop dispatching to listeners
  #
  # Returns nothing.
  finish: ->
    @message.finish()

  # Public: Creates a scoped http client with chainable methods for
  # modifying the request. This doesn't actually make a request though.
  # Once your request is assembled, you can call `get()`/`post()`/etc to
  # send the request.
  #
  # Returns a ScopedClient instance.
  http: (url, options) ->
    @robot.http(url, options)

module.exports = Response