]> kaliko git repositories - mpd-sima.git/blob - sima/lib/simaecho.py
Fixed false warning about wrong MBID format (Closes #6)
[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(id='musicbrainz:artist:{0}'.format(artist.mbid))
80         else:
81             payload.update(name=artist.name)
82         payload.update(bucket='id:musicbrainz')
83         payload.update(results=100)
84         if top:
85             if artist.mbid:
86                 aid = payload.pop('id')
87                 payload.update(artist_id=aid)
88             else:
89                 name = payload.pop('name')
90                 payload.update(artist=name)
91             payload.update(results=100)
92             payload.update(sort='song_hotttnesss-desc')
93         # > hashing the URL into a cache key
94         # return a sorted list of 2-tuple to have consistent cache
95         return sorted(payload.items(), key=lambda param: param[0])
96
97     def get_similar(self, artist=None):
98         """Fetch similar artists
99         """
100         payload = self._forge_payload(artist)
101         # Construct URL
102         ressource = '{0}/artist/similar'.format(SimaEch.root_url)
103         ans = self.http(ressource, payload)
104         self._controls_answer(ans.json())  # pylint: disable=no-member
105         for art in ans.json().get('response').get('artists'):  # pylint: disable=no-member
106             mbid = get_mbid(art)
107             yield Artist(mbid=mbid, name=art.get('name'))
108
109     def get_toptrack(self, artist=None):
110         """Fetch artist top tracks
111         """
112         payload = self._forge_payload(artist, top=True)
113         # Construct URL
114         ressource = '{0}/song/search'.format(SimaEch.root_url)
115         ans = self.http(ressource, payload)
116         self._controls_answer(ans.json())  # pylint: disable=no-member
117         titles = list()
118         art = {'artist': artist.name,
119                'musicbrainz_artistid': artist.mbid,}
120         for song in ans.json().get('response').get('songs'):  # pylint: disable=no-member
121             title = song.get('title')
122             if not art.get('musicbrainz_artistid'):
123                 art['musicbrainz_artistid'] = get_mbid(song, 'artist_foreign_ids')
124             if title not in titles:
125                 titles.append(title)
126                 yield Track(title=title, **art)
127
128
129 # VIM MODLINE
130 # vim: ai ts=4 sw=4 sts=4 expandtab