https://github.com/dacort/firejab
A simple Campfire to Jabber bridge
https://github.com/dacort/firejab
Last synced: 3 months ago
JSON representation
A simple Campfire to Jabber bridge
- Host: GitHub
- URL: https://github.com/dacort/firejab
- Owner: dacort
- Created: 2011-08-08T22:28:21.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2011-11-01T17:20:39.000Z (over 13 years ago)
- Last Synced: 2025-02-15T19:43:30.593Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 110 KB
- Stars: 5
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
- Changelog: HISTORY.markdown
Awesome Lists containing this project
README
Firejab
=====
Firejab is a simple gem for connecting Campfire to Jabber. All communication is through a Jabber (or gchat) user.
Overview
-----
All Firejab needs to function is the site and room id for Campfire, and authentication information for both Campfire and Jabber. It just takes two lines to run the bot:
``` ruby
c = Firejab::Connection.new(
:domain => campfire_domain,
:room_id => campfire_room_id,
:token => campfire_token,
:jabber => {
:username => jabber_email,
:password => jabber_password
}
)
c.run
```
The first time a user communicates with Firejab, it will request an authentication token. If you would like to add one manually (for testing purposes), there's a public `add_token` method:
``` ruby
c.add_token(jabber_email, campfire_token)
```
TODO
-----
* Persistent store of user authentication information
* Support for multiple rooms or rooms defined by user
* Verify that token is valid and lookup user data
Eventually will probably have to make a CampfireUser class to handle this easily/gracefully
* Make HTTP requests within EventMachine async
* Presence notifications
* Utility commands like /who
* Properly handle subscription requests
* Error handling/reconnects
* Jabber disconnects when I send this: "I can probably dig up the old VB code... ;)"
Proposed Schema
-----
| jabber_username | campfire_token | campfire_uid | campfire_name |