Merge lp:~davidc3/unity-scope-googlebooks/enhance-previews into lp:unity-scope-googlebooks

[David Callé]

* Add categories and ratings in previews
* Preview description ampersand fix
* Only sort results by relevancy (faster search)
* Bigger cover in previews
* Change "View" to "Google Books"
* Misc .scope file fixes

* Add categories and ratings in previews
* Preview description ampersand fix
* Only sort results by relevancy (faster search)
* Bigger cover in previews
* Change "View" to "Google Books"
* Misc .scope file fixes

[lp:~davidc3/unity-scope-googlebooks/enhance-previews]

9. By David Callé on 2013-10-24

Actually use the new logger

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:8
http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-ci/1/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-amd64-ci/1
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-armhf-ci/1
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-i386-ci/1

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity-scope-googlebooks-ci/1/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:9
http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-ci/2/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-amd64-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-armhf-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-googlebooks-saucy-i386-ci/2

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity-scope-googlebooks-ci/2/rebuild

review: Approve (continuous-integration)

[Guillermo Gonzalez (verterok)]

+1

review: Approve

=== modified file 'data/googlebooks.scope.in'
--- data/googlebooks.scope.in	2013-04-15 13:56:26 +0000
+++ data/googlebooks.scope.in	2013-10-24 11:06:27 +0000
@@ -1,16 +1,17 @@
 [Scope]
 DBusName=com.canonical.Unity.Scope.Books.Googlebooks
 DBusPath=/com/canonical/unity/scope/books/googlebooks
-Icon=
+Icon=/usr/share/icons/unity-icon-theme/places/svg/group-books.svg
 QueryBinary=
-_Keywords=googlebooks;books;
+_Keywords=googlebooks;books;book;read;
 RequiredMetadata=
 OptionalMetadata=author[s];publisher[s];published_date[s];selfLink[s];
 Loader=/usr/share/unity-scopes/googlebooks/unity_googlebooks_daemon.py
 RemoteContent=true
 Type=books
+Master=books.scope
 _Name=Google Books
-_Description=Find Google Books books
+_Description=This is an Ubuntu search plugin that enables books and magazines from Google Books to be searched and displayed in the Dash underneath the Books header. If you do not wish to search this content source, you can disable this search plugin.
 _SearchHint=Search Google Books
 
 [Desktop Entry]

=== modified file 'src/unity_googlebooks_daemon.py'
--- src/unity_googlebooks_daemon.py	2013-04-15 14:03:15 +0000
+++ src/unity_googlebooks_daemon.py	2013-10-24 11:06:27 +0000
@@ -20,6 +20,7 @@
 import urllib.parse
 import urllib.request
 import json
+import logging
 
 APP_NAME = 'unity-scope-googlebooks'
 LOCAL_PATH = '/usr/share/locale/'
@@ -27,6 +28,8 @@
 gettext.textdomain(APP_NAME)
 _ = gettext.gettext
 
+logger = logging.getLogger("unity.scope.googlebooks")
+
 GROUP_NAME = 'com.canonical.Unity.Scope.Books.Googlebooks'
 UNIQUE_PATH = '/com/canonical/unity/scope/books/googlebooks'
 SEARCH_URI = 'https://www.googleapis.com/books/v1/volumes'
@@ -35,20 +38,17 @@
 NO_RESULTS_HINT = _('Sorry, there are no Googlebooks results that match your search.')
 PROVIDER_CREDITS = _('Powered by Google Books')
 SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
-PROVIDER_ICON = SVG_DIR+'service-googlebooks.svg'
-DEFAULT_RESULT_ICON = SVG_DIR+'result-books.svg'
+#FIXME use the stadard Google icon until we have a Google Books one
+PROVIDER_ICON = SVG_DIR+'service-googlenews.svg'
+DEFAULT_RESULT_ICON = SVG_DIR+'group-books.svg'
 DEFAULT_RESULT_MIMETYPE = 'text/html'
 DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
 
-c1 = {'id'      :'recent',
-      'name'    :_('Recent'),
-      'icon'    :SVG_DIR+'group-installed.svg',
-      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-c2 = {'id'      :'top',
+c1 = {'id'      :'top',
       'name'    :_('Top'),
       'icon'    :SVG_DIR+'group-installed.svg',
       'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-CATEGORIES = [c1, c2]
+CATEGORIES = [c1]
 
 FILTERS = []
 
@@ -81,21 +81,21 @@
     if not search:
         return results
     search = urllib.parse.quote(search)
-    orders = ['newest', 'relevance']
+    orders = ['relevance']
     for order in orders:
-        uri = "%s?alt=json&key=%s&printType=books&q=%s&maxResults=20&orderBy=%s&&fields=items(selfLink,volumeInfo(title,publishedDate,authors,imageLinks/thumbnail,canonicalVolumeLink,description))" % (SEARCH_URI, API_KEY, search, order)
-        print (uri)
+        uri = "%s?alt=json&key=%s&printType=books&q=%s&maxResults=20&orderBy=%s&&fields=items(selfLink,volumeInfo(title,publishedDate,authors,imageLinks/thumbnail,canonicalVolumeLink,description,categories,averageRating))" % (SEARCH_URI, API_KEY, search, order)
+        logger.debug("Request: %s", uri)
         try:
             r = urllib.request.urlopen(uri).read()
             data = json.loads(r.decode('utf-8'))
-        except Exception as error:
+        except Exception:
             data = None
-            print (error)
+            logger.exception("Error while fetching data")
         if not data:
             return results
         for e in data['items']:
             authors, description, icon, publishedDate = '', '', '', ''
-            selfLink, uri = '', ''
+            selfLink, uri, categories, rating = '', '', '', ''
             title = e['volumeInfo']['title']
             if 'authors' in e['volumeInfo']:
                 authors = ', '.join(e['volumeInfo']['authors'])
@@ -109,16 +109,44 @@
                 selfLink = e['volumeInfo']['selfLink']
             if 'canonicalVolumeLink' in e['volumeInfo']:
                 uri = e['volumeInfo']['canonicalVolumeLink']
+            if 'averageRating' in e['volumeInfo']:
+                rating = e['volumeInfo']['averageRating']
+                rating = '\u2605' * round(rating) + '\u2606' * (5-round(rating))
+            if 'categories' in e['volumeInfo']:
+                categories = ', '.join(e['volumeInfo']['categories'])
             results.append({'uri':uri,
                             'title':title,
                             'icon':icon,
                             'comment':description,
-                            'selfLink':GLib.Variant('s', selfLink),
-                            'author':GLib.Variant('s', authors),
-                            'published_date':GLib.Variant('s', publishedDate),
-                            'category':orders.index(order)})
+                            'selfLink':selfLink,
+                            'author':authors,
+                            'published_date':publishedDate,
+                            'categories':categories,
+                            'rating':rating})
     return results
 
+class Preview (Unity.ResultPreviewer):
+
+    def do_run(self):
+        zoom_cover = self.result.icon_hint.replace("&zoom=1", "&zoom=2")
+        image = Gio.FileIcon.new(Gio.file_new_for_uri(zoom_cover))
+        clean_comment = self.result.comment.replace("&", "&")
+        preview = Unity.GenericPreview.new(self.result.title, clean_comment, image)
+        preview.props.subtitle = self.result.metadata['author'].get_string()
+        if self.result.metadata['rating'].get_string() != '':
+            preview.add_info(Unity.InfoHint.new("rating", _("Reader ratings"), None, self.result.metadata['rating'].get_string()))
+        if self.result.metadata['categories'].get_string() != '':
+            if ',' in self.result.metadata['categories'].get_string():
+                cat_string = _("Categories")
+            else:
+                cat_string = _("Category")
+            preview.add_info(Unity.InfoHint.new("category", cat_string, None, self.result.metadata['categories'].get_string()))
+        if self.result.metadata['published_date'].get_string() != '':
+            preview.add_info(Unity.InfoHint.new("Published", _("Published"), None, self.result.metadata['published_date'].get_string()))
+        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
+        view_action = Unity.PreviewAction.new('view', _('Google Books'), icon)
+        preview.add_action(view_action)
+        return preview
 
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
@@ -154,21 +182,8 @@
                 if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
                     i['dnd_uri'] = i['uri']
                 result_set.add_result(**i)
-        except Exception as error:
-            print (error)
-
-class Preview (Unity.ResultPreviewer):
-
-    def do_run(self):
-        preview = Unity.GenericPreview.new(self.result.title, self.result.comment, None)
-        preview.props.subtitle = self.result.metadata['author'].get_string()
-        if self.result.metadata['published_date'].get_string() != '':
-            preview.add_info(Unity.InfoHint.new("Published", _("Published"), None, self.result.metadata['published_date'].get_string()))
-        preview.props.image_source_uri = self.result.icon_hint
-        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
-        view_action = Unity.PreviewAction.new('view', _('View'), icon)
-        preview.add_action(view_action)
-        return preview
+        except Exception:
+            logger.exception("Error while creating results set")
 
 class Scope (Unity.AbstractScope):
     def __init__(self):