yaylib 2.1.0__tar.gz → 2.2.1__tar.gz

{yaylib-2.1.0 → yaylib-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yaylib
-Version: 2.1.0
+Version: 2.2.1
 Summary: Yay! API client SDK
 License: MIT
 Keywords: Yay!,yay-api,Yay! API

{yaylib-2.1.0 → yaylib-2.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "yaylib"
-version = "2.1.0"
+version = "2.2.1"
 description = "Yay! API client SDK"
 authors = ["ekkx"]
 license = "MIT"

{yaylib-2.1.0 → yaylib-2.2.1}/yaylib/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.1.0"
+__version__ = "2.2.1"
 
 # import apis into sdk package
 from yaylib.api.activities_api import ActivitiesApi

{yaylib-2.1.0 → yaylib-2.2.1}/yaylib/_config.py

@@ -12,6 +12,14 @@ DEFAULT_API_KEY = (
     "ccd59ee269c01511ba763467045c115779fcae3050238a252f1bd1a4b65cfec6"
 )
 
+# API key used by the browser-login fallback. When the primary email
+# login is rejected with a plain "unauthorized", the client retries
+# against POST /v2/users/login_with_email, which validates against this
+# key instead of DEFAULT_API_KEY. Set web_api_key="" to disable.
+DEFAULT_WEB_API_KEY = (
+    "e9f1ae4c4470f29a92c0168dc42b13637cc332692103f23e626bc2b016f66603"
+)
+
 # HS256 key used by signed_version and X-Jwt.
 DEFAULT_API_VERSION_KEY = "34c8c1cdf29b46a492e8ec58e6db37ec"
 

{yaylib-2.1.0 → yaylib-2.2.1}/yaylib/api/calls_api.py

@@ -23,6 +23,7 @@ from yaylib.models.call_action_signature_response import CallActionSignatureResp
 from yaylib.models.call_gift_history_response import CallGiftHistoryResponse
 from yaylib.models.call_status_response import CallStatusResponse
 from yaylib.models.conference_call_response import ConferenceCallResponse
+from yaylib.models.joinable_by import JoinableBy
 from yaylib.models.rtm_token_response import RtmTokenResponse
 from yaylib.models.user_response import UserResponse
 from yaylib.models.users_by_timestamp_response import UsersByTimestampResponse
@@ -4495,7 +4496,7 @@ class CallsApi:
         call_id: StrictInt,
         category_id: Optional[StrictStr] = None,
         game_title: Optional[StrictStr] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -4519,7 +4520,7 @@ class CallsApi:
         :param game_title:
         :type game_title: str
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -4573,7 +4574,7 @@ class CallsApi:
         call_id: StrictInt,
         category_id: Optional[StrictStr] = None,
         game_title: Optional[StrictStr] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -4597,7 +4598,7 @@ class CallsApi:
         :param game_title:
         :type game_title: str
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -4651,7 +4652,7 @@ class CallsApi:
         call_id: StrictInt,
         category_id: Optional[StrictStr] = None,
         game_title: Optional[StrictStr] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -4675,7 +4676,7 @@ class CallsApi:
         :param game_title:
         :type game_title: str
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of

{yaylib-2.1.0 → yaylib-2.2.1}/yaylib/api/chat_rooms_api.py

@@ -18,6 +18,7 @@ from typing_extensions import Annotated
 
 from pydantic import StrictBool, StrictInt, StrictStr
 from typing import List, Optional
+from yaylib.models.call_type import CallType
 from yaylib.models.chat_room_response import ChatRoomResponse
 from yaylib.models.chat_rooms_response import ChatRoomsResponse
 from yaylib.models.create_chat_room_response import CreateChatRoomResponse
@@ -5551,7 +5552,7 @@ class ChatRoomsApi:
         self,
         id: StrictInt,
         attachment_file_name: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         font_size: Optional[StrictInt] = None,
         gif_image_id: Optional[StrictInt] = None,
         message_type: Optional[MessageType] = None,
@@ -5581,7 +5582,7 @@ class ChatRoomsApi:
         :param attachment_file_name:
         :type attachment_file_name: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param font_size:
         :type font_size: int
         :param gif_image_id:
@@ -5657,7 +5658,7 @@ class ChatRoomsApi:
         self,
         id: StrictInt,
         attachment_file_name: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         font_size: Optional[StrictInt] = None,
         gif_image_id: Optional[StrictInt] = None,
         message_type: Optional[MessageType] = None,
@@ -5687,7 +5688,7 @@ class ChatRoomsApi:
         :param attachment_file_name:
         :type attachment_file_name: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param font_size:
         :type font_size: int
         :param gif_image_id:
@@ -5763,7 +5764,7 @@ class ChatRoomsApi:
         self,
         id: StrictInt,
         attachment_file_name: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         font_size: Optional[StrictInt] = None,
         gif_image_id: Optional[StrictInt] = None,
         message_type: Optional[MessageType] = None,
@@ -5793,7 +5794,7 @@ class ChatRoomsApi:
         :param attachment_file_name:
         :type attachment_file_name: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param font_size:
         :type font_size: int
         :param gif_image_id:

{yaylib-2.1.0 → yaylib-2.2.1}/yaylib/api/posts_api.py

@@ -18,8 +18,10 @@ from typing_extensions import Annotated
 
 from pydantic import StrictBool, StrictInt, StrictStr
 from typing import Any, Dict, List, Optional
+from yaylib.models.call_type import CallType
 from yaylib.models.create_post_response import CreatePostResponse
 from yaylib.models.gift_transactions_response import GiftTransactionsResponse
+from yaylib.models.joinable_by import JoinableBy
 from yaylib.models.like_posts_response import LikePostsResponse
 from yaylib.models.noreply_mode import NoreplyMode
 from yaylib.models.post import Post
@@ -63,13 +65,13 @@ class PostsApi:
         attachment_8_filename: Optional[StrictStr] = None,
         attachment_9_filename: Optional[StrictStr] = None,
         attachment_filename: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         category_id: Optional[StrictInt] = None,
         color: Optional[StrictInt] = None,
         font_size: Optional[StrictInt] = None,
         game_title: Optional[StrictStr] = None,
         group_id: Optional[StrictInt] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         language: Optional[StrictStr] = None,
         message_tags: Optional[Dict[str, Any]] = None,
         signed_info: Optional[StrictStr] = None,
@@ -113,7 +115,7 @@ class PostsApi:
         :param attachment_filename:
         :type attachment_filename: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param category_id:
         :type category_id: int
         :param color:
@@ -125,7 +127,7 @@ class PostsApi:
         :param group_id:
         :type group_id: int
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param language:
         :type language: str
         :param message_tags:
@@ -217,13 +219,13 @@ class PostsApi:
         attachment_8_filename: Optional[StrictStr] = None,
         attachment_9_filename: Optional[StrictStr] = None,
         attachment_filename: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         category_id: Optional[StrictInt] = None,
         color: Optional[StrictInt] = None,
         font_size: Optional[StrictInt] = None,
         game_title: Optional[StrictStr] = None,
         group_id: Optional[StrictInt] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         language: Optional[StrictStr] = None,
         message_tags: Optional[Dict[str, Any]] = None,
         signed_info: Optional[StrictStr] = None,
@@ -267,7 +269,7 @@ class PostsApi:
         :param attachment_filename:
         :type attachment_filename: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param category_id:
         :type category_id: int
         :param color:
@@ -279,7 +281,7 @@ class PostsApi:
         :param group_id:
         :type group_id: int
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param language:
         :type language: str
         :param message_tags:
@@ -371,13 +373,13 @@ class PostsApi:
         attachment_8_filename: Optional[StrictStr] = None,
         attachment_9_filename: Optional[StrictStr] = None,
         attachment_filename: Optional[StrictStr] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         category_id: Optional[StrictInt] = None,
         color: Optional[StrictInt] = None,
         font_size: Optional[StrictInt] = None,
         game_title: Optional[StrictStr] = None,
         group_id: Optional[StrictInt] = None,
-        joinable_by: Optional[StrictStr] = None,
+        joinable_by: Optional[JoinableBy] = None,
         language: Optional[StrictStr] = None,
         message_tags: Optional[Dict[str, Any]] = None,
         signed_info: Optional[StrictStr] = None,
@@ -421,7 +423,7 @@ class PostsApi:
         :param attachment_filename:
         :type attachment_filename: str
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param category_id:
         :type category_id: int
         :param color:
@@ -433,7 +435,7 @@ class PostsApi:
         :param group_id:
         :type group_id: int
         :param joinable_by:
-        :type joinable_by: str
+        :type joinable_by: JoinableBy
         :param language:
         :type language: str
         :param message_tags:
@@ -2436,7 +2438,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
         _request_timeout: Union[
@@ -2462,7 +2464,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param exclude_recent_gomimushi:
@@ -2522,7 +2524,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
         _request_timeout: Union[
@@ -2548,7 +2550,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param exclude_recent_gomimushi:
@@ -2608,7 +2610,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
         _request_timeout: Union[
@@ -2634,7 +2636,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param exclude_recent_gomimushi:
@@ -2728,7 +2730,7 @@ class PostsApi:
             
         if call_type is not None:
             
-            _query_params.append(('call_type', call_type))
+            _query_params.append(('call_type', call_type.value))
             
         if include_circle_call is not None:
             
@@ -2781,7 +2783,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         cross_generation: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
@@ -2810,7 +2812,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param cross_generation:
@@ -2875,7 +2877,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         cross_generation: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
@@ -2904,7 +2906,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param cross_generation:
@@ -2969,7 +2971,7 @@ class PostsApi:
         from_timestamp: Optional[StrictInt] = None,
         number: Optional[StrictInt] = None,
         category_id: Optional[StrictInt] = None,
-        call_type: Optional[StrictStr] = None,
+        call_type: Optional[CallType] = None,
         include_circle_call: Optional[StrictBool] = None,
         cross_generation: Optional[StrictBool] = None,
         exclude_recent_gomimushi: Optional[StrictBool] = None,
@@ -2998,7 +3000,7 @@ class PostsApi:
         :param category_id:
         :type category_id: int
         :param call_type:
-        :type call_type: str
+        :type call_type: CallType
         :param include_circle_call:
         :type include_circle_call: bool
         :param cross_generation:
@@ -3102,7 +3104,7 @@ class PostsApi:
             
         if call_type is not None:
             
-            _query_params.append(('call_type', call_type))
+            _query_params.append(('call_type', call_type.value))
             
         if include_circle_call is not None:
             

yaylib-2.2.1/yaylib/auth.py

@@ -0,0 +1,236 @@
+# PORTING.md §6: login_with_email is the ONLY wrapped auth endpoint —
+# it is the cache boundary, so "log in or use the cached session" is one
+# call. Other auth-flow body endpoints (create_user, edit_user,
+# login_with_sns, oauth token / refresh) stay as plain calls on the
+# generated API classes; wrapping each would multiply surface without
+# changing behaviour.
+
+from __future__ import annotations
+
+import json
+from typing import Optional
+
+from yaylib._error_codes import ErrCodeUnauthorized
+from yaylib.errors import as_api_error, code_of
+from yaylib.exceptions import ApiException
+from yaylib.models.login_email_user_request import LoginEmailUserRequest
+from yaylib.models.login_user_response import LoginUserResponse
+from yaylib.session import NoSessionError, Session, SessionSaveFailed
+
+
+async def login_with_email(
+    client,
+    *,
+    email: str,
+    password: str,
+    api_key: Optional[str] = None,
+    uuid: Optional[str] = None,
+    two_fa_code: Optional[str] = None,
+    no_cache: bool = False,
+) -> LoginUserResponse:
+    """Wrapped login with transparent session caching, called with
+    keyword arguments — the same call shape as every other generated
+    Python operation, not a builder. The generated layer accepts only a
+    single ``login_email_user_request`` body; this wrapper takes the
+    fields directly and auto-fills api_key / uuid from the client.
+    ``no_cache=True`` forces a fresh HTTP login.
+    """
+    return await _execute_login(
+        client,
+        email=email,
+        password=password,
+        api_key=api_key,
+        uuid=uuid,
+        two_fa_code=two_fa_code,
+        bypass_cache=no_cache,
+    )
+
+
+def _synthesize_login_response(session: Session) -> LoginUserResponse:
+    # Same shape regardless of cache hit vs. miss. Fields the server
+    # returns but the cache doesn't carry default to None.
+    return LoginUserResponse(
+        access_token=session.access_token,
+        refresh_token=session.refresh_token,
+        user_id=session.user_id,
+    )
+
+
+def _activate_cached_session(client, session: Session) -> None:
+    client.set_tokens(session.access_token, session.refresh_token)
+    if session.device_uuid:
+        client.set_device_uuid(session.device_uuid)
+    client.set_login_identity(session.email, session.user_id)
+    # Restore which key refreshes this session (empty → app key) so a
+    # cached web session refreshes with the web key after a restart.
+    client.set_oauth_key(session.oauth_key)
+
+
+async def _login_with_email_web(
+    client,
+    *,
+    email: str,
+    password: str,
+    uuid: str,
+    two_fa_code: Optional[str],
+) -> Optional[LoginUserResponse]:
+    """Fallback login against the browser endpoint (POST
+    /v2/users/login_with_email) using the client's ``web_api_key``.
+
+    Sent through the UNWRAPPED transport (``send_unwrapped``): no header
+    injection, no Bearer, no 401 refresh — a login must authenticate
+    purely by its body credentials (PORTING.md §6.1/§6.2). Only the
+    body's api_key and the endpoint version differ from the app login.
+
+    Returns the decoded response on success, or ``None`` when the
+    fallback is itself rejected (non-2xx) so the caller surfaces the
+    primary error. Raises an ``ApiException`` carrying the raw body when
+    a 2xx response fails to decode (§15), rather than masking it behind
+    the primary 401.
+    """
+    payload = {
+        "email": email,
+        "password": password,
+        "api_key": client.web_api_key,
+        "uuid": uuid,
+    }
+    if two_fa_code:
+        payload["two_fa_code"] = two_fa_code
+
+    # Present as the browser client. The web version string is not
+    # otherwise known to the SDK, so app_version stands in for it.
+    web_ua = (
+        "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) "
+        "AppleWebKit/537.36 (KHTML, like Gecko) "
+        "Chrome/120.0.0.0 Safari/537.36"
+    )
+    headers = {
+        "Content-Type": "application/json;charset=UTF-8",
+        "User-Agent": web_ua,
+        "Agent": f"YayWeb {client.app_version}",
+        "X-Device-Info": f"Yay {client.app_version} Web ({web_ua})",
+    }
+    url = f"{client.base_url}/v2/users/login_with_email"
+    try:
+        res = await client._transport.send_unwrapped(
+            "POST", url, headers, json.dumps(payload)
+        )
+    except Exception:  # noqa: BLE001
+        return None
+    if not (200 <= res.status <= 299):
+        return None
+    raw = res.data.decode("utf-8", "replace")
+    try:
+        return LoginUserResponse.from_json(raw)
+    except Exception as err:  # noqa: BLE001
+        # A 2xx we couldn't decode is a genuine login result: surface it
+        # with the raw body, not the primary 401.
+        raise ApiException(status=res.status, reason=res.reason, body=raw) from err
+
+
+async def _execute_login(
+    client,
+    *,
+    email: str,
+    password: str,
+    api_key: Optional[str],
+    uuid: Optional[str],
+    two_fa_code: Optional[str],
+    bypass_cache: bool,
+) -> LoginUserResponse:
+    if not email or not password:
+        raise ValueError(
+            "yaylib: login_with_email requires email and password"
+        )
+
+    # Cache lookup — only with a session store configured and no
+    # no_cache opt-out.
+    if client.session_store is not None and not bypass_cache:
+        try:
+            cached = await client.session_store.load(email)
+        except NoSessionError:
+            cached = None  # cache miss → fall through to HTTP login
+        # Any other error (rate-limit, disk failure) propagates: the
+        # caller must not silently drop it on the wire-bound load path.
+        if cached is not None:
+            _activate_cached_session(client, cached)
+            return _synthesize_login_response(cached)
+
+    login_key = api_key or client.api_key
+    body = LoginEmailUserRequest(
+        api_key=login_key,
+        email=email,
+        password=password,
+        uuid=uuid or client.device_uuid,
+        two_f_a_code=two_fa_code,
+    )
+    # The key that establishes the session also refreshes its tokens;
+    # the fallback switches it to web_api_key below.
+    oauth_key = login_key
+
+    try:
+        resp = await client.users_api.login_with_email(
+            login_email_user_request=body
+        )
+    except Exception as err:  # noqa: BLE001
+        api_err = as_api_error(err)
+        # Fallback (PORTING.md §6.2): a plain "unauthorized" retries
+        # against the browser login endpoint with web_api_key. Skipped
+        # for other 401s — notably Required2FA (the caller must supply a
+        # code, not switch keys) — and when the caller pinned a specific
+        # api_key, or when web_api_key is empty (the off switch).
+        caller_pinned = api_key is not None and api_key != client.api_key
+        if (
+            client.web_api_key
+            and not caller_pinned
+            and code_of(api_err) == ErrCodeUnauthorized
+        ):
+            fallback = await _login_with_email_web(
+                client,
+                email=email,
+                password=password,
+                uuid=uuid or client.device_uuid,
+                two_fa_code=two_fa_code,
+            )
+            if fallback is None:
+                # Fallback itself rejected: surface the primary error.
+                raise api_err
+            client._logger.debug(
+                "web login fallback ok",
+                extra={"event": "login_fallback", "outcome": "ok"},
+            )
+            resp = fallback
+            # This session was established with the web key, so its token
+            # refresh must use it too.
+            oauth_key = client.web_api_key
+        else:
+            raise api_err
+
+    access = resp.access_token or ""
+    refresh = resp.refresh_token or ""
+    user_id = resp.user_id or 0
+    client.set_tokens(access, refresh)
+    client.set_login_identity(email, user_id)
+    client.set_oauth_key(oauth_key)
+
+    if client.session_store is not None:
+        session = Session(
+            email=email,
+            user_id=user_id,
+            access_token=access,
+            refresh_token=refresh,
+            device_uuid=client.device_uuid,
+            oauth_key=client._session_oauth_key(),
+            updated_at="",
+        )
+        try:
+            await client.session_store.save(session)
+        except SessionSaveFailed:
+            raise
+        except Exception as err:  # noqa: BLE001
+            # PORTING.md §5: persist failure here surfaces as
+            # SessionSaveFailed, but the tokens are already active so the
+            # caller can choose to proceed.
+            raise SessionSaveFailed(err)
+
+    return resp