v0.2.3

- Добавлена авторизация напрямую через логин и пароль от "Моей Школы" - Исправлена обработка ошибок от API - Добавлены 3 новых метода в Mobile API "Моей школы" и соответственно типы для них
OctoDiary · Sep 21, 2023 · d79385c · d79385c
1 parent d2a842e
commit d79385c
Show file tree

Hide file tree

Showing 10 changed files with 316 additions and 5 deletions.
diff --git a/octodiary/__init__.py b/octodiary/__init__.py
@@ -12,7 +12,7 @@
 #        https://opensource.org/licenses/MIT
 #           https://github.com/OctoDiary
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 
 from . import asyncApi, syncApi, exceptions, types
 

diff --git a/octodiary/asyncApi/base.py b/octodiary/asyncApi/base.py
@@ -12,6 +12,7 @@
 #        https://opensource.org/licenses/MIT
 #           https://github.com/OctoDiary
 
+from json import JSONDecodeError
 from typing import Optional
 
 import aiohttp
@@ -63,7 +64,7 @@ async def _check_response(response: aiohttp.ClientResponse):
                         description=json_response.get("description", None),
                         details=json_response.get("details", None),
                     )
-            except:
+            except JSONDecodeError:
                 raise APIError(
                     url=str(response.url),
                     status_code=response.status,

diff --git a/octodiary/asyncApi/myschool/mobile.py b/octodiary/asyncApi/myschool/mobile.py
@@ -36,7 +36,11 @@
     SubjectMarksForSubject,
     UserChildrens,
     UserSettings,
+    RatingRankClass,
+    RatingRankSubject,
+    RatingRankShort,
 )
+from octodiary.types.myschool.web import SessionUserInfo
 
 from ..base import AsyncBaseApi
 
@@ -46,6 +50,31 @@ class AsyncMobileAPI(AsyncBaseApi):
     Async Mobile API class wrapper.
     """
 
+    async def login(self, username: str, password: str) -> str:
+        """Авторизоваться и получить токен напрямую через обычный логин и пароль."""
+        return (
+            await self.get(
+                url="https://authedu.mosreg.ru/v3/auth/kauth/callback",
+                required_token=False, return_raw_response=True,
+                params={
+                    "code": (
+                        await self.post(
+                            url="https://authedu.mosreg.ru/lms/api/sessions",
+                            required_token=False,
+                            json={
+                                "login": username,
+                                "password_plain": password
+                            },
+                            model=SessionUserInfo,
+                            custom_headers={
+                                "Accept": "application/json"
+                            }
+                        )
+                    ).authentication_token
+                }
+            )
+        ).cookies.get("aupd_token").value
+
     async def handle_action(self, response: ClientResponse, action: str = None, failed: str = None) -> str | bool:
         match action or failed:
             case None:
@@ -492,3 +521,77 @@ async def get_lesson_schedule_items(
             },
             model=LessonScheduleItems
         )
+
+    async def get_rating_rank_class(
+        self,
+        profile_id: int,
+        person_id: str,
+        classUnitId: int,
+        date: date = None
+    ) -> list[RatingRankClass]:
+        """
+        Получить общий рейтинг класса
+        """
+        return await self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/class",
+            model=RatingRankClass, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "person_id": person_id,
+                "classUnitId": classUnitId,
+                "date": self.date_to_string(date)
+            }
+        )
+
+    async def get_raging_rank_short(
+        self,
+        profile_id: int,
+        person_id: str,
+        begin_date: date,
+        end_date: date
+    ) -> list[RatingRankShort]:
+        """
+        Получить общий рейтинг класса
+        """
+        return await self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/class",
+            model=RatingRankShort, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "person_id": person_id,
+                "beginDate": self.date_to_string(begin_date),
+                "endDate": self.date_to_string(end_date),
+            }
+        )
+
+    async def get_rating_rank_subjects(
+        self,
+        profile_id: int,
+        person_id: str,
+        date: date
+    ) -> list[RatingRankSubject]:
+        """
+        Получить рейтинг по предметам
+        """
+        return await self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/subject",
+            model=RatingRankSubject, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "personId": person_id,
+                "date": self.date_to_string(date),
+            }
+        )
+
diff --git a/octodiary/asyncApi/myschool/web.py b/octodiary/asyncApi/myschool/web.py
@@ -43,6 +43,31 @@ class AsyncWebAPI(AsyncBaseApi):
     Async Web API class wrapper.
     """
 
+    async def login(self, username: str, password: str) -> str:
+        """Авторизоваться и получить токен напрямую через обычный логин и пароль."""
+        return (
+            await self.get(
+                url="https://authedu.mosreg.ru/v3/auth/kauth/callback",
+                required_token=False, return_raw_response=True,
+                params={
+                    "code": (
+                        await self.post(
+                            url="https://authedu.mosreg.ru/lms/api/sessions",
+                            required_token=False,
+                            json={
+                                "login": username,
+                                "password_plain": password
+                            },
+                            model=SessionUserInfo,
+                            custom_headers={
+                                "Accept": "application/json"
+                            }
+                        )
+                    ).authentication_token
+                }
+            )
+        ).cookies.get("aupd_token").value
+
     async def handle_action(self, response: ClientResponse, action: str = None, failed: str = None) -> str | bool:
         match action or failed:
             case None:

diff --git a/octodiary/syncApi/base.py b/octodiary/syncApi/base.py
@@ -159,7 +159,7 @@ def _check_response(response: requests.Response):
                         description=json_response.get("description", None),
                         details=json_response.get("details", None),
                     )
-            except:
+            except requests.exceptions.JSONDecodeError:
                 raise APIError(
                     url=str(response.url),
                     status_code=response.status_code,

diff --git a/octodiary/syncApi/myschool/mobile.py b/octodiary/syncApi/myschool/mobile.py
@@ -37,7 +37,11 @@
     SubjectMarksForSubject,
     UserChildrens,
     UserSettings,
+    RatingRankClass,
+    RatingRankSubject,
+    RatingRankShort
 )
+from octodiary.types.myschool.web import SessionUserInfo
 
 from ..base import SyncBaseApi
 
@@ -47,6 +51,31 @@ class SyncMobileAPI(SyncBaseApi):
     Sync Mobile API class wrapper.
     """
 
+    def login(self, username: str, password: str) -> str:
+        """Авторизоваться и получить токен напрямую через обычный логин и пароль."""
+        return (
+            self.get(
+                url="https://authedu.mosreg.ru/v3/auth/kauth/callback",
+                required_token=False, return_raw_response=True,
+                params={
+                    "code": (
+                        self.post(
+                            url="https://authedu.mosreg.ru/lms/api/sessions",
+                            required_token=False,
+                            json={
+                                "login": username,
+                                "password_plain": password
+                            },
+                            model=SessionUserInfo,
+                            custom_headers={
+                                "Accept": "application/json"
+                            }
+                        )
+                    ).authentication_token
+                }
+            )
+        ).cookies["aupd_token"]
+
     def handle_action(self, response: Response, action: str = None, failed: str = None) -> str | bool:
         match action or failed:
             case None:
@@ -499,3 +528,77 @@ def get_lesson_schedule_items(
             },
             model=LessonScheduleItems
         )
+
+    def get_rating_rank_class(
+        self,
+        profile_id: int,
+        person_id: str,
+        classUnitId: int,
+        date: date = None
+    ) -> list[RatingRankClass]:
+        """
+        Получить общий рейтинг класса
+        """
+        return self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/class",
+            model=RatingRankClass, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "person_id": person_id,
+                "classUnitId": classUnitId,
+                "date": self.date_to_string(date)
+            }
+        )
+
+    def get_raging_rank_short(
+        self,
+        profile_id: int,
+        person_id: str,
+        begin_date: date,
+        end_date: date
+    ) -> list[RatingRankShort]:
+        """
+        Получить общий рейтинг класса
+        """
+        return self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/class",
+            model=RatingRankShort, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "person_id": person_id,
+                "beginDate": self.date_to_string(begin_date),
+                "endDate": self.date_to_string(end_date),
+            }
+        )
+
+    def get_rating_rank_subjects(
+        self,
+        profile_id: int,
+        person_id: str,
+        date: date
+    ) -> list[RatingRankSubject]:
+        """
+        Получить рейтинг по предметам
+        """
+        return self.get(
+            url="https://authedu.mosreg.ru/api/ej/rating/v1/rank/subject",
+            model=RatingRankSubject, is_list=True,
+            custom_headers={
+                "x-mes-subsystem": "familymp",
+                "client-type": "diary-mobile",
+                "profile-id": profile_id
+            },
+            params={
+                "personId": person_id,
+                "date": self.date_to_string(date),
+            }
+        )
+
diff --git a/octodiary/syncApi/myschool/web.py b/octodiary/syncApi/myschool/web.py
@@ -44,6 +44,31 @@ class SyncWebAPI(SyncBaseApi):
     Sync Web API class wrapper.
     """
 
+    def login(self, username: str, password: str) -> str:
+        """Авторизоваться и получить токен напрямую через обычный логин и пароль."""
+        return (
+            self.get(
+                url="https://authedu.mosreg.ru/v3/auth/kauth/callback",
+                required_token=False, return_raw_response=True,
+                params={
+                    "code": (
+                        self.post(
+                            url="https://authedu.mosreg.ru/lms/api/sessions",
+                            required_token=False,
+                            json={
+                                "login": username,
+                                "password_plain": password
+                            },
+                            model=SessionUserInfo,
+                            custom_headers={
+                                "Accept": "application/json"
+                            }
+                        )
+                    ).authentication_token
+                }
+            )
+        ).cookies["aupd_token"]
+
     def handle_action(self, response: Response, action: str = None, failed: str = None) -> str | bool:
         match action or failed:
             case None:

diff --git a/octodiary/types/model.py b/octodiary/types/model.py
@@ -14,7 +14,7 @@
 
 import json
 import typing
-from datetime import datetime
+from datetime import datetime, date
 from enum import Enum
 
 from pydantic import BaseModel
@@ -25,7 +25,7 @@ class Type(BaseModel):
     def __default__(type: "Type"):
         if isinstance(type, (bytes, typing.Match)):
             return repr(type)
-        elif isinstance(type, (Enum, datetime)):
+        elif isinstance(type, (Enum, datetime, date)):
             return str(type)
 
         return {

diff --git a/octodiary/types/myschool/mobile/__init__.py b/octodiary/types/myschool/mobile/__init__.py
@@ -27,6 +27,8 @@
 from .user_childrens import UserChildrens
 from .user_settings import UserSettings
 from .users_profile_info import ProfileInfo
+from .rating import RatingRankClass, RatingRankShort, RatingRankSubject
+
 
 __all__ = [
     "EventsResponse",
@@ -44,4 +46,7 @@
     "Notification",
     "SubjectMarksForSubject",
     "LessonScheduleItems",
+    "RatingRankClass",
+    "RatingRankShort",
+    "RatingRankSubject"
 ]