s4-core v1.1.0

s4 Core

s4 Core is the engine that powers StudentRND's s4. We turned it into its own module for use with s4 connectors, they can listen for and send messages with their specified services. These connectors require little to no configuration, all you need to worry about is your bot's behavior.

Examples

Slack <-> Telegram Echo Command

First:

npm install s4-slack s4-telegram

var s4 = require('s4-core'),
    bot = new s4(),
    SlackConnector = require('s4-slack'), slack = new SlackConnector(bot, "YOUR-SLACK-API-KEY"),
    TelegramConnector = require('s4-telegram'), telegram = new TelegramConnector(bot, "YOUR-TELEGRAM-BOT-KEY");

bot.setConnector(bot.CONNECTOR_TYPES.TYPE_MESSAGE_SENDER, telegram); // send messages to Telegram
bot.setConnector(bot.CONNECTOR_TYPES.TYPE_MESSAGE_HANDLER, slack); // receive messages from Slack
// you can switch those two connectors around and receive from Telegram instead of Slack!

// this is documented here: https://github.com/StudentRND/s4/wiki/Commands
bot.addCommand("echo", "Echo the specified text.", function(message, args, channel, username){
  bot.sendMessage(username + " said " + message + " on Slack!", "some-telegram-chat-id");
});