Merge pull request #360 from mbland/reaction-added-v3

Handle reaction_added messages

Author: Don Goodman-Wilson

src/bot.coffee

@@ -1,6 +1,7 @@
 {Adapter, TextMessage, EnterMessage, LeaveMessage, TopicMessage, Message, CatchAllMessage} = require.main.require 'hubot'
 
 SlackClient = require './client'
+ReactionMessage = require './reaction-message'
 
 class SlackBot extends Adapter
 
@@ -20,6 +21,8 @@ class SlackBot extends Adapter
     @client.on 'close', @close
     @client.on 'error', @error
     @client.on 'message', @message
+    @client.on 'reaction_added', @reaction
+    @client.on 'reaction_removed', @reaction
     @client.on 'authenticated', @authenticated
 
     # Start logging in
@@ -157,6 +160,16 @@ class SlackBot extends Adapter
         message.user = user
         @receive new CatchAllMessage(message)
 
+  ###
+  Reaction added/removed event received from Slack
+  ###
+  reaction: (message) =>
+    {type, user, reaction, item_user, item, event_ts} = message
+    return if (user == @self.id) || (user == @self.bot_id) #Ignore anything we sent
 
+    user = @client.rtm.dataStore.getUserById(user)
+    user.room = item.channel
+    item_user = @client.rtm.dataStore.getUserById(item_user)
+    @receive new ReactionMessage(type, user, reaction, item_user, item, event_ts)
 
-module.exports = SlackBot
+module.exports = SlackBot

src/reaction-message.coffee

@@ -0,0 +1,16 @@
+{Message} = require.main.require 'hubot'
+
+class ReactionMessage extends Message
+  # Represents a message generated by an emoji reaction event
+  #
+  # type      - A String indicating 'reaction_added' or 'reaction_removed'
+  # user      - A User instance that reacted to the item.
+  # reaction  - A String identifying the emoji reaction.
+  # item_user - A String indicating the user that posted the item.
+  # item      - An Object identifying the target message, file, or comment item.
+  # event_ts  - A String of the reaction event timestamp.
+  constructor: (@type, @user, @reaction, @item_user, @item, @event_ts) ->
+    super @user
+    @type = @type.replace('reaction_', '')
+
+module.exports = ReactionMessage

test/bot.coffee

@@ -1,5 +1,6 @@
 should = require 'should'
 {Adapter, TextMessage, EnterMessage, LeaveMessage, TopicMessage, Message, CatchAllMessage} = require.main.require 'hubot'
+ReactionMessage = require '../src/reaction-message'
 
 describe 'Adapter', ->
   it 'Should initialize with a robot', ->
@@ -144,6 +145,36 @@ describe 'Handling incoming messages', ->
     should.equal (@stubs._received instanceof TopicMessage), true
     @stubs._received.user.id.should.equal @stubs.user.id
 
+  it 'Should handle reaction_added events as envisioned', ->
+    reactionMessage = {
+      type: 'reaction_added', user: @stubs.user.id, item_user: @stubs.self.id
+      item: { type: 'message', channel: @stubs.channel.id, ts: '1360782804.083113'
+      },
+      reaction: 'thumbsup', event_ts: '1360782804.083113'
+    }
+    @slackbot.reaction reactionMessage
+    should.equal (@stubs._received instanceof ReactionMessage), true
+    should.equal @stubs._received.user.id, @stubs.user.id
+    should.equal @stubs._received.user.room, @stubs.channel.id
+    should.equal @stubs._received.item_user.id, @stubs.self.id
+    should.equal @stubs._received.type, 'added'
+    should.equal @stubs._received.reaction, 'thumbsup'
+
+  it 'Should handle reaction_removed events as envisioned', ->
+    reactionMessage = {
+      type: 'reaction_removed', user: @stubs.user.id, item_user: @stubs.self.id
+      item: { type: 'message', channel: @stubs.channel.id, ts: '1360782804.083113'
+      },
+      reaction: 'thumbsup', event_ts: '1360782804.083113'
+    }
+    @slackbot.reaction reactionMessage
+    should.equal (@stubs._received instanceof ReactionMessage), true
+    should.equal @stubs._received.user.id, @stubs.user.id
+    should.equal @stubs._received.user.room, @stubs.channel.id
+    should.equal @stubs._received.item_user.id, @stubs.self.id
+    should.equal @stubs._received.type, 'removed'
+    should.equal @stubs._received.reaction, 'thumbsup'
+
   it 'Should handle unknown events as catchalls', ->
     @slackbot.message {subtype: 'hidey_ho', user: @stubs.user, channel: @stubs.channel}
     should.equal (@stubs._received instanceof CatchAllMessage), true
@@ -159,3 +190,13 @@ describe 'Handling incoming messages', ->
   it 'Should ignore messages it sent itself, if sent as a botuser', ->
     @slackbot.message { subtype: 'bot_message', bot: @stubs.self_bot, channel: @stubs.channel, text: 'Ignore me' }
     should.equal @stubs._received, undefined
+
+  it 'Should ignore reaction events that it generated itself', ->
+    reactionMessage = { type: 'reaction_removed', user: @stubs.self.id, reaction: 'thumbsup', event_ts: '1360782804.083113' }
+    @slackbot.reaction reactionMessage
+    should.equal @stubs._received, undefined
+
+  it 'Should ignore reaction events that it generated itself as a botuser', ->
+    reactionMessage = { type: 'reaction_added', user: @stubs.self_bot.id, reaction: 'thumbsup', event_ts: '1360782804.083113' }
+    @slackbot.reaction reactionMessage
+    should.equal @stubs._received, undefined

test/stubs.coffee

@@ -108,6 +108,13 @@ beforeEach ->
     sendMessage: (msg, room) =>
       @stubs.send room, msg
     dataStore:
+      getUserById: (id) =>
+        switch id
+          when @stubs.user.id then @stubs.user
+          when @stubs.bot.id then @stubs.bot
+          when @stubs.self.id then @stubs.self
+          when @stubs.self_bot.id then @stubs.self_bot
+          else undefined
       getChannelByName: (name) =>
         switch name
           when 'known_room' then {id: 'C00000004'}