ENH: Implementation of 'info_get' API

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -40,6 +40,14 @@ async def send_request(
 
         return response
 
+    # =============================================================================================
+    #                         INFO-CONTROLLER API METHODS
+    # =============================================================================================
+
+    async def info_get(self):
+        method, url = self._prepare_info_get()
+        return await self.send_request(method, url)
+
     # =============================================================================================
     #                         AUTHENTICATION-CONTROLLER API METHODS
     # =============================================================================================

src/save_and_restore_api/_api_base.py

@@ -159,6 +159,18 @@ def _prepare_request(
                 kwargs.update({"auth": auth})
         return kwargs
 
+    # =============================================================================================
+    #                         INFO-CONTROLLER API METHODS
+    # =============================================================================================
+
+    def _prepare_info_get(self):
+        method, url = "GET", "/"
+        return method, url
+
+    # =============================================================================================
+    #                         AUTHENTICATION-CONTROLLER API METHODS
+    # =============================================================================================
+
     def _prepare_login(self, *, username=None, password=None):
         method, url = "POST", "/login"
         params = {"username": username, "password": password}

src/save_and_restore_api/_api_threads.py

@@ -39,6 +39,14 @@ def send_request(
 
         return response
 
+    # =============================================================================================
+    #                         INFO-CONTROLLER API METHODS
+    # =============================================================================================
+
+    def info_get(self):
+        method, url = self._prepare_info_get()
+        return self.send_request(method, url)
+
     # =============================================================================================
     #                         AUTHENTICATION-CONTROLLER API METHODS
     # =============================================================================================

tests/test_misc.py

@@ -66,10 +66,36 @@ def test_version_01():
 
 
 # =============================================================================================
-#                         TESTS FOR AUTHENTICATION-CONTROLLER API METHODS
+#                         INFO-CONTROLLER API METHODS
 # =============================================================================================
 
 
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+# fmt: on
+def test_info_get_01(library):
+    """
+    Tests for the 'info_get' API.
+    """
+    if not _is_async(library):
+        with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
+
+            info = SR.info_get()
+            assert info["name"] == "service-save-and-restore"
+
+    else:
+        async def testing():
+            async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
+
+                info = await SR.info_get()
+                assert info["name"] == "service-save-and-restore"
+
+        asyncio.run(testing())
+
+# =============================================================================================
+#                         TESTS FOR AUTHENTICATION-CONTROLLER API METHODS
+# =============================================================================================
+
 # fmt: off
 @pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
 @pytest.mark.parametrize("username, password, roles, code", [