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     ratelimit = None
  52     name = 'EchoNest'
  53     cache = False
  54     stats = {'etag':0,
  55              'ccontrol':0,
  56              'minrl':120,
  57              'total':0}
  58
  59     def __init__(self):
  60         self.http = HttpClient(cache=self.cache, stats=self.stats)
  61
  62     def _controls_answer(self, ans):
  63         """Controls answer.
  64         """
  65         status = ans.get('response').get('status')
  66         code = status.get('code')
  67         if code is 0:
  68             return True
  69         if code is 5:
  70             raise WSNotFound('Artist not found')
  71         raise WSError(status.get('message'))
  72
  73     def _forge_payload(self, artist, top=False):
  74         """Build payload
  75         """
  76         payload = {'api_key': ECH.get('apikey')}
  77         if not isinstance(artist, Artist):
  78             raise TypeError('"{0!r}" not an Artist object'.format(artist))
  79         if artist.mbid:
  80             payload.update(
  81                     id='musicbrainz:artist:{0}'.format(artist.mbid))
  82         else:
  83             payload.update(name=artist.name)
  84         payload.update(bucket='id:musicbrainz')
  85         payload.update(results=100)
  86         if top:
  87             if artist.mbid:
  88                 aid = payload.pop('id')
  89                 payload.update(artist_id=aid)
  90             else:
  91                 name = payload.pop('name')
  92                 payload.update(artist=name)
  93             payload.update(results=100)
  94             payload.update(sort='song_hotttnesss-desc')
  95         # > hashing the URL into a cache key
  96         # return a sorted list of 2-tuple to have consistent cache
  97         return sorted(payload.items(), key=lambda param: param[0])
  98
  99     def get_similar(self, artist=None):
 100         """Fetch similar artists
 101         """
 102         payload = self._forge_payload(artist)
 103         # Construct URL
 104         ressource = '{0}/artist/similar'.format(SimaEch.root_url)
 105         ans = self.http(ressource, payload)
 106         self._controls_answer(ans.json())
 107         for art in ans.json().get('response').get('artists'):
 108             mbid = get_mbid(art)
 109             yield Artist(mbid=mbid, name=art.get('name'))
 110
 111     def get_toptrack(self, artist=None):
 112         """Fetch artist top tracks
 113         """
 114         payload = self._forge_payload(artist, top=True)
 115         # Construct URL
 116         ressource = '{0}/song/search'.format(SimaEch.root_url)
 117         ans = self.http(ressource, payload)
 118         self._controls_answer(ans.json())
 119         titles = list()
 120         art = {
 121                 'artist': artist.name,
 122                 'musicbrainz_artistid': artist.mbid,
 123                 }
 124         for song in ans.json().get('response').get('songs'):
 125             title = song.get('title')
 126             if not art.get('musicbrainz_artistid'):
 127                 art['musicbrainz_artistid'] = get_mbid(song, 'artist_foreign_ids')
 128             if title not in titles:
 129                 titles.append(title)
 130                 yield Track(title=title, **art)
 131
 132
 133 # VIM MODLINE
 134 # vim: ai ts=4 sw=4 sts=4 expandtab