skorn / lita-xmpp

XMPP (Jabber) adapter for lita

lita-xmpp

If it works, cool. If it doesn't, there's always HipChat.

lita-xmpp is an adapter for Lita that allows you to use the robot with XMPP.

Installation

Add lita-xmpp to your Lita instance's Gemfile:

gem "lita-xmpp"

Configuration

Required attributes

• jid (String) - The JID of your robot's account. Default: nil.
• password (String) - The password for your robot's account. Default: nil.

Optional attributes

• debug (Boolean) - If true, turns on the underlying Jabber library's (xmpp4r) logger, which is fairly verbose. Default: false.
• rooms (Symbol, Array) - An array of room JIDs that Lita should join upon connection. Can also be the symbol :all, which will cause Lita to discover and join all rooms. Default: nil (no rooms).
• muc_domain (String) - The XMPP Multi-User Chat domain to use.

There's no need to set config.robot.mention_name manually. The adapter will load the proper mention name from the XMPP roster upon connection.

Example

Lita.configure do |config|
  config.robot.name = "Lita Bot"
  config.robot.adapter = :xmpp
  config.adapters.xmpp.jid = "[email protected]"
  config.adapters.xmpp.password = "secret"
  config.adapters.xmpp.debug = false
  config.adapters.xmpp.rooms = :all
  config.adapters.xmpp.muc_domain = "conf.myserver.com"
  config.mention_name = "bot"
end

License

MIT