]> kaliko git repositories - mpd-sima.git/blob - sima/lib/simaecho.py
Fixed http caching for Lastfm.
[mpd-sima.git] / sima / lib / simaecho.py
1 # -*- coding: utf-8 -*-
2
3 # Copyright (c) 2014 Jack Kaliko <kaliko@azylum.org>
4 #
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.
9 #
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.
14 #
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/>.
17 #
18 #
19
20 """
21 Consume EchoNest web service
22 """
23
24 __version__ = '0.0.5'
25 __author__ = 'Jack Kaliko'
26
27
28
29 from sima import ECH
30 from sima.lib.meta import Artist
31 from sima.lib.track import Track
32 from sima.lib.http import HttpClient
33 from sima.utils.utils import WSError, WSNotFound
34 from sima.utils.utils import getws
35 if len(ECH.get('apikey')) == 23:  # simple hack allowing imp.reload
36     getws(ECH)
37
38
39 def get_mbid(obj, foreign='foreign_ids'):
40     if foreign in obj:
41         for frgnid in obj.get(foreign):
42             if frgnid.get('catalog') == 'musicbrainz':
43                 return frgnid.get('foreign_id').split(':')[2]
44     return None
45
46
47 class SimaEch:
48     """EchoNest http client
49     """
50     root_url = 'http://{host}/api/{version}'.format(**ECH)
51     name = 'EchoNest'
52     cache = False
53     stats = {'etag':0,
54              'ccontrol':0,
55              'minrl':120,
56              'total':0}
57
58     def __init__(self):
59         self.http = HttpClient(cache=self.cache, stats=self.stats)
60
61     def _controls_answer(self, ans):
62         """Controls answer.
63         """
64         status = ans.get('response').get('status')
65         code = status.get('code')
66         if code is 0:
67             return True
68         if code is 5:
69             raise WSNotFound('Artist not found')
70         raise WSError(status.get('message'))
71
72     def _forge_payload(self, artist, top=False):
73         """Build payload
74         """
75         payload = {'api_key': ECH.get('apikey')}
76         if not isinstance(artist, Artist):
77             raise TypeError('"{0!r}" not an Artist object'.format(artist))
78         if artist.mbid:
79             payload.update(
80                     id='musicbrainz:artist:{0}'.format(artist.mbid))
81         else:
82             payload.update(name=artist.name)
83         payload.update(bucket='id:musicbrainz')
84         payload.update(results=100)
85         if top:
86             if artist.mbid:
87                 aid = payload.pop('id')
88                 payload.update(artist_id=aid)
89             else:
90                 name = payload.pop('name')
91                 payload.update(artist=name)
92             payload.update(results=100)
93             payload.update(sort='song_hotttnesss-desc')
94         # > hashing the URL into a cache key
95         # return a sorted list of 2-tuple to have consistent cache
96         return sorted(payload.items(), key=lambda param: param[0])
97
98     def get_similar(self, artist=None):
99         """Fetch similar artists
100         """
101         payload = self._forge_payload(artist)
102         # Construct URL
103         ressource = '{0}/artist/similar'.format(SimaEch.root_url)
104         ans = self.http(ressource, payload)
105         self._controls_answer(ans.json())
106         for art in ans.json().get('response').get('artists'):
107             mbid = get_mbid(art)
108             yield Artist(mbid=mbid, name=art.get('name'))
109
110     def get_toptrack(self, artist=None):
111         """Fetch artist top tracks
112         """
113         payload = self._forge_payload(artist, top=True)
114         # Construct URL
115         ressource = '{0}/song/search'.format(SimaEch.root_url)
116         ans = self.http(ressource, payload)
117         self._controls_answer(ans.json())
118         titles = list()
119         art = {
120                 'artist': artist.name,
121                 'musicbrainz_artistid': artist.mbid,
122                 }
123         for song in ans.json().get('response').get('songs'):
124             title = song.get('title')
125             if not art.get('musicbrainz_artistid'):
126                 art['musicbrainz_artistid'] = get_mbid(song, 'artist_foreign_ids')
127             if title not in titles:
128                 titles.append(title)
129                 yield Track(title=title, **art)
130
131
132 # VIM MODLINE
133 # vim: ai ts=4 sw=4 sts=4 expandtab