README.md 9.97 KB
Newer Older
1
[asteroid]: https://www.npmjs.com/package/asteroid
2

3
# Rocket.Chat Node.js SDK
4

5
Application interface for server methods and message stream subscriptions.
6 7 8

## Overview

9 10 11
Using this package third party apps can control and query a Rocket.Chat server
instance, via Asteroid login and method calls as well as DDP for subscribing
to stream events.
12

13 14 15
Designed especially for chat automation, this SDK makes it easy for bot and
integration developers to provide the best solutions and experience for their
community.
16

17 18
For example, the Hubot Rocketchat adapter uses this package to enable chat-ops
workflows and multi-channel, multi-user, public and private interactions.
19
We have more bot features and adapters on the roadmap and encourage the
20
community to implement this SDK to provide adapters for their bot framework
21 22 23 24 25 26 27
or platform of choice.

## API

See full API documentation links in the generated docs. Below is just a summary:

---
28

29 30 31
Currently, there are two modules exported by the SDK:
- `driver` - Handles connection, method calls, room subscriptions (via Asteroid)
- `methodCache` - Manages results cache for calls to server (via LRU cache)
32

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
Access these modules by importing them from SDK, e.g:

ES6 `import { driver, methodCache } from '@rocket.chat/sdk'`

ES5 `const { driver, methodCache } = require('@rocket.chat/sdk')`

See [Asteroid][asteroid] docs for methods that can be called from that API.

Any Rocket.Chat server method can be called via `driver.callMethod`,
`driver.cacheCall` or `driver.asyncCall`. Server methods are not fully
documented, most require searching the Rocket.Chat codebase.

#### DRIVER METHODS

---

### `driver.connect(options, cb?)`

Connects to a Rocket.Chat server
52
- Options accepts `host` and `timeout` attributes
53
- Can return a promise, or use error-first callback pattern
54
- Resolves with an [Asteroid][asteroid] instance
55

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
### `driver.disconnect()`

Unsubscribe, logout, disconnect from Rocket.Chat
- Returns promise

### `driver.login(credentials)`

Login to Rocket.Chat via Asteroid
- Accepts object with `username` and/or `email` and `password`
- Returns promise
- Resolves with logged in user ID

### `driver.logout()`

Logout current user via Asteroid
- Returns promise

### `driver.subscribe(topic, roomId)`

Subscribe to Meteor subscription
- Accepts parameters for Rocket.Chat streamer
- Returns promise
- Resolves with subscription instance (with ID)

### `driver.unsubscribe(subscription)`

Cancel a subscription
- Accepts a subscription instance
- Returns promise

### `driver.unsubscribeAll()`

Cancel all current subscriptions
- Returns promise

### `driver.subscribeToMessages()`

Shortcut to subscribe to user's message stream
- Uses `.subscribe` arguments with defaults
  - topic: `stream-room-messages`
  - roomId: `__my_messages__`
- Returns a subscription instance

99
### `driver.reactToMessages(callback)`
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200

Fires callback with every change in subscriptions
- Subscribe must be called first
- Uses error-first callback pattern
- Second argument is the changed item
- Third argument is additional attributes, such as `roomType`

### `driver.asyncCall(method, params)`

Wraps server method calls to always be async
- Accepts a method name and params (array or single param)
- Returns a Promise

### `driver.cacheCall(method, key)`

Call server method with `methodCache`
- Accepts a method name and single param (used as cache key)
- Returns a promise
- Resolves with server results or cached if still valid

### `driver.callMethod(method, params)`

Implements either `asyncCall` or `cacheCall` if cache exists
- Accepts a method name and params (array or single param)
- Outcome depends on if `methodCache.create` was done for the method

### `driver.useLog(logger)`

Replace the default log, e.g. with one from a bot framework
- Accepts class or object with `debug`, `info`, `warn`, `error` methods.
- Returns nothing

### `driver.getRoomId(name)`

Get ID for a room by name
- Accepts name or ID string
- Is cached
- Returns a promise
- Resolves with room ID

### `driver.getRoomName(id)`

Get name for a room by ID
- Accepts ID string
- Is cached
- Returns a promise
- Resolves with room name

### `driver.getDirectMessageRoomId(username)`

Get ID for a DM room by its recipient's name
- Accepts string username
- Returns a promise
- Resolves with room ID

### `driver.joinRoom(room)`

Join the logged in user into a room
- Accepts room name or ID string
- Returns a promise

### `driver.joinRooms(rooms)`

As above, with array of room names/IDs

### `driver.prepareMessage(content, roomId?)`

Structure message content for sending
- Accepts a message object or message text string
- Optionally addressing to room ID with second param
- Returns a message object

### `driver.sendMessageByRoomId(content, roomId)`

Prepare and send message/s to specified room ID
- Content can be message object, message text string or array of strings
- Returns a promise
- Resolves when all sent

### `driver.sendMessageByRoom(content, room)`

As above, with room name instead of ID

### `driver.sendDirectToUser(content, username)`

As above, with username for DM instead of ID

### `driver.sendMessage(content, roomId?)`

Send a prepared message object (with pre-defined room ID)
- Optional argument allows redirecting message to different room

---

### METHOD CACHE

---

### `methodCache.use(instance)`

Set the instance to call methods on, with cached results
201
- Accepts an Asteroid instance (or possibly other classes)
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
- Returns nothing

### `methodCache.create(method, options?)`

Setup a cache for a method call
- Accepts method name and cache options object, such as:
  - `max` Maximum size of cache
  - `maxAge` Maximum age of cache

### `methodCache.call(method, key)`

Get results of a prior method call or call and cache
- Accepts method name to call and key as single param
- Only methods with a single string argument can be cached (currently) due to 
the usage of this argument as the index for the cached results.

### `methodCache.has(method)`

Checking if method has been cached
- Accepts method name
- Returns bool

### `methodCache.get(method, key)`

Get results of a prior method call
- Accepts method name and key (argument method called with)
- Returns results at key

### `methodCache.reset(method, key?)`

Reset a cached method call's results
- Accepts a method name, optional key
- If key given, clears only that result set
- Returns bool

### `methodCache.resetAll()`

 Reset cached results for all methods
 - Returns nothing
241

242 243 244 245 246
---

## Getting Started

A local instance of Rocket.Chat is required for unit tests to confirm connection
247 248
and subscription methods are functional. And it helps to manually run your SDK
interactions (i.e. bots) locally while in development.
249 250 251

## Use as Dependency

252 253 254 255 256 257
`yarn add @rocket.chat/sdk` or `npm install --save @rocket.chat/sdk`

ES6 module, using async

```
import * as rocketchat from '@rocket.chat/sdk'
258

259
const asteroid = await rocketchat.driver.connect({ host: 'localhost:3000' })
260
console.log('connected', asteroid)
261 262
```

263 264
ES5 module, using callback

265
```
266
const rocketchat = require('@rocket.chat/sdk')
267

268
rocketchat.driver.connect({ host: 'localhost:3000' }, function (err, asteroid) {
269 270 271 272
  if (err) console.error(err)
  else console.log('connected', asteroid)
})
```
273 274 275 276 277 278 279 280

## Develop & Test

### Settings

| Env var | Description |
| --------------------- | ---------------------------------------------------- |
| `ROCKETCHAT_URL` | URL of the Rocket.Chat to connect to |
281
| `ROCKETCHAT_AUTH` | Set to 'ldap' to enable LDAP login |
282 283
| `ADMIN_USERNAME` | Admin user password for API |
| `ADMIN_PASS` | Admin user password for API |
284 285
| `ROCKETCHAT_USER` | User password for SDK tests |
| `ROCKETCHAT_PASS` | Pass username for SDK tests |
286
| `INTEGRATION_ID` | ID applied to message object to integration source |
287 288 289 290
| `ROOM_CACHE_SIZE` | Size of cache (LRU) for room (ID or name) lookups |
| `ROOM_CACHE_MAX_AGE` | Max age of cache for room lookups |
| `DM_ROOM_CACHE_SIZE` | Size of cache for Direct Message room lookups |
| `DM_ROOM_CACHE_MAX_AGE` | Max age of cache for DM lookups |
291 292 293 294 295 296 297

These are only required in test and development, assuming in production they
will be passed from the adapter implementing this package.

### Installing Rocket.Chat

Clone and run a new instance of Rocket.Chat locally, using either the internal
298
mongo or a dedicated local mongo for testing, so you won't affect any other
299 300 301
Rocket.Chat development you might do locally.

The following will provision a default admin user on build, so it can be used to
302
access the API, allowing SDK utils to prepare for and clean up tests.
303

304 305
- `git clone https://github.com/RocketChat/Rocket.Chat.git rc-sdk-test`
- `cd rc-sdk-test`
306
- `meteor npm install`
307
- `export ADMIN_PASS=pass; export ADMIN_USERNAME=sdk; export MONGO_URL='mongodb://localhost:27017/rc-sdk-test'; meteor`
308 309 310 311 312

Using `yarn` to run local tests and build scripts is recommended.

Do `npm install -g yarn` if you don't have it. Then setup the project:

313 314
- `git clone https://github.com/RocketChat/Rocket.Chat.js.SDK.git`
- `cd Rocket.Chat.js.SDK`
315 316
- `yarn`

317
### Test and Build Scripts
318

319
- `yarn test` runs tests and coverage locally (pretest does lint)
320 321
- `yarn test:debug` runs tests without coverage, breaking for debug attach
- `yarn docs` generates docs
322 323 324 325
- `yarn build` runs tests, coverage, compiles, tests package, generates docs
- `yarn test:package` uses package-preview to make sure the published node
package can be required and run only with defined dependencies, to avoid errors
that might pass locally due to existing global dependencies or symlinks.
326

327 328
`yarn:hook` is run on git push hooks to prevent publishing with failing tests,
but won't change coverage to avoid making any working copy changes after commit.
329 330 331 332 333 334 335

### Integration Tests

The node scripts in `utils` are used to prepare for and clean up after test
interactions. They use the Rocket.Chat API to create a bot user and a mock human
user (benny) for the bot to interact with. They *should* restore the pre-test
state but it is always advised to only run tests with a connection to a clean
336
local or fresh re-usable container instance of Rocket.Chat.
337 338 339 340

### Debugging

Configs are included in source for VS Code using Wallaby or Mocha Sidebar.