Merge lp:~davidc3/unity-scope-reddit/many-fixes into lp:unity-scope-reddit

[David Callé]

Better query handling and many installer fixes

This branch makes the scope work again and cuts querying time by 4.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:7
http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-ci/1/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-amd64-ci/1/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-armhf-ci/1/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-i386-ci/1/console

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

review: Needs Fixing (continuous-integration)

[lp:~davidc3/unity-scope-reddit/many-fixes]

8. By David Callé on 2013-08-14

Fix packaging deps

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[lp:~davidc3/unity-scope-reddit/many-fixes]

9. By David Callé on 2013-08-14

Improve first comment use

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[lp:~davidc3/unity-scope-reddit/many-fixes]

10. By David Callé on 2013-08-14

Better preview image if available and nsfw filter toggle

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:10
http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-ci/4/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-amd64-ci/4
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-armhf-ci/4
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-reddit-saucy-i386-ci/4/console

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

review: Needs Fixing (continuous-integration)

[lp:~davidc3/unity-scope-reddit/many-fixes]

11. By David Callé on 2013-08-15

Dummy commit for Jenkins

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[David Callé (davidc3)]

review: Approve

=== modified file 'data/reddit.scope.in'
--- data/reddit.scope.in	2013-02-21 11:50:58 +0000
+++ data/reddit.scope.in	2013-08-15 13:53:44 +0000
@@ -1,15 +1,17 @@
 [Scope]
 DBusName=com.canonical.Unity.Scope.Info.Reddit
 DBusPath=/com/canonical/unity/scope/info/reddit
-Icon=
-_Keywords=reddit;
+Icon=/usr/share/icons/unity-icon-theme/places/svg/service-reddit.svg
+QueryBinary=
+_Keywords=reddit;r;
 RequiredMetadata=
-OptionalMetadata=[s]author;[s]target;
-Loader=/usr/lib/ubuntu-scopes/reddit/unity_reddit_daemon.py
+OptionalMetadata=author[s];target[s];domain[s];subreddit[s];comments[i];
+Loader=/usr/share/unity-scopes/reddit/unity_reddit_daemon.py
 RemoteContent=true
 Type=info
+Master=info
 _Name=Reddit
-_Description=Find Reddit posts
+_Description=This is an Ubuntu search plugin that enables information from Reddit 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 Reddit
 
 [Desktop Entry]

=== modified file 'data/unity-scope-reddit.service'
--- data/unity-scope-reddit.service	2013-02-21 11:50:58 +0000
+++ data/unity-scope-reddit.service	2013-08-15 13:53:44 +0000
@@ -1,3 +1,3 @@
 [D-BUS Service]
 Name=com.canonical.Unity.Scope.Info.Reddit
-Exec=/usr/lib/ubuntu-scopes/reddit/unity_reddit_daemon.py
+Exec=/usr/bin/python3 /usr/share/unity-scopes/scope-runner-dbus.py /usr/share/unity-scopes/reddit/unity_reddit_daemon.py

=== modified file 'debian/control'
--- debian/control	2013-02-21 11:50:58 +0000
+++ debian/control	2013-08-15 13:53:44 +0000
@@ -1,25 +1,32 @@
 Source: unity-scope-reddit
 Section: gnome
-Priority: extra
+Priority: optional
 Maintainer: David Callé <[e-mail]>
 Build-Depends: debhelper (>= 9),
                python3,
                python3-distutils-extra,
+               python3-gi,
                pkg-config,
                python3-nose,
-               gir1.2-unity-5.0 (>= 6.8),
-               gir1.2-dee-1.0,
+               gir1.2-unity-5.0 (>= 7),
+               gir1.2-dee-1.0 (>= 1.2.5),
                gir1.2-glib-2.0,
-Standards-Version: 3.9.3
-Homepage: https://launchpad.net/ubuntu-scopes
-
+Standards-Version: 3.9.4
+Homepage: https://launchpad.net/unity-scope-reddit
+# If you aren't a member of ~submarine but need to upload packaging changes,
+# just go ahead. ~submarine will notice and sync up the code again.
+Vcs-Bzr: https://code.launchpad.net/~submarine/unity-scope-reddit/trunk
+ 
 Package: unity-scope-reddit
 Architecture: all
 Depends: ${misc:Depends},
          ${python3:Depends},
          python3,
-         gir1.2-unity-5.0 (>= 6.8),
-         gir1.2-dee-1.0,
+         python3-gi,
+         gir1.2-unity-5.0 (>= 7),
+         gir1.2-dee-1.0 (>= 1.2.5),
+         unity-scopes-runner,
          gir1.2-glib-2.0
-Description: reddit scope for Unity
- A Dash search plugin for reddit.
+Description: Reddit scope for Unity
+ This package contains the "reddit" scope which allows Unity
+ to search for Reddit content.

=== modified file 'setup.cfg'
--- setup.cfg	2013-02-21 11:50:58 +0000
+++ setup.cfg	2013-08-15 13:53:44 +0000
@@ -3,4 +3,4 @@
 
 [build_i18n]
 domain=unity-scope-reddit
-desktop_files=[('share/unity/scopes', ('data/reddit.scope.in',))]
+desktop_files=[('share/unity/scopes/info', ('data/reddit.scope.in',))]

=== modified file 'setup.py'
--- setup.py	2013-02-21 11:50:58 +0000
+++ setup.py	2013-08-15 13:53:44 +0000
@@ -11,8 +11,6 @@
       license='GNU General Public License (GPL)',
       data_files=[
     ('share/dbus-1/services', ['data/unity-scope-reddit.service']),
-    ('share/icons/unity-icon-theme/places/svg', ['data/icons/service-reddit.svg']),
-    ('lib/ubuntu-scopes/reddit', ['src/unity_reddit_daemon.py']),
-    ('lib/ubuntu-scopes/reddit', ['src/__init__.py']),
+    ('share/unity-scopes/reddit', ['src/unity_reddit_daemon.py'])
     ], cmdclass={'build':  build_extra.build_extra,
                  'build_i18n': build_i18n.build_i18n,})

=== modified file 'src/unity_reddit_daemon.py'
--- src/unity_reddit_daemon.py	2013-02-21 11:50:58 +0000
+++ src/unity_reddit_daemon.py	2013-08-15 13:53:44 +0000
@@ -35,28 +35,16 @@
 PROVIDER_CREDITS = _('Powered by Reddit')
 SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
 PROVIDER_ICON = SVG_DIR+'service-reddit.svg'
-DEFAULT_RESULT_ICON = SVG_DIR+'result-info.svg'
+DEFAULT_RESULT_ICON = SVG_DIR+'service-reddit.svg'
 DEFAULT_RESULT_MIMETYPE = 'text/html'
 DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
 
 
-c1 = {'id'      :'hot',
-      'name'    :_('Hot'),
-      'icon'    :SVG_DIR+'group-installed.svg',
-      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-c2 = {'id'      :'new', 
-      'name'    :_('New'),
-      'icon'    :SVG_DIR+'group-installed.svg',
-      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-c2 = {'id'      :'controversial', 
-      'name'    :_('Controversial'),
-      'icon'    :SVG_DIR+'group-installed.svg',
-      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-c2 = {'id'      :'top', 
-      'name'    :_('Top'),
-      'icon'    :SVG_DIR+'group-installed.svg',
-      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
-CATEGORIES = [c1, c2]
+c1 = {'id'      :'results',
+      'name'    :_('Posts'),
+      'icon'    :SVG_DIR+'group-installed.svg',
+      'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
+CATEGORIES = [c1]
 
 FILTERS = []
 
@@ -66,7 +54,16 @@
 m2 = {'id'   :'author',
       'type' :'s',
       'field':Unity.SchemaFieldType.OPTIONAL}
-EXTRA_METADATA = [m1, m2]
+m3 = {'id'   :'domain',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m4 = {'id'   :'subreddit',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m5 = {'id'   :'comments',
+      'type' :'i',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2, m3, m4, m5]
 
 def search(search, filters):
     '''
@@ -83,36 +80,49 @@
     extras metadata fields (variant)
     '''
     results = []
+    uri = ''
     if not search:
-        return results
-    search = urllib.parse.quote(search)
-    cats = ['hot', 'new', 'controversial', 'top']
-    for cat in cats:
-        uri = '%sr/%s/%s.json?limit=25' % (SEARCH_URI, search, cat)
-        print(uri)
-        data = None
-        try:
-            response = urllib.request.urlopen(uri).read()
-            data = json.loads(response.decode('utf-8'))
-        except Exception as error:
-            print(error)
-            if cat == 'hot':
-                return results
+        uri = '%shot.json?limit=25' % (SEARCH_URI)
+    elif len(search) < 3:
+        return results
+    else:
+        search_cleaned = urllib.parse.quote(search.split('#')[0])
+        uri = '%sr/%s/hot.json?limit=25' % (SEARCH_URI, search_cleaned)
+    print(uri)
+    data = None
+    try:
+        hdr = { 'User-Agent' : 'unity-scope-reddit' }
+        req = urllib.request.Request(url=uri, 
+                                     headers=hdr)
+        response = urllib.request.urlopen(req).read()
+        data = json.loads(response.decode('utf-8'))
+    except Exception as error:
+        print(error)
+        return results
+    if not data or not 'data' in data:
+        return results
+    for d in data ['data']['children']:
+        if d['data']['over_18'] is True and not '#nsfw' in search:
+            ann_icon = Unity.AnnotatedIcon.new(Gio.ThemedIcon.new(DEFAULT_RESULT_ICON))
+            ann_icon.props.ribbon = "NSFW"
+            icon = ann_icon.to_string()
+            target = ''
+        else:
+            if d['data']['thumbnail'] != 'self':
+                icon = d['data']['thumbnail']
             else:
-                continue
-        if not data or not 'data' in data:
-            return results
-        for d in data ['data']['children']:
-            if d['data']['over_18'] is True:
                 icon = None
-            else:
-                icon = d['data']['thumbnail']
-            results.append({'uri':'%s%s' % (SEARCH_URI, d['data']['permalink']),
-                            'title':d['data']['title'],
-                            'icon':icon,
-                            'target':GLib.Variant('s', d['data']['url']),
-                            'author':GLib.Variant('s', d['data']['author']),
-                            'category':cats.index(cat)})
+            target = d['data']['url']
+        comment = d['data']['selftext']
+        results.append({'uri':'%s%s' % (SEARCH_URI, d['data']['permalink']),
+                        'title':d['data']['title'],
+                        'icon':icon,
+                        'target':target,
+                        'author':d['data']['author'],
+                        'subreddit':d['data']['subreddit'],
+                        'comment':comment,
+                        'comments':d['data']['num_comments'],
+                        'domain':d['data']['domain']})
     return results
 
 
@@ -149,22 +159,34 @@
                     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 = Unity.ScopeResult.create(str(i['uri']), str(i['icon']),
-                                                  i['category'], i['result_type'],
-                                                  str(i['mimetype']), str(i['title']),
-                                                  str(i['comment']), str(i['dnd_uri']),
-                                                  i['metadata'])
-                result_set.add_result(result)
+                result_set.add_result(**i)
         except Exception as error:
             print (error)
 
+class Preview (Unity.ResultPreviewer):
+
+    def do_run(self):
+        if self.result.metadata['target'].get_string().split('.')[-1] in ['jpg', 'png']:
+            image = Gio.FileIcon.new (Gio.file_new_for_uri(self.result.metadata['target'].get_string()))
+        else:
+            image = Gio.FileIcon.new (Gio.file_new_for_uri(self.result.icon_hint))
+        if self.result.comment != self.result.title and self.result.comment != '':
+            description = self.result.comment
+        elif len(self.result.title) > 23:
+            description = self.result.title
+        else:
+            description = ''
+        preview = Unity.GenericPreview.new(self.result.title, description, image)
+        preview.add_info(Unity.InfoHint.new('comments', _('Comments'), None, str(self.result.metadata['comments'].get_int32())))
+        preview.add_info(Unity.InfoHint.new('subreddit', _('Submitted to'), None, "r/%s" % (self.result.metadata['subreddit'].get_string())))
+        if not self.result.metadata['domain'].get_string().startswith("self."):
+            preview.add_info(Unity.InfoHint.new('domain', _('Source'), None, self.result.metadata['domain'].get_string()))
+        preview.props.subtitle = self.result.metadata['author'].get_string()
+        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
+        open_action = Unity.PreviewAction.new("open", _("View on Reddit"), icon)
+        preview.add_action(open_action)
+        return preview
+
 class Scope (Unity.AbstractScope):
     def __init__(self):
         Unity.AbstractScope.__init__(self)
@@ -216,5 +238,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_reddit.py'
--- tests/test_reddit.py	2013-02-21 11:50:58 +0000
+++ tests/test_reddit.py	2013-08-15 13:53:44 +0000
@@ -41,7 +41,7 @@
     def test_valid_searches(self):
         self.scope_module.SEARCH_URI = 'file:tests/data/mock_reddit_pass#'
         expected_results = ['Ubuntu for tablets hands-on video',
-                            '/usr/share/icons/unity-icon-theme/places/svg/result-info.svg',
+                            '/usr/share/icons/unity-icon-theme/places/svg/service-reddit.svg',
                             'file:tests/data/mock_reddit_pass#/r/Ubuntu/comments/18wux7/ubuntu_for_tablets_handson_video/']
         results = []
         for s in ['ubuntu']: