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'
28 from datetime import timedelta
30 from requests import Session, Request, Timeout, ConnectionError
33 from sima.lib.meta import Artist
34 from sima.lib.track import Track
35 from sima.lib.http import CacheController
36 from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError
37 from sima.utils.utils import getws, Throttle
38 if len(ECH.get('apikey')) == 23: # simple hack allowing imp.reload
42 WAIT_BETWEEN_REQUESTS = timedelta(0, 2)
47 """EchoNest http client
49 root_url = 'http://{host}/api/{version}'.format(**ECH)
53 stats = {'304':0, 'cached':0, 'minrl':'120'}
56 self.controller = CacheController(self.cache)
58 def _fetch(self, ressource, payload):
61 Use cached elements or proceed http request
63 req = Request('GET', ressource, params=payload,
66 cached_response = self.controller.cached_request(req.url, req.headers)
68 SimaEch.stat.update(cached=SimaEch.stat.get('cached')+1)
69 return cached_response.json()
71 return self._fetch_ws(req)
73 raise WSTimeout('Failed to reach server within {0}s'.format(
75 except ConnectionError as err:
78 @Throttle(WAIT_BETWEEN_REQUESTS)
79 def _fetch_ws(self, prepreq):
80 """fetch from web service"""
82 resp = sess.send(prepreq, timeout=SOCKET_TIMEOUT)
83 if resp.status_code == 304:
84 SimaEch.stats.update({'304':SimaEch.stats.get('304')+1})
85 resp = self.controller.update_cached_response(prepreq, resp)
86 elif resp.status_code != 200:
87 raise WSHTTPError('{0.status_code}: {0.reason}'.format(resp))
89 self._controls_answer(ans)
90 SimaEch.ratelimit = resp.headers.get('x-ratelimit-remaining', None)
91 minrl = min(SimaEch.ratelimit, SimaEch.stats.get('minrl'))
92 SimaEch.stats.update(minrl=minrl)
94 self.controller.cache_response(resp.request, resp)
97 def _controls_answer(self, ans):
100 status = ans.get('response').get('status')
101 code = status.get('code')
105 raise WSNotFound('Artist not found')
106 raise WSError(status.get('message'))
108 def _forge_payload(self, artist, top=False):
111 payload = {'api_key': ECH.get('apikey')}
112 if not isinstance(artist, Artist):
113 raise TypeError('"{0!r}" not an Artist object'.format(artist))
116 id='musicbrainz:artist:{0}'.format(artist.mbid))
118 payload.update(name=artist.name)
119 payload.update(bucket='id:musicbrainz')
120 payload.update(results=100)
123 aid = payload.pop('id')
124 payload.update(artist_id=aid)
126 name = payload.pop('name')
127 payload.update(artist=name)
128 payload.update(results=100)
129 payload.update(sort='song_hotttnesss-desc')
132 def get_similar(self, artist=None):
133 """Fetch similar artists
135 payload = self._forge_payload(artist)
137 ressource = '{0}/artist/similar'.format(SimaEch.root_url)
138 ans = self._fetch(ressource, payload)
139 for art in ans.get('response').get('artists'):
141 if 'foreign_ids' in art:
142 for frgnid in art.get('foreign_ids'):
143 if frgnid.get('catalog') == 'musicbrainz':
144 mbid = frgnid.get('foreign_id'
145 ).lstrip('musicbrainz:artist:')
146 yield Artist(mbid=mbid, name=art.get('name'))
148 def get_toptrack(self, artist=None):
149 """Fetch artist top tracks
151 payload = self._forge_payload(artist, top=True)
153 ressource = '{0}/song/search'.format(SimaEch.root_url)
154 ans = self._fetch(ressource, payload)
157 'artist': artist.name,
158 'musicbrainz_artistid': artist.mbid,
160 for song in ans.get('response').get('songs'):
161 title = song.get('title')
162 if title not in titles:
164 yield Track(title=title, **art)
168 # vim: ai ts=4 sw=4 sts=4 expandtab