openrelik-api-client 0.2.1__tar.gz → 0.2.2__tar.gz

{openrelik_api_client-0.2.1 → openrelik_api_client-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openrelik-api-client
-Version: 0.2.1
+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.1 → openrelik_api_client-0.2.2}/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-0.2.1 → openrelik_api_client-0.2.2}/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-0.2.1 → openrelik_api_client-0.2.2}/openrelik_api_client/workflows.py

@@ -42,7 +42,7 @@ class WorkflowsAPI:
         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")
@@ -62,7 +62,7 @@ class WorkflowsAPI:
             HTTPError: If the API request failed.
         """
         endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.get(endpoint)
+        response = self.api_client.get(endpoint)
         response.raise_for_status()
         if response.status_code == 200:
             return response.json()
@@ -83,7 +83,7 @@ class WorkflowsAPI:
         """
         workflow = None
         endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.patch(endpoint, json=workflow_data)
+        response = self.api_client.patch(endpoint, json=workflow_data)
         response.raise_for_status()
         if response.status_code == 200:
             workflow = response.json()
@@ -103,7 +103,7 @@ class WorkflowsAPI:
             HTTPError: If the API request failed.
         """
         endpoint = f"{self.folders_url}/{folder_id}/workflows/{workflow_id}"
-        response = self.api_client.session.delete(endpoint)
+        response = self.api_client.delete(endpoint)
         response.raise_for_status()
         return response.status_code == 204
 
@@ -127,7 +127,7 @@ class WorkflowsAPI:
         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.1 → openrelik_api_client-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openrelik-api-client"
-version = "0.2.1"
+version = "0.2.2"
 description = "API client that automatically handles token refresh"
 authors = ["Johan Berggren <jberggren@gmail.com>"]
 readme = "README.md"

openrelik_api_client-0.2.1/openrelik_api_client/test.py

@@ -1,11 +0,0 @@
-from folders import FoldersAPI
-
-
-def main():
-    c = FoldersAPI("http://172.19.0.6:8710", api_key="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmZThmMjkyYWViZDM0MjA3YjkyODYxOGQ5MmRmZThkMSIsImlhdCI6MTczNDQ0NzcyOSwibmJmIjoxNzM0NDQ3NzI5LCJleHAiOjE3MzUwNTI1MjksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODcxMCIsImF1ZCI6ImFwaS1jbGllbnQiLCJqdGkiOiI2ZWZhNzBiYWU0ZDE0MjJlOGM4ODY5OGY1NDhmOTBjYiIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.MJA48D570agD49oE4HXfTWCQRpyh5JCy7YCIsHN5YJs")
-    # r = c.create_root_folder("myfolder")
-    # r = c.create_subfolder(33, 'myfolder_sub')
-    print(c.folder_exists(1))
-
-
-main()