Removing saved albums (#352)

Author: joostlek

src/spotifyaio/spotify.py

@@ -8,7 +8,7 @@
 from typing import TYPE_CHECKING, Any, Awaitable, Callable, Self
 
 from aiohttp import ClientSession
-from aiohttp.hdrs import METH_GET, METH_POST, METH_PUT
+from aiohttp.hdrs import METH_DELETE, METH_GET, METH_POST, METH_PUT
 from yarl import URL
 
 from spotifyaio.exceptions import SpotifyConnectionError
@@ -144,6 +144,15 @@ async def _put(
         """Handle a PUT request to Spotify."""
         return await self._request(METH_PUT, uri, data=data, params=params)
 
+    async def _delete(
+        self,
+        uri: str,
+        data: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+    ) -> str:
+        """Handle a DELETE request to Spotify."""
+        return await self._request(METH_DELETE, uri, data=data, params=params)
+
     async def get_album(self, album_id: str) -> Album:
         """Get album."""
         identifier = get_identifier(album_id)
@@ -188,7 +197,17 @@ async def save_albums(self, album_ids: list[str]) -> None:
         }
         await self._put("v1/me/albums", params=params)
 
-    # Remove an album
+    async def remove_saved_albums(self, album_ids: list[str]) -> None:
+        """Remove saved albums."""
+        if not album_ids:
+            return
+        if len(album_ids) > 50:
+            msg = "Maximum of 50 albums can be removed at once"
+            raise ValueError(msg)
+        params: dict[str, Any] = {
+            "ids": ",".join([get_identifier(i) for i in album_ids])
+        }
+        await self._delete("v1/me/albums", params=params)
 
     # Check if one or more albums is already saved
 

tests/test_spotify.py

@@ -6,7 +6,7 @@
 from typing import TYPE_CHECKING, Any
 
 import aiohttp
-from aiohttp.hdrs import METH_GET, METH_POST, METH_PUT
+from aiohttp.hdrs import METH_DELETE, METH_GET, METH_POST, METH_PUT
 from aioresponses import CallbackResult, aioresponses
 import pytest
 from yarl import URL
@@ -214,6 +214,52 @@ async def test_save_too_many_albums(
     responses.assert_not_called()  # type: ignore[no-untyped-call]
 
 
+async def test_removing_saved_albums(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test deleting saved albums."""
+    responses.delete(
+        f"{SPOTIFY_URL}/v1/me/albums?ids=3IqzqH6ShrRtie9Yd2ODyG%252C1A2GTWGtFfWp7KSQTwWOyo%252C2noRn2Aes5aoNVsU6iWTh",
+        status=200,
+    )
+    await authenticated_client.remove_saved_albums(
+        [
+            "spotify:album:3IqzqH6ShrRtie9Yd2ODyG",
+            "1A2GTWGtFfWp7KSQTwWOyo",
+            "2noRn2Aes5aoNVsU6iWTh",
+        ]
+    )
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/albums",
+        METH_DELETE,
+        headers=HEADERS,
+        params={
+            "ids": "3IqzqH6ShrRtie9Yd2ODyG,1A2GTWGtFfWp7KSQTwWOyo,2noRn2Aes5aoNVsU6iWTh"
+        },
+        json=None,
+    )
+
+
+async def test_removing_no_saved_albums(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test removing no saved albums."""
+    await authenticated_client.remove_saved_albums([])
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_removing_too_many_saved_albums(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test removing too many saved albums."""
+    with pytest.raises(ValueError, match="Maximum of 50 albums can be removed at once"):
+        await authenticated_client.remove_saved_albums(["abc"] * 51)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
 @pytest.mark.parametrize(
     "playback_fixture",
     [