Merge lp:~unity-team/unity-lens-video/split-online-results into lp:unity-lens-video/remote-videos-scope-trunk

[Michal Hruby]

Add 'split' parameter to the query

Update to match latest designs - the scope now adds the 'split' parameter to the query to distinguish "online" and "suggestion" results.

[Jim Hodapp (jhodapp)]

Line 83: Add a comment describing what the "True" is there for. This will be convenient for those reading the code who are not familiar with the scope's source structure.

It is not obvious to me how the online vs. suggestion results differ and why they need to be "split." A comment above line 89 explaining the split and how it gets used would be very helpful.

Otherwise looks great, nice work.

review: Needs Fixing (code)

[Jim Hodapp (jhodapp)]

Since this did operate correctly and only needed comment improvements (and since Michal is on vacation), I'm setting this to be approved.

review: Approve (code)

=== modified file 'src/unity-scope-video-remote'
--- src/unity-scope-video-remote	2012-08-30 13:18:47 +0000
+++ src/unity-scope-video-remote	2012-09-14 10:44:17 +0000
@@ -52,6 +52,9 @@
 _ = gettext.gettext
 n_ = gettext.ngettext
 
+CAT_INDEX_ONLINE = 1
+CAT_INDEX_MORE = 2
+
 BUS_NAME = "net.launchpad.scope.RemoteVideos"
 SERVER = "http://videosearch.ubuntu.com/v0"
 
@@ -199,7 +202,22 @@
         if search and not working:
             search.finished()
 
-    def update_results_model(self, search, model, results):
+    def update_results_model(self, search, model, results, is_treat_yourself=False):
+        """Run the search method and check if a list of sources is present.
+        This is useful when coming out of a network issue."""
+        if isinstance(results, dict):
+            self.process_result_array(results['other'], model, CAT_INDEX_ONLINE)
+            self.process_result_array(results['treats'], model, CAT_INDEX_MORE)
+        else:
+            category = CAT_INDEX_MORE if is_treat_yourself else CAT_INDEX_ONLINE
+            self.process_result_array(results, model, category)
+
+        if search:
+            search.finished()
+        if self.sources_list == []:
+            self.query_list_of_sources()
+
+    def process_result_array(self, results, model, category):
         """Run the search method and check if a list of sources is present.
         This is useful when coming out of a network issue."""
         for i in results:
@@ -207,33 +225,43 @@
                 uri = i['url'].encode('utf-8')
                 title = i['title'].encode('utf-8')
                 icon = i['img'].encode('utf-8')
+                result_icon = icon
                 comment = i['source'].encode('utf-8')
                 details_url = ""
                 if "details" in i:
                     details_url = i['details'].encode('utf-8')
+                if category == CAT_INDEX_MORE:
+                    price = None
+                    price_key = 'formatted_price'
+                    if price_key in i:
+                        price = i[price_key]
+                    if not price or price is 'free':
+                        price = _('Free')
+                    anno_icon = Unity.AnnotatedIcon.new(Gio.FileIcon.new(Gio.File.new_for_uri(result_icon)))
+                    anno_icon.props.category = Unity.CategoryType.MOVIE
+                    anno_icon.props.ribbon = price
+                    result_icon = anno_icon.to_string()
 
                 if uri.startswith('http'):
                     # Instead of an uri, we pass a string of uri + metadata
-                    model.append(uri+'lens-meta://'+title+'lens-meta://'+icon+'lens-meta://'+details_url,
-                    icon, 2, "text/html", str(title), str(comment), str(uri))
-            except (KeyError, TypeError, AttributeError):
-                print "Malformed result, skipping."
-
-        model.flush_revision_queue()
-        if search:
-            search.finished()
-        if self.sources_list == []:
-            self.query_list_of_sources()
+                    fake_uri = "%slens-meta://%slens-meta://%slens-meta://%s"
+                    fake_uri = fake_uri % (uri, title, icon, details_url)
+                    model.append(fake_uri,
+                        result_icon, category, "text/html",
+                        str(title), str(comment), str(uri))
+            except (KeyError, TypeError, AttributeError) as detail:
+                print "Malformed result, skipping.", detail
 
     def get_results(self, search_string, search, model, sources):
         """Query the server with the search string and the list of sources."""
         if not search_string and not sources and self.recommendations:
-            self.update_results_model(search, model, self.recommendations)
+            self.update_results_model(search, model, self.recommendations, True)
             return
         if self._pending is not None:
             self.session.cancel_message(self._pending,
                                         Soup.KnownStatusCode.CANCELLED)
         query = dict(q=search_string)
+        query['split'] = 'true'
         if sources:
             query['sources'] = sources.encode("utf-8")
         query = urlencode(query)
@@ -263,7 +291,7 @@
                 results = json.loads(msg.response_body.data)
             except ValueError:
                 print "Error: got garbage json from the server"
-        if isinstance(results, dict):
+        if isinstance(results, dict) and 'results' in results:
             results = results.get('results', [])
         return results
 
@@ -335,29 +363,27 @@
         preview.set_rating(-1, 0)
 
         # TODO: For details of future source types, factor out common detail key/value pairs
-        if source == "Amazon":
-            if "directors" in details:
-                directors = details["directors"]
-                preview.add_info(Unity.InfoHint.new("directors",
-                    n_("Director", "Directors", len(directors)), None, ', '.join(directors)))
-            if "starring" in details:
-                cast = details["starring"]
-                if cast:
-                    preview.add_info(Unity.InfoHint.new("cast",
-                        n_("Cast", "Cast", len(cast)), None, ', '.join(cast)))
-            if "genres" in details:
-                genres = details["genres"] 
-                if genres:
-                    preview.add_info(Unity.InfoHint.new("genres",
-                        n_("Genre", "Genres", len(genres)), None, ', '.join(genres)))
+        if "directors" in details:
+            directors = details["directors"]
+            preview.add_info(Unity.InfoHint.new("directors",
+                n_("Director", "Directors", len(directors)), None, ', '.join(directors)))
+        if "starring" in details:
+            cast = details["starring"]
+            if cast:
+                preview.add_info(Unity.InfoHint.new("cast",
+                    n_("Cast", "Cast", len(cast)), None, ', '.join(cast)))
+        if "genres" in details:
+            genres = details["genres"] 
+            if genres:
+                preview.add_info(Unity.InfoHint.new("genres",
+                    n_("Genre", "Genres", len(genres)), None, ', '.join(genres)))
         # TODO: Add Vimeo & YouTube details for v1 of JSON API
-        else:
-            if "uploaded_by" in details:
-                preview.add_info(Unity.InfoHint.new("uploaded-by", _("Uploaded by"),
-                    None, details["uploaded_by"]))
-            if "date_uploaded" in details:
-                preview.add_info(Unity.InfoHint.new("uploaded-on", _("Uploaded on"),
-                    None, details["date_uploaded"]))
+        if "uploaded_by" in details:
+            preview.add_info(Unity.InfoHint.new("uploaded-by", _("Uploaded by"),
+                None, details["uploaded_by"]))
+        if "date_uploaded" in details:
+            preview.add_info(Unity.InfoHint.new("uploaded-on", _("Uploaded on"),
+                None, details["date_uploaded"]))
 
         return preview