Check saved album (#353)

Author: joostlek

src/spotifyaio/spotify.py

@@ -9,6 +9,7 @@
 
 from aiohttp import ClientSession
 from aiohttp.hdrs import METH_DELETE, METH_GET, METH_POST, METH_PUT
+import orjson
 from yarl import URL
 
 from spotifyaio.exceptions import SpotifyConnectionError
@@ -209,7 +210,18 @@ async def remove_saved_albums(self, album_ids: list[str]) -> None:
         }
         await self._delete("v1/me/albums", params=params)
 
-    # Check if one or more albums is already saved
+    async def are_albums_saved(self, album_ids: list[str]) -> dict[str, bool]:
+        """Check if albums are saved."""
+        if not album_ids:
+            return {}
+        if len(album_ids) > 20:
+            msg = "Maximum of 20 albums can be checked at once"
+            raise ValueError(msg)
+        identifiers = [get_identifier(i) for i in album_ids]
+        params: dict[str, Any] = {"ids": ",".join(identifiers)}
+        response = await self._get("v1/me/albums/contains", params=params)
+        body: list[bool] = orjson.loads(response)  # pylint: disable=no-member
+        return dict(zip(identifiers, body))
 
     async def get_new_releases(self) -> list[SimplifiedAlbum]:
         """Get new releases."""

tests/__snapshots__/test_spotify.ambr

@@ -1,4 +1,11 @@
 # serializer version: 1
+# name: test_checking_saved_albums
+  dict({
+    '1A2GTWGtFfWp7KSQTwWOyo': False,
+    '2noRn2Aes5aoNVsU6iWTh': True,
+    '3IqzqH6ShrRtie9Yd2ODyG': True,
+  })
+# ---
 # name: test_get_album
   dict({
     'album_id': '3IqzqH6ShrRtie9Yd2ODyG',

tests/fixtures/album_saved.json

@@ -0,0 +1,5 @@
+[
+    true,
+    false,
+    true
+]

tests/test_spotify.py

@@ -260,6 +260,55 @@ async def test_removing_too_many_saved_albums(
     responses.assert_not_called()  # type: ignore[no-untyped-call]
 
 
+async def test_checking_saved_albums(
+    responses: aioresponses,
+    snapshot: SnapshotAssertion,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking saved albums."""
+    responses.get(
+        f"{SPOTIFY_URL}/v1/me/albums/contains?ids=3IqzqH6ShrRtie9Yd2ODyG%252C1A2GTWGtFfWp7KSQTwWOyo%252C2noRn2Aes5aoNVsU6iWTh",
+        status=200,
+        body=load_fixture("album_saved.json"),
+    )
+    response = await authenticated_client.are_albums_saved(
+        [
+            "spotify:album:3IqzqH6ShrRtie9Yd2ODyG",
+            "1A2GTWGtFfWp7KSQTwWOyo",
+            "2noRn2Aes5aoNVsU6iWTh",
+        ]
+    )
+    assert response == snapshot
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/albums/contains",
+        METH_GET,
+        headers=HEADERS,
+        params={
+            "ids": "3IqzqH6ShrRtie9Yd2ODyG,1A2GTWGtFfWp7KSQTwWOyo,2noRn2Aes5aoNVsU6iWTh"
+        },
+        json=None,
+    )
+
+
+async def test_checking_no_saved_albums(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking no saved albums."""
+    await authenticated_client.are_albums_saved([])
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_checking_too_many_saved_albums(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking too many saved albums."""
+    with pytest.raises(ValueError, match="Maximum of 20 albums can be checked at once"):
+        await authenticated_client.are_albums_saved(["abc"] * 21)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
 @pytest.mark.parametrize(
     "playback_fixture",
     [