Jance Project
Welcome to the home page of the Jance bot.
Jance is a Jabber + Pownce bot that enables it's users to post to pownce by talking with him.
 |
| Jance and Gajim |
So far this is a little project, the source is released under the AGPL written in python using twisted and oauth to talk with the pownce API
You can get the latest release with:
hg clone http://hg.valkertown.org/jance.hg/
The Jance bot is currently running as pownce@valkertown.org, you can add him to any jabber roster(this includes Gmail accounts, and I think AIM too) and talk with him.
Valkertown's Jance bot is a development one and probably I would restart him from time to time so it may not be available.
Usage:
- Start a chat session with pownce@valkertown.org
- Send login to Jance, he will reply with and url You must visit this URL to authorize Jance to send the messages andd updates to Pownce. This process is fairly secure since you are visiting the official pownce page and your user name and password never go to the bot
- After you have authorized Jance to talk with Pownce you have to notify Jance with the command done, that's all you have to do before you start posting stuff to Pownce. Once done you don't have to do it again.
- In the case this step fails, start over and try to do it quickly since you have less than 20 seconds to issue the done command. This is caused by the oauth design and using a IM bot.
Now you can post messages, links and events to pownce, this way:
- msg to message
- link to url [message]
- event to event_name location date [message]
- reply post_id stars rsvp message
To query for the to field options you use the command:
- users
You can query the messages you send and get from pownce by issuing:
- notes [type] [limit] [page] to query the public notes that are published to Pownce
- mynotes [type] [limit] [page] to query the notes that are directed to you in pownce
- usernotes powceid [type] [limit] [page] to query the public notes of the especified user
At anytime you can query wich user is related to the JID you're using with:
- verify will return the user that's associated with the jabber account(Full JID including transport)
- logout will remove the JID and tokens from Jance database.
This documentation may get outdate so you can access the bot own documentation by issuing the command:
- help
Since currently Jance tokenizer and parser are quite stupid they only understand spaces as field separator so in the non comment/message fields you can't use spaces in them.
- type
- links, messages, events, files
- limit
- How many posts at a time you want to query
- page
- To access older posts
- to
- Can be public, all, set_x , friend_x
- message
- The message you attach it, it's free form.
- location
- As far as I can tell it's free form but since Pownce links to Google maps, better use locations that mean something to Google maps
- event_name
- Right now you can't use spaces here, besides from that it's free form.
- date
- Formatted like "YYYY-mm-dd HH:MM" -> 2008-01-16 20:00
Reply Command
Reply command requires an special consideration on it's own.
In Ponwce posts have unique ids, when you send to Jance the notes, usernotes and mynotes he will reply with something like this:
link from deepspawn: http://pownce.com/deepspawn/notes/2974890/ 2 min ago, 0 replies
So the post_id field in the reply command would be 2974890.
Now the stars field is a numeric field wich takes the following values:
- 0 No Rating
- 1 Star Rating
- 2 Stars Rating
- 3 Stars Rating
- 4 Stars Rating
- 5 Stars Rating
You can leave it at 0 but still will have to put something in any case, even for stuff like events that doesn't use the rating system.
Now for the RSVP field it's the same, it's a numeric value with the following values:
- 0 No RSVP Information
- 1 Attending
- 2 Busy Already
- 3 Not Attending
- 4 Running Late
- 5 Bringing Friends
- 6 Undecided
- 7 Wishing I Could Come!
You can leave it at 0 but will have to set it to some value in any case even if it's a reply to something that's not an event.
Next you will have the chance to set a message, if you set any of the other two values to non-zero you can ommit the message otherwise you must place some kind of message.
I don't know if this setting would please everyone but I think it's pretty straightforward and doesn't require too much writing on the user side, it's just not very verbose.
Feedback
I would love to hear feedback to improve the overall user experience of Jance, so you can write a mail to pownce@valkertown.org or contact me using deepspawn at Pownce.
Happy Powncing.
Callback URL: Jance Logged
© 2008 Carlos A. Perilla
