ENH: implementation of 'login' function

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -31,3 +31,7 @@ async def send_request(
             response = self._process_comm_exception(method=method, params=params, client_response=client_response)
 
         return response
+
+    async def login(self, *, username=None, password=None):
+        method, url, params = await self._prepare_login(username=username, password=password)
+        self.send_request(method, url, params=params)

src/save_and_restore_api/_api_base.py

@@ -1,9 +1,13 @@
-import getpass
+# import getpass
 import pprint
 from collections.abc import Mapping
 
 import httpx
 
+rest_api_method_map = {
+    "login": ("POST", "/login"),
+}
+
 
 class RequestParameterError(Exception): ...
 
@@ -53,21 +57,22 @@ def __init__(self, *, base_url, timeout, request_fail_exceptions=True):
     def ROOT_NODE_UID(self):
         return self._root_node_uid
 
+    @staticmethod
     def gen_auth(username, password):
         return httpx.BasicAuth(username=username, password=password)
 
     def set_auth(self, *, username, password):
         self._auth = self.gen_auth(username=username, password=password)
 
-    def set_username_password(self, username=None, password=None):
-        if not isinstance(username, str):
-            print("Username: ", end="")
-            username = input()
-        if not isinstance(password, str):
-            password = getpass.getpass()
+    # def set_username_password(self, username=None, password=None):
+    #     if not isinstance(username, str):
+    #         print("Username: ", end="")
+    #         username = input()
+    #     if not isinstance(password, str):
+    #         password = getpass.getpass()
 
-        self._username = username
-        self._password = password
+    #     self._username = username
+    #     self._password = password
 
     # # TODO: rewrite the logic in this function
     # def _check_response(self, *, request, response):
@@ -137,9 +142,10 @@ def _prepare_request(
                 kwargs.update({"auth": auth})
         return kwargs
 
-    def login(self, *, username=None, password=None):
-        params = {"username": self._username, "password": self._password}
-        self.send_request("POST", "/login", params=params)
+    def _prepare_login(self, *, username=None, password=None):
+        method, url = rest_api_method_map["login"]
+        params = {"username": username, "password": password}
+        return method, url, params
 
     def get_node(self, node_uid):
         return self.send_request("GET", f"/node/{node_uid}")

src/save_and_restore_api/_api_threads.py

@@ -31,3 +31,7 @@ def send_request(
             response = self._process_comm_exception(method=method, params=params, client_response=client_response)
 
         return response
+
+    def login(self, *, username=None, password=None):
+        method, url, params = self._prepare_login(username=username, password=password)
+        self.send_request(method, url, params=params)

tests/test_package.py

@@ -17,9 +17,9 @@ def test_import():
 def test_comm():
     SR = SaveRestoreAPI(base_url="http://localhost:8080/save-restore", timeout=2)
     # SR.set_username_password(username="johndoe", password="1234")
-    SR.set_username_password(username="user", password="userPass")
+    SR.set_auth(username="user", password="userPass")
     # SR.set_username_password(username="admin", password="adminPass")
     SR.open()
-    SR.login()
+    SR.login(username="user", password="userPass")
     SR.get_node(SR.ROOT_NODE_UID)
     SR.close()