ENH: refactoring of the API implementations and tests

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -58,22 +58,22 @@ async def nodes_get(self, uniqueIds):
         method, url, params = self._prepare_nodes_get(uniqueIds=uniqueIds)
         return await self.send_request(method, url, params=params)
 
-    async def node_add(self, parentNodeId, *, name, nodeType, **kwargs):
+    async def node_add(self, parentNodeId, *, name, nodeType, auth=None, **kwargs):
         # Reusing docstrings from the threaded version
         method, url, params = self._prepare_node_add(
             parentNodeId=parentNodeId, name=name, nodeType=nodeType, **kwargs
         )
-        return await self.send_request(method, url, params=params)
+        return await self.send_request(method, url, params=params, auth=auth)
 
-    async def node_delete(self, nodeId):
+    async def node_delete(self, nodeId, *, auth=None):
         # Reusing docstrings from the threaded version
         method, url = self._prepare_node_delete(nodeId=nodeId)
-        return await self.send_request(method, url)
+        return await self.send_request(method, url, auth=auth)
 
-    async def nodes_delete(self, uniqueIds):
+    async def nodes_delete(self, uniqueIds, *, auth=None):
         # Reusing docstrings from the threaded version
         method, url, params = self._prepare_nodes_delete(uniqueIds=uniqueIds)
-        return await self.send_request(method, url, params=params)
+        return await self.send_request(method, url, params=params, auth=auth)
 
     async def node_get_children(self, uniqueNodeId):
         # Reusing docstrings from the threaded version

src/save_and_restore_api/_api_base.py

@@ -52,11 +52,26 @@ def __init__(self, *, base_url, timeout, request_fail_exceptions=True):
         self._auth = None
 
     @staticmethod
-    def gen_auth(username, password):
+    def auth_gen(username, password):
+        """
+        Generate and return httpx.BasicAuth object based on username and password.
+        The object can be passed as ``auth`` parameter in API calls.
+        """
         return httpx.BasicAuth(username=username, password=password)
 
-    def set_auth(self, *, username, password):
-        self._auth = self.gen_auth(username=username, password=password)
+    def auth_set(self, *, username, password):
+        """
+        Configure authentication for the session based on username and password.
+        If the authentication is configured, there is no need to pass the authentication
+        object with each API call.
+        """
+        self._auth = self.auth_gen(username=username, password=password)
+
+    def auth_clear(self):
+        """
+        Clear authentication for the session.
+        """
+        self._auth = None
 
     # def set_username_password(self, username=None, password=None):
     #     if not isinstance(username, str):
@@ -132,7 +147,7 @@ def _prepare_request(
             kwargs.update({"data": data})
         if timeout is not None:
             kwargs.update({"timeout": self._adjust_timeout(timeout)})
-        if method != "GET":
+        if method.upper() != "GET":
             auth = auth or self._auth
             if auth is not None:
                 kwargs.update({"auth": auth})

src/save_and_restore_api/_api_threads.py

@@ -65,7 +65,7 @@ def nodes_get(self, uniqueIds):
         method, url, params = self._prepare_nodes_get(uniqueIds=uniqueIds)
         return self.send_request(method, url, params=params)
 
-    def node_add(self, parentNodeId, *, name, nodeType, **kwargs):
+    def node_add(self, parentNodeId, *, name, nodeType, auth=None, **kwargs):
         """
         Creates a new node under the specified parent node. Required parameters:
         ``name`` and ``nodeType``. Supported types: ``"FOLDER"``, ``"CONFIGURATION"``.
@@ -75,27 +75,27 @@ def node_add(self, parentNodeId, *, name, nodeType, **kwargs):
         method, url, params = self._prepare_node_add(
             parentNodeId=parentNodeId, name=name, nodeType=nodeType, **kwargs
         )
-        return self.send_request(method, url, params=params)
+        return self.send_request(method, url, params=params, auth=auth)
 
-    def node_delete(self, nodeId):
+    def node_delete(self, nodeId, *, auth=None):
         """
         Deletes the node with specified node ID. The call fails if the node can
         not be deleted.
 
         API: DELETE /node/{nodeId}
         """
         method, url = self._prepare_node_delete(nodeId=nodeId)
-        return self.send_request(method, url)
+        return self.send_request(method, url, auth=auth)
 
-    def nodes_delete(self, uniqueIds):
+    def nodes_delete(self, uniqueIds, *, auth=None):
         """
         Deletes multiple nodes specified as a list of UIDs. The call fails if
         any of the nodes can not be deleted.
 
         API: DELETE /node
         """
         method, url, params = self._prepare_nodes_delete(uniqueIds=uniqueIds)
-        return self.send_request(method, url, params=params)
+        return self.send_request(method, url, params=params, auth=auth)
 
     def node_get_children(self, uniqueNodeId):
         """

tests/common.py

@@ -29,7 +29,7 @@ def _clear():
         Remove all nodes from the database.
         """
         with SaveRestoreAPI(base_url=base_url, timeout=2) as SR:
-            SR.set_auth(username=user_username, password=user_password)
+            SR.auth_set(username=user_username, password=user_password)
 
             # Create all nodes. Children always follow the parent
             n_uid = 0