Add support for fetching episodes of a show (#316)

Author: joostlek

.pre-commit-config.yaml

@@ -73,7 +73,7 @@ repos:
         exclude: ^poetry\.lock$
         entry: poetry run codespell
         args:
-          - --ignore-words-list=doen,te,ons,Racoon
+          - --ignore-words-list=doen,te,ons,Racoon,Crate
       - id: detect-private-key
         name: 🕵️  Detect Private Keys
         language: system

src/spotifyaio/models.py

@@ -464,6 +464,13 @@ class SimplifiedEpisode(DataClassORJSONMixin):
     description: str
 
 
+@dataclass
+class ShowEpisodesResponse(DataClassORJSONMixin):
+    """ShowEpisodes response model."""
+
+    items: list[SimplifiedEpisode]
+
+
 @dataclass
 class Episode(SimplifiedEpisode, Item):
     """Episode model."""

src/spotifyaio/spotify.py

@@ -40,7 +40,9 @@
     SavedTrack,
     SavedTrackResponse,
     Show,
+    ShowEpisodesResponse,
     SimplifiedArtist,
+    SimplifiedEpisode,
     TopArtistsResponse,
     TopTracksResponse,
     UserProfile,
@@ -318,6 +320,13 @@ async def get_saved_shows(self) -> list[SavedShow]:
         response = await self._get("v1/me/shows", params=params)
         return SavedShowResponse.from_json(response).items
 
+    async def get_show_episodes(self, show_id: str) -> list[SimplifiedEpisode]:
+        """Get show episodes."""
+        identifier = show_id.split(":")[-1]
+        params: dict[str, Any] = {"limit": 48}
+        response = await self._get(f"v1/shows/{identifier}/episodes", params=params)
+        return ShowEpisodesResponse.from_json(response).items
+
     async def get_recently_played_tracks(self) -> list[PlayedTrack]:
         """Get recently played tracks."""
         params: dict[str, Any] = {"limit": 48}

tests/__snapshots__/test_spotify.ambr

@@ -1070,3 +1070,25 @@ async def test_get_artist_albums(
         params={"limit": 48},
         data=None,
     )
+
+
+async def test_get_show_episodes(
+    responses: aioresponses,
+    snapshot: SnapshotAssertion,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test retrieving episodes of a show."""
+    responses.get(
+        f"{SPOTIFY_URL}/v1/shows/0e30iIgSffe6xJhFKe35Db/episodes?limit=48",
+        status=200,
+        body=load_fixture("show_episodes.json"),
+    )
+    response = await authenticated_client.get_show_episodes("0e30iIgSffe6xJhFKe35Db")
+    assert response == snapshot
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/shows/0e30iIgSffe6xJhFKe35Db/episodes",
+        METH_GET,
+        headers=HEADERS,
+        params={"limit": 48},
+        data=None,
+    )