incubator-s4-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mmo...@apache.org
Subject [1/2] git commit: Update Twitter example documentation to reflect auth scheme changes
Date Sun, 06 Oct 2013 11:55:38 GMT
Updated Branches:
  refs/heads/dev 276a49772 -> fc379a642


Update Twitter example documentation to reflect auth scheme changes


Project: http://git-wip-us.apache.org/repos/asf/incubator-s4/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-s4/commit/1f9d84e3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-s4/tree/1f9d84e3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-s4/diff/1f9d84e3

Branch: refs/heads/dev
Commit: 1f9d84e3fc85a47ef795cd37b21813505cbdae4b
Parents: 276a497
Author: Matthieu Morel <mmorel@apache.org>
Authored: Sun Oct 6 13:18:16 2013 +0200
Committer: Matthieu Morel <mmorel@apache.org>
Committed: Sun Oct 6 13:53:04 2013 +0200

----------------------------------------------------------------------
 .../doc/0.6.0/twitter_trending_example.md       | 24 ++++++++++++++++++++
 1 file changed, 24 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/1f9d84e3/website/content/doc/0.6.0/twitter_trending_example.md
----------------------------------------------------------------------
diff --git a/website/content/doc/0.6.0/twitter_trending_example.md b/website/content/doc/0.6.0/twitter_trending_example.md
index f7fabf4..cbe8f26 100644
--- a/website/content/doc/0.6.0/twitter_trending_example.md
+++ b/website/content/doc/0.6.0/twitter_trending_example.md
@@ -24,9 +24,33 @@ Have a look at the code in these directories. You'll note that:
 > Note: You need a twitter4j.properties file in your home directory with the following
content (debug is optional):
 
 	debug=true
+	// not valid since june 2013
 	user=<a twitter username>
 	password=<matching password>
 
+**UPDATE:** In June 2013 Twitter updated the way external consumers can use Twitter APIs:
**external consumers must now use [OAuth](http://oauth.net/)**. 
+
+
+As a result, the twitter example shipped with S4 distribution *does not work out of the box*.
The good news is there is a workaround and we applied a [patch](https://issues.apache.org/jira/browse/S4-138)
on the `dev` branch.
+
+To make things work with the new Twitter access control scheme:
+
+1. get the code updates
+	* either by checking out the code from the `dev` branch
+	* or by applying the relevant [change](https://github.com/apache/incubator-s4/commit/276a49772f00a7880d270941a8e05c878ee2484e)
e.g. by cherry-picking it
+
+1. get an OAuth token. [This page](https://dev.twitter.com/docs/auth/tokens-devtwittercom)
may help
+
+1. use the token parameters in the twitter4j.properties file in the home directory:
+
+		oauth.consumerKey=<consumer key>
+		oauth.consumerSecret=<consumer secret>
+		oauth.accessToken=<access token>
+		oauth.accessTokenSecret=<access token secret>
+
+Once Twitter access is configured, we can start the S4 application.
+
+
 * Start a Zookeeper clean instance. From the S4 base directory, do:
 	
 		./s4 zkServer -clean


Mime
View raw message