1 # -*- coding: utf-8 -*-
3 # Copyright (c) 2014 Jack Kaliko <kaliko@azylum.org>
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 Consume EchoNest web service
25 __author__ = 'Jack Kaliko'
30 from datetime import datetime, timedelta
31 from time import sleep
33 from requests import get, Request, Timeout, ConnectionError
36 from sima.lib.meta import Artist
37 from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError
38 from sima.utils.utils import getws, Throttle, Cache, purge_cache
39 if len(ECH.get('apikey')) == 23: # simple hack allowing imp.reload
43 WAIT_BETWEEN_REQUESTS = timedelta(0, 1)
50 root_url = 'http://{host}/api/{version}'.format(**ECH)
52 timestamp = datetime.utcnow()
56 def __init__(self, cache=True):
58 self._ressource = None
59 self.current_element = None
61 purge_cache(self.__class__)
63 def _fetch(self, payload):
64 """Use cached elements or proceed http request"""
65 url = Request('GET', self._ressource, params=payload,).prepare().url
66 if url in SimaEch.cache:
67 self.current_element = SimaEch.cache.get(url).elem
70 self._fetch_ech(payload)
72 raise WSTimeout('Failed to reach server within {0}s'.format(
74 except ConnectionError as err:
77 @Throttle(WAIT_BETWEEN_REQUESTS)
78 def _fetch_ech(self, payload):
79 """fetch from web service"""
80 req = get(self._ressource, params=payload,
81 timeout=SOCKET_TIMEOUT)
82 self.__class__.ratelimit = req.headers.get('x-ratelimit-remaining', None)
83 if req.status_code is not 200:
84 raise WSHTTPError(req.status_code)
85 self.current_element = req.json()
86 self._controls_answer()
88 SimaEch.cache.update({req.url:
89 Cache(self.current_element)})
91 def _controls_answer(self):
94 status = self.current_element.get('response').get('status')
95 code = status.get('code')
99 raise WSNotFound('Artist not found: "{0}"'.format(self.artist))
100 raise WSError(status.get('message'))
102 def _forge_payload(self, artist):
105 payload = {'api_key': ECH.get('apikey')}
106 if not isinstance(artist, Artist):
107 raise TypeError('"{0!r}" not an Artist object'.format(artist))
111 id='musicbrainz:artist:{0}'.format(artist.mbid))
113 payload.update(name=artist.name)
114 payload.update(bucket='id:musicbrainz')
115 payload.update(results=100)
118 def get_similar(self, artist=None):
121 payload = self._forge_payload(artist)
123 self._ressource = '{0}/artist/similar'.format(SimaEch.root_url)
125 for art in self.current_element.get('response').get('artists'):
128 if 'foreign_ids' in art:
129 for frgnid in art.get('foreign_ids'):
130 if frgnid.get('catalog') == 'musicbrainz':
131 mbid = frgnid.get('foreign_id'
132 ).lstrip('musicbrainz:artist:')
133 yield Artist(mbid=mbid, name=art.get('name'))
137 # vim: ai ts=4 sw=4 sts=4 expandtab