Skip to content

Add album support #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 33 additions & 6 deletions src/spotifyaio/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

from dataclasses import dataclass, field
from enum import StrEnum
from typing import Any, cast

from mashumaro import field_options
from mashumaro.mixins.orjson import DataClassORJSONMixin
from mashumaro.types import SerializationStrategy


class DeviceType(StrEnum):
Expand Down Expand Up @@ -100,8 +102,20 @@ class SimplifiedArtist(DataClassORJSONMixin):
uri: str


class TracksSerializationStrategy(SerializationStrategy):
"""Serialization strategy for optional strings."""

def serialize(self, value: list[Any]) -> list[Any]:
"""Serialize optional string."""
return value

def deserialize(self, value: dict[str, Any]) -> list[Any]:
"""Deserialize optional string."""
return cast(list[Any], value.get("items", []))


@dataclass
class Album(DataClassORJSONMixin):
class SimplifiedAlbum(DataClassORJSONMixin):
"""Album model."""

album_type: AlbumType
Expand All @@ -115,6 +129,15 @@ class Album(DataClassORJSONMixin):
artists: list[SimplifiedArtist]


@dataclass
class Album(SimplifiedAlbum):
"""Album model."""

tracks: list[SimplifiedTrack] = field(
metadata=field_options(serialization_strategy=TracksSerializationStrategy())
)


@dataclass
class Artist(DataClassORJSONMixin):
"""Artist model."""
Expand All @@ -125,25 +148,29 @@ class Artist(DataClassORJSONMixin):


@dataclass
class Track(DataClassORJSONMixin):
"""Track model."""
class SimplifiedTrack(DataClassORJSONMixin):
"""SimplifiedTrack model."""

track_id: str = field(metadata=field_options(alias="id"))
album: Album
artists: list[Artist]
disc_number: int
duration_ms: int
explicit: bool
external_ids: dict[str, str]
external_urls: dict[str, str]
href: str
name: str
is_local: bool
track_number: int
object_type: str = field(metadata=field_options(alias="type"))
uri: str


@dataclass
class Track(SimplifiedTrack):
"""Track model."""

album: SimplifiedAlbum


@dataclass
class CurrentPlaying(DataClassORJSONMixin):
"""Current playing model."""
Expand Down
6 changes: 6 additions & 0 deletions src/spotifyaio/spotify.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

from spotifyaio.exceptions import SpotifyConnectionError, SpotifyError
from spotifyaio.models import (
Album,
BasePlaylist,
BaseUserProfile,
CategoryPlaylistResponse,
Expand Down Expand Up @@ -123,6 +124,11 @@ async def _put(
"""Handle a PUT request to Spotify."""
return await self._request(METH_PUT, uri, data=data, params=params)

async def get_album(self, album_id: str) -> Album:
"""Get album."""
response = await self._get(f"v1/albums/{album_id}")
return Album.from_json(response)

async def get_playback(self) -> PlaybackState | None:
"""Get playback state."""
response = await self._get("v1/me/player")
Expand Down
16 changes: 0 additions & 16 deletions tests/__snapshots__/test_playback.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,12 @@
'disc_number': 1,
'duration_ms': 245581,
'explicit': True,
'external_ids': dict({
'isrc': 'GBMJG1909751',
}),
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/4sIkwgf9bU7rQPvsA37rVQ',
}),
'href': 'https://api.spotify.com/v1/tracks/4sIkwgf9bU7rQPvsA37rVQ',
'is_local': False,
'name': 'Witte Was',
'object_type': 'track',
'track_id': '4sIkwgf9bU7rQPvsA37rVQ',
'track_number': 6,
'uri': 'spotify:track:4sIkwgf9bU7rQPvsA37rVQ',
Expand Down Expand Up @@ -152,16 +148,12 @@
'disc_number': 1,
'duration_ms': 268525,
'explicit': False,
'external_ids': dict({
'isrc': 'QZTB52388870',
}),
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/1FyXbzOlq3dkxaB6iRsETv',
}),
'href': 'https://api.spotify.com/v1/tracks/1FyXbzOlq3dkxaB6iRsETv',
'is_local': False,
'name': 'WARRIORS, Pt. 1 (Final Stage)',
'object_type': 'track',
'track_id': '1FyXbzOlq3dkxaB6iRsETv',
'track_number': 1,
'uri': 'spotify:track:1FyXbzOlq3dkxaB6iRsETv',
Expand Down Expand Up @@ -237,16 +229,12 @@
'disc_number': 1,
'duration_ms': 296466,
'explicit': False,
'external_ids': dict({
'isrc': 'USMR18070028',
}),
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/4e9hUiLsN4mx61ARosFi7p',
}),
'href': 'https://api.spotify.com/v1/tracks/4e9hUiLsN4mx61ARosFi7p',
'is_local': False,
'name': 'The Spirit Of Radio',
'object_type': 'track',
'track_id': '4e9hUiLsN4mx61ARosFi7p',
'track_number': 1,
'uri': 'spotify:track:4e9hUiLsN4mx61ARosFi7p',
Expand Down Expand Up @@ -322,16 +310,12 @@
'disc_number': 1,
'duration_ms': 152500,
'explicit': True,
'external_ids': dict({
'isrc': 'NLG661800442',
}),
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/3TE49HXyoNczZk2IBhP87z',
}),
'href': 'https://api.spotify.com/v1/tracks/3TE49HXyoNczZk2IBhP87z',
'is_local': False,
'name': 'Ome Robert',
'object_type': 'track',
'track_id': '3TE49HXyoNczZk2IBhP87z',
'track_number': 1,
'uri': 'spotify:track:3TE49HXyoNczZk2IBhP87z',
Expand Down
Loading