yaylib 0.0.0__py3-none-any.whl

yaylib/__init__.py

@@ -0,0 +1,39 @@
+"""
+
+Yay! (nanameue, Inc.) API Client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A powerful API wrapper for Yay! (yay.space) written in Python.
+
+:copyright: (c) 2023 ekkx
+:license: MIT, see LICENSE for more details.
+
+https://github.com/ekkx/yaylib
+
+"""
+
+__title__ = "yaylib"
+__author__ = "ekkx"
+__license__ = "MIT"
+__copyright__ = "Copyright (c) 2023 ekkx"
+__version__ = "1.5.0.dev4"
+
+from .client import Client
+from .constants import *
+from .errors import *
+from .models import *
+from .responses import *
+from .state import State
+from .utils import mention
+from .ws import *
+
+__all__ = (
+    "Client",
+    "constants",
+    "errors",
+    "models",
+    "responses",
+    "State",
+    "mention",
+    "ws",
+)

yaylib/api/__init__.py

@@ -0,0 +1,37 @@
+"""
+
+Yay! (nanameue, Inc.) API Client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A powerful API wrapper for Yay! (yay.space) written in Python.
+
+:copyright: (c) 2023 ekkx
+:license: MIT, see LICENSE for more details.
+
+https://github.com/ekkx/yaylib
+
+"""
+
+from .auth import *
+from .call import *
+from .chat import *
+from .group import *
+from .misc import *
+from .notification import *
+from .post import *
+from .review import *
+from .thread import *
+from .user import *
+
+__all__ = [
+    "auth",
+    "call",
+    "chat",
+    "group",
+    "misc",
+    "notification",
+    "post",
+    "review",
+    "thread",
+    "user",
+]

yaylib/api/auth.py

@@ -0,0 +1,231 @@
+"""
+MIT License
+
+Copyright (c) 2023 ekkx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from datetime import datetime
+from typing import Optional
+
+from cryptography import fernet
+
+from .. import config
+from ..responses import LoginUpdateResponse, LoginUserResponse, Response, TokenResponse
+from ..state import LocalUser
+from ..utils import md5
+
+
+class AuthApi:
+    """認証 API
+
+    Args:
+        client (Client):
+    """
+
+    def __init__(self, client) -> None:
+        # pylint: disable=import-outside-toplevel
+        from ..client import Client
+
+        self.__client: Client = client
+
+    async def change_email(self, **params) -> LoginUpdateResponse:
+        """メールアドレスを変更する
+
+        Args:
+            email (str):
+            password (str):
+            email_grant_token (str, optional):
+
+        Returns:
+            LoginUpdateResponse:
+        """
+        return await self.__client.request(
+            "PUT",
+            config.API_HOST + "/v1/users/change_email",
+            json=params,
+            return_type=LoginUpdateResponse,
+        )
+
+    async def change_password(self, **params) -> LoginUpdateResponse:
+        """パスワードを変更する
+
+        Args:
+            current_password (str):
+            new_password (str):
+
+        Returns:
+            LoginUpdateResponse:
+        """
+        return await self.__client.request(
+            "PUT",
+            config.API_HOST + "/v1/users/change_email",
+            json=params,
+            return_type=LoginUpdateResponse,
+        )
+
+    async def get_token(self, **params) -> TokenResponse:
+        """認証トークンを取得する
+
+        Args:
+            grant_type (str):
+            refresh_token (str, optional):
+            email (str, optional):
+            password (str, optional):
+
+        Returns:
+            TokenResponse:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/api/v1/oauth/token",
+            json=params,
+            return_type=TokenResponse,
+        )
+
+    async def login(
+        self, email: str, password: str, two_fa_code: Optional[str] = None
+    ) -> LoginUserResponse:
+        """メールアドレスでログインする
+
+        Args:
+            email (str):
+            password (str):
+            two_fa_code (str, optional):
+
+        Returns:
+            LoginUserResponse:
+        """
+        if not self.__client.state.has_encryption_key():
+            self.__client.state.set_encryption_key(password)
+
+        user = self.__client.state.get_user_by_email(email)
+        if user is not None:
+            try:
+                self.__client.state.set_user(self.__client.state.decrypt(user))
+            except fernet.InvalidToken as exc:
+                self.__client.state.destory(user.user_id)
+                self.__client.logger.error(
+                    # pylint: disable=line-too-long
+                    "Failed to decrypt the credentials stored locally. This might be due to a recent password change. Please try logging in again."
+                )
+                raise exc
+
+            self.__client.logger.info(
+                f"User found in local storage - UID: {user.user_id}"
+            )
+
+            return LoginUserResponse(
+                {
+                    "access_token": self.__client.access_token,
+                    "refresh_token": self.__client.refresh_token,
+                    "user_id": self.__client.user_id,
+                }
+            )
+
+        payload = {
+            "api_key": config.API_KEY,
+            "email": email,
+            "password": password,
+            "uuid": self.__client.device_uuid,
+        }
+        if two_fa_code is not None:
+            payload["two_fa_code"] = two_fa_code
+
+        response: LoginUserResponse = await self.__client.request(
+            "POST",
+            config.API_HOST + "/v3/users/login_with_email",
+            json=payload,
+            return_type=LoginUserResponse,
+        )
+
+        self.__client.state.set_user(
+            LocalUser(
+                user_id=response.user_id,
+                email=email,
+                device_uuid=self.__client.device_uuid,
+                access_token=response.access_token,
+                refresh_token=response.refresh_token,
+            )
+        )
+        self.__client.state.save()
+
+        self.__client.logger.info(
+            f"Authentication successful! - UID: {response.user_id}"
+        )
+
+        return response
+
+    async def resend_confirm_email(self) -> Response:
+        """確認メールを再送信する
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v2/users/resend_confirm_email",
+            return_type=Response,
+        )
+
+    async def restore_user(self, **params) -> LoginUserResponse:
+        """ユーザーを復元する
+
+        Args:
+            user_id (int):
+
+        Returns:
+            LoginUserResponse:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v2/users/restore",
+            json={
+                "api_key": config.API_KEY,
+                "uuid": self.__client.device_uuid,
+                "timestamp": int(datetime.now().timestamp()),
+                "signed_info": md5(
+                    self.__client.device_uuid,
+                    int(datetime.now().timestamp()),
+                    False,
+                ),
+            }.update(params),
+        )
+
+    async def save_account_with_email(self, **params) -> LoginUpdateResponse:
+        """メールアドレスでアカウントを保存する
+
+        Args:
+            email (str):
+            password (str, optional):
+            current_password (str, optional):
+            email_grant_token (str, optional):
+
+        Returns:
+            LoginUpdateResponse:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v3/users/login_update",
+            json={
+                "api_key": config.API_KEY,
+            }.update(params),
+            return_type=LoginUpdateResponse,
+        )

yaylib/api/call.py

@@ -0,0 +1,360 @@
+"""
+MIT License
+
+Copyright (c) 2023 ekkx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from typing import List
+
+from .. import config
+from ..responses import (
+    BgmsResponse,
+    CallActionSignatureResponse,
+    CallStatusResponse,
+    ConferenceCallResponse,
+    GamesResponse,
+    GenresResponse,
+    PostResponse,
+    PostsResponse,
+    Response,
+    UsersByTimestampResponse,
+)
+
+
+class CallApi:
+    """通話 API"""
+
+    def __init__(self, client) -> None:
+        # pylint: disable=import-outside-toplevel
+        from ..client import Client
+
+        self.__client: Client = client
+
+    async def get_user_active_call(self, user_id: int) -> PostResponse:
+        """ユーザーが参加中の通話を取得する
+
+        Args:
+            user_id (int):
+
+        Returns:
+            PostResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + "/v1/posts/active_call",
+            params={"user_id": user_id},
+            return_type=PostResponse,
+        )
+
+    async def get_bgms(self) -> BgmsResponse:
+        """通話のBGMを取得する
+
+        Returns:
+            BgmsResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + "/v1/calls/bgm",
+            return_type=BgmsResponse,
+        )
+
+    async def get_call(self, call_id: int) -> ConferenceCallResponse:
+        """通話を取得する
+
+        Args:
+            call_id (int):
+
+        Returns:
+            ConferenceCallResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + f"/v1/calls/conferences/{call_id}",
+            return_type=ConferenceCallResponse,
+        )
+
+    async def get_call_invitable_users(
+        self, call_id: int, **params
+    ) -> UsersByTimestampResponse:
+        """通話に招待可能なユーザーを取得する
+
+        Args:
+            call_id (int):
+            from_timestamp (int, optional):
+
+        Returns:
+            UsersByTimestampResponse:
+        """
+        # @Nullable @Query("user[nickname]")
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + f"/v1/calls/{call_id}/users/invitable",
+            params=params,
+            return_type=UsersByTimestampResponse,
+        )
+
+    async def get_call_status(self, opponent_id: int) -> CallStatusResponse:
+        """通話の状態を取得します
+
+        Args:
+            opponent_id (int):
+
+        Returns:
+            CallStatusResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + f"/v1/calls/phone_status/{opponent_id}",
+            return_type=CallStatusResponse,
+        )
+
+    async def get_games(self, **params) -> GamesResponse:
+        """通話に設定可能なゲームを取得する
+
+        Args:
+            number (int, optional):
+            ids (List[int], optional):
+            from_id (int, optional):
+
+        Returns:
+            GamesResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + "/v1/games/apps",
+            params=params,
+            return_type=GamesResponse,
+        )
+
+    async def get_genres(self, **params) -> GenresResponse:
+        """通話のジャンルを取得する
+
+        Args:
+            number (int, optional):
+            from (int, optional):
+
+        Returns:
+            GenresResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + "/v1/genres",
+            params=params,
+            return_type=GenresResponse,
+        )
+
+    async def get_group_calls(self, **params) -> PostsResponse:
+        """サークル内の通話を取得する
+
+        Args:
+            number (int, optional):
+            group_category_id (int, optional):
+            from_timestamp (int, optional):
+            scope (str, optional):
+
+        Returns:
+            PostsResponse:
+        """
+        return await self.__client.request(
+            "GET",
+            config.API_HOST + "/v1/posts/group_calls",
+            params=params,
+            return_type=PostsResponse,
+        )
+
+    async def invite_online_followings_to_call(
+        self, call_id: int, **params
+    ) -> Response:
+        """オンラインの友達をまとめて通話に招待します
+
+        Args:
+            call_id (int, optional):
+            group_id (str, optional):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + f"/v1/calls/{call_id}/bulk_invite",
+            params=params,
+            return_type=Response,
+        )
+
+    async def invite_users_to_call(self, call_id: int, user_ids: List[int]) -> Response:
+        """通話に複数のユーザーを招待する
+
+        Args:
+            call_id (int):
+            user_ids (List[int]):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + f"/v1/calls/conference_calls/{call_id}/invite",
+            payload={"call_id": call_id, "user_ids": user_ids},
+            return_type=Response,
+        )
+
+    async def invite_users_to_chat_call(self, **params) -> Response:
+        """ユーザーをチャット通話に招待する
+
+        Args:
+            chat_room_id (int):
+            room_id (int):
+            room_url (str):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v2/calls/invite",
+            payload=params,
+            return_type=Response,
+        )
+
+    async def kick_user_from_call(
+        self, call_id: int, **params
+    ) -> CallActionSignatureResponse:
+        """ユーザーを通話からキックする
+
+        Args:
+            call_id (int):
+            uuid (int):
+            ban (bool):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + f"/v3/calls/conference_calls/{call_id}/kick",
+            payload=params,
+            return_type=CallActionSignatureResponse,
+        )
+
+    async def start_call(self, call_id: int, **params) -> Response:
+        """通話を開始する
+
+        Args:
+            call_id (int):
+            joinable_by (str):
+            game_title (str, optional):
+            category_id (str, optional):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "PUT",
+            config.API_HOST + f"/v1/calls/{call_id}",
+            payload=params,
+            return_type=Response,
+        )
+
+    async def set_user_role(self, call_id: int, user_id: int, role: str) -> Response:
+        """通話の参加者に役職を付与する
+
+        Args:
+            call_id (int):
+            user_id (int):
+            role (str):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "PUT",
+            config.API_HOST + f"/v1/calls/{call_id}/users/{user_id}",
+            payload={"role": role},
+            return_type=Response,
+        )
+
+    async def join_call(self, **params) -> ConferenceCallResponse:
+        """通話に参加する
+
+        Args:
+            conference_id (int):
+            call_sid (str, optional):
+
+        Returns:
+            ConferenceCallResponse:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v1/calls/start_conference_call",
+            payload=params,
+            return_type=ConferenceCallResponse,
+        )
+
+    async def leave_call(self, **params) -> Response:
+        """通話から退出する
+
+        Args:
+            conference_id (int):
+            call_sid (str, optional):
+
+        Returns:
+            Response:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v1/calls/leave_conference_call",
+            payload=params,
+            return_type=Response,
+        )
+
+    async def join_call_as_anonymous(self, **params) -> ConferenceCallResponse:
+        """匿名で通話に参加する
+
+        Args:
+            conference_id (int):
+            agora_uid (str):
+
+        Returns:
+            ConferenceCallResponse:
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v1/anonymous_calls/start_conference_call",
+            payload=params,
+            return_type=ConferenceCallResponse,
+        )
+
+    async def leave_call_as_anonymous(self, **params) -> Response:
+        """匿名で参加した通話を退出する
+
+        Args:
+            conference_id (int):
+            agora_uid (str, optional):
+
+        Returns:
+            Response: _description_
+        """
+        return await self.__client.request(
+            "POST",
+            config.API_HOST + "/v1/anonymous_calls/leave_conference_call",
+            payload=params,
+            return_type=Response,
+        )