Merge lp:~erduende/gwibber/bitly-support into lp:gwibber

[Jesús Carmona]

This patch adds bit.ly urlshorter support. In order to implement urlshorten service account authentication i have done some changes to preference window layout. Preferences windows now has a new tab named 'services' where you can find urlshorten configuration and perhaps add photo upload services in the future.

I have tried to follow your coding style but if you think something has to be changed, i'll change it to accomplish your requirements.

Waiting your considerations, i still have to finish text translations.

Sorry about my bad english ;)

[lp:~erduende/gwibber/bitly-support]

749. By Jesús Carmona on 2010-05-31

Removed merge conflict tags from code

[Omer Akram (om26er)]

Can you please only make the branch for bit.ly currently there is no scope for an extra tab.

review: Needs Resubmitting

[Ken VanDine (ken-vandine)]

It would be great to support bit.ly, could you update this to work with current trunk and make it use oauth instead of username/password? Perhaps if you select bit.ly from the drop down you can show a link authorize it in a browser.

review: Needs Resubmitting

Unmerged revisions

749. By Jesús Carmona on 2010-05-31

Removed merge conflict tags from code

748. By Jesus Carmona <pixie@pixie-desktop> on 2010-05-31

Bazaar conflicts corrections??

747. By Jesús Carmona on 2010-05-31

Added auth error window before saving username and api key if validation data is incorrect

746. By Jesús Carmona on 2010-05-31

Removed gwibber's bitly account API KEY because it is not needed for validation

745. By Jesús Carmona on 2010-05-30

Added bit.ly account validation befrore preferences saving

- Created bit.ly gwibber account (gwibberservice)
- Added API KEY to bitly.py

744. By Jesus Carmona <pixie@pixie-desktop> on 2010-05-21

- Added support for Bit.ly url shorter service

- Added "services" tab to preferences ui
- Moved url shorter preferences to "services" tab
- Show/hide login and api key fields if protocol needs them
- Added "Get api key" link to bit.ly service
- Stores bit.ly username in couchdb settings db and api key in gnomekeyring

=== modified file 'gwibber/microblog/dispatcher.py'
--- gwibber/microblog/dispatcher.py	2010-04-14 15:30:37 +0000
+++ gwibber/microblog/dispatcher.py	2010-05-31 11:52:27 +0000
@@ -20,6 +20,11 @@
 from util.const import *
 
 try:
+  import gnomekeyring
+except:
+  gnomekeyring = None
+
+try:
   import indicate
 except:
   indicate = None
@@ -613,6 +618,11 @@
     if self.IsShort(url): return url
     try:
       s = urlshorter.PROTOCOLS[service].URLShorter()
+
+      if urlshorter.PROTOCOLS[service].PROTOCOL_INFO.get('authtype') == 'login':
+        urlshorter_key = gnomekeyring.find_items_sync(gnomekeyring.ITEM_GENERIC_SECRET,{"id": SETTINGS['urlshorter_user']})[0].secret
+        s.auth(SETTINGS['urlshorter_user'], urlshorter_key)
+
       return s.short(url)
     except: return url
 

=== modified file 'gwibber/microblog/urlshorter/__init__.py'
--- gwibber/microblog/urlshorter/__init__.py	2009-04-15 22:56:03 +0000
+++ gwibber/microblog/urlshorter/__init__.py	2010-05-31 11:52:27 +0000
@@ -1,5 +1,5 @@
 
-import cligs, isgd, tinyurlcom, trim, ur1ca
+import cligs, isgd, tinyurlcom, trim, ur1ca, bitly
 #import snipurlcom, zima
 
 PROTOCOLS = {
@@ -10,4 +10,5 @@
   "tr.im": trim,
   "ur1.ca": ur1ca,
   #"zi.ma": zima,
+  "bit.ly": bitly,
 }

=== added file 'gwibber/microblog/urlshorter/bitly.py'
--- gwibber/microblog/urlshorter/bitly.py	1970-01-01 00:00:00 +0000
+++ gwibber/microblog/urlshorter/bitly.py	2010-05-31 11:52:27 +0000
@@ -0,0 +1,81 @@
+
+"""
+
+Bit.ly interface for Gwibber
+erduende (Jesus Carmona) - 05/14/2010
+
+"""
+
+import gtk
+import urllib2
+import json
+
+
+PROTOCOL_INFO = {
+
+  "name": "bit.ly",
+  "version": 0.1,
+  "fqdn" : "http://bit.ly",
+
+  "config": [
+    "private:api_key",
+    "username",
+  ],
+
+  "authtype": "login",
+
+}
+
+API_SERVER = 'http://api.bit.ly/v3'
+API_KEY = "R_58b2b15d49b0f84f90fb03fcf8f82d23"
+
+class URLShorter:
+
+  def short(self, text):
+    shorten = json.loads(urllib2.urlopen(API_SERVER+"/shorten?login="+self.user+"&apiKey="+self.key+"&uri=%s&format=json" % urllib2.quote(text)).read())
+    if shorten.get('status_code') == 200:
+      return shorten['data']['url']
+    else:
+      return text
+
+  def validate(self):
+    validate = json.loads(urllib2.urlopen(API_SERVER+"/validate?x_login=%s&x_apiKey=%s&login=%s&apiKey=%s&format=json" % (self.urlshorter_login_entry.get_text(), self.urlshorter_apikey_entry.get_text(), self.urlshorter_login_entry.get_text(), self.urlshorter_apikey_entry.get_text())).read())
+    if validate.get('status_code') == 200:
+        return validate['data']['valid']
+    else:
+        return False
+
+  def auth(self, user=None, key=None):
+    self.user = user
+    self.key = key
+
+
+  def auth_ui(self, login=None, api_key=None):
+    self.urlshorter_auth_table = gtk.Table(3, 2, True)
+    urlshorter_login_label = gtk.Label("bit.ly login:")
+    self.urlshorter_login_entry = gtk.Entry()
+    if login:
+        self.urlshorter_login_entry.set_text(login)
+    self.urlshorter_auth_table.attach(urlshorter_login_label, 0, 1, 0, 1)
+    self.urlshorter_auth_table.attach(self.urlshorter_login_entry, 1, 2, 0, 1)
+
+    urlshorter_apikey_label = gtk.Label("bit.ly API key:")
+    self.urlshorter_apikey_entry = gtk.Entry()
+    if api_key:
+        self.urlshorter_apikey_entry.set_text(api_key)
+    self.urlshorter_auth_table.attach(urlshorter_apikey_label, 0, 1, 1, 2)
+    self.urlshorter_auth_table.attach(self.urlshorter_apikey_entry, 1, 2, 1, 2)
+
+    urlshorter_getkey_link = gtk.LinkButton("http://bit.ly/a/your_api_key", "Get your API key")
+    self.urlshorter_auth_table.attach(urlshorter_getkey_link, 1, 2, 2, 3, gtk.EXPAND)
+
+    return self.urlshorter_auth_table
+
+  def clear_ui(self):
+    self.urlshorter_auth_table.destroy()
+
+  def get_username(self):
+    return self.urlshorter_login_entry.get_text()
+
+  def get_password(self):
+    return self.urlshorter_apikey_entry.get_text()

=== modified file 'gwibber/microblog/util/const.py'
--- gwibber/microblog/util/const.py	2010-04-15 05:47:35 +0000
+++ gwibber/microblog/util/const.py	2010-05-31 11:52:27 +0000
@@ -13,6 +13,7 @@
   "show_fullname": True,
   "shorten_urls": True,
   "urlshorter": "is.gd",
+  "urlshorter_user": None,
   "reply_append_colon": True,
   "retweet_style": "recycle",
   "global_retweet": False,

=== modified file 'gwibber/preferences.py'
--- gwibber/preferences.py	2010-05-03 04:25:30 +0000
+++ gwibber/preferences.py	2010-05-31 11:52:27 +0000
@@ -29,6 +29,11 @@
 from gwibber import util
 import gtk, gconf
 
+try:
+  import gnomekeyring
+except:
+  gnomekeyring = None
+
 import gettext
 from gettext import lgettext as _
 if hasattr(gettext, 'bind_textdomain_codeset'):
@@ -37,6 +42,8 @@
 
 from microblog.util.const import *
 from microblog.urlshorter import PROTOCOLS as urlshorters
+from microblog.util.exceptions import GwibberProtocolError
+import microblog.urlshorter
 
 from dbus.mainloop.glib import DBusGMainLoop
 
@@ -84,8 +91,24 @@
         for urlshorter in urlshorters.keys(): self.urlshorter_selector.append_text(urlshorter)
         self.ui.get_object("urlshorter_container").pack_start(self.urlshorter_selector, True, True)
         self.urlshorter_selector.set_active_iter(dict([(x[0].strip(), x.iter) for x in self.urlshorter_selector.get_model()]).get(self.settings["urlshorter"], self.urlshorter_selector.get_model().get_iter_root()))
+        self.urlshorter_selector.connect("changed", self.on_urlshorter_selector_changed, None)
         self.urlshorter_selector.show_all()
 
+        active_urlshorter = urlshorters.get(self.urlshorter_selector.get_active_text())
+        if active_urlshorter.PROTOCOL_INFO.get('authtype') == 'login':
+            try:
+                urlshorter_user = str(self.settings.get("urlshorter_user"))
+                urlshorter_key = gnomekeyring.find_items_sync(gnomekeyring.ITEM_GENERIC_SECRET, {"id": urlshorter_user})[0].secret
+            except gnomekeyring.NoMatchError:
+                urlshorter_user = None
+                urlshorter_key = None
+
+            self.urlshorter_authenticated = active_urlshorter.URLShorter()
+            #self.urlshorter_auth_ui = self.urlshorter_authenticated.auth_ui(urlshorter_user, urlshorter_key)
+            self.ui.get_object("urlshorter_table").attach(self.urlshorter_authenticated.auth_ui(urlshorter_user, urlshorter_key), 0, 1, 2, 3)
+        else:
+            self.urlshorter_authenticated = None
+
         self.retweet_style_selector = gtk.combo_box_new_text()
         for format in RETWEET_FORMATS: self.retweet_style_selector.append_text(format)
         self.ui.get_object("retweet_style_container").pack_start(self.retweet_style_selector, True, True)
@@ -94,7 +117,26 @@
 
     def on_save_button_clicked(self, widget, data=None):
         self.settings["interval"] = int(self.ui.get_object("interval").get_value())
-        
+
+        # Only process authenticated url shorten service if url shorten is enabled 
+        if self.ui.get_object("shorten_urls").get_property("active"):
+            if self.urlshorter_authenticated:   
+                if self.urlshorter_authenticated.validate():
+                  self.settings["urlshorter_user"] = self.urlshorter_authenticated.get_username()
+                  gnomekeyring.item_create_sync(
+                                      gnomekeyring.get_default_keyring_sync(),
+                                      gnomekeyring.ITEM_GENERIC_SECRET,
+                                      "Gwibber pref: %s" % ('urlshorter'),
+                                      {"id": self.urlshorter_authenticated.get_username()},
+                                      self.urlshorter_authenticated.get_password(), True)
+                else:   
+                  GwibberProtocolError(type='auth', protocol='bit.ly', username=self.urlshorter_authenticated.get_username())
+                  return
+            else:
+                # TODO: Erease urlshorter key from keyring
+                self.settings["urlshorter_user"] = None
+
+
         # Only change autostart if it was already set before or if the user enabled it
         if self.gc.get("/apps/gwibber/autostart") is None:
             if self.ui.get_object("autostart").get_property("active"):
@@ -120,3 +162,12 @@
     def on_prefs_dialog_destroy_event(self, widget, data=None):
         gtk.main_quit()
 
+    def on_urlshorter_selector_changed(self, widget, data=None):
+        if urlshorters.get(widget.get_active_text()).PROTOCOL_INFO.get('authtype') == 'login':
+            self.urlshorter_authenticated = urlshorters.get(widget.get_active_text()).URLShorter()
+            self.ui.get_object("urlshorter_table").attach(self.urlshorter_authenticated.auth_ui(), 0, 1, 2, 3)
+            self.ui.get_object("urlshorter_table").show_all()
+        else:
+            if self.urlshorter_authenticated:
+                self.urlshorter_authenticated.clear_ui()
+                self.urlshorter_authenticated = None

=== modified file 'ui/gwibber-preferences-dialog.ui'
--- ui/gwibber-preferences-dialog.ui	2010-03-05 17:54:43 +0000
+++ ui/gwibber-preferences-dialog.ui	2010-05-31 11:52:27 +0000
@@ -19,7 +19,6 @@
     <child internal-child="vbox">
       <object class="GtkVBox" id="dialog-vbox1">
         <property name="visible">True</property>
-        <property name="orientation">vertical</property>
         <property name="spacing">2</property>
         <child>
           <object class="GtkNotebook" id="notebook1">
@@ -30,7 +29,6 @@
                 <property name="visible">True</property>
                 <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
                 <property name="border_width">5</property>
-                <property name="orientation">vertical</property>
                 <property name="spacing">10</property>
                 <child>
                   <object class="GtkFrame" id="frame1">
@@ -217,13 +215,11 @@
               <object class="GtkVBox" id="vbox1">
                 <property name="visible">True</property>
                 <property name="border_width">5</property>
-                <property name="orientation">vertical</property>
                 <property name="spacing">5</property>
                 <child>
                   <object class="GtkVBox" id="vbox7">
                     <property name="visible">True</property>
                     <property name="border_width">5</property>
-                    <property name="orientation">vertical</property>
                     <property name="spacing">5</property>
                     <child>
                       <object class="GtkCheckButton" id="show_fullname">
@@ -257,7 +253,6 @@
                         <child>
                           <object class="GtkVBox" id="vbox3">
                             <property name="visible">True</property>
-                            <property name="orientation">vertical</property>
                             <child>
                               <object class="GtkCheckButton" id="global_retweet">
                                 <property name="label" translatable="yes">Send retweets to all services</property>
@@ -273,7 +268,6 @@
                             <child>
                               <object class="GtkVBox" id="retweet_style_container">
                                 <property name="visible">True</property>
-                                <property name="orientation">vertical</property>
                                 <child>
                                   <placeholder/>
                                 </child>
@@ -315,7 +309,6 @@
                           <object class="GtkTable" id="table16">
                             <property name="visible">True</property>
                             <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
-                            <property name="n_rows">3</property>
                             <property name="homogeneous">True</property>
                             <child>
                               <object class="GtkCheckButton" id="reply_append_colon">
@@ -326,11 +319,57 @@
                                 <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
                                 <property name="draw_indicator">True</property>
                               </object>
-                              <packing>
-                                <property name="top_attach">2</property>
-                                <property name="bottom_attach">3</property>
-                              </packing>
                             </child>
+                          </object>
+                        </child>
+                      </object>
+                    </child>
+                    <child type="label">
+                      <object class="GtkLabel" id="label79">
+                        <property name="visible">True</property>
+                        <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
+                        <property name="label" translatable="yes">&lt;b&gt;Advanced&lt;/b&gt;</property>
+                        <property name="use_markup">True</property>
+                      </object>
+                    </child>
+                  </object>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="position">2</property>
+                  </packing>
+                </child>
+              </object>
+              <packing>
+                <property name="position">1</property>
+              </packing>
+            </child>
+            <child type="tab">
+              <object class="GtkLabel" id="messages_label">
+                <property name="visible">True</property>
+                <property name="label" translatable="yes">Messages</property>
+              </object>
+              <packing>
+                <property name="position">1</property>
+                <property name="tab_fill">False</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkVBox" id="vbox6">
+                <property name="visible">True</property>
+                <child>
+                  <object class="GtkFrame" id="frame6">
+                    <property name="visible">True</property>
+                    <property name="label_xalign">0</property>
+                    <property name="shadow_type">none</property>
+                    <child>
+                      <object class="GtkAlignment" id="alignment5">
+                        <property name="visible">True</property>
+                        <property name="left_padding">12</property>
+                        <child>
+                          <object class="GtkTable" id="urlshorter_table">
+                            <property name="visible">True</property>
+                            <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
+                            <property name="n_rows">3</property>
                             <child>
                               <object class="GtkCheckButton" id="shorten_urls">
                                 <property name="label" translatable="yes">Automatically shorten pasted URLs using:</property>
@@ -344,7 +383,6 @@
                             <child>
                               <object class="GtkVBox" id="urlshorter_container">
                                 <property name="visible">True</property>
-                                <property name="orientation">vertical</property>
                                 <property name="spacing">5</property>
                                 <child>
                                   <placeholder/>
@@ -355,36 +393,39 @@
                                 <property name="bottom_attach">2</property>
                               </packing>
                             </child>
+                            <child>
+                              <placeholder/>
+                            </child>
                           </object>
                         </child>
                       </object>
                     </child>
                     <child type="label">
-                      <object class="GtkLabel" id="label79">
+                      <object class="GtkLabel" id="label2">
                         <property name="visible">True</property>
-                        <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
-                        <property name="label" translatable="yes">&lt;b&gt;Advanced&lt;/b&gt;</property>
+                        <property name="label" translatable="yes">&lt;b&gt;URL Shortener&lt;/b&gt;</property>
                         <property name="use_markup">True</property>
                       </object>
                     </child>
                   </object>
                   <packing>
                     <property name="expand">False</property>
-                    <property name="position">2</property>
+                    <property name="fill">False</property>
+                    <property name="position">0</property>
                   </packing>
                 </child>
               </object>
               <packing>
-                <property name="position">1</property>
+                <property name="position">2</property>
               </packing>
             </child>
             <child type="tab">
-              <object class="GtkLabel" id="messages_label">
+              <object class="GtkLabel" id="services_label">
                 <property name="visible">True</property>
-                <property name="label" translatable="yes">Messages</property>
+                <property name="label" translatable="yes">Services</property>
               </object>
               <packing>
-                <property name="position">1</property>
+                <property name="position">2</property>
                 <property name="tab_fill">False</property>
               </packing>
             </child>
@@ -392,7 +433,6 @@
               <object class="GtkVBox" id="vbox5">
                 <property name="visible">True</property>
                 <property name="border_width">5</property>
-                <property name="orientation">vertical</property>
                 <property name="spacing">10</property>
                 <child>
                   <object class="GtkFrame" id="frame3">
@@ -408,7 +448,6 @@
                           <object class="GtkVBox" id="theme_container">
                             <property name="visible">True</property>
                             <property name="tooltip_text" translatable="yes">Select a message theme</property>
-                            <property name="orientation">vertical</property>
                             <property name="spacing">5</property>
                             <child>
                               <placeholder/>
@@ -432,7 +471,7 @@
                 </child>
               </object>
               <packing>
-                <property name="position">2</property>
+                <property name="position">3</property>
               </packing>
             </child>
             <child type="tab">
@@ -441,7 +480,7 @@
                 <property name="label" translatable="yes">Style</property>
               </object>
               <packing>
-                <property name="position">2</property>
+                <property name="position">3</property>
                 <property name="tab_fill">False</property>
               </packing>
             </child>