Merge lp:~facundo/ubuntu-rest-scopes/ebay-curated-categories into lp:ubuntu-rest-scopes

[Facundo Batista]

Incorporate curated top categories for eBay.

Incorporate curated top categories for eBay.

Test included.

Unmerged revisions

169. By Facundo Batista on 2014-07-11

Incorporate curated top categories.

=== added file 'configs/scopes/ebay_top_departments.yaml'
--- configs/scopes/ebay_top_departments.yaml	1970-01-01 00:00:00 +0000
+++ configs/scopes/ebay_top_departments.yaml	2014-07-11 19:01:44 +0000
@@ -0,0 +1,238 @@
+fr_BE:
+  - [Art & Antiquités, 353]
+  - [Cinéma & DVD, 11232]
+  - [Informatique & PDA, 160]
+  - [Jeux Vidéos & PC, 14616]
+  - [Livres & BD, 267]
+  - [Musique & Instruments, 11233]
+  - [Photo & Cameras, 625]
+  - [Sports & Vélos, 11796]
+  - [Tickets & Voyages, 11730]
+  - ["TV, Audio & Vidéo", 293]
+
+nl_BE:
+  - [Boeken & Strips, 267]
+  - [Computer & PDA, 160]
+  - ["Dvd's, Video's & Films", 11232]
+  - [Foto & Camera's, 625]
+  - [Games & Consoles, 14616]
+  - [Muziek & Instrumenten, 11233]
+  - [Sport & Fietsen, 11796]
+  - ["Tv, Audio & Video", 293]
+
+fr_FR:
+  - ["Art, antiquités", 353]
+  - ["DVD, cinéma", 11232]
+  - ["Image, son", 293]
+  - ["Informatique, Réseaux", 58058]
+  - ["Jeux vidéo, consoles", 1249]
+  - ["Livres, BD, revues", 267]
+  - ["Musique, CD, vinyles", 11233]
+  - ["Photo, caméscopes", 625]
+  - ["Sports, vacances", 888]
+  - ["Téléphonie, mobilité", 15032]
+
+de_CH:
+  - [Antiquitäten & Kunst, 353]
+  - ["Computer, Tablets & Netzwerk", 58058]
+  - [Filme & DVDs, 11232]
+  - [Foto & Camcorder, 625]
+  - [Handys & Kommunikation, 15032]
+  - [Musik, 11233]
+  - [PC- & Videospiele, 1249]
+  - [Sport, 888]
+  - [Tickets, 1305]
+  - ["TV, Video & Audio", 293]
+
+nl_NL:
+  - [Boeken en strips, 267]
+  - [Computers, 160]
+  - [Consumentenelektronica, 293]
+  - [Film en DVD, 11232]
+  - [Games en consoles, 14616]
+  - [GSM en telecom, 14675]
+  - ["Kunst, antiek en design", 353]
+  - ["Sport, fietsen en vakantie", 888]
+
+en_MY:
+  - [Art, 550]
+  - [Books, 267]
+  - [Cameras & Photo, 625]
+  - [Computers & Tablets, 58058]
+  - [Consumer Electronics, 293]
+  - [DVD & Movies, 11232]
+  - [Mobile Phones & Accessories, 15032]
+  - [Music, 11233]
+  - [Sporting Goods, 382]
+
+en_CA:
+  - [Art, 550]
+  - [Books, 267]
+  - [Cameras & Photo, 625]
+  - [Cell Phones & Accessories, 15032]
+  - [Computers/Tablets & Networking, 58058]
+  - [Consumer Electronics, 293]
+  - [DVDs & Movies, 11232]
+  - [Music, 11233]
+  - [Sporting Goods, 888]
+  - [Tickets & Experiences, 1305]
+
+fr_CA:
+  - [Art, 550]
+  - [Articles de sports, 888]
+  - [Billets & expériences, 1305]
+  - [Caméras & appareils photo, 625]
+  - [Cellulaires & accessoires, 15032]
+  - [DVD & films, 11232]
+  - [Électronique grand public, 293]
+  - [Livres, 267]
+  - [Musique, 11233]
+  - ["Ordinateur, tablette & réseau", 58058]
+
+de_DE:
+  - [Antiquitäten & Kunst, 353]
+  - ["Computer, Tablets & Netzwerk", 58058]
+  - [Filme & DVDs, 11232]
+  - [Foto & Camcorder, 625]
+  - [Handys & Kommunikation, 15032]
+  - [Musik, 11233]
+  - [PC- & Videospiele, 1249]
+  - [Sport, 888]
+  - [Tickets, 1305]
+  - ["TV, Video & Audio", 293]
+
+it_IT:
+  - [Arte e Antiquariato, 353]
+  - [Film e DVD, 11232]
+  - [Fotografia e Video, 625]
+  - [Informatica, 58058]
+  - [Libri e Riviste, 267]
+  - ["Musica, CD e Vinili", 11233]
+  - [Sport e Viaggi, 888]
+  - ["TV, Audio e Video", 293]
+
+en_US:
+  - [Art, 550]
+  - [Books, 267]
+  - [Cameras & Photo, 625]
+  - [Cell Phones & Accessories, 15032]
+  - [Computers/Tablets & Networking, 58058]
+  - [Consumer Electronics, 293]
+  - [DVDs & Movies, 11232]
+  - [Music, 11233]
+  - [Tickets & Experiences, 1305]
+
+pl_PL:
+  - [Antyki i Sztuka, 353]
+  - [Filmy i DVD, 11232]
+  - [Fotografia i Aparaty, 625]
+  - [Komputery i Laptopy, 58058]
+  - [Muzyka i CD, 11233]
+  - [RTV i AGD, 293]
+  - [Sport i Turystyka, 382]
+  - [Telefony i Akcesoria, 14675]
+
+zh_HK:
+  - [手機、通訊產品, 14675]
+  - [電子產品及電器, 293]
+  - [電腦及網絡, 58058]
+  - [數碼相機、攝影器材, 625]
+  - [電影音樂, 45099]
+  - [體育、休閒及旅遊, 888]
+  - [書籍, 267]
+
+en_AU:
+  - [Art, 550]
+  - ["Books, Magazines", 267]
+  - [Computers, 58058]
+  - [Electronics, 293]
+  - [Home Entertainment, 172176]
+  - [Movies, 11232]
+  - [Music, 11233]
+  - [Phones, 15032]
+  - [Sporting Goods, 888]
+  - ["Tickets, Travel", 11730]
+
+de_AT:
+  - [Antiquitäten & Kunst, 353]
+  - [Bücher, 267]
+  - ["Computer, Tablets & Netzwerk", 58058]
+  - [Filme & DVDs, 11232]
+  - [Foto & Camcorder, 625]
+  - [Handys & Kommunikation, 15032]
+  - [Musik, 11233]
+  - [PC- & Videospiele, 1249]
+  - [Sport, 888]
+  - [Tickets, 1305]
+  - ["TV, Video & Audio", 293]
+
+en_IN:
+  - [Audio & Home Entertainment, 293]
+  - [Books & Magazines, 267]
+  - [Cameras & Optics, 625]
+  - [Fitness & Sports, 13361]
+  - [Laptops & Computer Peripherals, 160]
+  - ["LCD, LED & Televisions", 11071]
+  - [Mobile Accessories, 14416]
+  - [Mobile Phones, 15032]
+  - [Movies & Music, 11232]
+  - [Tablets & Accessories, 178741]
+
+en_SG:
+  - [Art, 550]
+  - [Books, 267]
+  - [Cameras & Photo, 625]
+  - [Computers & Tablets, 58058]
+  - [Consumer Electronics, 293]
+  - [DVD & Movies, 11232]
+  - [Home & Garden, 11700]
+  - [Music, 11233]
+  - [Sporting Goods, 382]
+
+en_PH:
+  - [Art, 550]
+  - [Books, 267]
+  - [Cameras & Photo, 625]
+  - [Computers & Tablets, 58058]
+  - [Consumer Electronics, 293]
+  - [DVD & Movies, 11232]
+  - [Home & Garden, 11700]
+  - [Mobile Phones & Accessories, 15032]
+  - [Music, 11233]
+  - [Sporting Goods, 382]
+
+en_IE:
+  - [Art, 550]
+  - ["Books, Comics & Magazines", 267]
+  - [Cameras & Photography, 625]
+  - [Computers/Tablets & Networking, 58058]
+  - ["DVDs, Films & TV", 11232]
+  - [Events Tickets, 1305]
+  - ["Home, Furniture & DIY", 11700]
+  - [Mobile Phones & Communication, 15032]
+  - [Music, 11233]
+  - [Sporting Goods, 888]
+
+es_ES:
+  - [Arte y Antigüedades, 353]
+  - [Cámaras y Fotografía, 625]
+  - ["Cine, DVD y Películas", 11232]
+  - [Electrodomésticos, 20710]
+  - [Entradas y eventos, 1305]
+  - [Informática y tablets, 58058]
+  - ["Libros, Revistas y Comics", 267]
+  - [Móviles y telefonía, 15032]
+  - ["Música, CD y Vinilos", 11233]
+
+en_GB:
+  - [Art, 550]
+  - ["Books, Comics & Magazines", 267]
+  - [Cameras & Photography, 625]
+  - [Computers/Tablets & Networking, 58058]
+  - ["DVDs, Films & TV", 11232]
+  - [Events Tickets, 1305]
+  - [Mobile Phones & Communication, 15032]
+  - [Music, 11233]
+  - [Sound & Vision, 293]
+  - [Video Games & Consoles, 1249]
+

=== modified file 'src/scopes/ebay.py'
--- src/scopes/ebay.py	2014-06-25 14:54:41 +0000
+++ src/scopes/ebay.py	2014-07-11 19:01:44 +0000
@@ -7,6 +7,8 @@
 import json
 import re
 import logging
+import os
+import yaml
 
 from urllib2 import urlopen
 from urllib import urlencode
@@ -537,6 +539,33 @@
         super(App, self).__init__(*args, **kwargs)
         self.api_utils = {'key': self.config['secrets'].get('api_key')}
 
+        _rootdir = os.environ['ROOTDIR']
+        _configdir = self.config['scopes_config_dir']
+        _path = os.path.join(_rootdir, _configdir, 'ebay_top_departments.yaml')
+        with open(_path, 'r') as f:
+            self.top_departments = yaml.load(f)
+
+    def _get_top_departments(self, locale):
+        """Get the top departments, from a curated config."""
+        try:
+            curated_data = self.top_departments[locale]
+        except KeyError:
+            curated_data = self.top_departments['en_US']
+
+        subdeps = []
+        for dep_label, dep_id in curated_data:
+            subdeps.append({
+                'canned_query': 'scope://ebay?dep=%s' % (dep_id,),
+                'has_subdepartments': True,
+                'label': dep_label,
+            })
+        tree = {
+            'canned_query': 'scope://ebay',
+            'label': translator('All departments', locale),
+            'subdepartments': subdeps,
+        }
+        return tree
+
     def search(self, **kwargs):
         """Do the search."""
         limit = kwargs['limit']
@@ -556,19 +585,18 @@
         site_id, global_id = shop_loc.get(locale, shop_loc.itervalues().next())
         if not query.strip():
             # Surfacing API calls
-            available_deps = _get_available_departments(department,
-                                                        site_id,
-                                                        self.api_utils["key"],
-                                                        locale,
-                                                        filters=filters_state)
-            yield dict(departments=available_deps)
             if not department:
-                department, dep_label = _get_surfacing_department(
-                    available_deps)
+                top_deps = self._get_top_departments(locale)
+                yield dict(departments=top_deps)
+                department, dep_label = _get_surfacing_department(top_deps)
                 yield dict(category=_build_surfacing_category(dep_label,
                                                               locale))
                 grid_rendering = True
             else:
+                available_deps = _get_available_departments(
+                    department, site_id, self.api_utils["key"],
+                    locale, filters=filters_state)
+                yield dict(departments=available_deps)
                 yield dict(filters=_get_localized_filters(locale))
                 yield dict(category=localized_category(PRODUCTS_CATEGORY,
                                                        locale))

=== modified file 'src/scopes/tests/test_ebay.py'
--- src/scopes/tests/test_ebay.py	2014-06-25 14:54:41 +0000
+++ src/scopes/tests/test_ebay.py	2014-07-11 19:01:44 +0000
@@ -13,7 +13,7 @@
 from src.scopes import ebay
 from src.scopes.tests import get_fixture
 
-CONFIG = {'secrets': {}}
+CONFIG = {'secrets': {}, 'scopes_config_dir': 'configs/scopes'}
 
 SEARCH_URI = ('https://svcs.ebay.com/services/search/FindingService/v1'
               '?SECURITY-APPNAME=None&OPERATION-NAME=findItemsByKeywords'
@@ -81,7 +81,7 @@
         app = ebay.App(CONFIG)
         with patch.object(ebay, '_get_products') as mock:
             with patch.object(ebay, '_get_surfacing_department') as dep_mock:
-                with patch.object(ebay, '_get_available_departments') as mdep:
+                with patch.object(app, '_get_top_departments') as mdep:
                     mdep.return_value = {}
                     mock.return_value = get_fixture('ebay-surfacing.json')
                     dep_mock.return_value = ('550', 'Foo')
@@ -92,6 +92,7 @@
 
         # got the info as it should
         mock.assert_called_with(SURFACING_URI)
+        mdep.assert_called_with('C')
 
         # category
         self.assertEqual(response[1]['category']['title'], "Featured in Foo")
@@ -129,7 +130,7 @@
         app = ebay.App(CONFIG)
         with patch.object(ebay, '_get_products') as mock:
             with patch.object(ebay, '_get_surfacing_department') as dep_mock:
-                with patch.object(ebay, '_get_available_departments') as mdep:
+                with patch.object(app, '_get_top_departments') as mdep:
                     mdep.return_value = {}
                     mock.return_value = get_fixture(
                         'ebay-surfacing-no-img.json')
@@ -226,6 +227,44 @@
                'CategoryID=550&MaxEntries=10')
         mock.assert_called_with(uri)
 
+    def test_get_top_departments_knownlocale(self):
+        app = ebay.App(CONFIG)
+        app.top_departments = {
+            'fr_FR': [('Art', 12), ('Accessoires', 111)],
+        }
+        resp = app._get_top_departments('fr_FR')
+        self.assertEqual(resp, {
+            'canned_query': 'scope://ebay',
+            'label': u'Tous les départements',
+            'subdepartments': [{
+                'canned_query': 'scope://ebay?dep=12',
+                'has_subdepartments': True,
+                'label': 'Art',
+            }, {
+                'canned_query': 'scope://ebay?dep=111',
+                'has_subdepartments': True,
+                'label': 'Accessoires',
+            }]})
+
+    def test_get_top_departments_localefallback(self):
+        app = ebay.App(CONFIG)
+        app.top_departments = {
+            'en_US': [('Art', 550), ('Books', 999)],
+        }
+        resp = app._get_top_departments('fr_FR')
+        self.assertEqual(resp, {
+            'canned_query': 'scope://ebay',
+            'label': u'Tous les départements',
+            'subdepartments': [{
+                'canned_query': 'scope://ebay?dep=550',
+                'has_subdepartments': True,
+                'label': 'Art',
+            }, {
+                'canned_query': 'scope://ebay?dep=999',
+                'has_subdepartments': True,
+                'label': 'Books',
+            }]})
+
 
 class PreviewTestCase(TestCase):
     """Tests for the preview function."""