Merge lp:~verterok/unity-scope-ebay/missing-attributes into lp:unity-scope-ebay

[Guillermo Gonzalez]

Quote search string and handle missing searchResult and condition in the response.

Two fixes:
- quote search string
- handle missing searchResult and condition in the results

[Facundo Batista (facundo)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

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

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-ebay-ci/7/rebuild

review: Approve (continuous-integration)

=== modified file 'src/unity_ebay_daemon.py'
--- src/unity_ebay_daemon.py	2013-09-24 18:29:34 +0000
+++ src/unity_ebay_daemon.py	2013-10-01 21:04:21 +0000
@@ -78,16 +78,26 @@
     Search the server for eBay items
     '''
     results = []
-    search_url = SEARCH_URI % (API_KEY, search.replace(" ", "%20"))
+    result = None
+    search_url = SEARCH_URI % (API_KEY, urllib.parse.quote(search))
     try:
         logger.debug("Request: %s", search_url)
         response = urllib.request.urlopen(search_url).read()
         response = response.decode('utf8')
         json_response = json.loads(response)
-        result = json_response["findItemsByKeywordsResponse"][0]['searchResult'][0]['item']
+        search_result = json_response["findItemsByKeywordsResponse"][0].get('searchResult')
+        if search_result:
+            count = int(search_result[0]['@count'])
+            # if we got a searchResult and count > 0
+            if count > 0:
+                result = search_result[0]['item']
+        else:
+            # if there is not searchResult, we want to know what's in
+            # the response body
+            logger.warning("Missing searchResult key: %r", json_response)
     except:
         logger.exception("Error while fetching data.")
-        result = {}
+        result = []
     if result:
         for item in result:
             icon_hint = Unity.AnnotatedIcon.new(Gio.ThemedIcon.new(item['galleryURL'][0]))
@@ -104,7 +114,10 @@
 
             title = item['title'][0]
             uri = item['viewItemURL'][0]
-            condition = item['condition'][0]['conditionDisplayName'][0]
+            if 'condition' in item:
+                condition = item['condition'][0]['conditionDisplayName'][0]
+            else:
+                condition = None
             shipping_to = ', '.join(item['shippingInfo'][0]['shipToLocations'])
             payment_method = ', '.join(item['paymentMethod'])
             currency_code = item['sellingStatus'][0]['currentPrice'][0]['@currencyId']
@@ -178,6 +191,8 @@
         currency_code = self.result.metadata['currency_code']
         price = self.result.metadata['price']
         preview.props.subtitle = "%s %s" % (currency_code.unpack(), price.unpack())
+        if self.result.metadata['condition']:
+            preview.add_info(Unity.InfoHint.new("condition", _("Condition"), None, self.result.metadata['condition'].unpack()))
         preview.add_info(Unity.InfoHint.new("condition", _("Condition"), None, self.result.metadata['condition'].unpack()))
         preview.add_info(Unity.InfoHint.new("payment_methods", _("Payment method:"), None, self.result.metadata['payment_methods'].unpack()))
         preview.add_info(Unity.InfoHint.new("shipping_to", _("Shipping locations:"), None, self.result.metadata['shipping_to'].unpack()))

=== modified file 'tests/test_ebay.py'
--- tests/test_ebay.py	2013-09-20 22:02:28 +0000
+++ tests/test_ebay.py	2013-10-01 21:04:21 +0000
@@ -1,8 +1,14 @@
 #! /usr/bin/python3
 # -*- coding: utf-8 -*-
+
+import imp
+import json
+import urllib
+
+from io import BytesIO, StringIO
+from unittest import TestCase, mock
 from gi.repository import Unity
-from unittest import TestCase
-import imp
+
 
 class ResultSet(Unity.ResultSet):
     def __init__(self):
@@ -57,8 +63,35 @@
         self.scope_module.SEARCH_URI = 'file:tests/data/mock_ebay_fail#'
         for s in ['iphone']:
             result_set = self.perform_query(s)
-            print(result_set)
             self.assertEqual(len(result_set.results), 0)
 
+    def test_search_missing_condition(self):
+        query = "foo"
+        called = []
+        urlopen = urllib.request.urlopen
+        def fake_urlopen(req):
+            data = urlopen("file:tests/data/mock_ebay_pass").read()
+            # remove condition values from the result
+            result = json.loads(data.decode("utf-8"))
+            sresult = result['findItemsByKeywordsResponse'][0]['searchResult']
+            for i in sresult[0]['item']:
+                i.pop('condition')
+            return BytesIO(json.dumps(result).encode('utf-8'))
+        with mock.patch('urllib.request.urlopen', new=fake_urlopen):
+            result_set = self.perform_query(query)
+        self.assertEqual(len(result_set.results), 3)
+
+    def test_search_unicode(self):
+        query = "Święty Patryk"
+        called = []
+        urlopen = urllib.request.urlopen
+        self.scope_module.SEARCH_URI = '%s#%s'
+        def fake_urlopen(req):
+            called.append(req)
+            return urlopen("file:tests/data/mock_ebay_pass")
+        with mock.patch('urllib.request.urlopen', new=fake_urlopen):
+            self.perform_query(query)
+        self.assertEqual(urllib.parse.quote(query), called[0].split("#")[1])
+
 if __name__ == '__main__':
     unittest.main()