This incarnation is generalized a little, and it can serve as a (simple) general purpose IRC bot that will communicate with Trello. Configuration of API key and secret, channel name and URLs are driven thru ENV.
All you need to access is your developer key, providing the board is public. Trellobot uses the Trello API Ruby wrapper for this purpose. Trellobot has the capability to add cards to lists on a Trello board.
Trellobot understands the following commands:
- help - Displays help.
- lists - List all available lists on the board.
- sync - Resyncs cache with the board.
- card add this is a card - creates a new card named: 'this is a card' on a list defined in the TRELLO_ADD_CARDS_LIST env variable or if it's not present on a list named To Do
- card comment this is a comment on card - creates the comment 'this is a comment on card ' on the card with short id equal to
- card move to Doing - moves the card with short id equal to to the list Doing
- card add member joe - assign joe to the card with short id equal to .
- cards joe - return all cards assigned to joe
- card view email@example.com - sends an email to firstname.lastname@example.org with the content of the card with short id equal to
Anything else it interprets as the name of a list on the target board that has been configured. If you send a private message containing quit, accompanied by a passphrase, then Trellobot will disconnect from the server (and exit). Depending on how you have it deployed, it may very well respawn at that point, for example if you run it as a Heroku dyno.
Trellobot has quite a few env vars that is uses. Some of these are optional:
|TRELLO_API_KEY||Your Trello developer API key|
|TRELLO_API_SECRET||Your Trello developer API secret|
|TRELLO_API_ACCESS_TOKEN_KEY||Your Trello API access token key|
|TRELLO_BOARD_ID||The ID for your board|
|TRELLO_BOT_CHANNEL||The channel that trellobot should join - form is #channel - don't forget quotes for shell protection!|
|TRELLO_BOT_SERVER||The server the trellobot should connect to, defaults to irc.freenode.net|
|TRELLO_BOT_NAME||The name the trellobot should use, defaults to trellobot|
|TRELLO_BOT_QUIT_CODE||Passcode to cause trellobot to quit - defaults to empty|
|TRELLO_BOT_SERVER_USE_SSL||If ssl is required set this variable to "true" if not, do not set it at all. Optional|
|TRELLO_BOT_SERVER_SSL_PORT||If ssl is used set this variable to the port number that should be used. If not provided will default to 6697. Optional|
|TRELLO_ADD_CARDS_LIST||All cards are added at creation time to a default list. Set this variable to the name of this list, otherwise it will default to To Do|
|TRELLO_MAIL_ADDRESS||Address of the mail server used to send the cards|
|TRELLO_MAIL_PORT||Port of the mail server used to send the cards|
|TRELLO_MAIL_AUTHENTICATION||Type of authentication of the mail server used to send the cards|
|TRELLO_MAIL_USERNAME||Username in the mail server used to send the cards|
|TRELLO_MAIL_PASSWORD||Password for the username in the mail server used to send the cards|
|TRELLO_MAIL_ENABLE_STARTTLS_AUTO||Set to true if the mail server uses tls, false otherwise|
Where do I get an API key and API secret?
Log in as a Trello user and visit this URL to get a key and secret allocated: https://trello.com/1/appKey/generate
Where do I get an API Access Token Key?
You will need an access token to use ruby-trello 0.3.0 or higher, which trellobo depends on. To get it, you'll need to go to this URL:
At the end of this process, You'll be told to give some key to the app, this is what you want to put in the TRELLO_API_ACCESS_TOKEN_KEY
Where do I get the BOARD ID for my board?
The simplest way to get the id of your board is to
- Browse to it on the trello website
- Observe the URL; it should look something like https://trello.com/board/welcome-board/4e6a8095efa69909ba007382
- The id of your board is the 24-digit hex number at the end of the URL. In this case, it's
Initially, I used the magic of curl for this particular job of discovery. The Trello API covers a lot, as you can read in the beta docs and sometimes it's not immediately obvious where to grab on to find a particular piece of information.
The boards['id'] up there is the piece you are looking for - put this into the
TRELLO_BOARD_ID environment variable.
I've seen one weirdness on Heroku where a dyno running Trellobot appeared to disappear off into the dyno grid and keep running, even after it was stopped. This resulted in duplicate bots on the channel. After a couple of days the zombie bot disappeared of its own accord.
Pull requests are welcome :)