finished refactor and fixing some bugs

Author: silverbp

src/lib/command_factory.js

@@ -22,7 +22,7 @@ var utils = require('./utils.js');
 var util = require('util');
 var EventEmitter = require('events').EventEmitter;
 
-var formatCommand = function(name, format, description) {
+var formatHelpCommand = function(name, format, description) {
   var context, template_str, compiled_template, command;
 
   if (!format) {
@@ -34,7 +34,7 @@ var formatCommand = function(name, format, description) {
     'description': description
   };
 
-  template_str = '${format} - ${description}';
+  template_str = 'hubot ${format} - ${description}';
   compiled_template = _.template(template_str);
   command = compiled_template(context);
 
@@ -58,7 +58,8 @@ var getRegexForFormatString = function (format) {
 };
 
 function CommandFactory(robot) {
-  this.robot = robot;
+  var self = this;
+  self.robot = robot;
   EventEmitter.call(this);
 }
 
@@ -82,9 +83,8 @@ CommandFactory.prototype.addCommand = function (action_alias, messaging_handler)
   var action_alias_name = action_alias.name;
 
   _.each(action_alias.formats, function (format) {
-    var formatted_string = formatCommand(action_alias.name, format.display || format, action_alias.description);
-    var compiled_template = _.template('hubot ${command}');
-    self.robot.commands.push(compiled_template({ robotName: self.robot.name, command: formatted_string }));
+    var formatted_string = format.display || format;
+    self.robot.commands.push(formatHelpCommand(action_alias.name, formatted_string, action_alias.description));
 
     if (format.display) {
       _.each(format.representation, function (representation) {
@@ -99,6 +99,9 @@ CommandFactory.prototype.addCommand = function (action_alias, messaging_handler)
 
   self.robot.listen(function (msg) {
     var i, format_string, regex;
+    if (!msg.text) {
+      return false;
+    }
     var command = messaging_handler.normalizeCommand(msg.text);
     for (i = 0; i < format_strings.length; i++) {
       format_string = format_strings[i];
@@ -110,7 +113,7 @@ CommandFactory.prototype.addCommand = function (action_alias, messaging_handler)
       }
     }
     return false;
-  }, { id: action_alias_name }, function (msg) {
+  }, { id: 'st2.' + action_alias_name }, function (msg) {
     self.emit('st2.command_match', {
       msg: msg,
       alias_name: action_alias_name,

src/lib/messaging_handler/default.js

@@ -5,14 +5,17 @@ var env = process.env;
 var util = require('util');
 var utils = require('./../utils');
 var truncate = require('truncate');
-var hubot_alias = env.HUBOT_ALIAS;
+
+var hubot_alias_regex = new RegExp('^' + env.HUBOT_ALIAS);
 
 function DefaultMessagingHandler(robot) {
-  this.robot = robot;
-  this.truncate_length = env.ST2_MAX_MESSAGE_LENGTH;
+  var self = this;
+  self.robot = robot;
+  self.truncate_length = env.ST2_MAX_MESSAGE_LENGTH;
 }
 
 DefaultMessagingHandler.prototype.postData = function(data) {
+  var self = this;
   var recipient, split_message, formatted_message,
       text = "";
 
@@ -23,8 +26,8 @@ DefaultMessagingHandler.prototype.postData = function(data) {
     text = (data.user && !data.whisper) ? util.format('%s: ', data.user) : "";
   }
 
-  recipient = this.formatRecepient(recipient);
-  text += this.formatData(data.message);
+  recipient = self.formatRecepient(recipient);
+  text += self.formatData(data.message);
 
   // Ignore the delimiter in the default formatter and just concat parts.
   split_message = utils.splitMessage(text);
@@ -34,7 +37,7 @@ DefaultMessagingHandler.prototype.postData = function(data) {
     formatted_message = split_message.pretext || split_message.text;
   }
 
-  this.robot.messageRoom.call(this.robot, recipient, formatted_message);
+  self.robot.messageRoom.call(self.robot, recipient, formatted_message);
 };
 
 DefaultMessagingHandler.normalizeAddressee = function(msg) {
@@ -45,11 +48,13 @@ DefaultMessagingHandler.normalizeAddressee = function(msg) {
 };
 
 DefaultMessagingHandler.prototype.formatData = function(data) {
+  var self = this;
+
   if (utils.isNull(data)) {
     return "";
   }
-  if (this.truncate_length > 0) {
-    data = truncate(data, this.truncate_length);
+  if (self.truncate_length > 0) {
+    data = truncate(data, self.truncate_length);
   }
   return data;
 };
@@ -59,7 +64,7 @@ DefaultMessagingHandler.prototype.formatRecepient = function(recepient) {
 };
 
 DefaultMessagingHandler.prototype.normalizeCommand = function(command) {
-  return command.replace(/^${hubot_alias}/, "").trim();
+  return command.replace(hubot_alias_regex, "").trim();
 };
 
 module.exports = DefaultMessagingHandler;

src/lib/messaging_handler/hipchat.js

@@ -8,12 +8,14 @@ var DefaultMessagingHandler = require('./default');
 
 
 function HipchatMessagingHandler(robot) {
-  DefaultMessagingHandler.call(this, robot);
+  var self = this;
+  DefaultMessagingHandler.call(self, robot);
 }
 
 util.inherits(HipchatMessagingHandler, DefaultMessagingHandler);
 
 HipchatMessagingHandler.prototype.postData = function(data) {
+  var self = this;
   var recipient, split_message, formatted_message,
       pretext = "";
 
@@ -23,7 +25,7 @@ HipchatMessagingHandler.prototype.postData = function(data) {
   }
 
   if (recipient.indexOf('@') === -1 ) {
-    recipient = this.formatRecepient(recipient);
+    recipient = self.formatRecepient(recipient);
   }
   split_message = utils.splitMessage(data.message);
   if (pretext) {
@@ -34,16 +36,16 @@ HipchatMessagingHandler.prototype.postData = function(data) {
       same message, so split them */
   if (split_message.pretext) {
     if (data.whisper) {
-      this.robot.send.call(this.robot, data.channel, split_message.pretext);
+      self.robot.send.call(self.robot, data.channel, split_message.pretext);
     } else {
-      this.robot.messageRoom.call(this.robot, recipient, split_message.pretext);
+      self.robot.messageRoom.call(self.robot, recipient, split_message.pretext);
     }
   }
   if (split_message.text) {
     if (data.whisper) {
-      this.robot.send.call(this.robot, data.channel, this.formatData(split_message.text));
+      self.robot.send.call(self.robot, data.channel, self.formatData(split_message.text));
     } else {
-      this.robot.messageRoom.call(this.robot, recipient, this.formatData(split_message.text));
+      self.robot.messageRoom.call(self.robot, recipient, self.formatData(split_message.text));
     }
   }
 };
@@ -76,7 +78,8 @@ HipchatMessagingHandler.prototype.formatRecepient = function(recepient) {
 };
 
 HipchatMessagingHandler.prototype.normalizeCommand = function(command) {
-  return HipchatMessagingHandler.super_.prototype.normalizeCommand.call(this, command);
+  var self = this;
+  return HipchatMessagingHandler.super_.prototype.normalizeCommand.call(self, command);
 };
 
 module.exports = HipchatMessagingHandler;

src/lib/messaging_handler/index.js

@@ -6,7 +6,7 @@ var util = require('util');
 var fs = require('fs');
 var path = require('path');
 
-var filenames = fs.readdirSync('./');
+var filenames = fs.readdirSync(__dirname);
 
 var messagingHandlers = {};
 
@@ -16,7 +16,7 @@ filenames.forEach(function(filename) {
   }
 
   var message_handler = filename.replace(/\.[^/.]+$/, "");
-  messagingHandlers[message_handler] = require('./' + filename);
+  messagingHandlers[message_handler] = require(path.join(__dirname, filename));
 });
 
 module.exports.getMessagingHandler = function(adapterName, robot) {

src/lib/messaging_handler/slack.js

@@ -7,6 +7,7 @@ var utils = require('./../utils');
 var DefaultMessagingHandler = require('./default');
 
 function SlackMessagingHandler(robot) {
+  var self = this;
   DefaultMessagingHandler.call(this, robot);
 
   var sendMessageRaw = function(message) {
@@ -26,6 +27,8 @@ function SlackMessagingHandler(robot) {
 util.inherits(SlackMessagingHandler, DefaultMessagingHandler);
 
 SlackMessagingHandler.prototype.postData = function(data) {
+  var self = this;
+
   var recipient, attachment_color, split_message,
       attachment, pretext = "";
 
@@ -45,7 +48,7 @@ SlackMessagingHandler.prototype.postData = function(data) {
     }
   }
 
-  split_message = utils.splitMessage(this.formatData(data.message));
+  split_message = utils.splitMessage(self.formatData(data.message));
 
   if (split_message.text) {
     var content = {
@@ -55,7 +58,7 @@ SlackMessagingHandler.prototype.postData = function(data) {
     if (data.extra && data.extra.slack) {
       for (var attrname in data.extra.slack) { content[attrname] = data.extra.slack[attrname]; }
     }
-    var robot = this.robot;
+    var robot = self.robot;
     var chunks = split_message.text.match(/[\s\S]{1,7900}/g);
     var sendChunk = function (i) {
       content.text = chunks[i];
@@ -72,7 +75,7 @@ SlackMessagingHandler.prototype.postData = function(data) {
     };
     sendChunk(0);
   } else {
-    this.robot.messageRoom.call(this.robot, recipient, pretext + split_message.pretext);
+    self.robot.messageRoom.call(self.robot, recipient, pretext + split_message.pretext);
   }
 };
 
@@ -97,7 +100,8 @@ SlackMessagingHandler.prototype.formatRecepient = function(recepient) {
 };
 
 SlackMessagingHandler.prototype.normalizeCommand = function(command) {
-  command = SlackMessagingHandler.super_.prototype.normalizeCommand.call(this, command);
+  var self = this;
+  command = SlackMessagingHandler.super_.prototype.normalizeCommand.call(self, command);
   // replace left double quote with regular quote
   command = command.replace(/\u201c/g, '\u0022');
   // replace right double quote with regular quote

src/lib/messaging_handler/yammer.js

@@ -7,12 +7,14 @@ var utils = require('./../utils');
 var DefaultMessagingHandler = require('./default');
 
 function YammerMessagingHandler(robot) {
-  DefaultMessagingHandler.call(this, robot);
+  var self = this;
+  DefaultMessagingHandler.call(self, robot);
 }
 
 util.inherits(YammerMessagingHandler, DefaultMessagingHandler);
 
 YammerMessagingHandler.prototype.postData = function(data) {
+  var self = this;
   var recipient, split_message, formatted_message,
       text = "";
 
@@ -23,8 +25,8 @@ YammerMessagingHandler.prototype.postData = function(data) {
     text = (data.user && !data.whisper) ? util.format('@%s: ', data.user) : "";
   }
 
-  recipient = this.formatRecepient(recipient);
-  text += this.formatData(data.message);
+  recipient = self.formatRecepient(recipient);
+  text += self.formatData(data.message);
 
   // Ignore the delimiter in the default formatter and just concat parts.
   split_message = utils.splitMessage(text);
@@ -34,7 +36,7 @@ YammerMessagingHandler.prototype.postData = function(data) {
     formatted_message = split_message.pretext || split_message.text;
   }
 
-  this.robot.send.call(this.robot, recipient, formatted_message);
+  self.robot.send.call(self.robot, recipient, formatted_message);
 };
 
 YammerMessagingHandler.prototype.normalizeAddressee = function(msg) {