Consume EchoNest web service
"""
-__version__ = '0.0.1'
+__version__ = '0.0.5'
__author__ = 'Jack Kaliko'
-from datetime import datetime, timedelta
-
-from requests import get, Request, Timeout, ConnectionError
from sima import ECH
from sima.lib.meta import Artist
from sima.lib.track import Track
-from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError
-from sima.utils.utils import getws, Throttle, Cache, purge_cache
+from sima.lib.http import HttpClient
+from sima.utils.utils import WSError, WSNotFound
+from sima.utils.utils import getws
if len(ECH.get('apikey')) == 23: # simple hack allowing imp.reload
getws(ECH)
-# Some definitions
-WAIT_BETWEEN_REQUESTS = timedelta(0, 1)
-SOCKET_TIMEOUT = 4
+
+def get_mbid(obj, foreign='foreign_ids'):
+ if foreign in obj:
+ for frgnid in obj.get(foreign):
+ if frgnid.get('catalog') == 'musicbrainz':
+ return frgnid.get('foreign_id').split(':')[2]
+ return None
class SimaEch:
"""EchoNest http client
"""
root_url = 'http://{host}/api/{version}'.format(**ECH)
- cache = {}
- timestamp = datetime.utcnow()
- ratelimit = None
name = 'EchoNest'
+ cache = False
+ stats = {'etag':0,
+ 'ccontrol':0,
+ 'minrl':120,
+ 'total':0}
+
+ def __init__(self):
+ self.http = HttpClient(cache=self.cache, stats=self.stats)
- def __init__(self, cache=True):
- self.artist = None
- self._ressource = None
- self.current_element = None
- self.caching = cache
- purge_cache(self.__class__)
-
- def _fetch(self, payload):
- """Use cached elements or proceed http request"""
- url = Request('GET', self._ressource, params=payload,).prepare().url
- if url in SimaEch.cache:
- self.current_element = SimaEch.cache.get(url).elem
- return
- try:
- self._fetch_ws(payload)
- except Timeout:
- raise WSTimeout('Failed to reach server within {0}s'.format(
- SOCKET_TIMEOUT))
- except ConnectionError as err:
- raise WSError(err)
-
- @Throttle(WAIT_BETWEEN_REQUESTS)
- def _fetch_ws(self, payload):
- """fetch from web service"""
- req = get(self._ressource, params=payload,
- timeout=SOCKET_TIMEOUT)
- self.__class__.ratelimit = req.headers.get('x-ratelimit-remaining', None)
- if req.status_code is not 200:
- raise WSHTTPError('{0.status_code}: {0.reason}'.format(req))
- self.current_element = req.json()
- self._controls_answer()
- if self.caching:
- SimaEch.cache.update({req.url:
- Cache(self.current_element)})
-
- def _controls_answer(self):
+ def _controls_answer(self, ans):
"""Controls answer.
"""
- status = self.current_element.get('response').get('status')
+ status = ans.get('response').get('status')
code = status.get('code')
if code is 0:
return True
if code is 5:
- raise WSNotFound('Artist not found: "{0}"'.format(self.artist))
+ raise WSNotFound('Artist not found')
raise WSError(status.get('message'))
def _forge_payload(self, artist, top=False):
payload = {'api_key': ECH.get('apikey')}
if not isinstance(artist, Artist):
raise TypeError('"{0!r}" not an Artist object'.format(artist))
- self.artist = artist
if artist.mbid:
payload.update(
id='musicbrainz:artist:{0}'.format(artist.mbid))
payload.update(artist=name)
payload.update(results=100)
payload.update(sort='song_hotttnesss-desc')
- return payload
+ # > hashing the URL into a cache key
+ # return a sorted list of 2-tuple to have consistent cache
+ return sorted(payload.items(), key=lambda param: param[0])
def get_similar(self, artist=None):
"""Fetch similar artists
"""
payload = self._forge_payload(artist)
# Construct URL
- self._ressource = '{0}/artist/similar'.format(SimaEch.root_url)
- self._fetch(payload)
- for art in self.current_element.get('response').get('artists'):
- artist = {}
- mbid = None
- if 'foreign_ids' in art:
- for frgnid in art.get('foreign_ids'):
- if frgnid.get('catalog') == 'musicbrainz':
- mbid = frgnid.get('foreign_id'
- ).lstrip('musicbrainz:artist:')
+ ressource = '{0}/artist/similar'.format(SimaEch.root_url)
+ ans = self.http(ressource, payload)
+ self._controls_answer(ans.json())
+ for art in ans.json().get('response').get('artists'):
+ mbid = get_mbid(art)
yield Artist(mbid=mbid, name=art.get('name'))
def get_toptrack(self, artist=None):
"""
payload = self._forge_payload(artist, top=True)
# Construct URL
- self._ressource = '{0}/song/search'.format(SimaEch.root_url)
- self._fetch(payload)
+ ressource = '{0}/song/search'.format(SimaEch.root_url)
+ ans = self.http(ressource, payload)
+ self._controls_answer(ans.json())
titles = list()
- artist = {
+ art = {
'artist': artist.name,
'musicbrainz_artistid': artist.mbid,
}
- for song in self.current_element.get('response').get('songs'):
+ for song in ans.json().get('response').get('songs'):
title = song.get('title')
+ if not art.get('musicbrainz_artistid'):
+ art['musicbrainz_artistid'] = get_mbid(song, 'artist_foreign_ids')
if title not in titles:
titles.append(title)
- yield Track(title=title, **artist )
+ yield Track(title=title, **art)
# VIM MODLINE
home / dev / repositories / mpd-sima.git / blobdiff