Consume EchoNest web service
"""
-__version__ = '0.0.1'
+__version__ = '0.0.2'
__author__ = 'Jack Kaliko'
-import logging
-
from datetime import datetime, timedelta
-from time import sleep
-from requests import get, Request, Timeout, ConnectionError
+from requests import Session, Request, Timeout, ConnectionError
from sima import ECH
from sima.lib.meta import Artist
-from sima.utils.utils import getws
-if len(ECH.get('apikey')) == 23:
+from sima.lib.track import Track
+from sima.lib.http import CacheController
+from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError
+from sima.utils.utils import getws, Throttle
+if len(ECH.get('apikey')) == 23: # simple hack allowing imp.reload
getws(ECH)
# Some definitions
SOCKET_TIMEOUT = 4
-class EchoError(Exception):
- pass
-
-class EchoNotFound(EchoError):
- pass
-
-class EchoTimeout(EchoError):
- pass
-
-class EchoHTTPError(EchoError):
- pass
-
-class Throttle():
- def __init__(self, wait):
- self.wait = wait
- self.last_called = datetime.now()
-
- def __call__(self, func):
- def wrapper(*args, **kwargs):
- while self.last_called + self.wait > datetime.now():
- sleep(0.1)
- result = func(*args, **kwargs)
- self.last_called = datetime.now()
- return result
- return wrapper
-
-
-class Cache():
- def __init__(self, elem, last=None):
- self.elem = elem
- self.requestdate = last
- if not last:
- self.requestdate = datetime.utcnow()
-
- def created(self):
- return self.requestdate
-
- def get(self):
- return self.elem
-
-
-def purge_cache(age=4):
- now = datetime.utcnow()
- if now.hour == SimaEch.timestamp.hour:
- return
- SimaEch.timestamp = datetime.utcnow()
- cache = SimaEch.cache
- delta = timedelta(hours=age)
- for url in list(cache.keys()):
- timestamp = cache.get(url).created()
- if now - timestamp > delta:
- cache.pop(url)
-
-
-class SimaEch():
- """
+class SimaEch:
+ """EchoNest http client
"""
root_url = 'http://{host}/api/{version}'.format(**ECH)
- cache = {}
timestamp = datetime.utcnow()
ratelimit = None
+ name = 'EchoNest'
+ cache = False
- def __init__(self, cache=True):
- self.artist = None
+ def __init__(self):
self._ressource = None
self.current_element = None
- self.caching = cache
- purge_cache()
+ self.controller = CacheController(self.cache)
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
+ req = Request('GET', self._ressource, params=payload,
+ ).prepare()
+ if self.cache:
+ cached_response = self.controller.cached_request(req.url, req.headers)
+ if cached_response:
+ return cached_response.json()
+
try:
- self._fetch_ech(payload)
+ return self._fetch_ws(req)
except Timeout:
- raise EchoTimeout('Failed to reach server within {0}s'.format(
+ raise WSTimeout('Failed to reach server within {0}s'.format(
SOCKET_TIMEOUT))
except ConnectionError as err:
- raise EchoError(err)
+ raise WSError(err)
@Throttle(WAIT_BETWEEN_REQUESTS)
- def _fetch_ech(self, payload):
+ def _fetch_ws(self, prepreq):
"""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 EchoHTTPError(req.status_code)
- self.current_element = req.json()
- self._controls_answer()
- if self.caching:
- SimaEch.cache.update({req.url:
- Cache(self.current_element)})
-
- def _controls_answer(self):
- """Controls last.fm answer.
+ sess = Session()
+ resp = sess.send(prepreq, timeout=SOCKET_TIMEOUT)
+ self.__class__.ratelimit = resp.headers.get('x-ratelimit-remaining', None)
+ if resp.status_code is not 200:
+ raise WSHTTPError('{0.status_code}: {0.reason}'.format(resp))
+ ans = resp.json()
+ self._controls_answer(ans)
+ if self.cache:
+ self.controller.cache_response(resp.request, resp)
+ return ans
+
+ 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 EchoNotFound('Artist not found: "{0}"'.format(self.artist))
- raise EchoError(status.get('message'))
+ raise WSNotFound('Artist not found')
+ raise WSError(status.get('message'))
- def _forge_payload(self, artist):
- """
+ def _forge_payload(self, artist, top=False):
+ """Build payload
"""
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))
else:
- payload.update(name=artist.name)
+ payload.update(name=artist.name)
payload.update(bucket='id:musicbrainz')
- payload.update(results=30)
+ payload.update(results=100)
+ if top:
+ if artist.mbid:
+ aid = payload.pop('id')
+ payload.update(artist_id=aid)
+ else:
+ name = payload.pop('name')
+ payload.update(artist=name)
+ payload.update(results=100)
+ payload.update(sort='song_hotttnesss-desc')
return payload
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'):
+ ans = self._fetch(payload)
+ for art in ans.get('response').get('artists'):
artist = {}
mbid = None
if 'foreign_ids' in art:
).lstrip('musicbrainz:artist:')
yield Artist(mbid=mbid, name=art.get('name'))
+ def get_toptrack(self, artist=None):
+ """Fetch artist top tracks
+ """
+ payload = self._forge_payload(artist, top=True)
+ # Construct URL
+ self._ressource = '{0}/song/search'.format(SimaEch.root_url)
+ ans = self._fetch(payload)
+ titles = list()
+ artist = {
+ 'artist': artist.name,
+ 'musicbrainz_artistid': artist.mbid,
+ }
+ for song in ans.get('response').get('songs'):
+ title = song.get('title')
+ if title not in titles:
+ titles.append(title)
+ yield Track(title=title, **artist)
+
# VIM MODLINE
# vim: ai ts=4 sw=4 sts=4 expandtab
home / dev / repositories / mpd-sima.git / blobdiff