Release v2.1.0

Author: jodal

.coveragerc

@@ -1,6 +1,7 @@
 *.egg-info
 *.pyc
 *.swp
+.cache/
 .coverage
 .tox/
 MANIFEST

.gitignore

@@ -1,20 +1,25 @@
+sudo: false
+
 language: python
 
 python:
   - "2.7_with_system_site_packages"
 
+addons:
+  apt:
+    sources:
+      - mopidy-stable
+    packages:
+      - libffi-dev
+      - libspotify-dev
+      - mopidy
+      - python-all-dev
+
 env:
   - TOX_ENV=py27
   - TOX_ENV=flake8
 
 install:
-  - "wget -O - http://apt.mopidy.com/mopidy.gpg | sudo apt-key add -"
-  - "sudo wget -O /etc/apt/sources.list.d/mopidy.list http://apt.mopidy.com/mopidy.list"
-  - "sudo apt-get update || true"
-  - "sudo apt-get install mopidy-spotify"
-  # Note: The next line can be removed when pyspotify2 has been packaged as a
-  # Debian package.
-  - "sudo apt-get install python-all-dev libffi-dev libspotify-dev"
   - "pip install tox"
 
 script:

.travis.yml

@@ -1,5 +1,4 @@
 include *.txt
-include .coveragerc
 include .travis.yml
 include LICENSE
 include MANIFEST.in

MANIFEST.in

@@ -15,7 +15,7 @@ Mopidy-Spotify
     :alt: Travis CI build status
 
 .. image:: https://img.shields.io/coveralls/mopidy/mopidy-spotify/develop.svg?style=flat
-   :target: https://coveralls.io/r/mopidy/mopidy-spotify?branch=develop
+   :target: https://coveralls.io/r/mopidy/mopidy-spotify
    :alt: Test coverage
 
 `Mopidy <http://www.mopidy.com/>`_ extension for playing music from
@@ -139,6 +139,19 @@ Project resources
 Changelog
 =========
 
+v2.1.0 (2015-09-22)
+-------------------
+
+Feature release.
+
+- Require Requests >= 2.0.
+
+- Support using a proxy when connecting to Spotify. This was forgotten in the
+  2.0 reimplementation. (Fixes: #68)
+
+- Support using a proxy when accessing Spotify's web API to get cover and
+  artist imagery.
+
 v2.0.1 (2015-08-23)
 -------------------
 

README.rst

@@ -2,3 +2,4 @@ pytest
 pytest-cov
 pytest-capturelog
 mock
+responses

dev-requirements.txt

@@ -5,7 +5,7 @@
 from mopidy import config, ext
 
 
-__version__ = '2.0.1'
+__version__ = '2.1.0'
 
 
 class Extension(ext.Extension):

mopidy_spotify/__init__.py

@@ -4,7 +4,7 @@
 import os
 import threading
 
-from mopidy import backend
+from mopidy import backend, httpclient
 
 import pykka
 
@@ -89,13 +89,25 @@ def _get_session(self, config):
     def _get_spotify_config(self, config):
         ext = Extension()
         spotify_config = spotify.Config()
+
         spotify_config.load_application_key_file(
             os.path.join(os.path.dirname(__file__), 'spotify_appkey.key'))
+
         if config['spotify']['allow_cache']:
             spotify_config.cache_location = ext.get_cache_dir(config)
         else:
             spotify_config.cache_location = None
+
         spotify_config.settings_location = ext.get_data_dir(config)
+
+        proxy_uri = httpclient.format_proxy(config['proxy'], auth=False)
+        if proxy_uri is not None:
+            logger.debug('Connecting to Spotify through proxy: %s', proxy_uri)
+
+        spotify_config.proxy = proxy_uri
+        spotify_config.proxy_username = config['proxy'].get('username')
+        spotify_config.proxy_password = config['proxy'].get('password')
+
         return spotify_config
 
     def on_logged_in(self):

mopidy_spotify/backend.py

@@ -1,15 +1,13 @@
 from __future__ import unicode_literals
 
 import itertools
-import json
 import logging
 import operator
-import urllib2
 import urlparse
 
 from mopidy import models
 
-from mopidy_spotify import utils
+import requests
 
 
 # NOTE: This module is independent of libspotify and built using the Spotify
@@ -25,7 +23,7 @@
 logger = logging.getLogger(__name__)
 
 
-def get_images(uris):
+def get_images(requests_session, uris):
     result = {}
     uri_type_getter = operator.itemgetter('type')
     uris = sorted((_parse_uri(u) for u in uris), key=uri_type_getter)
@@ -37,9 +35,10 @@ def get_images(uris):
             else:
                 batch.append(uri)
                 if len(batch) >= _API_MAX_IDS_PER_REQUEST:
-                    result.update(_process_uris(uri_type, batch))
+                    result.update(
+                        _process_uris(requests_session, uri_type, batch))
                     batch = []
-        result.update(_process_uris(uri_type, batch))
+        result.update(_process_uris(requests_session, uri_type, batch))
     return result
 
 
@@ -60,20 +59,26 @@ def _parse_uri(uri):
     raise ValueError('Could not parse %r as a Spotify URI' % uri)
 
 
-def _process_uris(uri_type, uris):
+def _process_uris(requests_session, uri_type, uris):
     result = {}
+    ids = [u['id'] for u in uris]
     ids_to_uris = {u['id']: u for u in uris}
 
     if not uris:
         return result
 
+    lookup_uri = _API_BASE_URI % (uri_type, ','.join(ids))
+
+    try:
+        response = requests_session.get(lookup_uri)
+    except requests.RequestException as exc:
+        logger.debug('Fetching %s failed: %s', lookup_uri, exc)
+        return result
+
     try:
-        lookup_uri = _API_BASE_URI % (
-            uri_type, ','.join(sorted(ids_to_uris.keys())))
-        data = json.load(urllib2.urlopen(lookup_uri))
-    except (ValueError, IOError) as e:
-        error_msg = utils.locale_decode(e)
-        logger.debug('Fetching %s failed: %s', lookup_uri, error_msg)
+        data = response.json()
+    except ValueError as exc:
+        logger.debug('JSON decoding failed for %s: %s', lookup_uri, exc)
         return result
 
     for item in data.get(uri_type + 's', []):

mopidy_spotify/images.py

@@ -4,7 +4,8 @@
 
 from mopidy import backend
 
-from mopidy_spotify import browse, distinct, images, lookup, search
+import mopidy_spotify
+from mopidy_spotify import browse, distinct, images, lookup, search, utils
 
 
 logger = logging.getLogger(__name__)
@@ -15,7 +16,12 @@ class SpotifyLibraryProvider(backend.LibraryProvider):
 
     def __init__(self, backend):
         self._backend = backend
-        self._config = self._backend._config['spotify']
+        self._config = backend._config['spotify']
+        self._requests_session = utils.get_requests_session(
+            proxy_config=backend._config['proxy'],
+            user_agent='%s/%s' % (
+                mopidy_spotify.Extension.dist_name,
+                mopidy_spotify.__version__))
 
     def browse(self, uri):
         return browse.browse(self._config, self._backend._session, uri)
@@ -25,7 +31,7 @@ def get_distinct(self, field, query=None):
             self._config, self._backend._session, field, query)
 
     def get_images(self, uris):
-        return images.get_images(uris)
+        return images.get_images(self._requests_session, uris)
 
     def lookup(self, uri):
         return lookup.lookup(self._config, self._backend._session, uri)

mopidy_spotify/library.py

@@ -1,20 +1,27 @@
 from __future__ import unicode_literals
 
 import contextlib
-import locale
 import logging
 import time
 
+from mopidy import httpclient
+
+import requests
+
 
 logger = logging.getLogger(__name__)
 TRACE = logging.getLevelName('TRACE')
 
 
-def locale_decode(bytestr):
-    try:
-        return unicode(bytestr)
-    except UnicodeError:
-        return bytes(bytestr).decode(locale.getpreferredencoding())
+def get_requests_session(proxy_config, user_agent):
+    proxy = httpclient.format_proxy(proxy_config)
+    full_user_agent = httpclient.format_user_agent(user_agent)
+
+    session = requests.Session()
+    session.proxies.update({'http': proxy, 'https': proxy})
+    session.headers.update({'user-agent': full_user_agent})
+
+    return session
 
 
 @contextlib.contextmanager

mopidy_spotify/utils.py

@@ -24,10 +24,11 @@ def get_version(filename):
     zip_safe=False,
     include_package_data=True,
     install_requires=[
-        'setuptools',
         'Mopidy >= 1.1',
         'Pykka >= 1.1',
-        'pyspotify >= 2.0.2',
+        'pyspotify >= 2.0.5',
+        'requests >= 2.0',
+        'setuptools',
     ],
     entry_points={
         'mopidy.ext': [

setup.py

@@ -18,6 +18,8 @@ def config(tmpdir):
             'cache_dir': '%s' % tmpdir.join('cache'),
             'data_dir': '%s' % tmpdir.join('data'),
         },
+        'proxy': {
+        },
         'spotify': {
             'username': 'alice',
             'password': 'password',

tests/conftest.py

@@ -101,6 +101,23 @@ def test_on_start_configures_volume_normalization(spotify_mock, config):
     volume_normalization_mock.assert_called_once_with(False)
 
 
+def test_on_start_configures_proxy(spotify_mock, config):
+    config['proxy'] = {
+        'scheme': 'https',
+        'hostname': 'my-proxy.example.com',
+        'port': 8080,
+        'username': 'alice',
+        'password': 's3cret',
+    }
+    spotify_config = spotify_mock.Config.return_value
+
+    get_backend(config).on_start()
+
+    assert spotify_config.proxy == 'https://my-proxy.example.com:8080'
+    assert spotify_config.proxy_username == 'alice'
+    assert spotify_config.proxy_password == 's3cret'
+
+
 def test_on_start_adds_connection_state_changed_handler_to_session(
         spotify_mock, config):
     session = spotify_mock.Session.return_value