easy-slack-bot

Node.js based, modular Slack bot framework.

[![NPM Version][npm-image]][npm-url]
[![Linux Build][travis-image]][travis-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Dependency Status][deps-image]][deps-url]
[![devDependency Status][devs-image]][devs-url]
[![Codecov coverage][codecov-image]][codecov-url]

INSTALLATION

``bash
$ npm install easy-slack-bot --save
`

EXAMPLE

See sample files in "example" directory.

USAGE

Simple index.js:
`javascript
var SlackBot = require("easy-slack-bot"),
BotItems = __dirname + "/items",
BotOptions = {
Slack: {
SLACK_TOKEN: "slack-bot-token"
}
};

new SlackBot(BotItems, BotOptions);
`

Simple items/hello.js item:
`javascript
module.exports = function( bot )
{
// https://api.slack.com/methods/chat.postMessage
var params = {
icon_emoji: ':robot_face:'
};

return
{
// Get message
// https://rawgit.com/sipimokus/easy-slack-bot/master/docs/interfaces/islackbotsmessage.html
// https://rawgit.com/sipimokus/easy-slack-bot/master/docs/interfaces/iitemsonmessagecallback.html
message: function( message, callBack )
{
// Detecting word in message
if ( message.natural.indexOf("hello") > -1 )
{
// Answer message
callBack("Hello world!", params);

return true;
}

return false;
}
};
};
``

DOCUMENTATION

Source code documentation find here.

[npm-image]: https://img.shields.io/npm/v/easy-slack-bot.svg
[npm-url]: https://npmjs.org/package/easy-slack-bot
[travis-image]: https://img.shields.io/travis/sipimokus/easy-slack-bot/master.svg?label=linux
[travis-url]: https://travis-ci.org/sipimokus/easy-slack-bot/branches
[appveyor-image]: https://img.shields.io/appveyor/ci/sipimokus/easy-slack-bot/master.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/sipimokus/easy-slack-bot/history
[deps-image]: https://img.shields.io/david/sipimokus/easy-slack-bot.svg?label=deps
[deps-url]: https://david-dm.org/sipimokus/easy-slack-bot
[devs-image]: https://img.shields.io/david/dev/sipimokus/easy-slack-bot.svg?label=devDeps
[devs-url]: https://david-dm.org/sipimokus/easy-slack-bot?type=dev
[codecov-image]: https://img.shields.io/codecov/c/github/sipimokus/easy-slack-bot/master.svg
[codecov-url]: https://codecov.io/gh/sipimokus/easy-slack-bot/branch/master