Mercurial > prosody-wiki

annotate mod_pubsub_twitter.wiki @ 501:cd074071ac43

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_mam: update
author Kim Alvefur <zash@zash.se>
date Wed, 07 Jan 2015 21:22:53 +0100
parents 528721aaea46
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
342
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Subscribe to Twitter search queries over pubsub
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 Twitter has an open 'realtime' search API, but it requires polling (within their rate limits). This module allows Prosody to poll for you, and push new results to subscribers over XMPP.
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 = Configuration =
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 {{{
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13 Component "pubsub.example.com" "pubsub"
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 modules_enabled = { "pubsub_twitter" }
454
528721aaea46 a bunch of pages: strip trailing whitespace
Kim Alvefur <zash@zash.se>
parents: 342
diff changeset
15
342
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 twitter_searches = {
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 realtime = "xmpp OR realtime";
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18 prosody = "prosody xmpp";
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19 }
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20 }}}
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 This example creates two nodes, 'realtime' and 'prosody' that clients can subscribe to using [http://xmpp.org/extensions/xep-0060.html XEP-0060]. Results are in [http://atomenabled.org/ ATOM 1.0 format] for easy consumption.
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24 || *Option* || *Description* ||
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25 || twitter_searches || A list of virtual nodes to create and their associated Twitter search queries. ||
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26 || twitter_pull_interval || Number of minutes between polling for new results (default 20) ||
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27 || twitter_search_url || URL of the JSON search API, default: "http://search.twitter.com/search.json" ||
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29 = Compatibility =
8e758f27b460 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 || 0.9 || Works ||