Merge lp:~submarine/unity-scope-songsterr/general-misc-update into lp:unity-scope-songsterr

[David Callé]

Install fixes, more metadata and simple previews

General update, since I noticed it was tested on the server:
- a few install fixes
- Use icon everywhere
- More metadata
- Preview draft

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:8
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/1/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-amd64-ci/1/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-armhf-ci/1/console

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

review: Needs Fixing (continuous-integration)

[lp:~submarine/unity-scope-songsterr/general-misc-update]

9. By Mark Tully on 2013-06-17

Updated dependencies in debian/control

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:9
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/2/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-amd64-ci/2/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-armhf-ci/2/console

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

review: Needs Fixing (continuous-integration)

[David Callé (davidc3)]

review: Approve

[lp:~submarine/unity-scope-songsterr/general-misc-update]

10. By David Callé on 2013-07-01

Bump again

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:10
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/3/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-amd64-ci/3/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-armhf-ci/3/console

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

review: Needs Fixing (continuous-integration)

[David Callé (davidc3)]

Raring, heh.

[lp:~submarine/unity-scope-songsterr/general-misc-update]

11. By David Callé on 2013-07-02

Dummy commit

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:11
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/4/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-amd64-ci/4/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-armhf-ci/4/console

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

review: Needs Fixing (continuous-integration)

[lp:~submarine/unity-scope-songsterr/general-misc-update]

12. By David Callé on 2013-07-02

Bump changelog to use Saucy

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:12
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/5/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-amd64-ci/5/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-raring-armhf-ci/5/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:12
http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-ci/6/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-saucy-amd64-ci/1
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-songsterr-saucy-armhf-ci/1/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Guillermo Gonzalez (verterok)]

looks good

review: Approve

=== modified file 'data/songsterr.scope.in'
--- data/songsterr.scope.in	2013-02-21 01:16:56 +0000
+++ data/songsterr.scope.in	2013-07-02 08:52:27 +0000
@@ -1,15 +1,15 @@
 [Scope]
 DBusName=com.canonical.Unity.Scope.Music.Songsterr
 DBusPath=/com/canonical/unity/scope/music/songsterr
-Icon=
+Icon=/usr/share/icons/unity-icon-theme/places/svg/service-songsterr.svg
 _Keywords=songsterr;
 RequiredMetadata=
-OptionalMetadata=
-Loader=/usr/lib/ubuntu-scopes/songsterr/unity_songsterr_daemon.py
+OptionalMetadata=artist[s];tabs[s];
+Loader=/usr/share/unity-scopes/songsterr/unity_songsterr_daemon.py
 RemoteContent=true
 Type=music
 _Name=Songsterr
-_Description=Find Songsterr items
+_Description=This is an Ubuntu search plugin that enables tabs from Songsterr to be searched and displayed in the Dash underneath the Music header. If you do not wish to search this content source, you can disable this search plugin.
 _SearchHint=Search Songsterr
 
 [Desktop Entry]

=== modified file 'data/unity-scope-songsterr.service'
--- data/unity-scope-songsterr.service	2013-02-05 00:44:46 +0000
+++ data/unity-scope-songsterr.service	2013-07-02 08:52:27 +0000
@@ -1,3 +1,3 @@
 [D-BUS Service]
 Name=com.canonical.Unity.Scope.Music.Songsterr
-Exec=/usr/lib/ubuntu-scopes/songsterr/unity_songsterr_daemon.py
+Exec=/usr/bin/python3 /usr/share/unity-scopes/scope-runner-dbus.py /usr/share/unity-scopes/songsterr/unity_songsterr_daemon.py

=== modified file 'debian/changelog'
--- debian/changelog	2013-02-13 21:30:36 +0000
+++ debian/changelog	2013-07-02 08:52:27 +0000
@@ -1,5 +1,9 @@
-unity-scope-songsterr (0.1) UNRELEASED; urgency=low
+unity-scope-songsterr (0.1) saucy; urgency=low
 
+  [ Mark Tully ]
   * Initial release
+  
+  [ David Callé ]
+  * Misc integration fixes and cleaning
 
- -- Mark Tully <[e-mail]>  Wed, 13 Feb 2013 21:26:48 +0000
+ -- David Callé <david@aristote>  Tue, 02 Jul 2013 10:49:20 +0200

=== modified file 'debian/control'
--- debian/control	2013-02-13 21:30:36 +0000
+++ debian/control	2013-07-02 08:52:27 +0000
@@ -5,21 +5,24 @@
 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-songsterr
 
 Package: unity-scope-songsterr
 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: songsterr scope for Unity
  A Dash search plugin for songsterr.

=== modified file 'debian/rules' (properties changed: -x to +x)
=== modified file 'po/unity-scope-songsterr.pot'
--- po/unity-scope-songsterr.pot	2013-02-21 00:57:26 +0000
+++ po/unity-scope-songsterr.pot	2013-07-02 08:52:27 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2013-02-21 01:57+0100\n"
+"POT-Creation-Date: 2013-07-01 17:25+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -17,22 +17,38 @@
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: ../src/unity_songsterr_daemon.py:32 ../data/songsterr.scope.in.h:4
+#: ../src/unity_songsterr_daemon.py:33 ../data/songsterr.scope.in.h:4
 msgid "Search Songsterr"
 msgstr ""
 
-#: ../src/unity_songsterr_daemon.py:33
+#: ../src/unity_songsterr_daemon.py:34
 msgid "Sorry, there are no Songsterr results that match your search."
 msgstr ""
 
-#: ../src/unity_songsterr_daemon.py:34
+#: ../src/unity_songsterr_daemon.py:35
 msgid "Powered by Songsterr"
 msgstr ""
 
-#: ../src/unity_songsterr_daemon.py:44
+#: ../src/unity_songsterr_daemon.py:45 ../src/unity_songsterr_daemon.py:100
 msgid "Tabs"
 msgstr ""
 
+#: ../src/unity_songsterr_daemon.py:94
+msgid "Guitar"
+msgstr ""
+
+#: ../src/unity_songsterr_daemon.py:94
+msgid "Chords"
+msgstr ""
+
+#: ../src/unity_songsterr_daemon.py:94
+msgid "Bass"
+msgstr ""
+
+#: ../src/unity_songsterr_daemon.py:102
+msgid "View"
+msgstr ""
+
 #: ../data/songsterr.scope.in.h:1
 msgid "songsterr;"
 msgstr ""
@@ -42,5 +58,8 @@
 msgstr ""
 
 #: ../data/songsterr.scope.in.h:3
-msgid "Find Songsterr items"
+msgid ""
+"This is an Ubuntu search plugin that enables tabs from Songsterr to be "
+"searched and displayed in the Dash underneath the Music header. If you do "
+"not wish to search this content source, you can disable this search plugin."
 msgstr ""

=== modified file 'setup.cfg'
--- setup.cfg	2013-02-13 21:30:36 +0000
+++ setup.cfg	2013-07-02 08:52:27 +0000
@@ -3,4 +3,4 @@
 
 [build_i18n]
 domain=unity-scope-songsterr
-desktop_files=[('share/unity/scopes', ('data/songsterr.scope.in',))]
+desktop_files=[('share/unity/scopes/music', ('data/songsterr.scope.in',))]

=== modified file 'setup.py'
--- setup.py	2013-02-13 21:30:36 +0000
+++ setup.py	2013-07-02 08:52:27 +0000
@@ -16,8 +16,6 @@
       url='http://launchpad.net/ubuntu-scopes',
       license='GNU General Public License (GPL)',
       data_files=[('share/dbus-1/services', ['data/unity-scope-songsterr.service']),
-                  ('share/icons/unity-icon-theme/places/svg', ['data/icons/service-songsterr.svg']),
-                  ('lib/ubuntu-scopes/songsterr', ['src/unity_songsterr_daemon.py']),
-                  ('lib/ubuntu-scopes/songsterr', ['src/__init__.py']), ],
+                  ('share/unity-scopes/songsterr', ['src/unity_songsterr_daemon.py']), ],
       cmdclass={'build': build_extra.build_extra,
                 'build_i18n': build_i18n.build_i18n, })

=== modified file 'src/unity_songsterr_daemon.py'
--- src/unity_songsterr_daemon.py	2013-02-13 21:25:57 +0000
+++ src/unity_songsterr_daemon.py	2013-07-02 08:52:27 +0000
@@ -19,6 +19,7 @@
 import gettext
 import json
 import urllib.request
+import urllib.parse
 
 APP_NAME = 'unity-scope-songsterr'
 LOCAL_PATH = '/usr/share/locale/'
@@ -34,13 +35,13 @@
 PROVIDER_CREDITS = _('Powered by Songsterr')
 SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
 PROVIDER_ICON = SVG_DIR + 'service-songsterr.svg'
-DEFAULT_RESULT_ICON = SVG_DIR + 'result-info.svg'
+DEFAULT_RESULT_ICON = SVG_DIR + 'service-songsterr.svg'
 DEFAULT_RESULT_MIMETYPE = 'text/html'
 DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
 
 SEARCH_URI = 'http://www.songsterr.com/a/ra/songs.json?pattern=%s'
 
-c1 = {'id': 'tabs',
+c1 = {'id': 'songs',
       'name': _('Tabs'),
       'icon': SVG_DIR + 'group-installed.svg',
       'renderer': Unity.CategoryRenderer.VERTICAL_TILE}
@@ -48,32 +49,60 @@
 
 FILTERS = []
 
-EXTRA_METADATA = []
+m1 = {'id'   :'artist',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m2 = {'id'   :'tabs',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2]
 
 
 def search(search, filters):
     '''
-    Search the server for questions and use stackexchange's api for tags
+    Query the songsterr API
     '''
     results = []
-
+    if not search or len(search) < 3:
+        return results
+    search = urllib.parse.quote(search)
     uri = SEARCH_URI % search
+    print(uri)
     try:
         response = urllib.request.urlopen(uri).read()
-        response = response.decode('utf8')
-        json_response = json.loads(response)
-        result = json_response
+        result = json.loads(response.decode('utf8'))
     except:
         result = {}
     if result:
         for item in result:
+            if len(results) > 24:
+                break
             results.append({'uri': 'http://www.songsterr.com/a/wa/song?id=%s' % item['id'],
-                            'icon_hint': '',
-                            'category': 0,
                             'title': item['title'],
-                            'comment': item['artist']['name']})
+                            'artist': item['artist']['name'],
+                            'tabs': ";".join(item['tabTypes'])})
     return results
-    
+
+
+class Preview (Unity.ResultPreviewer):
+
+    def do_run(self):
+        icon = Gio.FileIcon.new(Gio.file_new_for_uri(self.result.icon_hint))
+        preview = Unity.GenericPreview.new(self.result.title, '', icon)
+        preview.props.subtitle = self.result.metadata['artist'].get_string()
+        tabs = self.result.metadata['tabs'].get_string().split(';')
+        tab_types = {"PLAYER":None,"TEXT_GUITAR_TAB":_("Guitar"),"CHORDS":_("Chords"),"TEXT_BASS_TAB":_("Bass")}
+        tab_list = []
+        for t in tabs:
+            if tab_types[t]:
+                tab_list.append(tab_types[t])
+        if len(tab_list) > 0:
+            preview.add_info(Unity.InfoHint.new("tabs", _("Tabs"), None, ', '.join(tab_list)))
+        icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
+        view_action = Unity.PreviewAction.new("open", _("View"), icon)
+        preview.add_action(view_action)
+        return preview
+
 
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
@@ -108,21 +137,9 @@
                     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)
+            print (error)
 
 
 class Scope(Unity.AbstractScope):
@@ -176,6 +193,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/data/mock_songsterr_pass'
--- tests/data/mock_songsterr_pass	2013-02-13 21:23:53 +0000
+++ tests/data/mock_songsterr_pass	2013-07-02 08:52:27 +0000
@@ -1,1 +1,1 @@
-[{"id":477,"type":"Song","title":"Tears Of The Dragon","artist":{"id":208,"type":"Artist","nameWithoutThePrefix":"Bruce Dickinson","useThePrefix":false,"name":"Bruce Dickinson"},"chordsPresent":true},{"id":6080,"type":"Song","title":"Navigate The Seas Of The Sun","artist":{"id":208,"type":"Artist","nameWithoutThePrefix":"Bruce Dickinson","useThePrefix":false,"name":"Bruce Dickinson"},"chordsPresent":true}]
+[{"id":477,"type":"Song","title":"Tears Of The Dragon","artist":{"id":208,"type":"Artist","nameWithoutThePrefix":"Bruce Dickinson","useThePrefix":false,"name":"Bruce Dickinson"},"chordsPresent":true,"tabTypes":["PLAYER","TEXT_GUITAR_TAB","CHORDS"]},{"id":6080,"type":"Song","title":"Navigate The Seas Of The Sun","artist":{"id":208,"type":"Artist","nameWithoutThePrefix":"Bruce Dickinson","useThePrefix":false,"name":"Bruce Dickinson"},"chordsPresent":true,"tabTypes":["PLAYER","TEXT_GUITAR_TAB","CHORDS"]}]