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 datetime, 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, 1)
47 """EchoNest http client
49 root_url = 'http://{host}/api/{version}'.format(**ECH)
50 timestamp = datetime.utcnow()
56 self._ressource = None
57 self.current_element = None
58 self.controller = CacheController(self.cache)
60 def _fetch(self, payload):
61 """Use cached elements or proceed http request"""
62 req = Request('GET', self._ressource, params=payload,
65 cached_response = self.controller.cached_request(req.url, req.headers)
67 return cached_response.json()
70 return self._fetch_ws(req)
72 raise WSTimeout('Failed to reach server within {0}s'.format(
74 except ConnectionError as err:
77 @Throttle(WAIT_BETWEEN_REQUESTS)
78 def _fetch_ws(self, prepreq):
79 """fetch from web service"""
81 resp = sess.send(prepreq, timeout=SOCKET_TIMEOUT)
82 self.__class__.ratelimit = resp.headers.get('x-ratelimit-remaining', None)
83 if resp.status_code is not 200:
84 raise WSHTTPError('{0.status_code}: {0.reason}'.format(resp))
86 self._controls_answer(ans)
88 self.controller.cache_response(resp.request, resp)
91 def _controls_answer(self, ans):
94 status = ans.get('response').get('status')
95 code = status.get('code')
99 raise WSNotFound('Artist not found')
100 raise WSError(status.get('message'))
102 def _forge_payload(self, artist, top=False):
105 payload = {'api_key': ECH.get('apikey')}
106 if not isinstance(artist, Artist):
107 raise TypeError('"{0!r}" not an Artist object'.format(artist))
110 id='musicbrainz:artist:{0}'.format(artist.mbid))
112 payload.update(name=artist.name)
113 payload.update(bucket='id:musicbrainz')
114 payload.update(results=100)
117 aid = payload.pop('id')
118 payload.update(artist_id=aid)
120 name = payload.pop('name')
121 payload.update(artist=name)
122 payload.update(results=100)
123 payload.update(sort='song_hotttnesss-desc')
126 def get_similar(self, artist=None):
127 """Fetch similar artists
129 payload = self._forge_payload(artist)
131 self._ressource = '{0}/artist/similar'.format(SimaEch.root_url)
132 ans = self._fetch(payload)
133 for art in ans.get('response').get('artists'):
136 if 'foreign_ids' in art:
137 for frgnid in art.get('foreign_ids'):
138 if frgnid.get('catalog') == 'musicbrainz':
139 mbid = frgnid.get('foreign_id'
140 ).lstrip('musicbrainz:artist:')
141 yield Artist(mbid=mbid, name=art.get('name'))
143 def get_toptrack(self, artist=None):
144 """Fetch artist top tracks
146 payload = self._forge_payload(artist, top=True)
148 self._ressource = '{0}/song/search'.format(SimaEch.root_url)
149 ans = self._fetch(payload)
152 'artist': artist.name,
153 'musicbrainz_artistid': artist.mbid,
155 for song in ans.get('response').get('songs'):
156 title = song.get('title')
157 if title not in titles:
159 yield Track(title=title, **artist)
163 # vim: ai ts=4 sw=4 sts=4 expandtab