Merge pull request #24 from Throne3d/add/event-unhandled

Add event for unhandled messages

Author: Throne3d

docs/API.rst

@@ -463,6 +463,14 @@ Events
 
     Emitted when ever the server responds with an error-type message.
     See the `raw` event for details on the `message` object.
+    Unhandled messages, although they are shown as errors in the log, are not emitted using this event: see `unhandled`.
+
+.. js:data:: 'unhandled'
+
+    `function (message) { }`
+
+    Emitted when ever the server responds with a message the bot doesn't recognize and doesn't handle.
+    See the `raw` event for details on the `message` object.
 
 Colors
 ------

lib/irc.js

@@ -658,10 +658,11 @@ function Client(server, nick, opt) {
             default:
                 if (message.commandType == 'error') {
                     self.emit('error', message);
-                    self.out.error(util.inspect(message));
+                    self.out.error(message);
                 }
                 else {
-                    self.out.debug('\u001b[01;31mUnhandled message: ' + util.inspect(message) + '\u001b[0m');
+                    self.out.error('Unhandled message:', message);
+                    self.emit('unhandled', message);
                     break;
                 }
         }
@@ -860,6 +861,7 @@ Client.prototype.connect = function(retryCount, callback) {
 
         lines.forEach(function iterator(line) {
             if (line.length) {
+                self.out.debug('Received:', line);
                 var message = parseMessage(line, self.opt.stripColors);
 
                 try {

test/test-irc.js

@@ -148,7 +148,6 @@ test ('does not crash when disconnected and trying to send messages', function(t
     withClient(function(obj) {
         var client = obj.client;
         var mock = obj.mock;
-        obj.closeWithEnd(t);
 
         mock.server.on('connection', function() {
             mock.send(greeting);
@@ -163,6 +162,48 @@ test ('does not crash when disconnected and trying to send messages', function(t
             client.say('#channel', 'message2');
             client.end();
             client.say('#channel', 'message3');
+            t.end();
+        });
+    });
+});
+
+test ('unhandled messages are emitted appropriately', function(t) {
+    withClient(function(obj) {
+        var client = obj.client;
+        var mock = obj.mock;
+        obj.closeWithEnd(t);
+        var endTimeout;
+
+        mock.server.on('connection', function() {
+            mock.send(greeting);
+        });
+
+        client.on('registered', function() {
+            mock.send(':127.0.0.1 150 :test\r\n');
+            //mock.close();
+            client.on('error', function(){console.log("error");});
+            client.on('unhandled', function(msg) {
+                var expected = {
+                    prefix: '127.0.0.1',
+                    server: '127.0.0.1',
+                    rawCommand: '150',
+                    command: '150',
+                    commandType: 'normal',
+                    args: ['test']
+                };
+                t.deepEqual(msg, expected, 'unhandled message should be emitted as expected');
+                client.disconnect();
+            });
+            endTimeout = setTimeout(function() {
+                if (t.ended) return;
+                t.ok(false, 'callback for event must be called');
+                client.disconnect();
+            }, 1000);
+        });
+
+        client.conn.once('close', function() {
+            clearTimeout(endTimeout)
+            client.end();
         });
     });
 });