Add method to shows (#491)

Author: joostlek

src/spotifyaio/spotify.py

@@ -746,11 +746,42 @@ async def get_saved_shows(self) -> list[SavedShow]:
         response = await self._get("v1/me/shows", params=params)
         return SavedShowResponse.from_json(response).items
 
-    # Save a show
+    async def save_shows(self, show_ids: list[str]) -> None:
+        """Save shows."""
+        if not show_ids:
+            return
+        if len(show_ids) > 50:
+            msg = "Maximum of 50 shows can be saved at once"
+            raise ValueError(msg)
+        params: dict[str, Any] = {
+            "ids": ",".join([get_identifier(i) for i in show_ids])
+        }
+        await self._put("v1/me/shows", params=params)
 
-    # Remove a show
+    async def remove_saved_shows(self, show_ids: list[str]) -> None:
+        """Remove saved shows."""
+        if not show_ids:
+            return
+        if len(show_ids) > 50:
+            msg = "Maximum of 50 shows can be removed at once"
+            raise ValueError(msg)
+        params: dict[str, Any] = {
+            "ids": ",".join([get_identifier(i) for i in show_ids])
+        }
+        await self._delete("v1/me/shows", params=params)
 
-    # Check if one or more shows is already saved
+    async def are_shows_saved(self, show_ids: list[str]) -> dict[str, bool]:
+        """Check if shows are saved."""
+        if not show_ids:
+            return {}
+        if len(show_ids) > 50:
+            msg = "Maximum of 50 shows can be checked at once"
+            raise ValueError(msg)
+        identifiers = [get_identifier(i) for i in show_ids]
+        params: dict[str, Any] = {"ids": ",".join(identifiers)}
+        response = await self._get("v1/me/shows/contains", params=params)
+        body: list[bool] = orjson.loads(response)  # pylint: disable=no-member
+        return dict(zip(identifiers, body))
 
     # Get a track
 

tests/__snapshots__/test_spotify.ambr

@@ -12,6 +12,12 @@
     '3o0RYoo5iOMKSmEbunsbvX': False,
   })
 # ---
+# name: test_check_saved_shows
+  dict({
+    '18yVqkdbdRvS24c0Ilj2ci': True,
+    '1HGw3J3NxZO1TP1BTtVhpZ': False,
+  })
+# ---
 # name: test_checking_saved_albums
   dict({
     '1A2GTWGtFfWp7KSQTwWOyo': False,

tests/fixtures/shows_saved.json

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

tests/test_spotify.py

@@ -2245,3 +2245,124 @@ async def test_get_audio_features(
         params=None,
         json=None,
     )
+
+
+async def test_save_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test saving shows."""
+    responses.put(
+        f"{SPOTIFY_URL}/v1/me/shows?ids=0TnOYISbd1XYRBk9myaseg",
+        status=200,
+        body="",
+    )
+    await authenticated_client.save_shows(["0TnOYISbd1XYRBk9myaseg"])
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/shows",
+        METH_PUT,
+        headers=HEADERS,
+        params={"ids": "0TnOYISbd1XYRBk9myaseg"},
+        json=None,
+    )
+
+
+async def test_save_no_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test saving no shows."""
+    await authenticated_client.save_shows([])
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_save_too_many_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test saving too many shows."""
+    with pytest.raises(ValueError, match="Maximum of 50 shows can be saved at once"):
+        await authenticated_client.save_shows(["abc"] * 51)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_remove_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test removing shows."""
+    responses.delete(
+        f"{SPOTIFY_URL}/v1/me/shows?ids=0TnOYISbd1XYRBk9myaseg",
+        status=200,
+        body="",
+    )
+    await authenticated_client.remove_saved_shows(["0TnOYISbd1XYRBk9myaseg"])
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/shows",
+        METH_DELETE,
+        headers=HEADERS,
+        params={"ids": "0TnOYISbd1XYRBk9myaseg"},
+        json=None,
+    )
+
+
+async def test_remove_no_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test removing no shows."""
+    await authenticated_client.remove_saved_shows([])
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_remove_too_many_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test removing too many shows."""
+    with pytest.raises(ValueError, match="Maximum of 50 shows can be removed at once"):
+        await authenticated_client.remove_saved_shows(["abc"] * 51)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_check_saved_shows(
+    responses: aioresponses,
+    snapshot: SnapshotAssertion,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking saved shows."""
+    responses.get(
+        f"{SPOTIFY_URL}/v1/me/shows/contains?ids=18yVqkdbdRvS24c0Ilj2ci%2C1HGw3J3NxZO1TP1BTtVhpZ",
+        status=200,
+        body=load_fixture("shows_saved.json"),
+    )
+    response = await authenticated_client.are_shows_saved(
+        ["18yVqkdbdRvS24c0Ilj2ci", "1HGw3J3NxZO1TP1BTtVhpZ"]
+    )
+    assert response == snapshot
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/me/shows/contains",
+        METH_GET,
+        headers=HEADERS,
+        params={"ids": "18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ"},
+        json=None,
+    )
+
+
+async def test_check_no_saved_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking no saved shows."""
+    assert await authenticated_client.are_shows_saved([]) == {}
+    responses.assert_not_called()  # type: ignore[no-untyped-call]
+
+
+async def test_check_too_many_saved_shows(
+    responses: aioresponses,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test checking too many saved shows."""
+    with pytest.raises(ValueError, match="Maximum of 50 shows can be checked at once"):
+        await authenticated_client.are_shows_saved(["abc"] * 51)
+    responses.assert_not_called()  # type: ignore[no-untyped-call]