syneto_api 0.2.37__tar.gz → 0.2.38__tar.gz

{syneto_api-0.2.37 → syneto_api-0.2.38}/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.1
 Name: syneto-api
-Version: 0.2.37
+Version: 0.2.38
 Summary: Syneto Client API library
 Home-page: https://github.com/SynetoNet/syneto-api
 License: Proprietary
 Author: Your Name
 Author-email: you@example.com
-Requires-Python: >=3.6,<4.0
+Requires-Python: >=3.6.2,<4.0.0
 Classifier: License :: Other/Proprietary License
 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: aiodns (>=3,<4)

{syneto_api-0.2.37 → syneto_api-0.2.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "syneto_api"
-version = "0.2.37"
+version = "0.2.38"
 description = "Syneto Client API library"
 authors = ["Your Name <you@example.com>"]
 license = "Proprietary"
@@ -9,7 +9,7 @@ repository = "https://github.com/SynetoNet/syneto-api"
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.6"
+python = "^3.6.2"
 python-dotenv = "^0.16"
 requests = {extras = ["secure"], version = "^2.25"}
 inflection = "^0.5"
@@ -21,6 +21,7 @@ cchardet = "^2.1"
 pytest = "^6.2.2"
 ipdb = "^0.13.7"
 pytest-asyncio = "^0.15"
+black = {version = "^21.6b0", allow-prereleases = true}
 
 [build-system]
 requires = ["poetry>=0.12"]

{syneto_api-0.2.37 → syneto_api-0.2.38}/setup.py

@@ -20,7 +20,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'syneto-api',
-    'version': '0.2.37',
+    'version': '0.2.38',
     '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',
@@ -32,7 +32,7 @@ setup_kwargs = {
     'packages': packages,
     'package_data': package_data,
     'install_requires': install_requires,
-    'python_requires': '>=3.6,<4.0',
+    'python_requires': '>=3.6.2,<4.0.0',
 }
 
 

{syneto_api-0.2.37 → syneto_api-0.2.38}/src/syneto_api/api_client.py

@@ -25,9 +25,7 @@ def make_url(url_base, *path_args, query_args: dict = None, **path_kwargs):
 
 
 class APIException(Exception):
-    def __init__(
-        self, url: str, status_code: int = 0, message: str = None, request_body: dict = None, response=None,
-    ):
+    def __init__(self, url: str, status_code: int = 0, message: str = None, request_body: dict = None, response=None):
         self.url = url
         self.status_code = status_code
         self.request_body = request_body
@@ -50,8 +48,9 @@ class APIClientBase:
         "DELETE": [200, 202, 204],
     }
 
-    def __init__(self, url_base=None, default_protocol="http", insecure_ssl=None):
+    def __init__(self, url_base=None, default_protocol="http", insecure_ssl=None, timeout=5 * 60):
         self.url_base = url_base
+        self.timeout = timeout
         protocols = ["http://", "https://"]
         if not any(self.url_base.lower().startswith(p) for p in protocols):
             self.url_base = f"{default_protocol}://{self.url_base}"
@@ -105,37 +104,39 @@ class APIClientBase:
             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, on_response_callback
+            print(self.timeout)
+            return await asyncio.wait_for(
+                self._unsafe_async_request(method, url, body, success_codes, error_subject, on_response_callback),
+                timeout=self.timeout,
             )
 
         except APIException as e:
             raise
 
-        except (aiohttp.ServerTimeoutError, requests.Timeout) as e:
+        except (aiohttp.ServerTimeoutError, requests.Timeout, asyncio.TimeoutError) 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 _unsafe_async_request(
         self, method: str, url: str, body: dict, success_codes: list, error_subject: str, on_response_callback
@@ -161,7 +162,6 @@ class APIClientBase:
             request_method = request_methods[method]
             async with request_method(url, **method_args) as response:
                 is_json = response.headers.get("content-type") == "application/json"
-
                 if response.status in success_codes:
                     logger.debug(f"Received {response.status} from {method} {url}")
                     if is_json or self._force_json:
@@ -278,10 +278,15 @@ class APIClientBase:
         return requests_methods[method]
 
     def get_request(
-        self, relative_url: str, *url_path_args, query_args: dict = None, success_codes: list = None, **url_path_kwargs,
+        self, relative_url: str, *url_path_args, query_args: dict = None, success_codes: list = None, **url_path_kwargs
     ):
         return self._request(
-            "GET", relative_url, *url_path_args, query_args=query_args, success_codes=success_codes, **url_path_kwargs,
+            "GET",
+            relative_url,
+            *url_path_args,
+            query_args=query_args,
+            success_codes=success_codes,
+            **url_path_kwargs,
         )
 
     def delete_request(self, *args, **kwargs):

{syneto_api-0.2.37 → syneto_api-0.2.38}/src/syneto_api/auth_api.py

@@ -24,6 +24,11 @@ class Authentication(APIClientBase):
         return self.get_request("/public-key", query_args={"username": username})
 
     def add_authorized_key(self, username: str, public_key: str):
-        return self.post_request(
-            "/authorized-keys", query_args={"username": username}, body={"public_key": public_key},
+        return self.post_request("/authorized-keys", query_args={"username": username}, body={"public_key": public_key})
+
+    def remove_authorized_key(self, username: str, public_key: str):
+        return self.delete_request(
+            "/authorized-keys",
+            query_args={"username": username},
+            body={"public_key": public_key},
         )

{syneto_api-0.2.37 → syneto_api-0.2.38}/src/syneto_api/protection_api.py

@@ -12,13 +12,7 @@ class Protection(APIClientBase):
     def get_policy(self, id):
         return self.get_request("/policies/{id}", id=id)
 
-    def create_policy(
-        self,
-        policy_name: str,
-        pool_name: str = None,
-        alert_enabled: bool = True,
-        rules: list = None,
-    ):
+    def create_policy(self, policy_name: str, pool_name: str = None, alert_enabled: bool = True, rules: list = None):
         body = {
             "policyName": policy_name,
             "poolName": pool_name,
@@ -28,12 +22,7 @@ class Protection(APIClientBase):
         return self.post_request("/policies", body=body)
 
     def patch_policy(
-        self,
-        id: str,
-        policy_name: str = None,
-        pool_name: str = None,
-        alert_enabled: bool = None,
-        rules: list = None,
+        self, id: str, policy_name: str = None, pool_name: str = None, alert_enabled: bool = None, rules: list = None
     ):
         body = {}
 
@@ -105,13 +94,13 @@ class Protection(APIClientBase):
         bandwidth_limit_value is in bytes
         bandwidth_limit_start_time format is HHMMSS'Z', the time should always use UTC timezone.
         bandwidth_limit_stop_time format is HHMMSS'Z', the time should always use UTC timezone.
-        bandwidth_limit_start_time and bandwidth_limit_stop_time time interval is when the 
+        bandwidth_limit_start_time and bandwidth_limit_stop_time time interval is when the
         replication bandwidth will be limited to the bandwidth_limit_value.
         Example:
         bandwidth_limit_value: 50000,
         bandwidth_limit_start_time: 090000Z,
         bandwidth_limit_stop_time: 163000Z,
-        The effect of these values is that between 9 AM UTC and 4:30 PM UTC 
+        The effect of these values is that between 9 AM UTC and 4:30 PM UTC
         the replication bandwidth will be limited to 50KB.
         """
 
@@ -155,13 +144,13 @@ class Protection(APIClientBase):
         bandwidth_limit_value is in bytes
         bandwidth_limit_start_time format is HHMMSS'Z', the time should always use UTC timezone.
         bandwidth_limit_stop_time format is HHMMSS'Z', the time should always use UTC timezone.
-        bandwidth_limit_start_time and bandwidth_limit_stop_time time interval is when the 
+        bandwidth_limit_start_time and bandwidth_limit_stop_time time interval is when the
         replication bandwidth will be limited to the bandwidth_limit_value.
         Example:
         bandwidth_limit_value: 50000,
         bandwidth_limit_start_time: 090000Z,
         bandwidth_limit_stop_time: 163000Z,
-        The effect of these values is that between 9 AM UTC and 4:30 PM UTC 
+        The effect of these values is that between 9 AM UTC and 4:30 PM UTC
         the replication bandwidth will be limited to 50KB.
         In order to update a replication host's bandwidth limit values you must include a value for
         bandwidth_limit_value, bandwidth_limit_start_time and bandwidth_limit_stop_time, if one of them
@@ -200,15 +189,18 @@ class Protection(APIClientBase):
         return self.get_request("/vms/{vm_syn_id}", vm_syn_id=vm_syn_id)
 
     def post_vm_recovery_point(self, vm_syn_id: str, job_id: str):
-        return self.post_request(
-            "/vms/recovery-points", body={"synId": vm_syn_id, "jobId": job_id}
-        )
+        return self.post_request("/vms/recovery-points", body={"synId": vm_syn_id, "jobId": job_id})
 
     def get_recovery_points(self, vm_syn_id: str, limit: int = 100, offset: int = 0):
         return self.get_request(
-            "/recovery-points",
-            query_args={"vm_syn_id": vm_syn_id, "limit": limit, "offset": offset},
+            "/recovery-points", query_args={"vm_syn_id": vm_syn_id, "limit": limit, "offset": offset}
         )
 
     def delete_recovery_point(self, recovery_point_id: str):
         return self.delete_request(f"/recovery-points/{recovery_point_id}")
+
+    def post_recovery_point_replicas(self, replicas):
+        return self.post_request("/recovery-points/replicas", body=replicas)
+
+    def post_vm_replicas(self, replicas):
+        return self.post_request("/vms/replicas", body=replicas)

{syneto_api-0.2.37 → syneto_api-0.2.38}/src/syneto_api/storage_api.py

@@ -29,7 +29,7 @@ class Storage(APIClientBase):
 
     def set_pool_periodic_scrub(self, pool_name: str, interval: str):
         return self.post_request(
-            "/pools/{pool_name}/scrub/interval", pool_name=pool_name, query_args={"interval": interval},
+            "/pools/{pool_name}/scrub/interval", pool_name=pool_name, query_args={"interval": interval}
         )
 
     def delete_pool_periodic_scrub(self, pool_name: str):
@@ -41,16 +41,12 @@ class Storage(APIClientBase):
     def stop_pool_scrub(self, pool_name: str):
         return self.put_request("/pools/{pool_name}/scrub/stop", pool_name=pool_name)
 
-    def get_volumes(
-        self, volume_type: str = "NFS", only_clones: bool = False, label_key: str = "",
-    ):
+    def get_volumes(self, volume_type: str = "NFS", only_clones: bool = False, label_key: str = ""):
         return self.get_request(
-            "/volumes", query_args={"volume_type": volume_type, "only_clones": only_clones, "label_key": label_key,},
+            "/volumes", query_args={"volume_type": volume_type, "only_clones": only_clones, "label_key": label_key}
         )
 
-    def create_volume(
-        self, pool_name: str, ips: list, volume_type: str = "NFS", quota: str = "none",
-    ):
+    def create_volume(self, pool_name: str, ips: list, volume_type: str = "NFS", quota: str = "none"):
         hosts = [{"ipNetwork": ip, "accessType": "rw"} for ip in ips]
         body = {
             "type": volume_type,
@@ -58,35 +54,35 @@ class Storage(APIClientBase):
             "nfsShareConfig": {"rootAccess": "true", "hosts": hosts},
             "quota": quota,
         }
-        return self.post_request("/volumes", body=body,)
+        return self.post_request("/volumes", body=body)
 
     def get_volume(self, volume_id: str):
-        return self.get_request("/volumes/{volume_id}", volume_id=volume_id,)
+        return self.get_request("/volumes/{volume_id}", volume_id=volume_id)
 
     def delete_volume(self, volume_id: str):
-        return self.delete_request("/volumes", query_args={"volume_id": volume_id},)
+        return self.delete_request("/volumes", query_args={"volume_id": volume_id})
 
     def promote_volume(self, volume_id: str):
         return self.put_request("/volumes/{volume_id}/promote", volume_id=volume_id)
 
     def get_volume_meta(self, volume_id: str, key: str):
-        return self.get_request("/volumes/{volume_id}/meta", volume_id=volume_id, query_args={"key": key},)
+        return self.get_request("/volumes/{volume_id}/meta", volume_id=volume_id, query_args={"key": key})
 
     def set_volume_meta(self, volume_id: str, key: str, value: dict):
         body = {"key": key, "value": value}
-        return self.put_request("/volumes/{volume_id}/meta", volume_id=volume_id, body=body,)
+        return self.put_request("/volumes/{volume_id}/meta", volume_id=volume_id, body=body)
 
     def get_volume_snapshots(self, volume_id: str):
-        return self.get_request("/volumes/{volume_id}/snapshots", volume_id=volume_id,)
+        return self.get_request("/volumes/{volume_id}/snapshots", volume_id=volume_id)
 
     def create_volume_snapshot(self, volume_id: str, snapshot_name: str):
         return self.post_request(
-            "/volumes/{volume_id}/snapshots", volume_id=volume_id, query_args={"snapshot_name": snapshot_name},
+            "/volumes/{volume_id}/snapshots", volume_id=volume_id, query_args={"snapshot_name": snapshot_name}
         )
 
     def get_volume_snapshot(self, volume_id: str, snapshot_name: str):
         return self.get_request(
-            "/volumes/{volume_id}/snapshots/{snapshot_name}", volume_id=volume_id, snapshot_name=snapshot_name,
+            "/volumes/{volume_id}/snapshots/{snapshot_name}", volume_id=volume_id, snapshot_name=snapshot_name
         )
 
     def remove_volume_snapshot(self, volume_id: str, snapshot_name: str):
@@ -95,43 +91,41 @@ class Storage(APIClientBase):
 
     def delete_volume_snapshot(self, volume_id: str, snapshot_name: str):
         return self.delete_request(
-            "/volumes/{volume_id}/snapshots", volume_id=volume_id, query_args={"snapshot_name": snapshot_name},
+            "/volumes/{volume_id}/snapshots", volume_id=volume_id, query_args={"snapshot_name": snapshot_name}
         )
 
     def rollback_volume_snapshot(self, volume_id: str, snapshot_name: str):
         return self.put_request(
-            "/volumes/{volume_id}/snapshots/{snapshot_name}/rollback", volume_id=volume_id, snapshot_name=snapshot_name,
+            "/volumes/{volume_id}/snapshots/{snapshot_name}/rollback", volume_id=volume_id, snapshot_name=snapshot_name
         )
 
     def get_volume_snapshot_clones(self, volume_id: str, snapshot_name: str):
         return self.get_request(
-            "/volumes/{volume_id}/snapshots/{snapshot_name}/clones", volume_id=volume_id, snapshot_name=snapshot_name,
+            "/volumes/{volume_id}/snapshots/{snapshot_name}/clones", volume_id=volume_id, snapshot_name=snapshot_name
         )
 
     def create_volume_snapshot_clone(self, volume_id: str, snapshot_name: str):
         return self.post_request(
-            "/volumes/{volume_id}/snapshots/{snapshot_name}/clones", volume_id=volume_id, snapshot_name=snapshot_name,
+            "/volumes/{volume_id}/snapshots/{snapshot_name}/clones", volume_id=volume_id, snapshot_name=snapshot_name
         )
 
-    def get_volume_files(
-        self, volume_id: str, path: str = "", recursive: bool = False, match_pattern: str = "",
-    ):
+    def get_volume_files(self, volume_id: str, path: str = "", recursive: bool = False, match_pattern: str = ""):
         return self.get_request(
             "/volumes/{volume_id}/files",
             volume_id=volume_id,
-            query_args={"path": path, "recursive": recursive, "match_pattern": match_pattern,},
+            query_args={"path": path, "recursive": recursive, "match_pattern": match_pattern},
         )
 
     def delete_volume_files(self, volume_id: str, file_path: str = None, pattern: str = None):
         return self.delete_request(
             "/volumes/{volume_id}/files",
             volume_id=volume_id,
-            body={"volume_id": volume_id, "file_path": file_path, "pattern": pattern,},
+            body={"volume_id": volume_id, "file_path": file_path, "pattern": pattern},
         )
 
     def get_volume_file_content(self, volume_id: str, file_path: str):
         return self.get_request(
-            "/volumes/{volume_id}/files/content", volume_id=volume_id, query_args={"file_path": file_path},
+            "/volumes/{volume_id}/files/content", volume_id=volume_id, query_args={"file_path": file_path}
         )
 
     def set_volume_file_content(self, volume_id: str, file_path: str, content: str):
@@ -143,18 +137,18 @@ class Storage(APIClientBase):
         )
 
     def create_directory_in_volume(self, volume_id: str, dir_path: str):
-        return self.post_request("/volumes/{volume_id}/folder", volume_id=volume_id, query_args={"dir_path": dir_path},)
+        return self.post_request("/volumes/{volume_id}/folder", volume_id=volume_id, query_args={"dir_path": dir_path})
 
     def delete_directory_in_volume(self, volume_id: str, dir_path: str):
         return self.delete_request(
-            "/volumes/{volume_id}/folder", volume_id=volume_id, query_args={"dir_path": dir_path},
+            "/volumes/{volume_id}/folder", volume_id=volume_id, query_args={"dir_path": dir_path}
         )
 
     def get_file_recovery_volume(self):
         return self.get_request("/file-recovery")
 
     def create_file_recovery_volume(self, pool_name: str):
-        return self.post_request("/file-recovery", body={"pool": pool_name},)
+        return self.post_request("/file-recovery", body={"pool": pool_name})
 
     def get_system_information(self):
         return self.get_request("/system")