Update playlist_api after merge conflict resolution

Re-implemented the changes from previous commits after a clean-slate sort of conflict resolution, as a partial merge would have been too messy.

Author: MonkeyDo

listenbrainz/webserver/views/playlist_api.py

@@ -12,11 +12,12 @@
 import listenbrainz.db.user as db_user
 from listenbrainz.domain.spotify import SpotifyService, SPOTIFY_PLAYLIST_PERMISSIONS
 from listenbrainz.domain.apple import AppleService
-from listenbrainz.troi.export import export_to_spotify, export_to_apple_music
-from listenbrainz.troi.import_ms import import_from_spotify, import_from_apple_music
+from listenbrainz.domain.soundcloud import SoundCloudService
+from listenbrainz.troi.export import export_to_spotify, export_to_apple_music, export_to_soundcloud
+from listenbrainz.troi.import_ms import import_from_spotify, import_from_apple_music, import_from_soundcloud
 from listenbrainz.webserver import db_conn, ts_conn
 from listenbrainz.metadata_cache.apple.client import Apple
-
+from listenbrainz.metadata_cache.soundcloud.client import SoundCloud
 from listenbrainz.webserver.utils import parse_boolean_arg
 from listenbrainz.webserver.decorators import crossdomain, api_listenstore_needed
 from listenbrainz.webserver.errors import APIBadRequest, APIInternalServerError, APINotFound, APIForbidden, APIError, PlaylistAPIXMLError, APIUnauthorized
@@ -869,15 +870,18 @@ def export_playlist(playlist_mbid, service):
     if not is_valid_uuid(playlist_mbid):
         log_raise_400("Provided playlist ID is invalid.")
 
-    if service != "spotify" and service != "apple_music":
-        raise APIBadRequest(f"Service {service} is not supported. We currently only support 'spotify' and 'apple_music'.")
+    if service != "spotify" and service != "apple_music" and service != "soundcloud":
+        raise APIBadRequest(f"Service {service} is not supported. We currently only support 'spotify', 'apple_music' and 'soundcloud'.")
 
     if service == "spotify":
         spotify_service = SpotifyService()
         token = spotify_service.get_user(user["id"], refresh=True)
     elif service == "apple_music":
         apple_service = AppleService()
         token = apple_service.get_user(user["id"])
+    elif service == "soundcloud":
+        soundcloud_service = SoundCloudService()
+        token = soundcloud_service.get_user(user["id"])
 
     if not token:
         raise APIBadRequest(f"Service {service} is not linked. Please link your {service} account first.")
@@ -893,6 +897,8 @@ def export_playlist(playlist_mbid, service):
             url = export_to_spotify(user["auth_token"], token["access_token"], is_public, playlist_mbid=playlist_mbid)
         elif service == "apple_music":
             url = export_to_apple_music(user["auth_token"], token["access_token"], token["refresh_token"], is_public, playlist_mbid=playlist_mbid)
+        elif service == "soundcloud":
+            url = export_to_soundcloud(user["auth_token"], token["access_token"], is_public, playlist_mbid=playlist_mbid)
         return jsonify({"external_url": url})
     except requests.exceptions.HTTPError as exc:
         error = exc.response.json()
@@ -917,22 +923,32 @@ def import_playlist_from_music_service(service):
     :resheader Content-Type: *application/json*
     """
     user = validate_auth_header()
+    supported_services = {
+        "spotify": SpotifyService,
+        "apple_music": AppleService,
+        "soundcloud": SoundCloudService
+    }
+
+    if service not in supported_services:
+        raise APIBadRequest(f"Service {service} is not supported. "
+                            f"Supported services are: 'spotify', 'apple_music', 'soundcloud'.")
 
-    if service != "apple_music" and service != "spotify":
-        raise APIBadRequest(f"Service {service} is not supported. We currently only support 'spotify'.")
+    service_class = supported_services[service]()
 
     if service == "spotify":
-        spotify_service = SpotifyService()
-        token = spotify_service.get_user(user["id"], refresh=True)
+        token = service_class.get_user(user["id"], refresh=True)
     elif service == "apple_music":
-        apple_service = AppleService()
         # TODO: implement refresh token for AppleMusic
+        apple_service = AppleService()
         token = apple_service.get_user(user["id"])
+    elif service == "soundcloud":
+        soundcloud_service = SoundCloudService()
+        token = soundcloud_service.get_user(user["id"])
 
     if not token:
         raise APIBadRequest(f"Service {service} is not linked. Please link your {service} account first.")
 
-    if service == "apple_music" and not token["refresh_token"]:
+    if service == "apple_music" and not token.get("refresh_token"):
         raise APIBadRequest("Not authorized to Apple Music. Please link your account first.")
 
     if service == "spotify" and not SPOTIFY_PLAYLIST_PERMISSIONS.issubset(set(token["scopes"])):
@@ -942,12 +958,17 @@ def import_playlist_from_music_service(service):
 
     try:
         if service == "spotify":
-            sp = spotipy.Spotify(token["access_token"])
-            playlists = sp.current_user_playlists()
+            spotify = spotipy.Spotify(auth=token["access_token"])
+            playlists = spotify.current_user_playlists()
             return jsonify(playlists["items"])
-        else:
-            apple = Apple().get_user_data("https://api.music.apple.com/v1/me/library/playlists/", token["refresh_token"])
-            return jsonify(apple["data"])
+        elif service == "apple_music":
+            apple = Apple()
+            playlists = apple.get_user_data("https://api.music.apple.com/v1/me/library/playlists/", token["refresh_token"])
+            return jsonify(playlists.get("data", []))
+        elif service == "soundcloud":
+            soundcloud = SoundCloud(token["access_token"])
+            playlists = soundcloud.get("https://api.soundcloud.com/me/playlists/")
+            return jsonify(playlists)
     except requests.exceptions.HTTPError as exc:
         error = exc.response.json()
         raise APIError(error.get("error") or exc.response.reason, exc.response.status_code)
@@ -960,7 +981,7 @@ def import_playlist_from_music_service(service):
 def import_tracks_from_spotify_playlist(playlist_id):
     """
 
-    Import a playlist tracks from a Spotify and convert them to JSPF.
+    Import a playlist's tracks from Spotify and convert them to JSPF.
 
     :reqheader Authorization: Token <user token>
     :param playlist_id: The Spotify playlist id to get the tracks from
@@ -996,7 +1017,7 @@ def import_tracks_from_spotify_playlist(playlist_id):
 def import_tracks_from_apple_playlist(playlist_id):
     """
 
-    Import a playlist tracks from a Apple Music and convert them to JSPF.
+    Import a playlist's tracks from Apple Music and convert them to JSPF.
 
     :reqheader Authorization: Token <user token>
     :param playlist_id: The Apple Music playlist id to get the tracks from
@@ -1025,6 +1046,36 @@ def import_tracks_from_apple_playlist(playlist_id):
         raise APIError(error.get("error") or exc.response.reason, exc.response.status_code)
 
 
+@playlist_api_bp.route("/soundcloud/<playlist_id>/tracks")
+@crossdomain
+@ratelimit()
+@api_listenstore_needed
+def import_tracks_from_soundcloud_playlist(playlist_id):
+    """
+    Import a playlist's tracks from SoundCloud and convert them to JSPF.
+    :reqheader Authorization: Token <user token>
+    :param playlist_id: The SoundCloud playlist id to get the tracks from
+    :statuscode 200: tracks are fetched and converted.
+    :statuscode 401: invalid authorization. See error message for details.
+    :statuscode 404: Playlist not found
+    :resheader Content-Type: *application/json*
+    """
+    user = validate_auth_header()
+
+    soundcloud_service = SoundCloudService()
+    token = soundcloud_service.get_user(user["id"])
+
+    if not token:
+        raise APIBadRequest(f"Service SoundCloud is not linked. Please link your SoundCloud account first.")
+
+    try:
+        playlist = import_from_soundcloud(token["access_token"], user["auth_token"], playlist_id)
+        return playlist
+    except requests.exceptions.HTTPError as exc:
+        error = exc.response.json()
+        raise APIError(error.get("error") or exc.response.reason, exc.response.status_code)
+
+
 @playlist_api_bp.post("/export-jspf/<service>")
 @crossdomain
 @ratelimit()
@@ -1042,15 +1093,18 @@ def export_playlist_jspf(service):
     """
     user = validate_auth_header()
 
-    if service != "spotify" and service != "apple_music":
-        raise APIBadRequest(f"Service {service} is not supported. We currently only support 'spotify' and 'apple_msuic'.")
+    if service != "spotify" and service != "apple_music" and service != "soundcloud":
+        raise APIBadRequest(f"Service {service} is not supported. We currently only support 'spotify', 'apple_music' and 'soundcloud'.")
 
     if service == "spotify":
         spotify_service = SpotifyService()
         token = spotify_service.get_user(user["id"], refresh=True)
     elif service == "apple_music":
         apple_service = AppleService()
         token = apple_service.get_user(user["id"])
+    elif service == "soundcloud":
+        soundcloud_service = SoundCloudService()
+        token = soundcloud_service.get_user(user["id"])
 
     if not token:
         raise APIBadRequest(f"Service {service} is not linked. Please link your {service} account first.")
@@ -1067,6 +1121,8 @@ def export_playlist_jspf(service):
             url = export_to_spotify(user["auth_token"], token["access_token"], is_public, jspf=jspf)
         elif service == "apple_music":
             url = export_to_apple_music(user["auth_token"], token["access_token"], token["refresh_token"], is_public, jspf=jspf)
+        elif service == "soundcloud":
+            url = export_to_soundcloud(user["auth_token"], token["access_token"], is_public, jspf=jspf)
         return jsonify({"external_url": url})
     except requests.exceptions.HTTPError as exc:
         error = exc.response.json()