botkit
Version:
Building blocks for Building Bots
334 lines (271 loc) • 9.5 kB
JavaScript
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
______ ______ ______ __ __ __ ______
/\ == \ /\ __ \ /\__ _\ /\ \/ / /\ \ /\__ _\
\ \ __< \ \ \/\ \ \/_/\ \/ \ \ _"-. \ \ \ \/_/\ \/
\ \_____\ \ \_____\ \ \_\ \ \_\ \_\ \ \_\ \ \_\
\/_____/ \/_____/ \/_/ \/_/\/_/ \/_/ \/_/
This is a sample Slack Button application that adds a bot to one or many slack teams.
# RUN THE APP:
Create a Slack app. Make sure to configure the bot user!
-> https://api.slack.com/applications/new
-> Add the Redirect URI: http://localhost:3000/oauth
Run your bot from the command line:
clientId=<my client id> clientSecret=<my client secret> port=3000 node slackbutton_bot_interactivemsg.js
# USE THE APP
Add the app to your Slack by visiting the login page:
-> http://localhost:3000/login
After you've added the app, try talking to your bot!
# EXTEND THE APP:
Botkit has many features for building cool and useful bots!
Read all about it here:
-> http://howdy.ai/botkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
/* Uses the slack button feature to offer a real time bot to multiple teams */
var Botkit = require('../../lib/Botkit.js');
if (!process.env.clientId || !process.env.clientSecret || !process.env.port) {
console.log('Error: Specify clientId clientSecret and port in environment');
process.exit(1);
}
var controller = Botkit.slackbot({
// interactive_replies: true, // tells botkit to send button clicks into conversations
json_file_store: './db_slackbutton_bot/',
// rtm_receive_messages: false, // disable rtm_receive_messages if you enable events api
}).configureSlackApp(
{
clientId: process.env.clientId,
clientSecret: process.env.clientSecret,
scopes: ['bot'],
}
);
controller.setupWebserver(process.env.port,function(err,webserver) {
controller.createWebhookEndpoints(controller.webserver);
controller.createOauthEndpoints(controller.webserver,function(err,req,res) {
if (err) {
res.status(500).send('ERROR: ' + err);
} else {
res.send('Success!');
}
});
});
// just a simple way to make sure we don't
// connect to the RTM twice for the same team
var _bots = {};
function trackBot(bot) {
_bots[bot.config.token] = bot;
}
controller.on('interactive_message_callback', function(bot, message) {
var ids = message.callback_id.split(/\-/);
var user_id = ids[0];
var item_id = ids[1];
controller.storage.users.get(user_id, function(err, user) {
if (!user) {
user = {
id: user_id,
list: []
}
}
for (var x = 0; x < user.list.length; x++) {
if (user.list[x].id == item_id) {
if (message.actions[0].value=='flag') {
user.list[x].flagged = !user.list[x].flagged;
}
if (message.actions[0].value=='delete') {
user.list.splice(x,1);
}
}
}
var reply = {
text: 'Here is <@' + user_id + '>s list:',
attachments: [],
}
for (var x = 0; x < user.list.length; x++) {
reply.attachments.push({
title: user.list[x].text + (user.list[x].flagged? ' *FLAGGED*' : ''),
callback_id: user_id + '-' + user.list[x].id,
attachment_type: 'default',
actions: [
{
"name":"flag",
"text": ":waving_black_flag: Flag",
"value": "flag",
"type": "button",
},
{
"text": "Delete",
"name": "delete",
"value": "delete",
"style": "danger",
"type": "button",
"confirm": {
"title": "Are you sure?",
"text": "This will do something!",
"ok_text": "Yes",
"dismiss_text": "No"
}
}
]
})
}
bot.replyInteractive(message, reply);
controller.storage.users.save(user);
});
});
controller.on('create_bot',function(bot,config) {
if (_bots[bot.config.token]) {
// already online! do nothing.
} else {
bot.startRTM(function(err) {
if (!err) {
trackBot(bot);
}
bot.startPrivateConversation({user: config.createdBy},function(err,convo) {
if (err) {
console.log(err);
} else {
convo.say('I am a bot that has just joined your team');
convo.say('You must now /invite me to a channel so that I can be of use!');
}
});
});
}
});
// Handle events related to the websocket connection to Slack
controller.on('rtm_open',function(bot) {
console.log('** The RTM api just connected!');
});
controller.on('rtm_close',function(bot) {
console.log('** The RTM api just closed');
// you may want to attempt to re-open
});
controller.hears(['add (.*)'],'direct_mention,direct_message',function(bot,message) {
controller.storage.users.get(message.user, function(err, user) {
if (!user) {
user = {
id: message.user,
list: []
}
}
user.list.push({
id: message.ts,
text: message.match[1],
});
bot.reply(message,'Added to list. Say `list` to view or manage list.');
controller.storage.users.save(user);
});
});
controller.hears(['list','tasks'],'direct_mention,direct_message',function(bot,message) {
controller.storage.users.get(message.user, function(err, user) {
if (!user) {
user = {
id: message.user,
list: []
}
}
if (!user.list || !user.list.length) {
user.list = [
{
'id': 1,
'text': 'Test Item 1'
},
{
'id': 2,
'text': 'Test Item 2'
},
{
'id': 3,
'text': 'Test Item 3'
}
]
}
var reply = {
text: 'Here is your list. Say `add <item>` to add items.',
attachments: [],
}
for (var x = 0; x < user.list.length; x++) {
reply.attachments.push({
title: user.list[x].text + (user.list[x].flagged? ' *FLAGGED*' : ''),
callback_id: message.user + '-' + user.list[x].id,
attachment_type: 'default',
actions: [
{
"name":"flag",
"text": ":waving_black_flag: Flag",
"value": "flag",
"type": "button",
},
{
"text": "Delete",
"name": "delete",
"value": "delete",
"style": "danger",
"type": "button",
"confirm": {
"title": "Are you sure?",
"text": "This will do something!",
"ok_text": "Yes",
"dismiss_text": "No"
}
}
]
})
}
bot.reply(message, reply);
controller.storage.users.save(user);
});
});
controller.hears('interactive', 'direct_message', function(bot, message) {
bot.reply(message, {
attachments:[
{
title: 'Do you want to interact with my buttons?',
callback_id: '123',
attachment_type: 'default',
actions: [
{
"name":"yes",
"text": "Yes",
"value": "yes",
"type": "button",
},
{
"name":"no",
"text": "No",
"value": "no",
"type": "button",
}
]
}
]
});
});
controller.hears('^stop','direct_message',function(bot,message) {
bot.reply(message,'Goodbye');
bot.rtm.close();
});
controller.on(['direct_message','mention','direct_mention'],function(bot,message) {
bot.api.reactions.add({
timestamp: message.ts,
channel: message.channel,
name: 'robot_face',
},function(err) {
if (err) { console.log(err) }
bot.reply(message,'I heard you loud and clear boss.');
});
});
controller.storage.teams.all(function(err,teams) {
if (err) {
throw new Error(err);
}
// connect all teams with bots up to slack!
for (var t in teams) {
if (teams[t].bot) {
controller.spawn(teams[t]).startRTM(function(err, bot) {
if (err) {
console.log('Error connecting bot to Slack:',err);
} else {
trackBot(bot);
}
});
}
}
});