warawara

XMPP bot for cerca public RSS feed
git clone http://git.permacomputing.net/repos/warawara.git # read-only access
Log | Files | Refs | README

README (1721B)


      1 warawara
      2 ========
      3 
      4 XMPP bot for cerca public RSS feed.
      5 
      6 
      7 hu?
      8 ---
      9 
     10 warawara is a simple XMPP bot that fetches an RSS feed and will only retain
     11 the top element (title, description and link). This data will be used to form
     12 a groupchat message for an XMPP MUC. Every 16 minutes it tries again and if
     13 there is something new it will post it, otherwise it will sleep further.
     14 
     15 It can be used for other RSS feeds but the odd choices are here because it is
     16 essentially made to be used with the cerca forum, which public feed only 
     17 display the latest posts, only one per thread, most recent at the top.
     18 
     19 It's not really meant to be an accurate notification system, because it does
     20 not even try to parse anything beyond fetching the first XML items, so if more
     21 than one message is posted between two fetches, only the latest one will be 
     22 retained. Also cerca does not keep the history of recent messages in the feed
     23 either, so at best warawara could just improve accuracy across threads, but not
     24 within one thread.
     25 
     26 warawara doesn't persist feed downloads between restarts or downtime. The first
     27 feed load is treated as "the beginning". So, new posts made between restarts or
     28 downtime will not create notifications.
     29 
     30 It's OK, warawara is just meant to be a little reminder that there is some
     31 activity on the forum.
     32 
     33 hack
     34 ----
     35 
     36 *change things*
     37 go build -v .
     38 ./warawara ...
     39 
     40 usage
     41 -----
     42 
     43 warawara [options]
     44 
     45 -bot            bot JID
     46 -muc            MUC JID
     47 -password       bot JID password
     48 -server         server to join
     49 -url            RSS feed URL
     50 
     51 
     52 example
     53 -------
     54 
     55 warawara -bot news@xmpp.pizza \
     56   -password h4cKM3
     57   -server xmpp.pizza
     58   -muc partyline@muc.xmpp.pizza
     59   -url https://login:password@cerca.exxonmobil.com/rss.xml
     60 
     61 
     62