Repository files navigation

   .d8888b.   888                      888  d88P  Y88b  888                      888  Y88b.       888                      888   "Y888b.    888   d888b.    .d8888b  888  .888  .d88b.   888d88b       "Y88b.  888      "88b  d88P"     888 .88P  d8P  Y8b  888P"        "888  888  .d888888  888       888888K   88888888  888   Y88b  d88P  888  888  888  Y88b.     888 "88b  Y8b.      888   "Y8888P"   888  "Y888888   "Y8888P  888  .888  "Y888P   888

Slacker processes Slack WebHook requests and executes pre-defined actions before responding to Slack.

1. Clone this repository.

````➜ git clone git@github.com:chris--young/Slacker.git````

2. InstallNode.js.

3. Set Slack Integrations.

* Create a Outgoing WebHook in Slack and point it to your instance of Slacker.  * Be sure to update `token` in `config.json` to match your outgoing-webhook.* Create an Incoming WebHook in Slack.   * Be sure to update `hostname` and `path` in `config.json` to match your incoming-webhook.

4. Start Slacker.

````➜ sh Slacker ````

Actions are script files located in theactions/ directory. When Slacker receives a request from Slack it will check for and execute the appropriate action. Actions receive adata object with relevant information about the request from Slack, process the data and then return a response string. Slacker facilitates the response process.

1. Create a new JavaScript file in theactions/ directory.

2. Require thebot module.

3. Define your action as an object.

4. Callbot.addAction() to complete the process. Slacker will search theactions/ directory and add valid actions when worker processes come online.

var bot = require(__dirname + '/../bot.js');var action = {  name: 'echo',  trigger: /^echo \".*\"$/,  description: 'Echo a string to Slack.',  setup: function() {    // This method will be run at server start up.  },  execute: function(data, callback) {    callback(data.text);  }};bot.addAction(action);

Thename attribute defines your action. It is used by thehelp andlist actions to inform users about your action.name attributes must be unique; Slacker will ignore actions if theirname has already been defined by another action. This attribute is required on all actions.

Your action'strigger attribute is a regular expression which defines when it will be exectued. If a Slack user activates your bot and his message text matches your action'strigger then Slacker will perform your action.trigger attributes should be unique; Slacker will ignore actions if theirtrigger attributes have already been defined by another action. This attribute is required on all actions.

Thedescription attribute is a string used to describe your action when a user triggers thelist action. This attribute is required on all actions.

Thesetup() method will be run when Slacker worker processes come online. You can use this method for any pre-execution logic you may need to perform. This method is optional.

Slacker calls theexecute() method when a request requires that your action be performed. It receives adata parameter with relavent request information, and acallback paramature that must return a string which will be the bot's response in Slack. This method is required on all actions.

var data = {  team_id: 'T028JNZFM',  team_domain: 'mobdev',  channel_id: 'C02DCNQRN',  channel_name: 'slacker-testing',  timestamp: '1405215092.000210',  user_id: 'U02A1R3PM',  user_name: 'chris_young',  text: 'echo foo'};

Slacker usesMocha for testing. To run the tests first install Mocha.

➜ npm install -g mocha

Then run the tests.

➜ npm test