Skip to content
XMPP (Jabber) adapter for lita
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
lita-xmpp.gemspec

README.md

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.adapter.jid = "12345_123456@myserver.com"
  config.adapter.password = "secret"
  config.adapter.debug = false
  config.adapter.rooms = :all
  config.adapter.muc_domain = "conf.myserver.com"
  config.mention_name = "bot"
end

License

MIT

You can’t perform that action at this time.