Initial commit of a simple example of how to use the slack-client module from Node.

Author: rharmes

README.md

@@ -8,7 +8,7 @@
 
 This is a Slack client library for Node.js. It is intended to expose all of the functionality of [Slack's Real Time Messaging API](https://api.slack.com/rtm) while providing some common abstractions and generally making your life easier, if you want it to.
 
-This code has been built to support our [hubot-slack](https://github.com/slackhq/hubot-slack) adapter. Most other functionality isn't yet supported, and documentation is minimal, at best.
+This code has been built to support our [hubot-slack](https://github.com/slackhq/hubot-slack) adapter. Most other functionality isn't yet supported, and documentation is minimal, at best. A simple example of how to use this module from Node.js can be found in the `examples` directory.
 
 ## Contribute
 

examples/simple.js

@@ -0,0 +1,69 @@
+// This is a simple example of how to use the slack-client module. It creates a
+// bot that responds to all messages in all channels it is in with a reversed
+// string of the text received.
+//
+// To run, copy your token below, then:
+//	npm install
+// 	cd examples
+// 	node simple.js
+
+var Slack = require('..');
+
+var token = 'xoxb-YOUR-TOKEN-HERE', // Add a bot at https://my.slack.com/services/new/bot and copy the token here.
+    autoReconnect = true,
+    autoMark = true;
+
+var slack = new Slack(token, autoReconnect, autoMark);
+
+slack.on('open', function() {
+
+	var channels = [],
+	    groups = [],
+	    unreads = slack.getUnreadCount(),
+	    key;
+
+	for (key in slack.channels) {
+		if (slack.channels[key].is_member) {
+			channels.push('#' + slack.channels[key].name);
+		}
+	}
+
+	for (key in slack.groups) {
+		if (slack.groups[key].is_open && !slack.groups[key].is_archived) {
+			groups.push(slack.groups[key].name);
+		}
+	}
+
+	console.log('Welcome to Slack. You are @%s of %s', slack.self.name, slack.team.name);
+	console.log('You are in: %s', channels.join(', '));
+	console.log('As well as: %s', groups.join(', '));
+	console.log('You have %s unread ' + (unreads === 1 ? 'message' : 'messages'), unreads);
+});
+
+slack.on('message', function(message) {
+
+	var type = message.type,
+	    channel = slack.getChannelGroupOrDMByID(message.channel),
+	    user = slack.getUserByID(message.user),
+	    time = message.ts,
+	    text = message.text,
+	    response = '';
+
+	console.log('Received: %s %s @%s %s "%s"', type, (channel.is_channel ? '#' : '') + channel.name, user.name, time, text);
+
+	// Respond to messages with the reverse of the text received.
+
+	if (type === 'message') {
+
+		response = text.split('').reverse().join('');
+		channel.send(response);
+		console.log('@%s responded with "%s"', slack.self.name, response);
+	}
+});
+
+slack.on('error', function(error) {
+
+	console.error('Error: %s', error);
+});
+
+slack.login();