openrelik-api-client 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

openrelik_api_client/api_client.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import tempfile
 from requests_toolbelt import MultipartEncoder
 from requests.exceptions import RequestException
 import requests
@@ -42,34 +43,58 @@ class APIClient:
         api_server_url,
         api_key=None,
         api_version="v1",
+        session=None
     ):
         self.base_url = f"{api_server_url}/api/{api_version}"
-        self.session = TokenRefreshSession(api_server_url, api_key)
+        if session:
+            self.session = session
+        else:
+            self.session = TokenRefreshSession(api_server_url, api_key)
 
     def get(self, endpoint, **kwargs):
         """Sends a GET request to the specified API endpoint."""
         url = f"{self.base_url}{endpoint}"
-        return self.session.get(url, **kwargs)
+        return self.session.request("GET", url, **kwargs)
 
     def post(self, endpoint, data=None, json=None, **kwargs):
         """Sends a POST request to the specified API endpoint."""
         url = f"{self.base_url}{endpoint}"
-        return self.session.post(url, data=data, json=json, **kwargs)
+        return self.session.request("POST", url, data=data, json=json, **kwargs)
 
     def put(self, endpoint, data=None, **kwargs):
         """Sends a PUT request to the specified API endpoint."""
         url = f"{self.base_url}{endpoint}"
-        return self.session.put(url, data=data, **kwargs)
+        return self.session.request("PUT", url, data=data, **kwargs)
 
     def patch(self, endpoint, data=None, json=None, **kwargs):
         """Sends a PATCH request to the specified API endpoint."""
         url = f"{self.base_url}{endpoint}"
-        return self.session.patch(url, data=data, json=json, **kwargs)
+        return self.session.request("PATCH", url, data=data, json=json, **kwargs)
 
     def delete(self, endpoint, **kwargs):
         """Sends a DELETE request to the specified API endpoint."""
         url = f"{self.base_url}{endpoint}"
-        return self.session.delete(url, **kwargs)
+        return self.session.request("DELETE", url, **kwargs)
+
+    def download_file(self, file_id: int, filename: str) -> str | None:
+        """Downloads a file from OpenRelik.
+
+        Args:
+            file_id: The ID of the file to download.
+            filename: The name of the file to download.
+
+        Returns:
+            str: The path to the downloaded file.
+        """
+        endpoint = f"{self.base_url}/files/{file_id}/download"
+        response = self.get(endpoint)
+        filename_prefix, extension = os.path.splitext(filename)
+        file = tempfile.NamedTemporaryFile(
+            mode="wb", prefix=f"{filename_prefix}", suffix=extension, delete=False
+        )
+        file.write(response.content)
+        file.close()
+        return file.name
 
     def upload_file(
         self, file_path: str, folder_id: int) -> int | None:
@@ -98,7 +123,7 @@ class APIClient:
             raise FileNotFoundError(f"File {file_path} not found.")
 
         if folder_id:
-            response = self.session.get(f"{self.base_url}/folders/{folder_id}")
+            response = self.get(f"{self.base_url}/folders/{folder_id}")
             if response.status_code == 404:
                 return file_id
 
@@ -119,7 +144,7 @@ class APIClient:
                               "application/octet-stream")}
                 )
                 headers = {"Content-Type": encoder.content_type}
-                response = self.session.post(
+                response = self.post(
                     f"{self.base_url}{endpoint}",
                     headers=headers,
                     data=encoder.to_string(),

openrelik_api_client/folders.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Any
+
 from openrelik_api_client.api_client import APIClient
 
 
@@ -36,7 +38,7 @@ class FoldersAPI:
         folder_id = None
         endpoint = f"{self.api_client.base_url}/folders/"
         params = {"display_name": display_name}
-        response = self.api_client.session.post(endpoint, json=params)
+        response = self.api_client.post(endpoint, json=params)
         response.raise_for_status()
         if response.status_code == 201:
             folder_id = response.json().get('id')
@@ -59,7 +61,7 @@ class FoldersAPI:
         folder_id = None
         endpoint = f"{self.api_client.base_url}/folders/{folder_id}/folders"
         data = {"display_name": display_name}
-        response = self.api_client.session.post(endpoint, json=data)
+        response = self.api_client.post(endpoint, json=data)
         response.raise_for_status()
         if response.status_code == 201:
             folder_id = response.json().get("id")
@@ -78,6 +80,29 @@ class FoldersAPI:
             HTTPError: If the API request failed.
         """
         endpoint = f"{self.api_client.base_url}/folders/{folder_id}"
-        response = self.api_client.session.get(endpoint)
+        response = self.api_client.get(endpoint)
         response.raise_for_status()
         return response.status_code == 200
+
+    def update_folder(
+        self, folder_id: int, folder_data: dict[str, Any]
+    ):
+        """Updates an existing folder.
+
+        Args:
+            folder_id: The ID of the folder to update.
+            folder_data: The updated folder data.
+
+        Returns:
+            The updated folder data, or None.
+
+        Raises:
+            HTTPError: If the API request failed.
+        """
+        endpoint = f"{self.api_client.base_url}/folders/{folder_id}"
+        response = self.api_client.patch(
+            endpoint,
+            json=folder_data
+        )
+        response.raise_for_status()
+        return response.json()

openrelik_api_client/workflows.py

@@ -21,6 +21,7 @@ class WorkflowsAPI:
     def __init__(self, api_client: APIClient):
         super().__init__()
         self.api_client = api_client
+        self.folders_url = f"{self.api_client.base_url}/folders"
 
     def create_workflow(
             self, folder_id: int, file_ids: list, template_id: int = None) -> int | None:
@@ -38,10 +39,10 @@ class WorkflowsAPI:
             HTTPError: If the API request failed.
         """
         workflow_id = None
-        endpoint = f"{self.api_client.base_url}/folders/{folder_id}/workflows/"
+        endpoint = f"{self.folders_url}/{folder_id}/workflows/"
         data = {"folder_id": folder_id,
                 "file_ids": file_ids, "template_id": template_id}
-        response = self.api_client.session.post(endpoint, json=data)
+        response = self.api_client.post(endpoint, json=data)
         response.raise_for_status()
         if response.status_code == 200:
             workflow_id = response.json().get("id")
@@ -60,9 +61,8 @@ class WorkflowsAPI:
          Raises:
             HTTPError: If the API request failed.
         """
-        endpoint = f"{
-            self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.get(endpoint)
+        endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
+        response = self.api_client.get(endpoint)
         response.raise_for_status()
         if response.status_code == 200:
             return response.json()
@@ -82,9 +82,8 @@ class WorkflowsAPI:
             HTTPError: If the API request failed.
         """
         workflow = None
-        endpoint = f"{
-            self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.patch(endpoint, json=workflow_data)
+        endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
+        response = self.api_client.patch(endpoint, json=workflow_data)
         response.raise_for_status()
         if response.status_code == 200:
             workflow = response.json()
@@ -103,9 +102,8 @@ class WorkflowsAPI:
         Raises:
             HTTPError: If the API request failed.
         """
-        endpoint = f"{
-            self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.delete(endpoint)
+        endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
+        response = self.api_client.delete(endpoint)
         response.raise_for_status()
         return response.status_code == 204
 
@@ -124,12 +122,12 @@ class WorkflowsAPI:
             HTTPError: If the API request failed.
         """
         workflow = None
-        endpoint = f"{
-            self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}/run/"
+        endpoint = (
+            f"{self.folders_url}/{folder_id}/workflows/{workflow_id}/run/")
         workflow = self.get_workflow(folder_id, workflow_id)
         spec = json.loads(workflow.get('spec_json'))
         data = {'workflow_spec': spec}
-        response = self.api_client.session.post(endpoint, json=data)
+        response = self.api_client.post(endpoint, json=data)
         response.raise_for_status()
         if response.status_code == 200:
             workflow = response.json()

{openrelik_api_client-0.2.0.dist-info → openrelik_api_client-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openrelik-api-client
-Version: 0.2.0
+Version: 0.2.2
 Summary: API client that automatically handles token refresh
 Author: Johan Berggren
 Author-email: jberggren@gmail.com

openrelik_api_client-0.2.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+openrelik_api_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openrelik_api_client/api_client.py,sha256=lOMGbAEGvUyWooldQaGqVDCk2A0J4spdrzR_J4vlwq8,7620
+openrelik_api_client/folders.py,sha256=X8PjogrhO9fDBCfGVE63bCm0L4TsY6WxNXntGinPLRk,3426
+openrelik_api_client/workflows.py,sha256=hVByxpCOQi9ScKGL3IjxxFhkQkKQzKxdwKT-l_stp4Y,4679
+openrelik_api_client-0.2.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openrelik_api_client-0.2.2.dist-info/METADATA,sha256=-Io2DGh5DreA96Ha9CFoWNhJ_mvjEXXcT6MbAE9vfPI,2063
+openrelik_api_client-0.2.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+openrelik_api_client-0.2.2.dist-info/RECORD,,

openrelik_api_client-0.2.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-openrelik_api_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openrelik_api_client/api_client.py,sha256=omf6Bwo9-ounH04tb3GJAVkSatGUbjMMI6rTcaYyuFY,6765
-openrelik_api_client/folders.py,sha256=VWQ3SYTpo5zU1aZ0c50rSqgpBySNHBTKKXmp4z0mrRA,2796
-openrelik_api_client/workflows.py,sha256=P-1B0MQDujcMmI8R2SmzHtmpeYYoZGwLroZko-HNnd4,4771
-openrelik_api_client-0.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openrelik_api_client-0.2.0.dist-info/METADATA,sha256=XZBiBVOtWNXQoT94rqEiRBB3nVX2PsH73sqDHCeoz5Y,2063
-openrelik_api_client-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-openrelik_api_client-0.2.0.dist-info/RECORD,,