30810eecd7
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Code scanning - action / CodeQL-Build (push) Failing after 2s
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# Rocket.chat bot helpers
|
|
|
|
This package provides some extra shortcut Meteor methods intended to help Hubot scripts.
|
|
|
|
## Approach
|
|
|
|
This was an experiment in how to extend Hubot and Rocket.chat integration.
|
|
|
|
Keeping controller logic out of Hubot scripts made sense to me, but its not necessarily the best approach.
|
|
|
|
For bots to use these methods they obviously need this package added to Rocket.chat as well as the [rocketchat adapter](https://github.com/RocketChat/hubot-rocketchat).
|
|
|
|
## Usage
|
|
|
|
In Hubot scripts, call bot helper methods using Meteor.call with the first argument as the helper type, then the method name as second argument.
|
|
|
|
At present, there's only one type of helper (`botRequest`) for simple getters, more utility methods may be added in future.
|
|
|
|
e.g. Below uses `onlineNames` method, which returns array of names of online users (not including bots).
|
|
|
|
Listens for *"who is online"* and replies with something like *"Robert, Desmond and Billie are currently online"*.
|
|
|
|
```
|
|
# Use Bot Helpers class to check who's online
|
|
robot.hear /who is online/i, (res) ->
|
|
promise = robot.adapter.callMethod('botRequest', 'onlineNames')
|
|
promise.then (result) ->
|
|
if result.length > 0
|
|
names = result.join(', ').replace(/,(?=[^,]*$)/, ' and ') # convert last comma to 'and'
|
|
res.send "#{ names } #{ if result.length == 1 then 'is' else 'are' } currently online"
|
|
else
|
|
res.send "Nobody is currently online... \*cricket sound\*"
|
|
return
|
|
, (error) ->
|
|
res.send "Uh, sorry I don't know, something's not working"
|
|
return
|
|
```
|
|
|
|
Method names that include fields like `allUsernames` return an 1D array of just that property.
|
|
|
|
First two methods return 2D array with properties defined in a defaults object (currently id, name, username, status, emails).
|
|
|
|
- `allUsers`
|
|
- `onlineUsers`
|
|
- `allUsernames`
|
|
- `onlineUsernames`
|
|
- `allNames`
|
|
- `onlineNames`
|
|
- `allIDs`
|
|
- `onlineIDs`
|
|
|
|
## Tests
|
|
|
|
None yet, PR adding tests would be much apreciated.
|