ENH: implementation of 'version_get' API

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -48,6 +48,15 @@ async def info_get(self):
         method, url = self._prepare_info_get()
         return await self.send_request(method, url)
 
+    async def version_get(self):
+        """
+        Returns current version of Save and Restore service.
+
+        API: GET /verson
+        """
+        method, url = self._prepare_version_get()
+        return await self.send_request(method, url)
+
     # =============================================================================================
     #                         AUTHENTICATION-CONTROLLER API METHODS
     # =============================================================================================

src/save_and_restore_api/_api_base.py

@@ -100,7 +100,12 @@ def auth_clear(self):
 
     def _process_response(self, *, client_response):
         client_response.raise_for_status()
-        response = client_response.json() if client_response.content else ""
+        response = ""
+        if client_response.content:
+            try:
+                response = client_response.json()
+            except json.JSONDecodeError:
+                response = client_response.text
         return response
 
     def _process_comm_exception(self, *, method, params, client_response):
@@ -167,6 +172,10 @@ def _prepare_info_get(self):
         method, url = "GET", "/"
         return method, url
 
+    def _prepare_version_get(self):
+        method, url = "GET", "/version"
+        return method, url
+
     # =============================================================================================
     #                         AUTHENTICATION-CONTROLLER API METHODS
     # =============================================================================================

src/save_and_restore_api/_api_threads.py

@@ -52,6 +52,15 @@ def info_get(self):
         method, url = self._prepare_info_get()
         return self.send_request(method, url)
 
+    def version_get(self):
+        """
+        Returns information on the name and current version of the service.
+
+        API: GET /verson
+        """
+        method, url = self._prepare_version_get()
+        return self.send_request(method, url)
+
     # =============================================================================================
     #                         AUTHENTICATION-CONTROLLER API METHODS
     # =============================================================================================

tests/test_misc.py

@@ -92,6 +92,33 @@ async def testing():
 
         asyncio.run(testing())
 
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+# fmt: on
+def test_version_get_01(library):
+    """
+    Tests for the 'version_get' API.
+    """
+    if not _is_async(library):
+        with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
+
+            info = SR.version_get()
+            isinstance(info, str)
+            assert "service-save-and-restore" in info
+            assert "version" in info
+
+    else:
+        async def testing():
+            async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
+
+                info = await SR.version_get()
+                isinstance(info, str)
+                assert "service-save-and-restore" in info
+                assert "version" in info
+
+        asyncio.run(testing())
+
+
 # =============================================================================================
 #                         TESTS FOR AUTHENTICATION-CONTROLLER API METHODS
 # =============================================================================================