Add method to get chapter (#481)

Author: joostlek

src/spotifyaio/models.py

@@ -646,7 +646,7 @@ class AudioFeatures(DataClassORJSONMixin):
 
 
 @dataclass
-class Chapter(DataClassORJSONMixin):
+class SimplifiedChapter(DataClassORJSONMixin):
     """Chapter model."""
 
     chapter_id: str = field(metadata=field_options(alias="id"))
@@ -661,11 +661,18 @@ class Chapter(DataClassORJSONMixin):
     external_urls: dict[str, str]
 
 
+@dataclass
+class Chapter(SimplifiedChapter):
+    """Chapter model."""
+
+    audiobook: SimplifiedAudiobook
+
+
 @dataclass
 class AudiobookChapterResponse(DataClassORJSONMixin):
     """Audiobook chapter response model."""
 
-    items: list[Chapter]
+    items: list[SimplifiedChapter]
 
 
 @dataclass
@@ -707,7 +714,7 @@ class SimplifiedAudiobook(DataClassORJSONMixin):
 class Audiobook(SimplifiedAudiobook):
     """Audiobook model."""
 
-    chapters: list[Chapter]
+    chapters: list[SimplifiedChapter]
 
     @classmethod
     def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:

src/spotifyaio/spotify.py

@@ -54,6 +54,7 @@
     Show,
     ShowEpisodesResponse,
     SimplifiedAudiobook,
+    SimplifiedChapter,
     SimplifiedEpisode,
     TopArtistsResponse,
     TopTracksResponse,
@@ -291,7 +292,9 @@ async def get_audiobooks(self, audiobook_ids: list[str]) -> list[Audiobook]:
         response = await self._get("v1/audiobooks", params=params)
         return AudiobooksResponse.from_json(response).audiobooks
 
-    async def get_audiobook_chapters(self, audiobook_id: str) -> list[Chapter]:
+    async def get_audiobook_chapters(
+        self, audiobook_id: str
+    ) -> list[SimplifiedChapter]:
         """Get audiobook chapters."""
         identifier = get_identifier(audiobook_id)
         params: dict[str, Any] = {"limit": 50}
@@ -343,7 +346,11 @@ async def get_category(self, category_id: str) -> Category:
         response = await self._get(f"v1/browse/categories/{category_id}")
         return Category.from_json(response)
 
-    # Get chapter
+    async def get_chapter(self, chapter_id: str) -> Chapter:
+        """Get chapter."""
+        identifier = chapter_id.split(":")[-1]
+        response = await self._get(f"v1/chapters/{identifier}")
+        return Chapter.from_json(response)
 
     # Get several chapters
 

tests/__snapshots__/test_spotify.ambr

@@ -7895,6 +7895,98 @@
     }),
   ])
 # ---
+# name: test_get_chapter
+  dict({
+    'audiobook': dict({
+      'audiobook_id': '58cFIY8IT7yGqR3kHnKqzV',
+      'authors': list([
+        dict({
+          'name': 'Anya Niewierra',
+        }),
+      ]),
+      'description': '''
+        Author(s): Anya Niewierra
+        Narrator(s): Nienke Brinkhuis, Cees van Ede, Mattijn Hartemink<p>Na het succes van de bestsellers <i>Het bloemenmeisje</i> en <i>De Camino</i> komt Anya Niewierra met <i>De nomade</i>. Een aangrijpende thriller over vaderliefde en een verborgen verleden.</p><p>De 37-jarige documentairemaker Olga Liebke woont met haar zonderlinge vader in het Harz-gebergte. Olga heeft een innige band met de inmiddels dementerende man. Haar moeder stierf in het kraambed en ze heeft verder geen familie. Tenminste, zo is het verhaal.</p><p>Maar dan vertelt haar vader herinneringen die niet rijmen met de geschiedenis zoals zij die kent. Ze gaat twijfelen over haar achtergrond en ontdekt documenten uit de voormalige Sovjet-Unie.</p><p>Olga reist naar de driehoek Polen, Litouwen en Belarus en stuit op een huiveringwekkend geheim.</p>
+        <br>
+        <p>‘Anya Niewierra heeft met <i>De nomade</i> weer een magnifiek boek afgeleverd, dat mogelijk nog indrukwekkender is dan <i>De Camino</i>.’<br>
+        Heleen Spanjaard, <i>Margriet</i></p><p>‘Verrassend, meeslepend en bloedstollend. <i>De nomade</i> is een waardige opvolger van <i>De Camino</i>.’<br>
+        Rob Cobben, cultuurverslaggever <i>Dagblad De Limburger</i></p>
+      ''',
+      'edition': 'Unabridged',
+      'explicit': False,
+      'external_urls': dict({
+        'spotify': 'https://open.spotify.com/show/58cFIY8IT7yGqR3kHnKqzV',
+      }),
+      'html_description': 'Author(s): Anya Niewierra<br/>Narrator(s): Nienke Brinkhuis, Cees van Ede, Mattijn Hartemink<br/>&lt;p&gt;Na het succes van de bestsellers &lt;i&gt;Het bloemenmeisje&lt;/i&gt; en &lt;i&gt;De Camino&lt;/i&gt; komt Anya Niewierra met &lt;i&gt;De nomade&lt;/i&gt;. Een aangrijpende thriller over vaderliefde en een verborgen verleden.&lt;/p&gt;<br/>&lt;p&gt;De 37-jarige documentairemaker Olga Liebke woont met haar zonderlinge vader in het Harz-gebergte. Olga heeft een innige band met de inmiddels dementerende man. Haar moeder stierf in het kraambed en ze heeft verder geen familie. Tenminste, zo is het verhaal.&lt;/p&gt;<br/>&lt;p&gt;Maar dan vertelt haar vader herinneringen die niet rijmen met de geschiedenis zoals zij die kent. Ze gaat twijfelen over haar achtergrond en ontdekt documenten uit de voormalige Sovjet-Unie.&lt;/p&gt;<br/>&lt;p&gt;Olga reist naar de driehoek Polen, Litouwen en Belarus en stuit op een huiveringwekkend geheim.&lt;/p&gt;<br/>&lt;br&gt;<br/>&lt;p&gt;‘Anya Niewierra heeft met &lt;i&gt;De nomade&lt;/i&gt; weer een magnifiek boek afgeleverd, dat mogelijk nog indrukwekkender is dan &lt;i&gt;De Camino&lt;/i&gt;.’&lt;br&gt;<br/>Heleen Spanjaard, &lt;i&gt;Margriet&lt;/i&gt;&lt;/p&gt;<br/>&lt;p&gt;‘Verrassend, meeslepend en bloedstollend. &lt;i&gt;De nomade&lt;/i&gt; is een waardige opvolger van &lt;i&gt;De Camino&lt;/i&gt;.’&lt;br&gt;<br/>Rob Cobben, cultuurverslaggever &lt;i&gt;Dagblad De Limburger&lt;/i&gt;&lt;/p&gt;',
+      'images': list([
+        dict({
+          'height': 640,
+          'url': 'https://i.scdn.co/image/ab676663000022a8ecf13d909d494c02ba057feb',
+          'width': 640,
+        }),
+        dict({
+          'height': 300,
+          'url': 'https://i.scdn.co/image/ab6766630000db5becf13d909d494c02ba057feb',
+          'width': 300,
+        }),
+        dict({
+          'height': 64,
+          'url': 'https://i.scdn.co/image/ab6766630000703becf13d909d494c02ba057feb',
+          'width': 64,
+        }),
+      ]),
+      'languages': list([
+        'nl',
+      ]),
+      'name': 'De nomade',
+      'narrators': list([
+        dict({
+          'name': 'Nienke Brinkhuis',
+        }),
+        dict({
+          'name': 'Cees van Ede',
+        }),
+        dict({
+          'name': 'Mattijn Hartemink',
+        }),
+      ]),
+      'publisher': 'Anya Niewierra',
+      'total_chapters': 49,
+      'type': 'audiobook',
+      'uri': 'spotify:show:58cFIY8IT7yGqR3kHnKqzV',
+    }),
+    'chapter_id': '3NW4BmIOG0qzQZgtLgsydR',
+    'chapter_number': 0,
+    'duration_ms': 249652,
+    'explicit': False,
+    'external_urls': dict({
+      'spotify': 'https://open.spotify.com/episode/3NW4BmIOG0qzQZgtLgsydR',
+    }),
+    'images': list([
+      dict({
+        'height': 640,
+        'url': 'https://i.scdn.co/image/ab676663000022a8ecf13d909d494c02ba057feb',
+        'width': 640,
+      }),
+      dict({
+        'height': 300,
+        'url': 'https://i.scdn.co/image/ab6766630000db5becf13d909d494c02ba057feb',
+        'width': 300,
+      }),
+      dict({
+        'height': 64,
+        'url': 'https://i.scdn.co/image/ab6766630000703becf13d909d494c02ba057feb',
+        'width': 64,
+      }),
+    ]),
+    'languages': list([
+      'nl',
+    ]),
+    'name': 'Track 1',
+    'type': 'chapter',
+    'uri': 'spotify:episode:3NW4BmIOG0qzQZgtLgsydR',
+  })
+# ---
 # name: test_get_current_playing
   dict({
     'context': dict({