dobotjs

Does a bunch of stuff for the Slack group!

Since we got a lot of integrations going, we thought it'd be cool to just build an app and consolidate a lot of the custom things we wanted to make.

Requirements

• node >= 7.x -- node must be run with the --harmony-async-await flag
• express
• body-parser (to parse the JSON)
• request (simplified HTTP requests)

Also go check out the Slack API for more information.

Running

To start the server simply run:

npm start

To start the server in development mode under nodemon simply run:

npm demon

Future updates

• global resource posting by Slack command: use /resource with your topic to submit resources from any channel.
• get help with a problem: use /whatevercommandhere with your question to get help from more knowledgeable members.

Adding Functionality

do.bot can handle both commands and events. To add a new piece of functionality, simply add a folder with an app.js file that registers your command or event with do.bot into the apps directory.

#/apps/verify_url/app.js
# this the the event to handle url verifications from slack

const event = require('../../controllers/event');

event.handler.add('url_verification', function verifyUrl(request, response){
    const body = request.body;

    response.status(200);
    response.set('Content-Type', 'application/x-www-form-urlencoded');
    response.send(body.challenge);
});

Commands

With do.bot you register a simple async function to handle a command:

const command = require('../../controllers/command');

const help = 'check out my command';

async function myCommandHandler(request, response){
    response.status(200);
    response.send('hi from my command');
}

command.handler.add('mycommand', myCommandHandler, help);

Now when someone types /mycommand do.bot will respond with "hi from my command", its that simple!

Complex Commands

do.bot allows you to define simple one-off commands like above, but it also allows you to define commands within commands.

do.bot offers two classes to handle complex commands StringArgumentParser and NumberArgumentParser. NumberArgumentParser will allow you to define subcommands based on the number of space-separated values that are passed with the command call. While StringArgumentParser will match the beginning of the value passed to the command from slack and execute the corresponding sub-command accordingly. StringArgumentParser includes an instance of NumberArgumentParser by default allowing both to be defined at once.

const command = require('./controllers/command');

const help = 'check out my command';

const commands = {
    'count': {
        'help': '/mycommand count will count the words given to the command',
        'command': async function(input, request, response){
            response.status(200);
            response.send('You passed in '+ input.split(' ').length + ' words')
        }
    },
    1: {
        'help': '/mycommand any number of args',
        'command': async function(input, request, response){
            response.status(200);
            response.send('one matched: ' + input)
        }
    }
}

const command_parser = new command.StringArgumentParser(commands);
command.handler.add('mycommand', command_parser, help);

When someone types /mycommand count how many words is this? do.bot will respond with 'You passed in 5 words'.

If someone typed in /mycommand hello do.bot would match the 1 command and respond with one matched: hello.

If you choose not to define a help command, do.bot will iterate through all of the defined commands and create a help string based on all of the sub-commands help entries. This will automatically enable /mycommand help

Events

Write about events