Merge lp:~davidc3/unity-scope-deviantart/previews into lp:unity-scope-deviantart

[David Callé]

Add previews

Add basic previews.
http://ubuntuone.com/5BzZqi6LhC7GiWfrEpMShC

[lp:~davidc3/unity-scope-deviantart/previews]

34. By David Callé on 2013-04-19

Add tags support in previews

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:33
http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-ci/1/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-raring-amd64-ci/1

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:34
http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-ci/2/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-raring-amd64-ci/2

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

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

112 + preview.props.image_source_uri = self.result.metadata['resource'].get_string()

The "image_source_uri" property is for requesting Unity to generate a thumbnail for a *local* media file, please don't try to use with remote uris. The property you want is "image" (also the third parameter to GenericPreview.new).

review: Needs Fixing

[Michal Hruby (mhr3)]

117 + preview.props.subtitle = _("By ") + author

Please use format strings for these kind of translations. _("By %s") % author

[lp:~davidc3/unity-scope-deviantart/previews]

35. By David Callé on 2013-04-19

Fix translation string for By

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:35
http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-ci/3/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-raring-amd64-ci/3

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

review: Approve (continuous-integration)

[lp:~davidc3/unity-scope-deviantart/previews]

36. By David Callé on 2013-04-23

Use the image property of Unity Preview instead of image_source_uri

37. By David Callé on 2013-04-23

Do it everywhere

[Michal Hruby (mhr3)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:37
http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-ci/4/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-deviantart-raring-amd64-ci/4

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

review: Approve (continuous-integration)

=== modified file 'data/deviantart.scope.in'
--- data/deviantart.scope.in	2013-03-15 17:28:32 +0000
+++ data/deviantart.scope.in	2013-04-23 10:30:34 +0000
@@ -4,7 +4,7 @@
 Icon=
 _Keywords=art;deviantart;image;da;deviant;
 RequiredMetadata=
-OptionalMetadata=published[s];author[s]
+OptionalMetadata=published[s];author[s];tags[s];
 Loader=/usr/share/unity-scopes/deviantart/unity_deviantart_daemon.py
 RemoteContent=true
 Type=graphics

=== modified file 'src/unity_deviantart_daemon.py'
--- src/unity_deviantart_daemon.py	2013-03-19 22:20:35 +0000
+++ src/unity_deviantart_daemon.py	2013-04-23 10:30:34 +0000
@@ -14,12 +14,13 @@
 # You should have received a copy of the GNU General Public License along 
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from gi.repository import Unity, UnityExtras
-from gi.repository import Gio, GLib
+from gi.repository import Unity
+from gi.repository import Gio
 import feedparser
 import urllib.parse
 import urllib.request
 import gettext
+import re
 
 APP_NAME = 'unity-scope-deviantart'
 LOCAL_PATH = '/usr/share/locale/'
@@ -48,13 +49,16 @@
 
 FILTERS = []
 
-m1 = {'id'   :'published',
+m1 = {'id'   :'tags',
       'type' :'s',
       'field':Unity.SchemaFieldType.OPTIONAL}
 m2 = {'id'   :'author',
       'type' :'s',
       'field':Unity.SchemaFieldType.OPTIONAL}
-EXTRA_METADATA = [m1, m2]
+m3 = {'id'   :'resource',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2, m3]
 
 def search(search, filters):
     '''
@@ -74,7 +78,7 @@
     if not search:
         return results
     search = urllib.parse.quote(search)
-    uri = "%srss.xml?type=deviation&q=boost:popular+%s" % (SEARCH_URI, search)
+    uri = "%srss.xml?type=deviation&limit=25&q=boost:popular+%s" % (SEARCH_URI, search)
     print(uri)
     try:
         feed = feedparser.parse(uri)
@@ -92,10 +96,10 @@
             results.append({'uri':entry['link'].replace('http://', 'https://'),
                             'icon':entry['media_thumbnail'][0]['url'].replace('http://', 'https://'),
                             'title':entry['title'],
-                            'comment':entry['tags'][0]['label'],
-                            'date':entry['published'],
-                            'author':GLib.Variant('s', entry['media_copyright']['url']),
-                            'published':GLib.Variant('s', entry['published'])})
+                            'comment':entry['summary'],
+                            'author':entry['media_copyright']['url'],
+                            'tags':entry['tags'][0]['term'],
+                            'resource':entry['media_content'][0]['url'].replace('http://', 'https://')})
         except Exception as error:
             print("Skipping an invalid result", error)
     return results
@@ -134,22 +138,37 @@
                     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 strip_html_tags(self, data):
+        data = data.replace('<br />', '\n')
+        p = re.compile(r'<.*?>')
+        return p.sub('', data)
+
+    def do_run(self):
+        comment = self.strip_html_tags(self.result.comment.strip())
+        preview = Unity.GenericPreview.new(self.result.title, comment, None)
+        if self.result.metadata and 'tags' in self.result.metadata and self.result.metadata['tags'].get_string() != '':
+            tags = self.result.metadata['tags'].get_string().split('/')
+            if len(tags) > 0:
+                preview.add_info(Unity.InfoHint.new("tags", _("Tags"), None, ', '.join(tags)))
+        if self.result.metadata and 'resource' in self.result.metadata and self.result.metadata['resource'].get_string() != '':
+            thumbnail = Gio.FileIcon.new(Gio.file_new_for_uri(self.result.metadata['resource'].get_string()))
+        else:
+            thumbnail = Gio.FileIcon.new(Gio.file_new_for_uri(self.result.icon_hint))
+        preview.props.image = thumbnail
+        if self.result.metadata and 'author' in self.result.metadata and self.result.metadata['author'].get_string() != '':
+            author = self.result.metadata['author'].get_string().split('://')[1].split('.deviantart')[0]
+            preview.props.subtitle = _("By %s") % author
+        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
+        view_action = Unity.PreviewAction.new("view", _("View"), icon)
+        preview.add_action(view_action)
+        return preview
+
 class Scope (Unity.AbstractScope):
     def __init__(self):
         Unity.AbstractScope.__init__(self)
@@ -201,5 +220,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_deviantart.py'
--- tests/test_deviantart.py	2013-02-14 14:59:25 +0000
+++ tests/test_deviantart.py	2013-04-23 10:30:34 +0000
@@ -40,14 +40,15 @@
 
     def test_valid_searches(self):
         self.scope_module.SEARCH_URI = 'file:tests/data/mock_deviantart_pass#'
-        expected_results = ['Noise Context Pane',
-                            'Application Interfaces']
+        expected_results = ['Asus eeeBox Heaven And Earth',
+                            'https://th07.deviantart.net/fs70/150/f/2013/016/2/d/asus_eeebox_heaven_and_earth_by_mmesantos1-d5roikz.png']
         results = []
         for s in ['danrabbit']:
             result_set = self.perform_query(s)
-            results.append(result_set.results[1]['title'])
-            results.append(result_set.results[1]['comment'])
+            results.append(result_set.results[0]['title'])
+            results.append(result_set.results[0]['icon'])
         self.assertEqual(results, expected_results)
+        self.assertEqual(result_set.results[0]['comment'].startswith('OS: Linux Mint XFCE 14 x86'), True)
 
     def test_failing_search(self):
         self.scope_module.SEARCH_URI = 'file:tests/data/mock_deviantart_fail#'