https://github.com/thunderpush/hubot-thunderpush
https://github.com/thunderpush/hubot-thunderpush
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thunderpush/hubot-thunderpush
- Owner: thunderpush
- License: mit
- Created: 2014-03-19T18:38:54.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-03-27T10:09:37.000Z (about 12 years ago)
- Last Synced: 2025-08-27T22:15:18.310Z (10 months ago)
- Language: CoffeeScript
- Size: 122 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hubot-thunderpush
A Hubot script to interact with a Thunderpush server as an API console.
Thunderpush is a Tornado and SockJS based push service. It provides a Beaconpush (beaconpush.com) inspired HTTP API and client. (https://github.com/thunderpush/thunderpush)
## Installing
Add dependency to Hubot's package.json:
```json
{
...
"dependencies": {
...
"hubot-thunderpush": "latest"
}
}
```
Include package in Hubot's external-scripts.json:
```json
["hubot-thunderpush"]
```
## Configuration
```
HUBOT_THUNDERPUSH_URL # Thunderpush API server URL
HUBOT_THUNDERPUSH_KEY # Thunderpush API Key
HUBOT_THUNDERPUSH_SECRET # Thunderpush API Secret Key
```
## UNIX
To launch hubot locally with the correct environment variable value:
```
./scripts/console
```
To add the correct environment variable to an existing and working Heroku deployment, you'll issue something like:
```
heroku config:add HUBOT_THUNDERPUSH_URL=http://thunderpush.myhost.com
heroku config:add HUBOT_THUNDERPUSH_KEY=key
heroku config:add HUBOT_THUNDERPUSH_SECRET=secret
```
## Commands
```
# Post message to a channel
hubot thunder send #
# Post message to a user
hubot thunder send @
# Get all online users
hubot thunder get all users
# Get user online status
hubot thunder get @ [status]
# Get channel online users
hubot thunder get # users
# Get channel online users
hubot thunder disconnect @
```
## Links
GitHub: https://github.com/thunderpush/hubot-thunderpush
npmjs: https://npmjs.org/package/hubot-thunderpush
Thunderpush: https://github.com/thunderpush/thunderpush