Soundcloud backend

.travis.yml

@@ -5,6 +5,7 @@ install:
   - "sudo wget -q -O /etc/apt/sources.list.d/mopidy.list http://apt.mopidy.com/mopidy.list"
   - "sudo apt-get update || true"
   - "sudo apt-get install $(apt-cache depends mopidy | awk '$2 !~ /mopidy/ {print $2}')"
+  - "sudo apt-get install python-requests"
 
 before_script:
   - "rm $VIRTUAL_ENV/lib/python$TRAVIS_PYTHON_VERSION/no-global-site-packages.txt"

docs/modules/backends/soundcloud.rst

@@ -0,0 +1,8 @@
+.. soundcloud-backend:
+
+*************************************************
+:mod:`mopidy.backends.soundcloud` -- SoundCloud backend
+*************************************************
+
+.. automodule:: mopidy.backends.soudcloud
+    :synopsis: Backend for the SoundCloud music streaming service

mopidy/backends/soundcloud/__init__.py

@@ -0,0 +1,25 @@
+"""A backend for playing music from Soundcloud.
+
+This backend handles URIs starting with ``soundcloud:``.
+
+See :ref:`music-from-soundcloud-storage` for further instructions on using this
+backend.
+
+**Issues:**
+
+https://github.com/mopidy/mopidy/issues?labels=Soundcloud+backend
+
+**Dependencies:**
+
+.. literalinclude:: ../../../requirements/soundcloud.txt
+
+**Settings:**
+
+- :attr:`mopidy.settings.SOUNDCLOUD_AUTH_TOKEN`
+- :attr:`mopidy.settings.SOUNDCLOUD_EXPLORE`
+"""
+
+from __future__ import unicode_literals
+
+# flake8: noqa
+from .actor import SoundcloudBackend

mopidy/backends/soundcloud/actor.py

@@ -0,0 +1,33 @@
+from __future__ import unicode_literals
+
+import logging
+import pykka
+
+from mopidy import settings
+from mopidy.backends import base
+
+
+from .library import SoundcloudLibraryProvider
+from .playlists import SoundcloudPlaylistsProvider
+from .soundcloud import SoundCloudClient
+
+logger = logging.getLogger('mopidy.backends.soundcloud')
+
+
+class SoundcloudBackend(pykka.ThreadingActor, base.Backend):
+    def __init__(self, audio):
+        super(SoundcloudBackend, self).__init__()
+
+        if not settings.SOUNDCLOUD_AUTH_TOKEN:
+            logger.error(("In order to use SoundCloud backend "
+                          "you must provide settings.SOUNDCLOUD_AUTH_TOKEN. "
+                          "Get yours at http://www.mopidy.com/authenticate"))
+        else:
+            self.sc_api = SoundCloudClient(
+                settings.SOUNDCLOUD_AUTH_TOKEN)
+
+        self.library = SoundcloudLibraryProvider(backend=self)
+        self.playback = base.BasePlaybackProvider(audio=audio, backend=self)
+        self.playlists = SoundcloudPlaylistsProvider(backend=self)
+
+        self.uri_schemes = ['soundcloud']

mopidy/backends/soundcloud/library.py

@@ -0,0 +1,44 @@
+from __future__ import unicode_literals
+
+import logging
+
+from mopidy.backends import base
+from mopidy.models import SearchResult
+
+logger = logging.getLogger('mopidy.backends.soundcloud')
+
+
+class SoundcloudLibraryProvider(base.BaseLibraryProvider):
+    def __init__(self, *args, **kwargs):
+        super(SoundcloudLibraryProvider, self).__init__(*args, **kwargs)
+
+    def find_exact(self, **query):
+        return self.search(**query)
+
+    def search(self, **query):
+        print(query)
+        if not query:
+            return
+
+        for (field, val) in query.iteritems():
+
+            # TODO: Devise method for searching SoundCloud via artists
+            if field == "album" and query['album'] == "SoundCloud":
+                return SearchResult(
+                    uri='soundcloud:search',
+                    tracks=self.backend.sc_api.search(query['artist']) or [])
+            elif field == "any":
+                return SearchResult(
+                    uri='soundcloud:search',
+                    tracks=self.backend.sc_api.search(val[0]) or [])
+            else:
+                return []
+
+    def lookup(self, uri):
+        try:
+            id = uri.split('//')[1]
+            logger.debug(u'SoundCloud track id for %s: %s' % (uri, id))
+            return [self.backend.sc_api.get_track(id, True)]
+        except Exception as error:
+            logger.debug(u'Failed to lookup %s: %s', uri, error)
+            return []

mopidy/backends/soundcloud/playlists.py

@@ -0,0 +1,74 @@
+from __future__ import unicode_literals
+
+import logging
+
+from mopidy import settings
+from mopidy.backends import base, listener
+from mopidy.models import Playlist
+
+logger = logging.getLogger('mopidy.backends.soundcloud.playlists')
+
+
+class SoundcloudPlaylistsProvider(base.BasePlaylistsProvider):
+
+    def __init__(self, *args, **kwargs):
+        super(SoundcloudPlaylistsProvider, self).__init__(*args, **kwargs)
+        self.refresh()
+
+    def create(self, name):
+        pass  # TODO
+
+    def delete(self, uri):
+        pass  # TODO
+
+    def lookup(self, uri):
+        for playlist in self._playlists:
+            if playlist.uri == uri:
+                return playlist
+
+    def refresh(self):
+        logger.info('Loading playlists from SoundCloud')
+        username = self.backend.sc_api.get_user().get('username')
+        playlists = []
+
+        liked = Playlist(
+            uri='soundcloud:playlist-liked',
+            name="%s's liked on SoundCloud" % username,
+            tracks=self.backend.sc_api.get_favorites()
+        )
+        playlists.append(liked)
+
+        stream = Playlist(
+            uri='soundcloud:playlist-user',
+            name="%s's stream on SoundCloud" % username,
+            tracks=self.backend.sc_api.get_user_stream()
+        )
+        playlists.append(stream)
+
+        for (name, uri, tracks) in self.backend.sc_api.get_sets():
+            scset = Playlist(
+                uri='soundcloud:%s' % uri,
+                name=name,
+                tracks=tracks
+            )
+            playlists.append(scset)
+
+        for cat in settings.SOUNDCLOUD_EXPLORE:
+
+            (category, section) = cat.split('/')
+            logger.info('Fetching Explore playlist %s from SoundCloud' % section)
+            tracks = self.backend.sc_api.get_explore_category(
+                category, section)
+
+            exp = Playlist(
+                uri='soundcloud:cat-%s' % section.lower(),
+                name='Explore %s on SoundCloud' % section,
+                tracks=tracks
+            )
+            playlists.append(exp)
+
+        self._playlists = playlists
+        listener.BackendListener.send('playlists_loaded')
+
+    def save(self, playlist):
+        pass  # TODO