Merge branch 'develop'

Author: iLLiCiTiT

ayon_api/__init__.py

@@ -116,6 +116,7 @@
     get_folder_by_name,
     get_folder_by_path,
     get_folders,
+    get_folders_hierarchy,
 
     get_tasks,
 

ayon_api/_api.py

@@ -723,6 +723,11 @@ def get_folders(*args, **kwargs):
     return con.get_folders(*args, **kwargs)
 
 
+def get_folders_hierarchy(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_folders_hierarchy(*args, **kwargs)
+
+
 def get_tasks(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_tasks(*args, **kwargs)

ayon_api/server_api.py

@@ -313,6 +313,11 @@ class ServerAPI(object):
         default_settings_variant (Optional[str]): Settings variant used by
             default if a method for settings won't get any (by default is
             'production').
+        ssl_verify (Union[bool, str, None]): Verify SSL certificate
+            Looks for env variable value 'AYON_CA_FILE' by default. If not
+            available then 'True' is used.
+        cert (Optional[str]): Path to certificate file. Looks for env
+            variable value 'AYON_CERT_FILE' by default.
     """
 
     def __init__(
@@ -321,7 +326,9 @@ def __init__(
         token=None,
         site_id=None,
         client_version=None,
-        default_settings_variant=None
+        default_settings_variant=None,
+        ssl_verify=None,
+        cert=None,
     ):
         if not base_url:
             raise ValueError("Invalid server URL {}".format(str(base_url)))
@@ -335,6 +342,19 @@ def __init__(
         self._site_id = site_id
         self._client_version = client_version
         self._default_settings_variant = default_settings_variant
+
+        if ssl_verify is None:
+            # Custom AYON env variable for CA file or 'True'
+            # - that should cover most default behaviors in 'requests'
+            #   with 'certifi'
+            ssl_verify = os.environ.get("AYON_CA_FILE") or True
+
+        if cert is None:
+            cert = os.environ.get("AYON_CERT_FILE")
+
+        self._ssl_verify = ssl_verify
+        self._cert = cert
+
         self._access_token_is_service = None
         self._token_is_valid = None
         self._server_available = None
@@ -374,6 +394,54 @@ def get_rest_url(self):
     base_url = property(get_base_url)
     rest_url = property(get_rest_url)
 
+    def get_ssl_verify(self):
+        """Enable ssl verification.
+
+        Returns:
+            bool: Current state of ssl verification.
+        """
+
+        return self._ssl_verify
+
+    def set_ssl_verify(self, ssl_verify):
+        """Change ssl verification state.
+
+        Args:
+            ssl_verify (Union[bool, str, None]): Enabled/disable
+                ssl verification, can be a path to file.
+        """
+
+        if self._ssl_verify == ssl_verify:
+            return
+        self._ssl_verify = ssl_verify
+        if self._session is not None:
+            self._session.verify = ssl_verify
+
+    def get_cert(self):
+        """Current cert file used for connection to server.
+
+        Returns:
+            Union[str, None]: Path to cert file.
+        """
+
+        return self._cert
+
+    def set_cert(self, cert):
+        """Change cert file used for connection to server.
+
+        Args:
+            cert (Union[str, None]): Path to cert file.
+        """
+
+        if cert == self._cert:
+            return
+        self._cert = cert
+        if self._session is not None:
+            self._session.cert = cert
+
+    ssl_verify = property(get_ssl_verify, set_ssl_verify)
+    cert = property(get_cert, set_cert)
+
     @property
     def access_token(self):
         """Access token used for authorization to server.
@@ -545,7 +613,11 @@ def as_username(self, username):
     @property
     def is_server_available(self):
         if self._server_available is None:
-            response = requests.get(self._base_url)
+            response = requests.get(
+                self._base_url,
+                cert=self._cert,
+                verify=self._ssl_verify
+            )
             self._server_available = response.status_code == 200
         return self._server_available
 
@@ -596,6 +668,8 @@ def create_session(self):
         self.validate_token()
 
         session = requests.Session()
+        session.cert = self._cert
+        session.verify = self._ssl_verify
         session.headers.update(self.get_headers())
 
         self._session_functions_mapping = {

ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for Ayon server."""
-__version__ = "0.2.1"
+__version__ = "0.2.2"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.2.1"
+version = "0.2.2"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]