syneto_api 0.2.22__tar.gz → 0.2.24__tar.gz

{syneto_api-0.2.22 → syneto_api-0.2.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syneto-api
-Version: 0.2.22
+Version: 0.2.24
 Summary: Syneto Client API library
 Home-page: https://github.com/SynetoNet/syneto-api
 License: Proprietary
@@ -12,7 +12,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
-Requires-Dist: aiohttp[speedups] (>=3.7,<4.0)
+Requires-Dist: aiodns (>=3,<4)
+Requires-Dist: aiohttp (>=3.7,<4.0)
+Requires-Dist: cchardet (>=2.1,<3.0)
 Requires-Dist: inflection (>=0.5,<0.6)
 Requires-Dist: python-dotenv (>=0.16,<0.17)
 Requires-Dist: requests[secure] (>=2.25,<3.0)

{syneto_api-0.2.22 → syneto_api-0.2.24}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "syneto_api"
-version = "0.2.22"
+version = "0.2.24"
 description = "Syneto Client API library"
 authors = ["Your Name <you@example.com>"]
 license = "Proprietary"
@@ -13,11 +13,14 @@ python = "^3.6"
 python-dotenv = "^0.16"
 requests = {extras = ["secure"], version = "^2.25"}
 inflection = "^0.5"
-aiohttp = {version = "^3.7", extras = ["speedups"]}
+aiohttp = "^3.7"
+aiodns = "^3"
+cchardet = "^2.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.2"
 ipdb = "^0.13.7"
+pytest-asyncio = "^0.15"
 
 [build-system]
 requires = ["poetry>=0.12"]

{syneto_api-0.2.22 → syneto_api-0.2.24}/setup.py

@@ -11,14 +11,16 @@ package_data = \
 {'': ['*']}
 
 install_requires = \
-['aiohttp[speedups]>=3.7,<4.0',
+['aiodns>=3,<4',
+ 'aiohttp>=3.7,<4.0',
+ 'cchardet>=2.1,<3.0',
  'inflection>=0.5,<0.6',
  'python-dotenv>=0.16,<0.17',
  'requests[secure]>=2.25,<3.0']
 
 setup_kwargs = {
     'name': 'syneto-api',
-    'version': '0.2.22',
+    'version': '0.2.24',
     'description': 'Syneto Client API library',
     'long_description': '# Syneto API\n\nSyneto Client API library: authentication, storage, virtualization and protection\n\n# Installation\n\n```\n$ pip install syneto-api\n```\n\n# Basic Usage\n\n```\nfrom syneto_api import Authentication, Virtualization, Storage, Protection\n\nauth_api = Authentication(url_base="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)\nresponse = auth_api.login(username="admin", password="admin")\njwt = response[\'jwt\']\n\nvirt_api = Virtualization(url_base="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)\nvirt_api.set_auth_jwt(jwt)\nprint(virt_api.get_vms())\n\nstorage_api = Storage(url_base="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)\nstorage_api.set_auth_jwt(jwt)\nprint(storage_api.get_pools())\n```\n\n# Environment Variables\n\nFor conveninence, the base urls for the api endpoints are also accepted as environment variables, please see below.\n\n```\nAUTH_SERVICE=https://syneto-instance-ip-address/api/auth\nVIRTUALIZATION_SERVICE=https://syneto-instance-ip-address/api/virtualization\nSTORAGE_SERVICE=https://syneto-instance-ip-address/api/storage\nPROTECTION_SERVICE=https://syneto-instance-ip-address/api/protection\n```\n\nIf you are using self-signed SSL certificates, set the following env. so that the http request library does not perform ssl verification. \n\n```\nALLOW_INSECURE_SSL=True\n```\n',
     'author': 'Your Name',

{syneto_api-0.2.22 → syneto_api-0.2.24}/src/syneto_api/api_client.py

@@ -5,8 +5,10 @@ import requests
 import urllib.parse
 import logging
 import traceback
+import urllib.parse
 
 from .settings import get_env_flag
+from .keyring import KeyRing
 
 logger = logging.getLogger(__name__)
 
@@ -55,8 +57,13 @@ class APIClientBase:
             self.url_base = f"{default_protocol}://{self.url_base}"
 
         self.url_base = self.url_base.rstrip("/")
-
         self.headers = {"accept": "application/json"}
+        parsed_base_url = urllib.parse.urlparse(self.url_base)
+        keyring = KeyRing(parsed_base_url.netloc)
+        JWT_TOKEN = keyring.get_token()
+        if JWT_TOKEN is not None:
+            self.headers.update({"Authorization": f"Bearer {JWT_TOKEN}"})
+
         self._verify_ssl_cert = True
         self._force_json = True
         if insecure_ssl is not None:
@@ -66,6 +73,9 @@ class APIClientBase:
 
         self._use_asyncio = True
 
+    def async(self, use_async=True):
+        self._use_asyncio = use_async
+
     def _request(
         self,
         method: str,
@@ -82,14 +92,17 @@ class APIClientBase:
         if not success_codes:
             success_codes = APIClientBase.SUCCESS_CODES[method]
 
+        if self._use_asyncio and is_event_loop_available():
+            return self._async_request(method, url, body, success_codes, error_subject)
+        else:
+            return self._sync_request(method, url, body, success_codes, error_subject)
+
+    async def _async_request(self, method: str, url: str, body: dict, success_codes: list, error_subject: str):
         try:
-            if self._use_asyncio and is_event_loop_available():
-                logger.debug(f"Calling {method} {url} with aiohttp lib")
-                loop = asyncio.get_event_loop()
-                return loop.run_until_complete(self._async_request(method, url, body, success_codes, error_subject))
-            else:
-                logger.debug(f"Calling {method} {url} with requests lib")
-                return self._sync_request(method, url, body, success_codes, error_subject)
+            logger.debug(f"Calling {method} {url} with aiohttp lib")
+            # loop = asyncio.get_event_loop()
+            # return loop.run_until_complete(self._async_request(method, url, body, success_codes, error_subject))
+            return await self._unsafe_async_request(method, url, body, success_codes, error_subject)
 
         except APIException as e:
             raise
@@ -97,29 +110,29 @@ class APIClientBase:
         except (aiohttp.ServerTimeoutError, requests.Timeout) as e:
             logger.warning(f"Failed {method} request to {url}, network timeout: {str(e)}")
             error = self._append_url_if_not_local_service("network timeout")
-            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body,) from e
 
         except (aiohttp.ClientSSLError, requests.exceptions.SSLError) as e:
             logger.warning(f"Failed {method} request to {url}, ssl error: {str(e)}")
             error = self._append_url_if_not_local_service("ssl error")
-            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body,) from e
 
         except (aiohttp.ClientConnectionError, requests.ConnectionError) as e:
             logger.warning(f"Failed {method} request to {url}, connect error: {str(e)}")
             error = self._append_url_if_not_local_service("network connect error")
-            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body,) from e
 
         except (aiohttp.ClientError, requests.RequestException) as e:
             logger.warning(f"Failed {method} request to {url}, network error: {str(e)}")
             error = self._append_url_if_not_local_service("network error")
-            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body,) from e
 
         except Exception as e:
             logger.warning(f"Failed {method} request to {url}: {str(e)}")
             error = self._append_url_if_not_local_service(str(e) or type(e).__name__)
-            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body,) from e
 
-    async def _async_request(self, method: str, url: str, body: dict, success_codes: list, error_subject: str):
+    async def _unsafe_async_request(self, method: str, url: str, body: dict, success_codes: list, error_subject: str):
         headers = None
         if self.headers is not None and len(self.headers) > 0:
             headers = self.headers
@@ -160,6 +173,39 @@ class APIClientBase:
                 )
 
     def _sync_request(self, method: str, url: str, body: dict, success_codes: list, error_subject: str):
+        try:
+            logger.debug(f"Calling {method} {url} with requests lib")
+            return self._unsafe_sync_request(method, url, body, success_codes, error_subject)
+
+        except APIException as e:
+            raise
+
+        except (aiohttp.ServerTimeoutError, requests.Timeout) as e:
+            logger.warning(f"Failed {method} request to {url}, network timeout: {str(e)}")
+            error = self._append_url_if_not_local_service("network timeout")
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+
+        except (aiohttp.ClientSSLError, requests.exceptions.SSLError) as e:
+            logger.warning(f"Failed {method} request to {url}, ssl error: {str(e)}")
+            error = self._append_url_if_not_local_service("ssl error")
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+
+        except (aiohttp.ClientConnectionError, requests.ConnectionError) as e:
+            logger.warning(f"Failed {method} request to {url}, connect error: {str(e)}")
+            error = self._append_url_if_not_local_service("network connect error")
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+
+        except (aiohttp.ClientError, requests.RequestException) as e:
+            logger.warning(f"Failed {method} request to {url}, network error: {str(e)}")
+            error = self._append_url_if_not_local_service("network error")
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+
+        except Exception as e:
+            logger.warning(f"Failed {method} request to {url}: {str(e)}")
+            error = self._append_url_if_not_local_service(str(e) or type(e).__name__)
+            raise APIException(url=url, message=f"{error_subject} has failed ({error})", request_body=body) from e
+
+    def _unsafe_sync_request(self, method: str, url: str, body: dict, success_codes: list, error_subject: str):
         method_func = self._get_method_func(method)
         method_args = {"verify": self._verify_ssl_cert}
         if self.headers is not None and len(self.headers) > 0:

{syneto_api-0.2.22 → syneto_api-0.2.24}/src/syneto_api/auth_api.py

@@ -1,5 +1,7 @@
 import os
 from .api_client import APIClientBase
+from .keyring import KeyRing
+import urllib.parse
 
 
 class Authentication(APIClientBase):
@@ -8,7 +10,13 @@ class Authentication(APIClientBase):
 
     def login(self, username: str, password: str):
         body = {"username": username, "password": password}
-        return self.post_request("/login", body=body)
+        response = self.post_request("/login", body=body)
+        if "jwt" in response:
+            token = response["jwt"]
+            parsed_base_url = urllib.parse.urlparse(self.url_base)
+            keyring = KeyRing(parsed_base_url.netloc)
+            keyring.set_token(token)
+        return response
 
     def get_public_key(self, username: str):
         return self.get_request("/public-key", query_args={"username": username})

syneto_api-0.2.24/src/syneto_api/keyring.py

@@ -0,0 +1,17 @@
+class Multiton(type):
+    __instances = {}
+
+    def __call__(cls, url: str, *args, **kwds):
+        if url not in cls.__instances:
+            cls.__instances[url] = super(Multiton, cls).__call__(*args, **kwds)
+        return cls.__instances[url]
+
+
+class KeyRing(metaclass=Multiton):
+    __JWT_TOKEN = None
+
+    def set_token(self, token: str):
+        self.__JWT_TOKEN = token
+
+    def get_token(self):
+        return self.__JWT_TOKEN