Add support for calendar endpoint

Author: vlee489

sendou/client.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Optional, Union
 from datetime import datetime, timedelta
 from aiohttp_client_cache import CacheBackend
-from sendou.models import User, Tournament, Match
+from sendou.models import User, Tournament, Match, CalendarEntry
 from sendou.requests import RequestsClient
 
 
@@ -76,6 +76,21 @@ async def run():
         data = await self.__client.get_response(path)
         return User(data, self.__client)
 
+    async def get_calendar(self, year: str, month: str) -> List[CalendarEntry]:
+        """
+        Get Sendou.ink calendar
+
+        Attributes:
+            year: Year
+            month: Month
+
+        Returns:
+            (List[CalendarEntry]): Calendar Entries
+        """
+        path = CalendarEntry.api_route(year=year, month=month)
+        data = await self.__client.get_response(path)
+        return [CalendarEntry(entry, self.__client) for entry in data]
+
     async def get_tournament(self, tournament_id: str) -> Optional[Tournament]:
         """
         Get Sendou.ink tournament
@@ -88,7 +103,7 @@ async def get_tournament(self, tournament_id: str) -> Optional[Tournament]:
         """
         path = Tournament.api_route(tournament_id=tournament_id)
         data = await self.__client.get_response(path)
-        return Tournament(tournament_id, data, self.__client)
+        return Tournament(int(tournament_id), data, self.__client)
 
     async def get_tournament_matches(self, match_id: str) -> Optional[Match]:
         """

sendou/models/__init__.py

@@ -7,4 +7,5 @@
 from .badge import Badge
 from .plusServer import PlusTiers
 from .stageMapList import Stage, ModeShort, StageWithMode
+from .calendarEntry import CalendarEntry
 

sendou/models/calendarEntry.py

@@ -0,0 +1,58 @@
+from .baseModel import BaseModel
+from sendou.requests import RequestsClient
+from typing import Optional
+from datetime import datetime
+from dateutil import parser
+
+from .tournament import Tournament
+
+
+class CalendarEntry(BaseModel):
+    """
+    Calendar Entry Model
+
+    Attributes:
+        name (str): Event Name
+        tournament_id (int): Tournament ID
+        tournament_url (str): Tournament URL
+        start_time (datetime): Event Start Time
+    """
+    name: str
+    tournament_id: Optional[int]
+    tournament_url: Optional[str]
+    start_time: datetime
+
+    def __init__(self, data: dict, request_client: RequestsClient):
+        super().__init__(data, request_client)
+        self.name = data.get("name", "")
+        self.tournament_id = data.get("tournamentId", None)
+        self.tournament_url = data.get("tournamentUrl", "")
+        self.start_time = parser.parse(data.get("startTime", ""))
+
+    @staticmethod
+    def api_route(**kwargs) -> str:
+        """
+        API Route
+        Args:
+            year (str): Year
+            month (str): Month
+
+        Returns:
+            str: API Route
+        """
+        return f"api/calendar/{kwargs.get('year')}/{kwargs.get('month')}"
+
+    async def get_tournament(self) -> Optional[Tournament]:
+        """
+        Get the tournament for the calendar entry
+        Returns:
+            (Optional[Tournament]): Tournament
+        """
+        if self.tournament_id is None:
+            return None
+        path = Tournament.api_route(tournament_id=self.tournament_id)
+        data = await self._request_client.get_response(path)
+        return Tournament(self.tournament_id, data, self._request_client)
+
+    def __repr__(self):
+        return f"<CalendarEntry name={self.name} | tournament_id={self.tournament_id} | start_time={self.start_time}>"

sendou/models/tournament/tournament.py

@@ -52,14 +52,14 @@ class TournamentBracket(BaseModel):
         type (BracketType): Bracket Type
         name (str): Bracket Name
         _index (int): Bracket Index
-        __tournament_id (str): Tournament ID
+        __tournament_id (int): Tournament ID
     """
     type: BracketType
     name: str
     _index: int
-    __tournament_id: str
+    __tournament_id: int
 
-    def __init__(self, data: dict, index: int, tournament_id: str, request_client: RequestsClient):
+    def __init__(self, data: dict, index: int, tournament_id: int, request_client: RequestsClient):
         """
         Init
         :param data: Raw data from API
@@ -98,15 +98,15 @@ class Tournament(BaseModel):
         teams (TournamentTeamInfo): Tournament Team Info
         brackets (List[TournamentBracket]): Tournament Brackets
     """
-    id: str
+    id: int
     name: str
     url: str
     logo_url: Optional[str]
     start_time: datetime
     teams: TournamentTeamInfo
     brackets: List[TournamentBracket]
 
-    def __init__(self, id: str, data: dict, request_client: RequestsClient):
+    def __init__(self, id: int, data: dict, request_client: RequestsClient):
         """
         Init