Add support for fetching a category (#312)

Author: joostlek

src/spotifyaio/models.py

@@ -382,6 +382,16 @@ class CategoryPlaylistResponse(DataClassORJSONMixin):
     playlists: PlaylistResponse
 
 
+@dataclass
+class Category(DataClassORJSONMixin):
+    """Category model."""
+
+    category_id: str = field(metadata=field_options(alias="id"))
+    name: str
+    href: str
+    icons: list[Image]
+
+
 class ProductType(StrEnum):
     """Product type."""
 

src/spotifyaio/spotify.py

@@ -17,6 +17,7 @@
     ArtistResponse,
     BasePlaylist,
     BaseUserProfile,
+    Category,
     CategoryPlaylistResponse,
     CurrentPlaying,
     Device,
@@ -278,6 +279,11 @@ async def get_featured_playlists(self) -> list[BasePlaylist]:
         response = await self._get("v1/browse/featured-playlists", params=params)
         return FeaturedPlaylistResponse.from_json(response).playlists.items
 
+    async def get_category(self, category_id: str) -> Category:
+        """Get category."""
+        response = await self._get(f"v1/browse/categories/{category_id}")
+        return Category.from_json(response)
+
     async def get_saved_albums(self) -> list[SavedAlbum]:
         """Get saved albums."""
         params: dict[str, Any] = {"limit": 48}

tests/__snapshots__/test_spotify.ambr

@@ -366,6 +366,20 @@
     'uri': 'spotify:album:3IqzqH6ShrRtie9Yd2ODyG',
   })
 # ---
+# name: test_get_category
+  dict({
+    'category_id': '0JQ5DAqbMKFRY5ok2pxXJ0',
+    'href': 'https://api.spotify.com/v1/browse/categories/0JQ5DAqbMKFRY5ok2pxXJ0',
+    'icons': list([
+      dict({
+        'height': 274,
+        'url': 'https://t.scdn.co/media/original/dinner_1b6506abba0ba52c54e6d695c8571078_274x274.jpg',
+        'width': 274,
+      }),
+    ]),
+    'name': 'Cooking & Dining',
+  })
+# ---
 # name: test_get_category_playlists
   list([
     dict({

tests/fixtures/category.json

@@ -0,0 +1,12 @@
+{
+  "href": "https://api.spotify.com/v1/browse/categories/0JQ5DAqbMKFRY5ok2pxXJ0",
+  "id": "0JQ5DAqbMKFRY5ok2pxXJ0",
+  "icons": [
+    {
+      "height": 274,
+      "url": "https://t.scdn.co/media/original/dinner_1b6506abba0ba52c54e6d695c8571078_274x274.jpg",
+      "width": 274
+    }
+  ],
+  "name": "Cooking & Dining"
+}

tests/test_spotify.py

@@ -982,3 +982,25 @@ async def test_get_top_tracks(
         params={"limit": 48},
         data=None,
     )
+
+
+async def test_get_category(
+    responses: aioresponses,
+    snapshot: SnapshotAssertion,
+    authenticated_client: SpotifyClient,
+) -> None:
+    """Test retrieving a category."""
+    responses.get(
+        f"{SPOTIFY_URL}/v1/browse/categories/dinner",
+        status=200,
+        body=load_fixture("category.json"),
+    )
+    response = await authenticated_client.get_category("dinner")
+    assert response == snapshot
+    responses.assert_called_once_with(
+        f"{SPOTIFY_URL}/v1/browse/categories/dinner",
+        METH_GET,
+        headers=HEADERS,
+        params=None,
+        data=None,
+    )