nshimiye/relay

# relay

Bot user that can send and receive messages to and from different users

[![npm version](https://badge.fury.io/js/bot-relay.svg)](https://badge.fury.io/js/bot-relay)
[![Dependency Status](https://gemnasium.com/badges/github.com/nshimiye/relay.svg)](https://gemnasium.com/github.com/nshimiye/relay)


[![Build Status](https://travis-ci.org/nshimiye/relay.svg?branch=master)](https://travis-ci.org/nshimiye/relay)
[![Coverage Status](https://coveralls.io/repos/github/nshimiye/relay/badge.svg?branch=master)](https://coveralls.io/github/nshimiye/relay?branch=master)
[![Code Climate](https://codeclimate.com/github/nshimiye/relay/badges/gpa.svg)](https://codeclimate.com/github/nshimiye/relay)
[![Join the chat at https://gitter.im/nshimiye/relay](https://badges.gitter.im/nshimiye/relay.svg)](https://gitter.im/nshimiye/relay?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# Installation
```bash
npm install bot-relay
```

# usage
* Instance initialization
```javascript
const relay = require('bot-relay');
let token = '<slack bot token>'; //@TODO add url to get this token
let slackRelay = relay.slackRelay(token);

slackRelay.connect().then( relayInstance => {
  // send messages to known users
  // broadcast messages to all users
  // post messages to channels
}, connectionError => {
  // you can try to reconnect
  // you can verify with slack to make sure your token is still valid
});
```

* Turn the bot on and off.
```javascript
slackRelay.connect(); // return promise - resolve with relay instance
slackRelay.disconnect(); // return promise - resolve with success message
```

* Relay provide a "notify" method that takes in the user-name or channel-name
```javascript
relayInstance.notify('<user-1>', 'user_typing');
```

* Send message to slack user
```javascript
relayInstance.send('Hi there!', '<user-1>');
```

* Post in a slack channel
```javascript
relayInstance.post('Hello! I am alive :)', '<channel-1>');
```

* Send message to slack user
```javascript
relayInstance.broadcast('Sorry for spamming!', ['<user-1>', '<user-2>']);
```