on master help sign in
Add Spotify engine
commita2a8fbf6230892c2af8e2bb7b76ca3410c61b188 authorCqoicebordel <Cqoicebordel@users.noreply.github.com> dateFri 20 Feb 2015, 18:47 (12 years ago) parent7f7f10b
4 files changed+189
searx/engines/spotify.py+60 searx/settings.yml+4 searx/tests/engines/test_spotify.py+124 searx/tests/test_engines.py+1
searx/engines/spotify.pynew file+60
@@ -0,0 +1,60 @@
1+## Spotify (Music)
2+#
3+# @website https://spotify.com
4+# @provide-api yes (https://developer.spotify.com/web-api/search-item/)
5+#
6+# @using-api yes
7+# @results JSON
8+# @stable yes
9+# @parse url, title, content, embedded
10+
11+from json import loads
12+from urllib import urlencode
13+
14+# engine dependent config
15+categories = ['music']
16+paging = True
17+
18+# search-url
19+url = 'https://api.spotify.com/'
20+search_url = url + 'v1/search?{query}&type=track&offset={offset}'
21+
22+embedded_url = '<iframe data-src="https://embed.spotify.com/?uri=spotify:track:{audioid}"\
23+ width="300" height="80" frameborder="0" allowtransparency="true"></iframe>'
24+
25+
26+# do search-request
27+def request(query, params):
28+ offset = (params['pageno'] - 1) * 20
29+
30+ params['url'] = search_url.format(query=urlencode({'q': query}),
31+ offset=offset)
32+
33+ return params
34+
35+
36+# get response from search-request
37+def response(resp):
38+ results = []
39+
40+ search_res = loads(resp.text)
41+
42+ # parse results
43+ for result in search_res.get('tracks', {}).get('items', {}):
44+ if result['type'] == 'track':
45+ title = result['name']
46+ url = result['external_urls']['spotify']
47+ content = result['artists'][0]['name'] +\
48+ " &bull; " +\
49+ result['album']['name'] +\
50+ " &bull; " + result['name']
51+ embedded = embedded_url.format(audioid=result['id'])
52+
53+ # append result
54+ results.append({'url': url,
55+ 'title': title,
56+ 'embedded': embedded,
57+ 'content': content})
58+
59+ # return results
60+ return results
searx/settings.yml+4
@@ -195,6 +195,10 @@ engines:
195195 shortcut : scc
196196 disabled : True
197197
198+ - name : spotify
199+ engine : spotify
200+ shortcut : stf
201+
198202 - name : subtitleseeker
199203 engine : subtitleseeker
200204 shortcut : ss
searx/tests/engines/test_spotify.pynew file+124
@@ -0,0 +1,124 @@
1+from collections import defaultdict
2+import mock
3+from searx.engines import spotify
4+from searx.testing import SearxTestCase
5+
6+
7+class TestSpotifyEngine(SearxTestCase):
8+
9+ def test_request(self):
10+ query = 'test_query'
11+ dicto = defaultdict(dict)
12+ dicto['pageno'] = 0
13+ params = spotify.request(query, dicto)
14+ self.assertIn('url', params)
15+ self.assertIn(query, params['url'])
16+ self.assertIn('spotify.com', params['url'])
17+
18+ def test_response(self):
19+ self.assertRaises(AttributeError, spotify.response, None)
20+ self.assertRaises(AttributeError, spotify.response, [])
21+ self.assertRaises(AttributeError, spotify.response, '')
22+ self.assertRaises(AttributeError, spotify.response, '[]')
23+
24+ response = mock.Mock(text='{}')
25+ self.assertEqual(spotify.response(response), [])
26+
27+ response = mock.Mock(text='{"data": []}')
28+ self.assertEqual(spotify.response(response), [])
29+
30+ json = """
31+ {
32+ "tracks": {
33+ "href": "https://api.spotify.com/v1/search?query=nosfell&offset=0&limit=20&type=track",
34+ "items": [
35+ {
36+ "album": {
37+ "album_type": "album",
38+ "external_urls": {
39+ "spotify": "https://open.spotify.com/album/5c9ap1PBkSGLxT3J73toxA"
40+ },
41+ "href": "https://api.spotify.com/v1/albums/5c9ap1PBkSGLxT3J73toxA",
42+ "id": "5c9ap1PBkSGLxT3J73toxA",
43+ "name": "Album Title",
44+ "type": "album",
45+ "uri": "spotify:album:5c9ap1PBkSGLxT3J73toxA"
46+ },
47+ "artists": [
48+ {
49+ "external_urls": {
50+ "spotify": "https://open.spotify.com/artist/0bMc6b75FfZEpQHG1jifKu"
51+ },
52+ "href": "https://api.spotify.com/v1/artists/0bMc6b75FfZEpQHG1jifKu",
53+ "id": "0bMc6b75FfZEpQHG1jifKu",
54+ "name": "Artist Name",
55+ "type": "artist",
56+ "uri": "spotify:artist:0bMc6b75FfZEpQHG1jifKu"
57+ }
58+ ],
59+ "disc_number": 1,
60+ "duration_ms": 202386,
61+ "explicit": false,
62+ "external_ids": {
63+ "isrc": "FRV640600067"
64+ },
65+ "external_urls": {
66+ "spotify": "https://open.spotify.com/track/2GzvFiedqW8hgqUpWcASZa"
67+ },
68+ "href": "https://api.spotify.com/v1/tracks/2GzvFiedqW8hgqUpWcASZa",
69+ "id": "1000",
70+ "is_playable": true,
71+ "name": "Title of track",
72+ "popularity": 6,
73+ "preview_url": "https://p.scdn.co/mp3-preview/7b8ecda580965a066b768c2647f877e43f7b1a0a",
74+ "track_number": 3,
75+ "type": "track",
76+ "uri": "spotify:track:2GzvFiedqW8hgqUpWcASZa"
77+ }
78+ ],
79+ "limit": 20,
80+ "next": "https://api.spotify.com/v1/search?query=nosfell&offset=20&limit=20&type=track",
81+ "offset": 0,
82+ "previous": null,
83+ "total": 107
84+ }
85+ }
86+ """
87+ response = mock.Mock(text=json)
88+ results = spotify.response(response)
89+ self.assertEqual(type(results), list)
90+ self.assertEqual(len(results), 1)
91+ self.assertEqual(results[0]['title'], 'Title of track')
92+ self.assertEqual(results[0]['url'], 'https://open.spotify.com/track/2GzvFiedqW8hgqUpWcASZa')
93+ self.assertEqual(results[0]['content'], 'Artist Name &bull; Album Title &bull; Title of track')
94+ self.assertIn('1000', results[0]['embedded'])
95+
96+ json = """
97+ {
98+ "tracks": {
99+ "href": "https://api.spotify.com/v1/search?query=nosfell&offset=0&limit=20&type=track",
100+ "items": [
101+ {
102+ "href": "https://api.spotify.com/v1/tracks/2GzvFiedqW8hgqUpWcASZa",
103+ "id": "1000",
104+ "is_playable": true,
105+ "name": "Title of track",
106+ "popularity": 6,
107+ "preview_url": "https://p.scdn.co/mp3-preview/7b8ecda580965a066b768c2647f877e43f7b1a0a",
108+ "track_number": 3,
109+ "type": "album",
110+ "uri": "spotify:track:2GzvFiedqW8hgqUpWcASZa"
111+ }
112+ ],
113+ "limit": 20,
114+ "next": "https://api.spotify.com/v1/search?query=nosfell&offset=20&limit=20&type=track",
115+ "offset": 0,
116+ "previous": null,
117+ "total": 107
118+ }
119+ }
120+ """
121+ response = mock.Mock(text=json)
122+ results = spotify.response(response)
123+ self.assertEqual(type(results), list)
124+ self.assertEqual(len(results), 0)
searx/tests/test_engines.py+1
@@ -28,6 +28,7 @@ from searx.tests.engines.test_piratebay import * # noqa
2828from searx.tests.engines.test_searchcode_code import * # noqa
2929from searx.tests.engines.test_searchcode_doc import * # noqa
3030from searx.tests.engines.test_soundcloud import * # noqa
31+from searx.tests.engines.test_spotify import * # noqa
3132from searx.tests.engines.test_stackoverflow import * # noqa
3233from searx.tests.engines.test_startpage import * # noqa
3334from searx.tests.engines.test_subtitleseeker import * # noqa