hubot-flowdock-irc-relay

Sync an IRC channel with a Flowdock flow via Hubot.

This relay server will listen to incoming messages in a flow and a channel and relay them to each other.

It will also immitate an IRC client for each flowdock user in the flow and disguise messages as if they're written by that user.

For now, the relay server defaults to posting its error messages into the flow. This might be changed in the future, but for now, will help with identifying problems.

NOTES:

• Currently, as Flowdock doesn't provide an API for distinguishing whether a user is online or just registered to a specific flow, all registered users will be relayed to the IRC channel. This might prove to be confusing. Would love to implement a workaround if someone provides one.
• When relaying to flowdock, the IRC channel is added to the message: (#channel_name) user: message. This is used as an identifier to prevent echoing.
• When relaying to IRC, A (flowdock) string is added to the message. This is used as an identifier to prevent echoing.
• This relay server currently has no real direct dependency in Hubot. That is, Hubot it simply used as an executor.
• This is currently written in javascript, not coffeescript (DUH!)

Required Environment Variables

The following environment varaibles must be set:

# The Flowdock email you want to use (also the default relay user)
HUBOT_FLOWDOCK_LOGIN_EMAIL
# The flowdock password for the user
HUBOT_FLOWDOCK_LOGIN_PASSWORD
# The flowid of the flow to relay (e.g. 080cded7-aeea-446f-a1bb-5f5e09e66f54)
HUBOT_FLOWDOCK_IRC_FLOWID
# The IRC channel's name to relay (e.g. #test_irc_channel)
HUBOT_FLOWDOCK_IRC_CHANNEL
# The IRC server to use (e.g. irc.freenode.com)
HUBOT_FLOWDOCK_IRC_SERVER
# The default relay client to use (e.g. cosmo-admin)
HUBOT_FLOWDOCK_IRC_RELAY_CLIENT
# Whether heartbeat messages should be sent to the flow (defaults to False. Any other value will be True)
HEARTBEAT_ENABLED
# The interval in which heatbeat messages are sent (defaults to 43200000 (12 hours))
HEARTBEAT_INTERVAL
# The flow to send the heartbeat message to (defaults to HUBOT_FLOWDOCK_IRC_FLOWID)
HEARTBEAT_FLOWID
# The heartbeat message to send (defaults to 'Flowdock-IRC Relay is still ALIVE! MUHAHAHAHA')
HEARTBEAT_MESSAGE

Getting Started

In your package.json, add the following:

"dependencies": {
    "hubot-flowdock-irc-relay": ">=0.0.4",
},

And in external-scripts.json make sure you have:

['hubot-flowdock-irc-relay']

Usage

Well, since the relay server simply runs in the background, there really is nothing you need to do.

In the future, a server management interface might be added so that you're able to hotswap channels, sign in as specific clients, and more...