https://github.com/timnew/hubot-bearychat
BearyChat Adapter for Hubot
https://github.com/timnew/hubot-bearychat
Last synced: 9 months ago
JSON representation
BearyChat Adapter for Hubot
- Host: GitHub
- URL: https://github.com/timnew/hubot-bearychat
- Owner: timnew
- License: mit
- Created: 2016-01-01T16:07:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-01T06:54:30.000Z (over 10 years ago)
- Last Synced: 2025-07-10T21:26:32.339Z (11 months ago)
- Language: CoffeeScript
- Homepage: https://github.com/timnew/hubot-bearychat
- Size: 9.77 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DEPRECATED: The hubot-bearychat package ownship has been transfered back to BearyChat company per their request, and I also removed myself from the package maintiners list as their requirement. The new package will be developed and maintained by BearyChat company. Code here is deprecated and not related to new adapter. The repo will not updated any longer. Please use offical adapter in the future.
=========================================================================================
hubot-bearychat [![NPM version][npm-image]][npm-url] [![Dependency Status][depstat-image]][depstat-url]
================
> `hubot-bearychat` is an [BearyChat] adapter for Hubot
## Install
Install using [npm][npm-url].
$ npm install hubot-bearychat --save
And start hubot with adapter `bearychat`
$ bin/hubot -a bearychat
## Configuration
Due to lack of built-in support from [BearyChat], so this adapter simulate the full conversation capability with a pair of `Incoming` and `Outgoing` Robots.
### Incoming Robot
1. Add a Incoming Robot(Purple one) to your BearyChat
2. Copy the `Hook Address` url in the `Robot Settings`, it looks like `https://hook.bearychat.com//incoming/`
3. Set the url to environment variable `BEARY_CHAT_INCOMING`
### Outgoing Robot
1. Add a Outgoing Robot(Black one) to your BearyChat
2. Set the `trigger word` to your robot's name or robot's alias (Be careful this is case-sensitive)
3. Set `https:///bearychat/outgoing` to the `POST Request Address` in your `Robot Settings`
**Hint: ** Adapter by default register the web hook url at `/bearychat/outgoing`, but this can be override with `BEARY_CHAT_OUTGOING` environment variable.
### Test
Once you set it up, and have your robot deployed.
If everything goes right, you will see Robot posts ` is online.` message to your chatroom.
And if you says ` adapter`, it will responds `bearychat`.
**PITFALL: ** It robot doesn't responds, check your Outgoing Robot's `trigger word`, it must be aligned to your you robot's name or alias. Or Your robot cannot parse it properly. And if you are using English, you need to aware the trigger word is case-sensitive.
## License
MIT
[![NPM downloads][npm-downloads]][npm-url]
[homepage]: https://github.com/timnew/hubot-bearychat
[npm-url]: https://npmjs.org/package/hubot-bearychat
[npm-image]: http://img.shields.io/npm/v/hubot-bearychat.svg?style=flat
[npm-downloads]: http://img.shields.io/npm/dm/hubot-bearychat.svg?style=flat
[depstat-url]: https://gemnasium.com/timnew/hubot-bearychat
[depstat-image]: http://img.shields.io/gemnasium/timnew/hubot-bearychat.svg?style=flat
[BearyChat]: https://bearychat.com/