Merge lp:~the-dod/sahana-eden/twitter-oauth into lp:sahana-eden

[The Dod]

Twitter-OAuth integration, phase 1.
See comment on the commit.
Hope I'm doing everything right being new to s3 and all :)

[Fran Boon (flavour)]

Hi,

This work looks great - you're really getting to grips with the framework :)

I'm not sure about the naming of these settings:
deployment_settings.oauth.consumer_key=""
deployment_settings.oauth.consumer_secret=""

Would we now have a different oauth consumer key/secret for other applications?
If so then we should have twitter in the name to differentiate, e.g.:
deployment_settings.twitter.oauth_consumer_key=""
deployment_settings.twitter.oauth_consumer_secret=""

& hence:
def get_twitter_oauth_consumer_key(self):
def get_twitter_oauth_consumer_secret(self):

I'm happy to make the code changes & all below, just want clarity on your understanding.

I'm not sure I like assuming that non-GETs are POSTs, we do support HTTP PUT & DELETE too.

I'd personally prefer to be told about a missing library before a missing configuration as this can be a more significant blocker.

Also a few PEP8 cleanups needed (spaces after commas)- just try to bear it in mind for new code.

Many thanks - help clarify my understanding of OAuth & then I can merge/cleanup :)

F

review: Needs Information

[The Dod (the-dod)]

First - I'd like to add one more resubmission - I've used jr.method to see whether we're in ["create","delete"] or we should make pin.readable False. Looks neater, and saves API calls to twitter too ;)

OAuth:

We can't register a global app for all sahana instances in the world (although it would work), because if you distribute these credentials, they can be used for hanky panky in your name, but it's easy (and requires no human verification) to register a twitter app:

you just login to twitter as @YourOrg or @YourOrgTech (better use an account of a real person or org that tweets "normal" tweets, so that twitter doesn't falsely-detect you as malware), and register an app at http://twitter.com/apps -form would look like
http://zzzen.com/sahana-twitter-app-reg.jpg

[ The "via" link is a vanity thing. Cool for publicizing the org or a specific event/campaign/etc. See "2 turntables..." link at http://twitter.com/TheRealDod/status/14221966738 ]

Once app is registered and credentials are in 000_config, site's operator (not necessarily the tech who did the 000_config) logs in to twitter as @YourOrgSahanaBot (this can be a virgin account that represents the sahana instance).

From twitter settings operator then click the "from twitter" link in the update form and gets something like
http://zzzen.com/sahana-oauth-request.jpg
After clicking allow, twitter returns a PIN for the form, and the rest of the OAuth happens at onvalidate.

[The Dod (the-dod)]

oops. s/["create","delete"]/["create","update"]/ (it's only in the comment here. not in the code :) )

[lp:~the-dod/sahana-eden/twitter-oauth]

1348. By Fran Boon on 2010-10-11

Merge thedod: Twitter OAuth support using tweepy. Also did general cleanup of Messaging

=== modified file 'controllers/msg.py'
--- controllers/msg.py	2010-10-10 05:06:31 +0000
+++ controllers/msg.py	2010-10-11 20:32:47 +0000
@@ -12,13 +12,13 @@
 
 # Options Menu (available in all Functions' Views)
 response.menu_options = [
-	[T("Compose"), False, URL(r=request, c="msg", f="compose")],
-	[T("Distribution groups"), False, URL(r=request, f="group"), [
-		[T("List/Add"), False, URL(r=request, f="group")],
-		[T("Group Memberships"), False, URL(r=request, f="group_membership")],
-	]],
-	[T("Log"), False, URL(r=request, f="log")],
-	[T("Outbox"), False, URL(r=request, f="outbox")],
+    [T("Compose"), False, URL(r=request, c="msg", f="compose")],
+    [T("Distribution groups"), False, URL(r=request, f="group"), [
+        [T("List/Add"), False, URL(r=request, f="group")],
+        [T("Group Memberships"), False, URL(r=request, f="group_membership")],
+    ]],
+    [T("Log"), False, URL(r=request, f="log")],
+    [T("Outbox"), False, URL(r=request, f="outbox")],
     #["CAP", False, URL(r=request, f="tbc")]
 ]
 
@@ -228,8 +228,8 @@
             _title=T("Delete") + "|" + T("If this is set to True then mails will be deleted from the server after downloading.")))
 
     if not auth.has_membership(auth.id_group("Administrator")):
-		session.error = UNAUTHORISED
-		redirect(URL(r=request, f="index"))
+        session.error = UNAUTHORISED
+        redirect(URL(r=request, f="index"))
     # CRUD Strings
     ADD_SETTING = T("Add Setting")
     VIEW_SETTINGS = T("View Settings")
@@ -251,6 +251,70 @@
     response.menu_options = admin_menu_options
     return shn_rest_controller(module, "email_settings", listadd=False, deletable=False)
 
[e-mail]_requires_membership(1)
+def twitter_settings():
+    """ RESTful CRUD controller for twitter settings - appears in the administration menu """
+
+    # CRUD Strings
+    ADD_SETTING = T("Add Setting")
+    VIEW_SETTINGS = T("View Settings")
+    s3.crud_strings[tablename] = Storage(
+        title_create = ADD_SETTING,
+        title_display = T("Setting Details"),
+        title_list = VIEW_SETTINGS,
+        title_update = T("Authenticate system's Twitter account"),
+        title_search = T("Search Settings"),
+        subtitle_list = T("Settings"),
+        label_list_button = VIEW_SETTINGS,
+        label_create_button = ADD_SETTING,
+        msg_record_created = T("Setting added"),
+        msg_record_modified = T("System's Twitter account updated"),
+        msg_record_deleted = T("Setting deleted"),
+        msg_list_empty = T("No Settings currently defined")
+    )
+    
+    def prep(jr):
+        if not (deployment_settings.oauth.consumer_key and deployment_settings.oauth.consumer_secret):
+            session.error=T("You should edit oauth_settings at models/000_config.py")
+            return True
+        try:
+            import tweepy
+        except:
+            session.error=T("Couldn't import tweepy library")
+            return True
+        oauth = tweepy.OAuthHandler(deployment_settings.oauth.consumer_key,
+            deployment_settings.oauth.consumer_secret)
+
+        resource = request.function
+        tablename = module + "_" + resource
+        table = db[tablename]
+
+        if jr.http == "GET" and jr.method in ["create","update"]: # We're showing the form
+            try:
+                session.s3.twitter_oauth_url = oauth.get_authorization_url()
+                session.s3.twitter_request_key = oauth.request_token.key
+                session.s3.twitter_request_secret = oauth.request_token.secret
+            except tweepy.TweepError:
+                session.error=T("problem connecting to twitter.com - please refresh")
+                return True
+            table.pin.readable = True
+            table.pin.label = SPAN(T("PIN number "),
+                A(T("from Twitter"), _href=T(session.s3.twitter_oauth_url), _target="_blank"),
+                T(" (leave empty to detach account)"))
+            table.pin.value = ""
+            table.twitter_account.label = T("Current twitter account")
+            return True
+        else: # Not showing form, no need for pin
+            table.pin.readable = False
+            table.pin.label = T("PIN") # won't be seen
+            table.pin.value = ""       # but let's be on the safe side
+        return True
+    response.s3.prep = prep
+    
+    response.menu_options = admin_menu_options
+    return shn_rest_controller(module, "twitter_settings", listadd=False, deletable=False)
+
+
 #--------------------------------------------------------------------------------------------------
 
 # The following 2 functions hook into the pr functions
@@ -395,16 +459,16 @@
     return item
 
 def process_sms_via_api():
-	"Controller for SMS api processing - to be called via cron"
+    "Controller for SMS api processing - to be called via cron"
 
-	msg.process_outbox(contact_method = 2)
-	return
+    msg.process_outbox(contact_method = 2)
+    return
 
 def process_email_via_api():
-	"Controller for Email api processing - to be called via cron"
+    "Controller for Email api processing - to be called via cron"
 
-	msg.process_outbox(contact_method = 1)
-	return
+    msg.process_outbox(contact_method = 1)
+    return
 
 def process_sms_via_tropo():
     "Controller for SMS tropo processing - to be called via cron"
@@ -632,4 +696,3 @@
     response.s3.pagination = True
     
     return shn_rest_controller(module, resource, listadd=False)
-

=== modified file 'models/000_config.py'
--- models/000_config.py	2010-10-10 10:16:05 +0000
+++ models/000_config.py	2010-10-11 20:32:47 +0000
@@ -27,6 +27,14 @@
 deployment_settings.auth.registration_requires_approval = False
 deployment_settings.auth.openid = False
 
+# Twitter OAuth settings:
+# Register an app at http://twitter.com/apps
+# (select Aplication Type: Client)
+# You'll get your consumer_key and consumer_secret from twitter
+# Keep these empty if you don't need twitter integration
+deployment_settings.oauth.consumer_key=""
+deployment_settings.oauth.consumer_secret=""
+
 # Base settings
 # Set this to the Public URL of the instance
 deployment_settings.base.public_url = "http://127.0.0.1:8000"
@@ -254,7 +262,7 @@
                 pr_address = {"importer" : True},
                 pr_pe_contact = {"importer" : True},
                 pr_presence = {"importer" : True},
-	 	        pr_identity = {"importer" : True},
+                pr_identity = {"importer" : True},
                 pr_person = {"importer" : True},
                 pr_group = {"importer" : True},
                 pr_group_membership = {"importer" : True},
@@ -327,18 +335,18 @@
     #        module_type = 10,
     #    ),
     importer = Storage(
-    	     name_nice = "Spreadsheet Importer",
-    	     description = "Used to import data from spreadsheets into the database",
-    	     module_type = 10,
+             name_nice = "Spreadsheet Importer",
+             description = "Used to import data from spreadsheets into the database",
+             module_type = 10,
     ),
     survey = Storage(
-    	     name_nice = "Survey Module",
-    	     description = "Create, enter, and manage surveys.",
-    	     module_type = 10,
+             name_nice = "Survey Module",
+             description = "Create, enter, and manage surveys.",
+             module_type = 10,
     )
     #lms = Storage(
     #        name_nice = T("Logistics Management System"),
     #        description = T("An intake system, a warehouse management system, commodity tracking, supply chain management, procurement and other asset and resource management capabilities."),
     #        module_type = 10
     #    ),
-)
\ No newline at end of file
+)

=== modified file 'models/00_utils.py'
--- models/00_utils.py	2010-10-04 21:57:29 +0000
+++ models/00_utils.py	2010-10-11 20:32:47 +0000
@@ -38,7 +38,7 @@
     # Security Policy
     #session.s3.self_registration = deployment_settings.get_security_self_registration()
     session.s3.security_policy = deployment_settings.get_security_policy()
-
+    
     # We Audit if either the Global or Module asks us to
     # (ignore gracefully if module author hasn't implemented this)
     try:

=== modified file 'models/01_menu.py'
--- models/01_menu.py	2010-10-09 20:35:42 +0000
+++ models/01_menu.py	2010-10-11 20:32:47 +0000
@@ -91,6 +91,7 @@
     [T("Messaging"), False, "#",[
             [T("Global Messaging Settings"), False, URL(r=request, c="msg", f="setting", args=[1, "update"])],
             [T("Email Settings"), False, URL(r=request, c="msg", f="email_settings", args=[1, "update"])],
+            [T("Twitter Settings"), False, URL(r=request, c="msg", f="twitter_settings", args=[1, "update"])],
             [T("Modem Settings"), False, URL(r=request, c="msg", f="modem_settings", args=[1, "update"])],
             [T("Gateway Settings"), False, URL(r=request, c="msg", f="gateway_settings", args=[1, "update"])],
             [T("Tropo Settings"), False, URL(r=request, c="msg", f="tropo_settings", args=[1, "update"])],

=== modified file 'models/msg.py'
--- models/msg.py	2010-10-10 20:14:10 +0000
+++ models/msg.py	2010-10-11 20:32:47 +0000
@@ -6,7 +6,6 @@
 
 module = "msg"
 if deployment_settings.has_module(module):
-
     # Settings
     resource = "setting"
     tablename = "%s_%s" % (module, resource)
@@ -18,6 +17,53 @@
     table.outgoing_sms_handler.requires = IS_IN_SET(["Modem","Gateway","Tropo"], zero=None)
 
     #------------------------------------------------------------------------
+    resource="twitter_settings"
+    tablename = "%s_%s" % (module, resource)
+    table = db.define_table(tablename,
+                            Field("pin"),
+                            Field("oauth_key"),
+                            Field("oauth_secret"),
+                            Field("twitter_account"),
+                            migrate=migrate)
+    table.oauth_key.writable = False
+    table.oauth_secret.writable = False
+
+    ### comment these 2 when debugging
+    table.oauth_key.readable = False
+    table.oauth_secret.readable = False
+    
+    table.twitter_account.writable = False
+    
+    def twitter_settings_onvalidation(form):
+        """ Complete oauth: take tokens from session + pin from form, and do the 2nd API call to twitter """
+        if form.vars.pin and session.s3.twitter_request_key and session.s3.twitter_request_secret:
+            try:
+                import tweepy
+            except:
+                raise HTTP(501,body="can't import tweepy")
+                          
+            oauth = tweepy.OAuthHandler(deployment_settings.oauth.consumer_key,
+                deployment_settings.oauth.consumer_secret)
+            oauth.set_request_token(session.s3.twitter_request_key,session.s3.twitter_request_secret)
+            try:
+                oauth.get_access_token(form.vars.pin)
+                form.vars.oauth_key = oauth.access_token.key
+                form.vars.oauth_secret = oauth.access_token.secret
+                twitter = tweepy.API(oauth)
+                form.vars.twitter_account = twitter.me().screen_name
+                form.vars.pin = "" # we won't need it anymore
+                return
+            except tweepy.TweepError:
+                session.error=T("Settings were reset because authenticating with twitter failed")
+        # Either user asked to reset, or error - clear everything
+        for k in ['oauth_key','oauth_secret','twitter_account']:
+            form.vars[k] = None
+        for k in ['twitter_request_key','twitter_request_secret']:
+            session.s3[k] = ""
+        
+    s3xrc.model.configure(table, onvalidation=twitter_settings_onvalidation) 
+
+    #------------------------------------------------------------------------
     resource = "email_settings"
     tablename = "%s_%s" % (module, resource)
     table = db.define_table(tablename,

=== modified file 'modules/s3cfg.py'
--- modules/s3cfg.py	2010-09-21 06:34:46 +0000
+++ modules/s3cfg.py	2010-10-11 20:32:47 +0000
@@ -11,6 +11,7 @@
         self.database = Storage()
         self.gis = Storage()
         self.mail = Storage()
+        self.oauth = Storage()
         self.L10n = Storage()
         self.security = Storage()
         self.ui = Storage()
@@ -107,6 +108,12 @@
     def get_gis_spatialdb(self):
         return self.gis.get("spatialdb", False)
     
+    # OAuth settings
+    def get_oauth_consumer_key(self):
+        return self.oauth.get("consumer_key","")
+    def get_oauth_consumer_secret(self):
+        return self.oauth.get("consumer_secret","")
+    
     # L10N Settings
     def get_L10n_countries(self):
         return self.L10n.get("countries", "")