Add method to get several chapters (#487)

Author: joostlek

src/spotifyaio/models.py

@@ -668,6 +668,19 @@ class Chapter(SimplifiedChapter):
     audiobook: SimplifiedAudiobook
 
 
+@dataclass
+class ChaptersResponse(DataClassORJSONMixin):
+    """Chapters response model."""
+
+    chapters: list[Chapter]
+
+    @classmethod
+    def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
+        """Pre deserialize hook."""
+        items = [item for item in d["chapters"] if item is not None]
+        return {"chapters": items}
+
+
 @dataclass
 class AudiobookChapterResponse(DataClassORJSONMixin):
     """Audiobook chapter response model."""

src/spotifyaio/spotify.py

@@ -30,6 +30,7 @@
     Category,
     CategoryPlaylistResponse,
     Chapter,
+    ChaptersResponse,
     CurrentPlaying,
     Device,
     Devices,
@@ -363,7 +364,18 @@ async def get_chapter(self, chapter_id: str) -> Chapter:
         response = await self._get(f"v1/chapters/{identifier}")
         return Chapter.from_json(response)
 
-    # Get several chapters
+    async def get_chapters(self, chapter_ids: list[str]) -> list[Chapter]:
+        """Get chapters."""
+        if not chapter_ids:
+            return []
+        if len(chapter_ids) > 50:
+            msg = "Maximum of 50 chapters can be requested at once"
+            raise ValueError(msg)
+        params: dict[str, Any] = {
+            "ids": ",".join([get_identifier(i) for i in chapter_ids])
+        }
+        response = await self._get("v1/chapters", params=params)
+        return ChaptersResponse.from_json(response).chapters
 
     async def get_episode(self, episode_id: str) -> Episode:
         """Get episode."""

tests/__snapshots__/test_spotify.ambr

@@ -21486,6 +21486,100 @@
     }),
   ])
 # ---
+# name: test_get_several_chapters
+  list([
+    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_show
   dict({
     'description': 'Safety Third is a weekly show hosted by William Osman, NileRed, The Backyard Scientist, Allen Pan, and a couple other YouTube "Scientists". Sometimes we have guests, sometimes it\'s just us, but always: safety is our number three priority.',