Merge pull request #189 from ynput/bugfix/184-serverapiget_addon_settings_schema-requested-url-is-wrong

Fix addons url functions

Author: iLLiCiTiT

ayon_api/__init__.py

@@ -85,6 +85,7 @@
     get_attributes_fields_for_type,
     get_default_fields_for_type,
     get_addons_info,
+    get_addon_endpoint,
     get_addon_url,
     download_addon_private_file,
     get_installers,
@@ -313,6 +314,7 @@
     "get_attributes_fields_for_type",
     "get_default_fields_for_type",
     "get_addons_info",
+    "get_addon_endpoint",
     "get_addon_url",
     "download_addon_private_file",
     "get_installers",

ayon_api/_api.py

@@ -780,8 +780,8 @@ def dispatch_event(*args, **kwargs):
         sender (Optional[str]): Sender of event.
         event_hash (Optional[str]): Event hash.
         project_name (Optional[str]): Project name.
-        username (Optional[str]): Username which triggered event.
         depends_on (Optional[str]): Add dependency to another event.
+        username (Optional[str]): Username which triggered event.
         description (Optional[str]): Description of event.
         summary (Optional[dict[str, Any]]): Summary of event that can be used
             for simple filtering on listeners.
@@ -1155,6 +1155,30 @@ def get_addons_info(*args, **kwargs):
     return con.get_addons_info(*args, **kwargs)
 
 
+def get_addon_endpoint(*args, **kwargs):
+    """Calculate endpoint to addon route.
+
+    Examples:
+
+        >>> api = ServerAPI("https://your.url.com")
+        >>> api.get_addon_url(
+        ...     "example", "1.0.0", "private", "my.zip")
+        'addons/example/1.0.0/private/my.zip'
+
+    Args:
+        addon_name (str): Name of addon.
+        addon_version (str): Version of addon.
+        *subpaths (str): Any amount of subpaths that are added to
+            addon url.
+
+    Returns:
+        str: Final url.
+
+    """
+    con = get_server_api_connection()
+    return con.get_addon_endpoint(*args, **kwargs)
+
+
 def get_addon_url(*args, **kwargs):
     """Calculate url to addon route.
 
@@ -1163,13 +1187,14 @@ def get_addon_url(*args, **kwargs):
         >>> api = ServerAPI("https://your.url.com")
         >>> api.get_addon_url(
         ...     "example", "1.0.0", "private", "my.zip")
-        'https://your.url.com/addons/example/1.0.0/private/my.zip'
+        'https://your.url.com/api/addons/example/1.0.0/private/my.zip'
 
     Args:
         addon_name (str): Name of addon.
         addon_version (str): Version of addon.
         *subpaths (str): Any amount of subpaths that are added to
             addon url.
+        use_rest (Optional[bool]): Use rest endpoint.
 
     Returns:
         str: Final url.

ayon_api/server_api.py

@@ -16,6 +16,7 @@
 import warnings
 import itertools
 from contextlib import contextmanager
+from typing import Optional
 
 try:
     from http import HTTPStatus
@@ -1323,49 +1324,44 @@ def _do_rest_request(self, function, url, **kwargs):
         return new_response
 
     def raw_post(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [POST] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [POST] {}".format(url))
         return self._do_rest_request(
             RequestTypes.post,
             url,
             **kwargs
         )
 
     def raw_put(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [PUT] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [PUT] {}".format(url))
         return self._do_rest_request(
             RequestTypes.put,
             url,
             **kwargs
         )
 
     def raw_patch(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [PATCH] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [PATCH] {}".format(url))
         return self._do_rest_request(
             RequestTypes.patch,
             url,
             **kwargs
         )
 
     def raw_get(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [GET] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [GET] {}".format(url))
         return self._do_rest_request(
             RequestTypes.get,
             url,
             **kwargs
         )
 
     def raw_delete(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [DELETE] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [DELETE] {}".format(url))
         return self._do_rest_request(
             RequestTypes.delete,
             url,
@@ -1708,6 +1704,30 @@ def enroll_event_job(
 
         return response.data
 
+    def _endpoint_to_url(
+        self,
+        endpoint: str,
+        use_rest: Optional[bool] = True
+    ):
+        """Cleanup endpoint and return full url to AYON server.
+
+        If endpoint already starts with server url only slashes are removed.
+
+        Args:
+            endpoint (str): Endpoint to be cleaned.
+            use_rest (Optional[bool]): Use only base server url if set to
+                False, otherwise REST endpoint is used.
+
+        Returns:
+            str: Full url to AYON server.
+
+        """
+        endpoint = endpoint.lstrip("/").rstrip("/")
+        if endpoint.startswith(self._base_url):
+            return endpoint
+        base_url = self._rest_url if use_rest else self._graphql_url
+        return f"{base_url}/{endpoint}"
+
     def _download_file_to_stream(self, url, stream, chunk_size, progress):
         kwargs = {"stream": True}
         if self._session is None:
@@ -1752,9 +1772,8 @@ def download_file_to_stream(
 
         if endpoint.startswith(self._base_url):
             url = endpoint
-        else:
-            endpoint = endpoint.lstrip("/").rstrip("/")
-            url = "{}/{}".format(self._rest_url, endpoint)
+
+        url = self._endpoint_to_url(endpoint)
 
         if progress is None:
             progress = TransferProgress()
@@ -1922,11 +1941,7 @@ def upload_file_from_stream(
             requests.Response: Response object
 
         """
-        if endpoint.startswith(self._base_url):
-            url = endpoint
-        else:
-            endpoint = endpoint.lstrip("/").rstrip("/")
-            url = "{}/{}".format(self._rest_url, endpoint)
+        url = self._endpoint_to_url(endpoint)
 
         # Create dummy object so the function does not have to check
         #   'progress' variable everywhere
@@ -2337,15 +2352,15 @@ def get_addons_info(self, details=True):
         response.raise_for_status()
         return response.data
 
-    def get_addon_url(self, addon_name, addon_version, *subpaths):
-        """Calculate url to addon route.
+    def get_addon_endpoint(self, addon_name, addon_version, *subpaths):
+        """Calculate endpoint to addon route.
 
         Examples:
 
             >>> api = ServerAPI("https://your.url.com")
             >>> api.get_addon_url(
             ...     "example", "1.0.0", "private", "my.zip")
-            'https://your.url.com/addons/example/1.0.0/private/my.zip'
+            'addons/example/1.0.0/private/my.zip'
 
         Args:
             addon_name (str): Name of addon.
@@ -2360,13 +2375,41 @@ def get_addon_url(self, addon_name, addon_version, *subpaths):
         ending = ""
         if subpaths:
             ending = "/{}".format("/".join(subpaths))
-        return "{}/addons/{}/{}{}".format(
-            self._base_url,
+        return "addons/{}/{}{}".format(
             addon_name,
             addon_version,
             ending
         )
 
+    def get_addon_url(
+        self, addon_name, addon_version, *subpaths, use_rest=True
+    ):
+        """Calculate url to addon route.
+
+        Examples:
+
+            >>> api = ServerAPI("https://your.url.com")
+            >>> api.get_addon_url(
+            ...     "example", "1.0.0", "private", "my.zip")
+            'https://your.url.com/api/addons/example/1.0.0/private/my.zip'
+
+        Args:
+            addon_name (str): Name of addon.
+            addon_version (str): Version of addon.
+            *subpaths (str): Any amount of subpaths that are added to
+                addon url.
+            use_rest (Optional[bool]): Use rest endpoint.
+
+        Returns:
+            str: Final url.
+
+        """
+        endpoint = self.get_addon_endpoint(
+            addon_name, addon_version, *subpaths
+        )
+        url_base = self._base_url if use_rest else self._rest_url
+        return f"{url_base}/{endpoint}"
+
     def download_addon_private_file(
         self,
         addon_name,
@@ -2404,12 +2447,13 @@ def download_addon_private_file(
         dst_dirpath = os.path.dirname(dst_filepath)
         os.makedirs(dst_dirpath, exist_ok=True)
 
-        url = self.get_addon_url(
+        endpoint = self.get_addon_endpoint(
             addon_name,
             addon_version,
             "private",
             filename
         )
+        url = f"{self._base_url}/{endpoint}"
         self.download_file(
             url, dst_filepath, chunk_size=chunk_size, progress=progress
         )
@@ -3222,7 +3266,7 @@ def get_addon_settings_schema(
         if project_name:
             args = (project_name, )
 
-        endpoint = self.get_addon_url(
+        endpoint = self.get_addon_endpoint(
             addon_name, addon_version, "schema", *args
         )
         result = self.get(endpoint)