Merge lp:~davidc3/unity-scope-songkick/fix-previews into lp:unity-scope-songkick

[David Callé]

Fix previews and move to Info master scope

Fix previews and move to info master scope

http://ubuntuone.com/10Bup3EFcIZtWkr79Xrdpg

[lp:~davidc3/unity-scope-songkick/fix-previews]

17. By David Callé on 2013-10-07

Fix wrong paste

18. By David Callé on 2013-10-07

Fix location failure case

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:16
http://10.97.0.26:8080/job/unity-scope-songkick-ci/8/
Executed test runs:
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-amd64-ci/8
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-armhf-ci/8
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-i386-ci/8

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:18
http://10.97.0.26:8080/job/unity-scope-songkick-ci/9/
Executed test runs:
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-amd64-ci/9
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-armhf-ci/9
    SUCCESS: http://10.97.0.26:8080/job/unity-scope-songkick-saucy-i386-ci/9

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

review: Approve (continuous-integration)

[Guillermo Gonzalez (verterok)]

+1

review: Approve

=== modified file 'data/songkick.scope.in'
--- data/songkick.scope.in	2013-03-15 17:29:46 +0000
+++ data/songkick.scope.in	2013-10-07 20:41:53 +0000
@@ -1,16 +1,17 @@
 [Scope]
 DBusName=com.canonical.Unity.Scope.Music.Songkick
 DBusPath=/com/canonical/unity/scope/music/songkick
-Icon=
-_Keywords=songkick;
+Icon=/usr/share/icons/unity-icon-theme/places/svg/service-songkick.svg
+_Keywords=songkick;concert;band;artist;
 RequiredMetadata=
 OptionalMetadata=
 Loader=/usr/share/unity-scopes/songkick/unity_songkick_daemon.py
 RemoteContent=true
-Type=music
+Master=info.scope
+Type=info
 _Name=Songkick
-_Description=Find Songkick items
-_SearchHint=Search Songkick
+_Description=This is an Ubuntu search plugin that enables information from Songkick to be searched and displayed in the Dash underneath the Info header. If you do not wish to search this content source, you can disable this search plugin.
+_SearchHint=Search concerts near you
 
 [Desktop Entry]
 X-Ubuntu-Gettext-Domain=unity-scope-songkick

=== modified file 'src/unity_songkick_daemon.py'
--- src/unity_songkick_daemon.py	2013-10-03 19:07:24 +0000
+++ src/unity_songkick_daemon.py	2013-10-07 20:41:53 +0000
@@ -18,6 +18,7 @@
 from gi.repository import Unity
 import gettext
 import urllib.request
+import urllib.parse
 import json
 import datetime
 import logging
@@ -58,17 +59,24 @@
 
 logger = logging.getLogger("unity.scope.songkick")
 
-def search(search, filters):
+def search(search, filters, metadata):
     '''
     Search the server for questions and use stackexchange's api for tags
     '''
     results = []
-    search = search.replace(" ", "%20")
-    if search == "":
-        uri = '%s?location=clientip&apikey=%s' % (SEARCH_URI, API_KEY)
+    try:
+        location = metadata.get_property('location')
+        latitude = location.latitude
+        longitude = location.longitude
+    except Exception:
+        logger.exception("Error while fetching location.")
+        location = None
+
+    if len(search) < 1 and location:
+        uri = '%s?location=geo:%s,%s&apikey=%s' % (SEARCH_URI,latitude,longitude,API_KEY)
     else:
+        search = urllib.parse.quote(search)
         uri = '%s?artist_name=%s&apikey=%s' % (SEARCH_URI, search, API_KEY)
-
     try:
         logger.debug("Request: %s", uri)
         response = urllib.request.urlopen(uri).read()
@@ -78,83 +86,61 @@
     except Exception:
         logger.exception("Error while fetching: %r", uri)
         result = []
-    if result:
-        for item in result:
-            icon_hint = ""
-            for artist in item['performance']:
-                #if artist['artist']['displayName'].lower() == search.replace("%20", " "):
-                icon_hint = 'http://www2.sk-static.com/images/media/profile_images/artists/%s/col2' % artist['artist']['id']
-                continue
-
-            comment = item['venue']['displayName']
-            comment += "\n" + item['venue']['metroArea']['displayName']
-            comment += "\n" + item['venue']['metroArea']['country']['displayName']
-            try:
-                starttime = item['start']['datetime']
-                now = datetime.datetime.now()
-                starttime = now.strptime(starttime[:19], "%Y-%m-%dT%H:%M:%S")
-                comment += "\n\n<b>Doors open:</b> %s" % starttime.strftime("%A %x %H:%M")
-            except:
-                starttime = item['start']['date']
-                now = datetime.datetime.now()
-                starttime = now.strptime(starttime, "%Y-%m-%d")
-                comment += "\n\n<b>Doors open:</b> %s" % starttime.strftime("%A %x")
-            comment += "\n\n<b>Lineup:</b>\n\n"
-
-            headliners = ""
-            support = ""
-            for performer in item['performance']:
-                if performer['billing'] == 'headline':
-                    headliners += ", %s" % performer['displayName']
-                else:
-                    support += ", %s" % performer['displayName']
-            comment += "<big>%s</big>\n" % headliners[2:]
-            if not support == "":
-                comment += "with\n%s" % support[2:]
-
-            for artist in item['performance']:
-                icon_hint = 'http://www2.sk-static.com/images/media/profile_images/artists/%s/col2' % artist['artist']['id']
-                continue
-            results.append({'uri': item['uri'],
-                            'icon': icon_hint,
-                            'category': 0,
-                            'title': item['displayName'],
-                            'comment': comment})
-
+    for item in result:
+        icon_hint = None
+        comment = item['venue']['displayName']
+        venue = item['venue']['displayName']
+        city = "%s, %s" % (item['venue']['metroArea']['displayName'],
+                           item['venue']['metroArea']['country']['displayName'])
+        try:
+            starttime = item['start']['datetime']
+            now = datetime.datetime.now()
+            starttime = now.strptime(starttime[:19], "%Y-%m-%dT%H:%M:%S")
+            date = starttime.strftime("%A %x %H:%M")
+        except:
+            starttime = item['start']['date']
+            now = datetime.datetime.now()
+            starttime = now.strptime(starttime, "%Y-%m-%d")
+            date = starttime.strftime("%A %x")
+        performers = []
+        for performer in item['performance']:
+            if performer['billing'] == 'headline':
+                performers.append(performer['displayName'])
+        for performer in item['performance']:
+            if performer['billing'] != 'headline':
+                performers.append(performer['displayName'])
+        description = " / ".join(performers)
+        for artist in item['performance']:
+            icon_hint = 'http://www2.sk-static.com/images/media/profile_images/artists/%s/col2' % artist['artist']['id']
+            continue
+        results.append({'uri': item['uri'],
+                        'icon': icon_hint,
+                        'title': item['displayName'],
+                        'comment': venue,
+                        'city': city,
+                        'description': description,
+                        'date': date})
     return results
 
 
-def preview(scope, uri):
-    '''
-    Preview request handler
-    '''
-    # FIXME: Previews not yet implemented
-    model = self.model
-    iteration = model.get_first_iter()
-    end_iter = model.get_last_iter()
-    preview = None
-    while iteration != end_iter:
-        if model.get_value(iteration, 0) == uri:
-            title = ""
-            description = model.get_value(iteration, 6)
-            icon_hint = model.get_value(iteration, 1)[:-1] + "6"
-
-            # Assemble the preview
-            preview = Unity.GenericPreview.new(title, description, None)
-            preview.props.image_source_uri = icon_hint
-            preview.props.subtitle = model.get_value(iteration, 5).title()
-
-            # Add the "View" action
-            button_icon = Gio.ThemedIcon.new(SVG_DIR + "songkick.png")
-            view_action = Unity.PreviewAction.new("activate_uri", "View on Songkick", button_icon)
-            view_action.connect("activated", self.activate_uri)
-            preview.add_action(view_action)
-            break
-
-        iteration = model.next(iteration)
-    if preview is None:
-        print ("Couldn't find model row for requested preview uri: '%s'", uri)
-    return preview
+class Preview (Unity.ResultPreviewer):
+
+    def do_run(self):
+        thumb = self.result.icon_hint.replace("/col2", "/col4")
+        image = Gio.FileIcon.new (Gio.file_new_for_uri(thumb))
+        description = self.result.metadata['description'].unpack()
+        description = description.replace('&', '&amp;')
+        preview = Unity.GenericPreview.new(self.result.title, description, image)
+        preview.add_info(Unity.InfoHint.new("venue", _("Venue"), None,
+                                            self.result.comment))
+        preview.add_info(Unity.InfoHint.new("city", _("Location"), None,
+                                            self.result.metadata['city'].unpack()))
+        preview.props.subtitle = "%s at %s" % (self.result.metadata['date'].unpack(),
+                                               self.result.comment)
+        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
+        view_action = Unity.PreviewAction.new("activate_uri", "View on Songkick", icon)
+        preview.add_action(view_action)
+        return preview
 
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
@@ -172,7 +158,8 @@
         try:
             result_set = self.search_context.result_set
             for i in search(self.search_context.search_query,
-                            self.search_context.filter_state):
+                            self.search_context.filter_state,
+                            self.search_context.search_metadata):
                 if not 'uri' in i or not i['uri'] or i['uri'] == '':
                     continue
                 if not 'icon' in i or not i['icon'] or i['icon'] == '':
@@ -189,13 +176,6 @@
                     i['comment'] = ''
                 if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
                     i['dnd_uri'] = i['uri']
-                i['metadata'] = {}
-                if EXTRA_METADATA:
-                    for e in i:
-                        for m in EXTRA_METADATA:
-                            if m['id'] == e:
-                                i['metadata'][e] = i[e]
-                i['metadata']['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
                 result_set.add_result(**i)
         except Exception:
             logger.exception("Error while building result set.")
@@ -252,6 +232,11 @@
         se = MySearch(search_context)
         return se
 
+    def do_create_previewer(self, result, metadata):
+        rp = Preview()
+        rp.set_scope_result(result)
+        rp.set_search_metadata(metadata)
+        return rp
 
 def load_scope():
     return Scope()

=== modified file 'tests/test_songkick.py'
--- tests/test_songkick.py	2013-10-03 19:07:24 +0000
+++ tests/test_songkick.py	2013-10-07 20:41:53 +0000
@@ -62,7 +62,7 @@
         self.scope_module.logger.addHandler(handler)
         result_set = self.perform_query("foo")
         self.assertEqual(len(result_set.results), 0)
-        self.assertEqual(len(handler.records), 0)
+        self.assertEqual(len(handler.records), 1)
 
 
 class Handler(logging.Handler):