Add method to check if audiobooks are saved (#480)

Author: joostlek

src/spotifyaio/spotify.py

@@ -333,7 +333,18 @@ async def remove_saved_audiobooks(self, audiobook_ids: list[str]) -> None:
         }
         await self._delete("v1/me/audiobooks", params=params)
 
-    # Check if one or more audiobooks is already saved
+    async def are_audiobooks_saved(self, audiobook_ids: list[str]) -> dict[str, bool]:
+        """Check if audiobooks are saved."""
+        if not audiobook_ids:
+            return {}
+        if len(audiobook_ids) > 50:
+            msg = "Maximum of 50 audiobooks can be checked at once"
+            raise ValueError(msg)
+        identifiers = [get_identifier(i) for i in audiobook_ids]
+        params: dict[str, Any] = {"ids": ",".join(identifiers)}
+        response = await self._get("v1/me/audiobooks/contains", params=params)
+        body: list[bool] = orjson.loads(response)  # pylint: disable=no-member
+        return dict(zip(identifiers, body))
 
     async def get_categories(self) -> list[Category]:
         """Get list of categories."""

tests/__snapshots__/test_spotify.ambr

@@ -1,4 +1,11 @@
 # serializer version: 1
+# name: test_check_saved_audiobooks
+  dict({
+    '18yVqkdbdRvS24c0Ilj2ci': False,
+    '1HGw3J3NxZO1TP1BTtVhpZ': False,
+    '7iHfbu1YPACw6oZPAFJtqe': False,
+  })
+# ---
 # name: test_checking_saved_albums
   dict({
     '1A2GTWGtFfWp7KSQTwWOyo': False,

tests/fixtures/audiobooks_saved.json

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

tests/test_spotify.py

@@ -1540,6 +1540,56 @@ async def test_remove_too_many_audiobooks(
     responses.assert_not_called()  # type: ignore[no-untyped-call]
 
 
+async def test_check_saved_audiobooks(
+    responses: aioresponses,
+    snapshot: SnapshotAssertion,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking saved audiobooks."""
+    responses.get(
+        f"{SPOTIFY_URL}/v1/me/audiobooks/contains?ids=18yVqkdbdRvS24c0Ilj2ci,"
+        f"1HGw3J3NxZO1TP1BTtVhpZ,7iHfbu1YPACw6oZPAFJtqe",
+        status=200,
+        body=load_fixture("audiobooks_saved.json"),
+    )
+    response = await authenticated_client.are_audiobooks_saved(
+        ["18yVqkdbdRvS24c0Ilj2ci", "1HGw3J3NxZO1TP1BTtVhpZ", "7iHfbu1YPACw6oZPAFJtqe"]
+    )
+    assert response == snapshot
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/audiobooks/contains",
+        METH_GET,
+        headers=HEADERS,
+        params={
+            "ids": "18yVqkdbdRvS24c0Ilj2ci,"
+            "1HGw3J3NxZO1TP1BTtVhpZ,"
+            "7iHfbu1YPACw6oZPAFJtqe"
+        },
+        json=None,
+    )
+
+
+async def test_check_no_saved_audiobooks(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking no saved audiobooks."""
+    assert await authenticated_client.are_audiobooks_saved([]) == {}
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_check_too_many_saved_audiobooks(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking too many saved audiobooks."""
+    with pytest.raises(
+        ValueError, match="Maximum of 50 audiobooks can be checked at once"
+    ):
+        await authenticated_client.are_audiobooks_saved(["abc"] * 51)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
 async def test_get_show_episodes(
     responses: aioresponses,
     snapshot: SnapshotAssertion,