aioaudiobookshelf 0.1.0__py3-none-any.whl

aioaudiobookshelf/__init__.py

@@ -0,0 +1,72 @@
+"""Client library for Audiobookshelf."""
+
+from aiohttp.client_exceptions import ClientResponseError, InvalidUrlClientError
+
+from aioaudiobookshelf.client import AdminClient, SessionConfiguration, SocketClient, UserClient
+from aioaudiobookshelf.exceptions import LoginError
+from aioaudiobookshelf.schema.calls_login import LoginParameters, LoginResponse
+
+__version__ = "0.1.0"
+
+
+async def _get_login_response(
+    *, session_config: SessionConfiguration, username: str, password: str
+) -> LoginResponse:
+    login_request = LoginParameters(username=username, password=password).to_dict()
+
+    try:
+        resp = await session_config.session.post(
+            f"{session_config.url}/login",
+            json=login_request,
+            ssl=session_config.verify_ssl,
+            raise_for_status=True,
+        )
+    except (ClientResponseError, InvalidUrlClientError) as exc:
+        raise LoginError from exc
+    return LoginResponse.from_json(await resp.read())
+
+
+async def get_user_client(
+    *,
+    session_config: SessionConfiguration,
+    username: str,
+    password: str,
+) -> UserClient:
+    """Get a user client."""
+    login_response = await _get_login_response(
+        session_config=session_config, username=username, password=password
+    )
+
+    return UserClient(session_config=session_config, login_response=login_response)
+
+
+async def get_user_and_socket_client(
+    *,
+    session_config: SessionConfiguration,
+    username: str,
+    password: str,
+) -> tuple[UserClient, SocketClient]:
+    """Get user and socket client."""
+    login_response = await _get_login_response(
+        session_config=session_config, username=username, password=password
+    )
+
+    user_client = UserClient(session_config=session_config, login_response=login_response)
+    if not session_config.token:
+        session_config.token = user_client.token
+    socket_client = SocketClient(session_config=session_config)
+    return user_client, socket_client
+
+
+async def get_admin_client(
+    *,
+    session_config: SessionConfiguration,
+    username: str,
+    password: str,
+) -> UserClient:
+    """Get a admin client."""
+    login_response = await _get_login_response(
+        session_config=session_config, username=username, password=password
+    )
+
+    return AdminClient(session_config=session_config, login_response=login_response)

aioaudiobookshelf/client/__init__.py

@@ -0,0 +1,189 @@
+"""Clients for Audiobookshelf."""
+
+import logging
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Any
+
+import socketio
+import socketio.exceptions
+from aiohttp import ClientSession
+
+from aioaudiobookshelf.exceptions import BadUserError
+from aioaudiobookshelf.schema.events_socket import (
+    LibraryItemRemoved,
+    PodcastEpisodeDownload,
+    UserItemProgressUpdatedEvent,
+)
+from aioaudiobookshelf.schema.library import LibraryItemExpanded
+from aioaudiobookshelf.schema.media_progress import MediaProgress
+from aioaudiobookshelf.schema.user import User, UserType
+
+from .authors import AuthorsClient
+from .collections_ import CollectionsClient
+from .items import ItemsClient
+from .libraries import LibrariesClient
+from .me import MeClient
+from .playlists import PlaylistsClient
+from .podcasts import PodcastsClient
+from .series import SeriesClient
+from .session import SessionClient
+
+
+@dataclass(kw_only=True)
+class SessionConfiguration:
+    """Session configuration for abs client."""
+
+    session: ClientSession
+    url: str
+    verify_ssl: bool = True
+    token: str = ""
+    pagination_items_per_page: int = 10
+    logger: logging.Logger | None = None
+
+    @property
+    def headers(self) -> dict[str, str]:
+        """Session headers."""
+        if self.token is None:
+            raise RuntimeError("Token not set.")
+        return {"Authorization": f"Bearer {self.token}"}
+
+    def __post_init__(self) -> None:
+        """Post init."""
+        self.url = self.url.rstrip("/")
+
+
+class UserClient(
+    LibrariesClient,
+    ItemsClient,
+    CollectionsClient,
+    PlaylistsClient,
+    MeClient,
+    AuthorsClient,
+    SeriesClient,
+    SessionClient,
+    PodcastsClient,
+):
+    """Client which uses endpoints accessible to a user."""
+
+    def _verify_user(self) -> None:
+        if self.user.type_ not in [UserType.ADMIN, UserType.ROOT, UserType.USER]:
+            raise BadUserError
+
+
+class AdminClient(UserClient):
+    """Client which uses endpoints accessible to users and admins."""
+
+    def _verify_user(self) -> None:
+        if self.user.type_ not in [UserType.ADMIN, UserType.ROOT]:
+            raise BadUserError
+
+
+class SocketClient:
+    """Client for connecting to abs' socket."""
+
+    def __init__(self, session_config: SessionConfiguration) -> None:
+        """Init SocketClient."""
+        self.session_config = session_config
+
+        self.client = socketio.AsyncClient(
+            reconnection=True,
+            reconnection_attempts=0,
+            handle_sigint=False,
+            ssl_verify=self.session_config.verify_ssl,
+        )
+
+        self.set_item_callbacks()
+        self.set_user_callbacks()
+        self.set_podcast_episode_download_callbacks()
+
+    def set_item_callbacks(
+        self,
+        *,
+        on_item_added: Callable[[LibraryItemExpanded], Any] | None = None,
+        on_item_updated: Callable[[LibraryItemExpanded], Any] | None = None,
+        on_item_removed: Callable[[LibraryItemRemoved], Any] | None = None,
+        on_items_added: Callable[[list[LibraryItemExpanded]], Any] | None = None,
+        on_items_updated: Callable[[list[LibraryItemExpanded]], Any] | None = None,
+    ) -> None:
+        """Set item callbacks."""
+        self.on_item_added = on_item_added
+        self.on_item_updated = on_item_updated
+        self.on_item_removed = on_item_removed
+        self.on_items_added = on_items_added
+        self.on_items_updated = on_items_updated
+
+    def set_user_callbacks(
+        self,
+        *,
+        on_user_updated: Callable[[User], Any] | None = None,
+        on_user_item_progress_updated: Callable[[str, MediaProgress], Any] | None = None,
+    ) -> None:
+        """Set user callbacks."""
+        self.on_user_updated = on_user_updated
+        self.on_user_item_progress_updated = on_user_item_progress_updated
+
+    def set_podcast_episode_download_callbacks(
+        self, *, on_episode_download_finished: Callable[[PodcastEpisodeDownload], Any] | None = None
+    ) -> None:
+        """Set podcast episode download callbacks."""
+        self.on_episode_download_finished = on_episode_download_finished
+
+    async def init_client(self) -> None:
+        """Initialize the client."""
+        self.client.on("connect", handler=self._on_connect)
+
+        self.client.on("user_updated", handler=self._on_user_updated)
+        self.client.on("user_item_progress_updated", handler=self._on_user_item_progress_updated)
+
+        self.client.on("item_added", handler=self._on_item_added)
+        self.client.on("item_updated", handler=self._on_item_updated)
+        self.client.on("item_removed", handler=self._on_item_removed)
+        self.client.on("items_added", handler=self._on_items_added)
+        self.client.on("items_updated", handler=self._on_items_updated)
+
+        self.client.on("episode_download_finished", handler=self._on_episode_download_finished)
+
+        await self.client.connect(url=self.session_config.url)
+
+    async def shutdown(self) -> None:
+        """Shutdown client (disconnect, or stop reconnect attempt)."""
+        await self.client.shutdown()
+
+    logout = shutdown
+
+    async def _on_connect(self) -> None:
+        await self.client.emit(event="auth", data=self.session_config.token)
+
+    async def _on_user_updated(self, data: dict[str, Any]) -> None:
+        if self.on_user_updated is not None:
+            await self.on_user_updated(User.from_dict(data))
+
+    async def _on_user_item_progress_updated(self, data: dict[str, Any]) -> None:
+        if self.on_user_item_progress_updated is not None:
+            event = UserItemProgressUpdatedEvent.from_dict(data)
+            await self.on_user_item_progress_updated(event.id_, event.data)
+
+    async def _on_item_added(self, data: dict[str, Any]) -> None:
+        if self.on_item_added is not None:
+            await self.on_item_added(LibraryItemExpanded.from_dict(data))
+
+    async def _on_item_updated(self, data: dict[str, Any]) -> None:
+        if self.on_item_updated is not None:
+            await self.on_item_updated(LibraryItemExpanded.from_dict(data))
+
+    async def _on_item_removed(self, data: dict[str, Any]) -> None:
+        if self.on_item_removed is not None:
+            await self.on_item_removed(LibraryItemRemoved.from_dict(data))
+
+    async def _on_items_added(self, data: list[dict[str, Any]]) -> None:
+        if self.on_items_added is not None:
+            await self.on_items_added([LibraryItemExpanded.from_dict(x) for x in data])
+
+    async def _on_items_updated(self, data: list[dict[str, Any]]) -> None:
+        if self.on_items_updated is not None:
+            await self.on_items_updated([LibraryItemExpanded.from_dict(x) for x in data])
+
+    async def _on_episode_download_finished(self, data: dict[str, Any]) -> None:
+        if self.on_episode_download_finished is not None:
+            await self.on_episode_download_finished(PodcastEpisodeDownload.from_dict(data))

aioaudiobookshelf/client/_base.py

@@ -0,0 +1,110 @@
+"""BaseClient."""
+
+import logging
+from abc import abstractmethod
+from typing import TYPE_CHECKING, Any
+
+from aiohttp.client_exceptions import ClientResponseError
+
+if TYPE_CHECKING:
+    from aioaudiobookshelf.client import SessionConfiguration
+from aioaudiobookshelf.exceptions import ApiError
+from aioaudiobookshelf.schema.calls_login import LoginResponse
+
+
+class BaseClient:
+    """Base for clients."""
+
+    def __init__(
+        self, session_config: "SessionConfiguration", login_response: LoginResponse
+    ) -> None:
+        self.session_config = session_config
+        self.user = login_response.user
+        if not self.session_config.token:
+            self.session_config.token = login_response.user.token
+        self._token = self.session_config.token
+
+        if self.session_config.logger is None:
+            self.logger = logging.getLogger(__name__)
+            logging.basicConfig()
+            self.logger.setLevel(logging.DEBUG)
+        else:
+            self.logger = self.session_config.logger
+
+        self.logger.debug(
+            "Initialized client %s, token: %s",
+            self.__class__.__name__,
+            self._token,
+        )
+
+        self._verify_user()
+
+    @property
+    def token(self) -> str:
+        return self._token
+
+    @abstractmethod
+    def _verify_user(self) -> None:
+        """Verify if user has enough permissions for endpoints in use."""
+
+    async def _post(
+        self,
+        endpoint: str,
+        data: dict[str, Any] | None = None,
+    ) -> bytes:
+        """POST request to abs api."""
+        try:
+            response = await self.session_config.session.post(
+                f"{self.session_config.url}/{endpoint}",
+                json=data,
+                ssl=self.session_config.verify_ssl,
+                headers=self.session_config.headers,
+                raise_for_status=True,
+            )
+        except ClientResponseError as exc:
+            raise ApiError(f"API POST call to {endpoint} failed.") from exc
+        return await response.read()
+
+    async def _get(self, endpoint: str, params: dict[str, str | int] | None = None) -> bytes:
+        """GET request to abs api."""
+        response = await self.session_config.session.get(
+            f"{self.session_config.url}/{endpoint}",
+            params=params,
+            ssl=self.session_config.verify_ssl,
+            headers=self.session_config.headers,
+        )
+        status = response.status
+        if response.content_type == "application/json" and status == 200:
+            return await response.read()
+        if status == 404:
+            return b""
+        raise ApiError(f"API GET call to {endpoint} failed.")
+
+    async def _patch(self, endpoint: str, data: dict[str, Any] | None = None) -> None:
+        """PATCH request to abs api."""
+        try:
+            await self.session_config.session.patch(
+                f"{self.session_config.url}/{endpoint}",
+                json=data,
+                ssl=self.session_config.verify_ssl,
+                headers=self.session_config.headers,
+                raise_for_status=True,
+            )
+        except ClientResponseError as exc:
+            raise ApiError(f"API PATCH call to {endpoint} failed.") from exc
+
+    async def _delete(self, endpoint: str) -> None:
+        """DELETE request to abs api."""
+        try:
+            await self.session_config.session.delete(
+                endpoint,
+                ssl=self.session_config.verify_ssl,
+                headers=self.session_config.headers,
+                raise_for_status=True,
+            )
+        except ClientResponseError as exc:
+            raise ApiError(f"API DELETE call to {endpoint} failed.") from exc
+
+    async def logout(self) -> None:
+        """Logout client."""
+        await self._post("logout")

aioaudiobookshelf/client/authors.py

@@ -0,0 +1,34 @@
+"""Calls to /api/authors."""
+
+from aioaudiobookshelf.client._base import BaseClient
+from aioaudiobookshelf.schema.author import Author
+from aioaudiobookshelf.schema.calls_authors import AuthorWithItems, AuthorWithItemsAndSeries
+
+
+class AuthorsClient(BaseClient):
+    """AuthorsClient."""
+
+    async def get_author(
+        self, *, author_id: str, include_items: bool = False, include_series: bool = False
+    ) -> Author | AuthorWithItems | AuthorWithItemsAndSeries:
+        """Get an author.
+
+        Include series always includes items.
+        """
+        response_cls: type[Author | AuthorWithItems | AuthorWithItemsAndSeries] = Author
+        if include_series:
+            include_items = True
+        endpoint = f"/api/authors/{author_id}"
+        if include_items:
+            endpoint += "?include=items"
+            response_cls = AuthorWithItems
+        if include_series:
+            endpoint += ",series"
+            response_cls = AuthorWithItemsAndSeries
+
+        response = await self._get(endpoint)
+        return response_cls.from_json(response)
+
+    # update author
+    # match author
+    # get author image

aioaudiobookshelf/client/collections_.py

@@ -0,0 +1,28 @@
+"""Calls to /api/collections."""
+
+from aioaudiobookshelf.schema.calls_collections import AllCollectionsResponse
+from aioaudiobookshelf.schema.collection import CollectionExpanded
+
+from ._base import BaseClient
+
+
+class CollectionsClient(BaseClient):
+    """CollectionsClient."""
+
+    # create collection
+
+    async def get_all_collections(self) -> list[CollectionExpanded]:
+        """Get all collections accessible to user."""
+        data = await self._get(endpoint="/api/collections")
+        return AllCollectionsResponse.from_json(data).collections
+
+    async def get_collection(self, *, collection_id: str) -> CollectionExpanded:
+        """Get a collection."""
+        data = await self._get(endpoint=f"/api/collections/{collection_id}")
+        return CollectionExpanded.from_json(data)
+
+    # update
+    # delete
+    # add book
+    # remove book
+    # batch add + remove

aioaudiobookshelf/client/items.py

@@ -0,0 +1,108 @@
+"""Calls to /api/items."""
+
+from aioaudiobookshelf.client._base import BaseClient
+from aioaudiobookshelf.schema.calls_items import (
+    LibraryItemsBatchBookResponse,
+    LibraryItemsBatchParameters,
+    LibraryItemsBatchPodcastResponse,
+    PlaybackSessionParameters,
+)
+from aioaudiobookshelf.schema.library import (
+    LibraryItemBook,
+    LibraryItemExpandedBook,
+    LibraryItemExpandedPodcast,
+    LibraryItemPodcast,
+)
+from aioaudiobookshelf.schema.session import PlaybackSessionExpanded
+
+
+class ItemsClient(BaseClient):
+    """ItemsClient."""
+
+    # delete all items (admin)
+
+    async def get_library_item_book(
+        self, *, book_id: str, expanded: bool = False
+    ) -> LibraryItemBook | LibraryItemExpandedBook:
+        """Get book library item.
+
+        We only support expanded as parameter.
+        """
+        data = await self._get(f"/api/items/{book_id}?expanded={int(expanded)}")
+        if not expanded:
+            return LibraryItemBook.from_json(data)
+        return LibraryItemExpandedBook.from_json(data)
+
+    async def get_library_item_podcast(
+        self, *, podcast_id: str, expanded: bool = False
+    ) -> LibraryItemPodcast | LibraryItemExpandedPodcast:
+        """Get book library item.
+
+        We only support expanded as parameter.
+        """
+        data = await self._get(f"/api/items/{podcast_id}?expanded={int(expanded)}")
+        if not expanded:
+            return LibraryItemPodcast.from_json(data)
+        return LibraryItemExpandedPodcast.from_json(data)
+
+    # delete library item
+    # update library item media
+    # get item cover
+    # upload cover
+    # update cover
+    # remove cover
+    # match lib item
+
+    async def get_playback_session(
+        self,
+        *,
+        session_parameters: PlaybackSessionParameters,
+        item_id: str,
+        episode_id: str | None = None,
+    ) -> PlaybackSessionExpanded:
+        """Play a media item."""
+        endpoint = f"/api/items/{item_id}/play"
+        if episode_id is not None:
+            endpoint += f"/{episode_id}"
+        response = await self._post(endpoint, data=session_parameters.to_dict())
+        return PlaybackSessionExpanded.from_json(response)
+
+    # update audio track
+    # scan item
+    # get tone metadata
+    # update chapters
+    # tone scan
+
+    async def _get_libray_item_batch(
+        self, *, item_ids: list[str] | LibraryItemsBatchParameters
+    ) -> bytes:
+        if isinstance(item_ids, list):
+            if not item_ids:
+                return b""
+            params = LibraryItemsBatchParameters(library_item_ids=item_ids)
+        else:
+            if not item_ids.library_item_ids:
+                return b""
+            params = item_ids
+
+        return await self._post("/api/items/batch/get", data=params.to_dict())
+
+    async def get_library_item_batch_book(
+        self, *, item_ids: list[str] | LibraryItemsBatchParameters
+    ) -> list[LibraryItemExpandedBook]:
+        """Get multiple library items at once. Always expanded."""
+        data = await self._get_libray_item_batch(item_ids=item_ids)
+        if not data:
+            return []
+        return LibraryItemsBatchBookResponse.from_json(data).library_items
+
+    async def get_library_item_batch_podcast(
+        self, *, item_ids: list[str] | LibraryItemsBatchParameters
+    ) -> list[LibraryItemExpandedPodcast]:
+        """Get multiple library items at once. Always expanded."""
+        data = await self._get_libray_item_batch(item_ids=item_ids)
+        if not data:
+            return []
+        return LibraryItemsBatchPodcastResponse.from_json(data).library_items
+
+    # batch delete, update, quick match