Merge pull request #107 from jonfreedman/master

Optional behavior to ignore message history if required

Author: markstory

package.json

@@ -28,7 +28,8 @@
     "node": ">=0.10"
   },
   "dependencies": {
-    "node-xmpp-client": "3.0.0"
+    "node-xmpp-client": "3.0.0",
+    "uuid": "2.0.2"
   },
   "devDependencies": {
     "coffee-script": "1.1.3",

src/xmpp.coffee

@@ -1,11 +1,14 @@
 {Adapter,Robot,TextMessage,EnterMessage,LeaveMessage} = require 'hubot'
 {JID, Stanza, Client, parse, Element} = require 'node-xmpp-client'
+uuid = require 'uuid'
 util = require 'util'
 
 class XmppBot extends Adapter
 
   reconnectTryCount: 0
   currentIqId: 1001
+  joining: []
+  joined: []
 
   constructor: ( robot ) ->
     @robot = robot
@@ -143,6 +146,17 @@ class XmppBot extends Adapter
         x.c('password').t(room.password)
       return x
 
+    if process.env.HUBOT_XMPP_UUID_ON_JOIN?
+      # send a guid message and ignore any responses until that's been received
+      uuid = uuid.v4()
+      params = {
+        to: room.jid
+        type: 'groupchat'
+      }
+      @robot.logger.info "Joining #{room.jid} with #{uuid}"
+      @joining[uuid] = room.jid
+      @client.send new Stanza('message', params).c('body').t(uuid)
+
   # XMPP Leaving a room - http://xmpp.org/extensions/xep-0045.html#exit
   leaveRoom: (room) ->
     # messageFromRoom check for joined rooms so remvove it from the list
@@ -244,6 +258,11 @@ class XmppBot extends Adapter
     from = stanza.attrs.from
     message = body.getText()
 
+    # check if this is a join guid and if so start accepting messages
+    if process.env.HUBOT_XMPP_UUID_ON_JOIN? and message of @joining
+      @robot.logger.info "Now accepting messages from #{@joining[message]}"
+      @joined.push @joining[message]
+
     if stanza.attrs.type == 'groupchat'
       # Everything before the / is the room name in groupchat JID
       [room, user] = from.split '/'
@@ -280,6 +299,9 @@ class XmppBot extends Adapter
     user.room = room
     user.privateChatJID = privateChatJID if privateChatJID
 
+    # only process persistent chant messages if we have matched a join
+    return if process.env.HUBOT_XMPP_UUID_ON_JOIN? and stanza.attrs.type == 'groupchat' and user.room not in @joined
+
     @robot.logger.debug "Received message: #{message} in room: #{user.room}, from: #{user.name}. Private chat JID is #{user.privateChatJID}"
 
     @receive new TextMessage(user, message)

test/adapter-test.coffee

@@ -5,6 +5,7 @@ Bot = require '../src/xmpp'
 
 assert = require 'assert'
 sinon  = require 'sinon'
+uuid = require 'uuid'
 
 describe 'XmppBot', ->
   describe '#parseRooms()', ->
@@ -997,3 +998,89 @@ describe 'XmppBot', ->
 
       mock.verify()
       assert.ok bot.robot.logger.error.called
+
+  describe 'uuid_on_join', () ->
+    beforeEach ->
+      uuid['v4'] = () -> 'fake-uuid-for-testing'
+      process.env.HUBOT_XMPP_UUID_ON_JOIN = true
+
+    bot = Bot.use()
+
+    bot.client =
+      stub: 'xmpp client'
+
+    bot.robot =
+      name: 'bot'
+      logger:
+        debug: () ->
+        info: () ->
+      brain:
+        userForId: (id, options)->
+          user = {}
+          user['name'] = id
+          for k of (options or {})
+            user[k] = options[k]
+          return user
+
+    room =
+      jid: 'test@example.com'
+      password: false
+
+    it 'should call @client.send() with a uuid', (done) ->
+      bot.client.send = (message) ->
+        if message.name == 'body'
+          assert.equal message.children.length, 1
+          assert.equal message.children[0], 'fake-uuid-for-testing'
+          done()
+      bot.joinRoom room
+
+    it 'should ignore messages', (done) ->
+      stanza =
+        attrs:
+          type: 'groupchat'
+        name: 'message'
+        flag: 'ignore_me'
+      proxied = bot.readMessage
+      bot.readMessage = (message) ->
+        proxied(message)
+        if message.flag == 'ignore_me'
+          done()
+      bot.receive = (message) ->
+        throw 'no message should be received'
+      bot.read stanza
+
+    it 'listen for the uuid before responding', (done) ->
+      stanza =
+        attrs:
+          type: 'groupchat'
+          from: 'test@example.com/bot'
+        name: 'message'
+        flag: 'join_me'
+        getChild: ->
+          body =
+            getText: ->
+              'fake-uuid-for-testing'
+      proxied = bot.readMessage
+      bot.readMessage = (message) ->
+        proxied(message)
+        assert.equal true, 'test@example.com' in bot.joined
+        if message.flag == 'join_me'
+          done()
+      bot.receive = (message) ->
+        throw 'no message should be received'
+      bot.read stanza
+
+    it 'should process messages after joining', (done) ->
+      stanza =
+        attrs:
+          type: 'groupchat'
+          from: 'test@example.com/someone'
+        name: 'message'
+        getChild: ->
+          body =
+            getText: ->
+              '@bot howdy'
+      bot.receive = (message) ->
+        assert.equal message, '@bot howdy'
+        done()
+      bot.read stanza