Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idobata/hubot-idobata
Idobata adapter for GitHub's Hubot
https://github.com/idobata/hubot-idobata
Last synced: about 1 month ago
JSON representation
Idobata adapter for GitHub's Hubot
- Host: GitHub
- URL: https://github.com/idobata/hubot-idobata
- Owner: idobata
- Created: 2014-01-07T06:31:50.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T11:52:19.000Z (over 4 years ago)
- Last Synced: 2024-10-13T01:19:44.807Z (2 months ago)
- Language: CoffeeScript
- Homepage: https://github.com/idobata/hubot-idobata
- Size: 226 KB
- Stars: 65
- Watchers: 39
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hubot-idobata
[](https://greenkeeper.io/)
[](https://travis-ci.org/idobata/hubot-idobata)
Idobata adapter for GitHub's Hubot
## Setup
1. Install [yeoman](http://yeoman.io/) generator for hubot:
``` sh
$ npm install --global generator-hubot
```
2. Create a new hubot:
``` sh
$ mkdir
$ cd
$ yo hubot
```
When generator ask you:
```
? Bot adapter: (campfire)
```
Please type `idobata`.
Then generator creates hubot project using `hubot-idobata`.
3. Create your bot on [Idobata][]:
4. Configure it:
This adapter requires the following environment variable:
* `HUBOT_IDOBATA_API_TOKEN`: the API token of bot's account.
This token is came from:
## Adapter specified API
### Send message as HTML
You can use `Adapter#sendHTML` instead of `Robot#send` to create message as HTML.
``` coffee
module.exports = (robot) ->
robot.respond /PING$/i, (msg) ->
# This API creates the palin text message.
# msg.send "PONG"
adapter = msg.robot.adapter
envelope = msg.envelope
# This API creates the HTML message.
adapter.sendHTML envelope, '
PONG'
```
## Deploying to heroku
1. First, setup your hubot to deploy to heroku:
* [Deploying Hubot to Heroku](https://github.com/github/hubot/blob/master/docs/deploying/heroku.md)
2. Add config to heroku:
* `HUBOT_IDOBATA_API_TOKEN`
```
$ heroku config:set HUBOT_IDOBATA_API_TOKEN=
```
* `HUBOT_NAME`
```
$ heroku config:set HUBOT_NAME=
```
3. Edit `Procfile`:
```
web: bin/hubot -a idobata
```
## Development
### Install
To customize hubot-idobata, it is recommended to work in your bot.
After clone, you can install it from your local path.
``` sh
$ git clone https://github.com/idobata/hubot-idobata.git
$ cd /path/to/your/pretty/bot
$ npm install /path/to/hubot-idobata
```
You need to re-install it every time you edit `/path/to/hubot-idobata/*`.
**Caution**
If you clone hubot-idobata to under `node_modules/`, hubot *couldn't respond* your message.
(see: [idobata/hubot-idobata#1](https://github.com/idobata/hubot-idobata/issues/1))
### Test
``` sh
$ npm test
```
## Links
* [Idobata][]
* [Hubot][]
[Idobata]: https://idobata.io/
[Hubot]: http://hubot.github.com/
[hubot-idobata]: https://github.com/idobata/hubot-idobata
## License
(The MIT License)
Copyright (c) 2014 Eiwa System Management, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.