implement help and gem commands

Author: Ramesh, Gaurav

.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules

README.md

@@ -0,0 +1,3 @@
+# slack-terminalize-cli
+
+Sample app to work with [slack-terminalize](https://github.com/ggauravr/slack-terminalize) with some basic custom commands

commands/app-error.js

@@ -0,0 +1,3 @@
+module.exports = function (param) {
+	console.log("param.. err handling", param.command, param.args);
+};

commands/gem.js

@@ -0,0 +1,29 @@
+var request = require('request'),
+	util 	= require('../util');
+
+module.exports = function (param) {
+	var	channel		= param.channel,
+		endpoint	= param.commandConfig.endpoint.replace('{gem}', param.args[0]);
+
+	(function(channel){
+		
+		request(endpoint, function (err, response, body) {
+			var info = [];
+
+			if (!err && response.statusCode === 200) {
+				body = JSON.parse(body);
+
+				info.push('Gem: ' + body.name + ' - ' + body.info);
+				info.push('Authors: ' + body.authors);
+				info.push('Project URI: ' + body.project_uri);
+			}
+			else {
+				info = ['No such gem found!'];
+			}
+
+			util.postMessage(channel, info.join('\n\n'));
+		});
+
+	})(channel);
+
+};

commands/help.js

@@ -0,0 +1,41 @@
+var slackTerminal 	= require('slack-terminalize'),
+	commands 		= slackTerminal.getCommandObjects(),
+	util			= require('../util');
+
+var _helpAll = function () {
+	var name,
+		index,
+		command,
+		response = [];
+
+	index = 1;
+	for (name in commands) {
+		command = commands[name];
+
+		if (!command.exclude) {
+			response.push(index++  + '. ' + _helpCommand(name));
+		}
+	}
+
+	return response.join('\n\n');
+};
+
+var _helpCommand = function (name) {
+	var response = [ commands[name].help, 'Alias: ' + commands[name].alias.join(', '), commands[name].description ];
+
+	return response.join('\n\n');
+};
+
+module.exports = function (param) {
+	var	channel		= param.channel,
+		response;
+
+	if (!param.args.length) {
+		response = _helpAll();
+	}
+	else {
+		response = _helpCommand(param.args[0]);
+	}
+
+	util.postMessage(channel, response);
+};

config/commands.json

@@ -0,0 +1,19 @@
+{
+	"help": {
+		"alias": [ "halp" ],
+		"endpoint": "#",
+		"help": "help [command](optional)",
+		"description": "To get help on all supported commands, or a specified command"
+	},
+
+	"gem": {
+		"alias": [],
+		"endpoint": "https://rubygems.org/api/v1/gems/{gem}.json",
+		"help": "gem [gem-name]",
+		"description": "Fetches details of the specified Ruby gem"
+	},
+
+	"app-error": {
+		"exclude": true
+	}
+}

index.js

@@ -0,0 +1,8 @@
+var slackTerminal = require('slack-terminalize');
+
+slackTerminal.init({
+	SLACK_TOKEN: '<xoxb-your-token-here>'
+}, {
+	CONFIG_DIR: __dirname + '/config',
+	COMMAND_DIR: __dirname + '/commands'
+});

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "slack-sample-cli",
+  "version": "1.0.0",
+  "description": "Sample app to show working with slack-terminalize module",
+  "main": "index.js",
+  "dependencies": {
+    "request": "^2.65.0",
+    "slack-terminalize": "^0.0.3"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:gnramesh/slack-sample-cli.git"
+  },
+  "engines": {
+    "node": "0.12.x"
+  },
+  "keywords": [
+    "slack",
+    "terminal"
+  ],
+  "author": "Gaurav Ramesh",
+  "license": "MIT"
+}

util.js

@@ -0,0 +1,22 @@
+/**
+ * Wrapper function for postMessage from slack-client to handle formatting.
+ * 
+ * @param  { object } slack-client Channel boject
+ * @param  { string } message to send to Slack channel
+ * @param  { boolean } flag to indicate block formatting
+ * @return { none }
+ * 
+ */
+var postMessage = function (channel, response, format) {
+
+	format = format || true;
+	response = (format && '```' + response + '```') || response;
+
+	channel.postMessage({
+		as_user: true,
+		text: response
+	});
+
+};
+
+exports.postMessage = postMessage;