searxng/searx/engines/soundcloud.py

73 lines
2 KiB
Python
Raw Normal View History

"""
Soundcloud (Music)
@website https://soundcloud.com
@provide-api yes (https://developers.soundcloud.com/)
@using-api yes
@results JSON
@stable yes
@parse url, title, content, publishedDate, embedded
"""
2014-09-02 16:12:30 +00:00
2013-10-17 19:21:23 +00:00
from json import loads
from urllib import urlencode, quote_plus
from dateutil import parser
2013-10-17 19:21:23 +00:00
2014-09-02 16:12:30 +00:00
# engine dependent config
2013-10-17 19:21:23 +00:00
categories = ['music']
2014-09-02 16:12:30 +00:00
paging = True
2013-10-17 19:21:23 +00:00
2014-09-02 16:12:30 +00:00
# api-key
2013-10-17 19:21:23 +00:00
guest_client_id = 'b45b1aa10f1ac2941910a7f0d10f8e28'
2014-01-30 00:50:15 +00:00
2014-09-02 16:12:30 +00:00
# search-url
url = 'https://api.soundcloud.com/'
2014-12-16 16:26:16 +00:00
search_url = url + 'search?{query}'\
'&facet=model'\
'&limit=20'\
'&offset={offset}'\
'&linked_partitioning=1'\
'&client_id={client_id}' # noqa
2014-01-20 01:31:20 +00:00
embedded_url = '<iframe width="100%" height="166" ' +\
'scrolling="no" frameborder="no" ' +\
'data-src="https://w.soundcloud.com/player/?url={uri}"></iframe>'
2013-10-17 19:21:23 +00:00
2014-09-02 16:12:30 +00:00
# do search-request
2013-10-17 19:21:23 +00:00
def request(query, params):
2014-01-30 00:50:15 +00:00
offset = (params['pageno'] - 1) * 20
2014-09-02 16:12:30 +00:00
2014-01-30 00:50:15 +00:00
params['url'] = search_url.format(query=urlencode({'q': query}),
2014-09-02 16:12:30 +00:00
offset=offset,
client_id=guest_client_id)
2013-10-17 19:21:23 +00:00
return params
2014-09-02 16:12:30 +00:00
# get response from search-request
2013-10-17 19:21:23 +00:00
def response(resp):
results = []
2014-09-02 16:12:30 +00:00
2013-10-17 19:21:23 +00:00
search_res = loads(resp.text)
2014-09-02 16:12:30 +00:00
# parse results
2013-10-17 19:21:23 +00:00
for result in search_res.get('collection', []):
2013-10-19 22:52:32 +00:00
if result['kind'] in ('track', 'playlist'):
2013-10-17 19:21:23 +00:00
title = result['title']
content = result['description']
publishedDate = parser.parse(result['last_modified'])
uri = quote_plus(result['uri'])
embedded = embedded_url.format(uri=uri)
2014-09-02 16:12:30 +00:00
# append result
2014-01-20 01:31:20 +00:00
results.append({'url': result['permalink_url'],
'title': title,
'publishedDate': publishedDate,
'embedded': embedded,
2014-01-20 01:31:20 +00:00
'content': content})
2014-09-02 16:12:30 +00:00
# return results
2013-10-17 19:21:23 +00:00
return results