Update tests

worthless/launcher.py

@@ -1,28 +1,42 @@
 import aiohttp
 import locale
 from worthless import constants
+from pathlib import Path
+from worthless.classes import launcher
 
 
 class Launcher:
-    def __init__(self):
+    """
+    Contains functions to get information from server and client like the official launcher.
+    """
+
+    def __init__(self, gamedir=Path.cwd()):
+        """Initialize the launcher API
+
+        Args:
+            gamedir (Path): Path to the game directory.
+        """
         self._api = constants.LAUNCHER_API_URL
         self._lang = self._get_system_language()
+        if isinstance(gamedir, str):
+            gamedir = Path(gamedir)
+        self._gamedir = gamedir.resolve()
 
-    # Workaround because miHoYo uses retcode for their API
     @staticmethod
     async def _get(url, **kwargs) -> dict:
+        # Workaround because miHoYo uses retcode for their API instead of HTTP status code
         async with aiohttp.ClientSession() as session:
             rsp = await session.get(url, **kwargs)
             rsp_json = await rsp.json()
-            # Why retcode seriously? They can just make the page not returning 200 status code.
             if rsp_json["retcode"] != 0:
+                # TODO: Add more information to the error message
                 raise aiohttp.ClientResponseError(code=rsp_json["retcode"],
                                                   message=rsp_json["message"],
                                                   history=rsp.history,
                                                   request_info=rsp.request_info)
             return rsp_json
 
-    async def _get_launcher_info(self, adv=True) -> dict:
+    async def _get_launcher_info(self, adv=True) -> launcher.Info:
         params = {"key": "gcStgarh",
                   "filter_adv": str(adv).lower(),
                   "launcher_id": "10",
@@ -31,13 +45,17 @@ class Launcher:
         if rsp["data"]["adv"] is None:
             params["language"] = "en-us"
             rsp = await self._get(self._api + "/content", params=params)
-        return rsp
+        lc_info = launcher.Info.from_dict(rsp["data"])
+        return lc_info
 
     @staticmethod
     def _get_system_language() -> str:
+        """Gets system language compatible with server parameters.
+
+        Return:
+             System language with format xx-xx.
         """
-        Get system language compatible with server parameters.
-        """
+
         try:
             lang = locale.getdefaultlocale()[0]
             lowercase_lang = lang.lower().replace("_", "-")
@@ -45,38 +63,84 @@ class Launcher:
         except ValueError:
             return "en-us"
 
+    async def override_gamedir(self, gamedir: str) -> None:
+        """Overrides game directory with another directory.
+
+        Args:
+            gamedir (str): New directory to override with.
+        """
+
+        self._gamedir = Path(gamedir).resolve()
+
     async def override_language(self, language: str) -> None:
+        """Overrides system detected language with another language.
+
+        Args:
+            language (str): Language to override with.
         """
-        Override system detected language with another language.
-        :param language: The language to override with.
-        :return: None
-        """
+
         self._lang = language.lower().replace("_", "-")
 
     async def get_version_info(self) -> dict:
+        """Gets version info from the server.
+
+        This function gets version info including audio pack and their download url from the server.
+
+        Returns:
+            A dict containing version info from the server.
+        Raises:
+            aiohttp.ClientResponseError: An error occurred while fetching the information.
+        """
+
         rsp = await self._get(self._api + "/resource", params={"key": "gcStgarh",
                                                                "launcher_id": "10"})
         return rsp
 
-    async def get_launcher_info(self) -> dict:
-        """
-        This function will get short launcher info from the server (only contains background image and FAQ)
-        :return: dict: Launcher info from the server.
+    async def get_launcher_info(self) -> launcher.Info:
+        """Gets short launcher info from the server
+
+        This function only gets background image and the FAQ url from the server.
+
+        Returns:
+            A dict containing short launcher info from the server.
+        Raises:
+            aiohttp.ClientResponseError: An error occurred while fetching the information.
         """
+
         return await self._get_launcher_info(adv=True)
 
-    async def get_launcher_full_info(self) -> dict:
-        """
-        This function will get full launcher info from the server.
-        Since the server content is very long for a short explanation, you should see it manually.
-        :return: dict: Launcher info from the server.
+    async def get_launcher_full_info(self) -> launcher.Info:
+        """Gets full launcher info from the server.
+
+        Returns:
+            A dict containing full launcher info from the server.
+        Raises:
+            aiohttp.ClientResponseError: An error occurred while fetching the information.
         """
+
         return await self._get_launcher_info(adv=False)
 
     async def get_launcher_background_url(self) -> str:
+        """Gets launcher background image url from the server.
+
+        Returns:
+            Background image url.
+        Raises:
+            aiohttp.ClientResponseError: An error occurred while fetching the background image.
         """
-        This function will get launcher background image from the server.
-        :return: str: Background image URL.
-        """
+
         rsp = await self.get_launcher_info()
-        return rsp["data"]["adv"]["background"]
+        return rsp.background.background
+
+    async def get_system_game_info(self, table_handle, keys, require_all_keys):
+        # TODO: Implement
+        raise NotImplementedError("Not implemented yet.")
+        pass
+
+    async def get_system_game_version(self) -> str:
+        """Gets the game version from the current system.
+        :return: str: System game version.
+        """
+
+        rsp = await self.get_version_info()
+        return rsp["data"]["system"]["game_version"]