Add support for fetching top artists and tracks (#311)

Author: joostlek

.pre-commit-config.yaml

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

src/spotifyaio/models.py

@@ -12,6 +12,18 @@
 from mashumaro.types import Discriminator, SerializationStrategy
 
 
+class LowercaseAlbumTypeSerializationStrategy(SerializationStrategy):
+    """Serialization strategy for objects encapsulated in items."""
+
+    def serialize(self, value: AlbumType) -> str:
+        """Serialize optional string."""
+        return value
+
+    def deserialize(self, value: str) -> AlbumType:
+        """Deserialize optional string."""
+        return AlbumType(value.lower())
+
+
 class DeviceType(StrEnum):
     """Device type."""
 
@@ -73,6 +85,7 @@ class AlbumType(StrEnum):
     """Album type."""
 
     ALBUM = "album"
+    EP = "ep"
     SINGLE = "single"
     COMPILATION = "compilation"
 
@@ -119,7 +132,11 @@ def deserialize(self, value: dict[str, Any]) -> list[Any]:
 class SimplifiedAlbum(DataClassORJSONMixin):
     """Album model."""
 
-    album_type: AlbumType
+    album_type: AlbumType = field(
+        metadata=field_options(
+            serialization_strategy=LowercaseAlbumTypeSerializationStrategy()
+        )
+    )
     total_tracks: int
     album_id: str = field(metadata=field_options(alias="id"))
     images: list[Image]
@@ -219,6 +236,20 @@ class Artist(SimplifiedArtist):
     """Artist model."""
 
 
+@dataclass
+class TopArtistsResponse(DataClassORJSONMixin):
+    """Top artists response model."""
+
+    items: list[Artist]
+
+
+@dataclass
+class TopTracksResponse(DataClassORJSONMixin):
+    """Top tracks response model."""
+
+    items: list[Track]
+
+
 @dataclass
 class SimplifiedTrack(DataClassORJSONMixin):
     """SimplifiedTrack model."""

src/spotifyaio/spotify.py

@@ -5,7 +5,7 @@
 import asyncio
 from dataclasses import dataclass
 from importlib import metadata
-from typing import Any, Awaitable, Callable, Self
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Self
 
 from aiohttp import ClientSession
 from aiohttp.hdrs import METH_GET, METH_POST, METH_PUT
@@ -37,9 +37,14 @@
     SavedTrackResponse,
     Show,
     SimplifiedArtist,
+    TopArtistsResponse,
+    TopTracksResponse,
     UserProfile,
 )
 
+if TYPE_CHECKING:
+    from spotifyaio import Artist, Track
+
 
 @dataclass
 class SpotifyClient:
@@ -306,6 +311,18 @@ async def get_category_playlists(self, category_id: str) -> list[BasePlaylist]:
         )
         return CategoryPlaylistResponse.from_json(response).playlists.items
 
+    async def get_top_artists(self) -> list[Artist]:
+        """Get top artists."""
+        params: dict[str, Any] = {"limit": 48}
+        response = await self._get("v1/me/top/artists", params=params)
+        return TopArtistsResponse.from_json(response).items
+
+    async def get_top_tracks(self) -> list[Track]:
+        """Get top tracks."""
+        params: dict[str, Any] = {"limit": 48}
+        response = await self._get("v1/me/top/tracks", params=params)
+        return TopTracksResponse.from_json(response).items
+
     async def get_episode(self, episode_id: str) -> Episode:
         """Get episode."""
         identifier = episode_id.split(":")[-1]