Make the bot able to join password protected channels

Author: ekmartin

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.1.0] - 2015-03-27
+### Added
+- Make the bot able to join password protected IRC channels. Example:
+
+```json
+"channelMapping": {
+  "#slack": "#irc channel-password",
+}
+```
+
 ## [3.0.0] - 2015-03-24
 ### Changed
 Move from using outgoing/incoming integrations to Slack's

README.md

@@ -37,6 +37,9 @@ if the IRC channels are on different networks.
 
 To set the log level to debug, export the environment variable `NODE_ENV` as `development`.
 
+slack-irc also supports invite-only IRC channels, and will join any channels it's invited to
+as long as they're present in the channel mapping.
+
 Example configuration:
 ```js
 [
@@ -49,7 +52,7 @@ Example configuration:
         ["AUTH", "test", "password"]
     ],
     "channelMapping": { // Maps each Slack-channel to an IRC-channel, used to direct messages to the correct place
-      "#slack": "#irc",
+      "#slack": "#irc channel-password", // Add channel keys after the channel name
       "privategroup": "#other-channel" // No hash in front of private groups
     }
   },

lib/bot.js

@@ -23,9 +23,17 @@ function Bot(options) {
 
   this.server = options.server;
   this.nickname = options.nickname;
-  this.channelMapping = validateChannelMapping(options.channelMapping);
+  this.channels = _.values(options.channelMapping);
+
+  this.channelMapping = {};
+
+  // Remove channel passwords from the mapping
+  _.forOwn(options.channelMapping, function(ircChan, slackChan) {
+    this.channelMapping[slackChan] = ircChan.split(' ')[0];
+  }, this);
+
   this.invertedMapping = _.invert(this.channelMapping);
-  this.channels = _.values(this.channelMapping);
+
   this.autoSendCommands = options.autoSendCommands || [];
 }
 
@@ -37,7 +45,6 @@ Bot.prototype.connect = function() {
     realName: this.nickname,
     channels: this.channels
   });
-
   this.attachListeners();
 };
 
@@ -116,6 +123,8 @@ Bot.prototype.sendToIRC = function(message) {
 
   var channelName = channel.is_channel ? '#' + channel.name : channel.name;
   var ircChannel = this.channelMapping[channelName];
+
+  logger.debug('chan', channelName, this.channelMapping[channelName]);
   if (ircChannel) {
     var user = this.slack.getUserByID(message.user);
     var text = '<' + user.name + '> ' + this.parseText(message.getBody());
@@ -141,7 +150,7 @@ Bot.prototype.sendToSlack = function(author, channel, text) {
       parse: 'full',
       icon_url: 'http://api.adorable.io/avatars/48/' + author + '.png'
     };
-    logger.debug('Sending message to Slack', message);
+    logger.debug('Sending message to Slack', message, channel, '->', slackChannelName);
     slackChannel.postMessage(message);
   }
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "slack-irc",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Connects IRC and Slack channels by sending messages back and forth.",
   "keywords": [
     "slack",

test/bot.test.js

@@ -39,7 +39,7 @@ describe('Bot', function() {
       icon_url: 'http://api.adorable.io/avatars/48/testuser.png'
     };
 
-    this.bot.sendToSlack(message.username, config.channelMapping['#slack'], message.text);
+    this.bot.sendToSlack(message.username, '#irc', message.text);
     ChannelStub.prototype.postMessage.should.have.been.calledWith(message);
   });
 

test/channel-mapping.test.js

@@ -1,9 +1,21 @@
 var chai = require('chai');
+var rewire = require('rewire');
+var irc = require('irc');
 var ConfigurationError = require('../lib/errors').ConfigurationError;
 var validateChannelMapping = require('../lib/validators').validateChannelMapping;
+var Bot = rewire('../lib/bot');
+var config = require('./fixtures/single-test-config.json');
+var SlackStub = require('./stubs/slack-stub');
+var ClientStub = require('./stubs/irc-client-stub');
+
 chai.should();
 
 describe('Channel Mapping', function() {
+  before(function() {
+    irc.Client = ClientStub;
+    Bot.__set__('Slack', SlackStub);
+  });
+
   it('should fail when not given proper JSON', function() {
     var wrongMapping = 'not json';
     function wrap() {
@@ -19,4 +31,11 @@ describe('Channel Mapping', function() {
     }
     (wrap).should.not.throw();
   });
+
+  it('should clear channel keys from the mapping', function() {
+    var bot = new Bot(config);
+    bot.channelMapping['#slack'].should.equal('#irc');
+    bot.invertedMapping['#irc'].should.equal('#slack');
+    bot.channels[0].should.equal('#irc channelKey');
+  });
 });

test/fixtures/single-test-config.json

@@ -7,6 +7,6 @@
     ["AUTH", "test", "password"]
   ],
   "channelMapping": {
-    "#slack": "#irc"
+    "#slack": "#irc channelKey"
   }
 }