Improved ETag support, add some stats

[mpd-sima.git] / sima / lib / simaecho.py

diff --git a/sima/lib/simaecho.py b/sima/lib/simaecho.py
index 36c985e6d14b5b652b99d69ab10009fe2a850b8e..2706513b47c5f8d0ad2114ed316769fa493b2774 100644 (file)
--- a/sima/lib/simaecho.py
+++ b/sima/lib/simaecho.py
@@ -25,7 +25,7 @@ __version__ = '0.0.2'
 __author__ = 'Jack Kaliko'
 
 
-from datetime import datetime, timedelta
+from datetime import timedelta
 
 from requests import Session, Request, Timeout, ConnectionError
 
@@ -50,6 +50,10 @@ class SimaEch:
     ratelimit = None
     name = 'EchoNest'
     cache = False
+    stats = {'etag':0,
+            'ccontrol':0,
+            'minrl':120,
+            'total':0}
 
     def __init__(self):
         self.controller = CacheController(self.cache)
@@ -61,9 +65,11 @@ class SimaEch:
         """
         req = Request('GET', ressource, params=payload,
                       ).prepare()
+        SimaEch.stats.update(total=SimaEch.stats.get('total')+1)
         if self.cache:
             cached_response = self.controller.cached_request(req.url, req.headers)
             if cached_response:
+                SimaEch.stats.update(ccontrol=SimaEch.stats.get('ccontrol')+1)
                 return cached_response.json()
         try:
             return self._fetch_ws(req)
@@ -78,11 +84,16 @@ class SimaEch:
         """fetch from web service"""
         sess = Session()
         resp = sess.send(prepreq, timeout=SOCKET_TIMEOUT)
-        self.__class__.ratelimit = resp.headers.get('x-ratelimit-remaining', None)
-        if resp.status_code is not 200:
+        if resp.status_code == 304:
+            SimaEch.stats.update(etag=SimaEch.stats.get('etag')+1)
+            resp = self.controller.update_cached_response(prepreq, resp)
+        elif resp.status_code != 200:
             raise WSHTTPError('{0.status_code}: {0.reason}'.format(resp))
         ans = resp.json()
         self._controls_answer(ans)
+        SimaEch.ratelimit = resp.headers.get('x-ratelimit-remaining', None)
+        minrl = min(int(SimaEch.ratelimit), SimaEch.stats.get('minrl'))
+        SimaEch.stats.update(minrl=minrl)
         if self.cache:
             self.controller.cache_response(resp.request, resp)
         return ans
@@ -120,7 +131,9 @@ class SimaEch:
                 payload.update(artist=name)
             payload.update(results=100)
             payload.update(sort='song_hotttnesss-desc')
-        return payload
+        # > hashing the URL into a cache key
+        # return a sorted list of 2-tuple to have consistent cache
+        return sorted(payload.items(), key=lambda param: param[0])
 
     def get_similar(self, artist=None):
         """Fetch similar artists
@@ -130,7 +143,6 @@ class SimaEch:
         ressource = '{0}/artist/similar'.format(SimaEch.root_url)
         ans = self._fetch(ressource, payload)
         for art in ans.get('response').get('artists'):
-            artist = {}
             mbid = None
             if 'foreign_ids' in art:
                 for frgnid in art.get('foreign_ids'):
@@ -147,7 +159,7 @@ class SimaEch:
         ressource = '{0}/song/search'.format(SimaEch.root_url)
         ans = self._fetch(ressource, payload)
         titles = list()
-        artist = {
+        art = {
                 'artist': artist.name,
                 'musicbrainz_artistid': artist.mbid,
                 }
@@ -155,7 +167,7 @@ class SimaEch:
             title = song.get('title')
             if title not in titles:
                 titles.append(title)
-                yield Track(title=title, **artist)
+                yield Track(title=title, **art)
 
 
 # VIM MODLINE