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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -0,0 +1,186 @@
1
+ # Copyright 2024 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ from requests_toolbelt import MultipartEncoder
16
+ from requests.exceptions import RequestException
17
+ import requests
18
+ import os
19
+ from pathlib import Path
20
+ from uuid import uuid4
21
+ import math
22
+
23
+
24
+ class APIClient:
25
+ """
26
+ A reusable API client that automatically handles token refresh on 401 responses.
27
+
28
+ Attributes:
29
+ api_server_url (str): The URL of the API server.
30
+ api_key (str): The API key.
31
+ api_version (str): The API version.
32
+ session (requests.Session): The session object.
33
+
34
+ Example usage:
35
+ client = APIClient(api_server_url, refresh_token)
36
+ response = client.get("/users/me/")
37
+ print(response.json())
38
+ """
39
+
40
+ def __init__(
41
+ self,
42
+ api_server_url,
43
+ api_key=None,
44
+ api_version="v1",
45
+ ):
46
+ self.base_url = f"{api_server_url}/api/{api_version}"
47
+ self.session = TokenRefreshSession(api_server_url, api_key)
48
+
49
+ def get(self, endpoint, **kwargs):
50
+ """Sends a GET request to the specified API endpoint."""
51
+ url = f"{self.base_url}{endpoint}"
52
+ return self.session.get(url, **kwargs)
53
+
54
+ def post(self, endpoint, data=None, json=None, **kwargs):
55
+ """Sends a POST request to the specified API endpoint."""
56
+ url = f"{self.base_url}{endpoint}"
57
+ return self.session.post(url, data=data, json=json, **kwargs)
58
+
59
+ def put(self, endpoint, data=None, **kwargs):
60
+ """Sends a PUT request to the specified API endpoint."""
61
+ url = f"{self.base_url}{endpoint}"
62
+ return self.session.put(url, data=data, **kwargs)
63
+
64
+ def patch(self, endpoint, data=None, json=None, **kwargs):
65
+ """Sends a PATCH request to the specified API endpoint."""
66
+ url = f"{self.base_url}{endpoint}"
67
+ return self.session.patch(url, data=data, json=json, **kwargs)
68
+
69
+ def delete(self, endpoint, **kwargs):
70
+ """Sends a DELETE request to the specified API endpoint."""
71
+ url = f"{self.base_url}{endpoint}"
72
+ return self.session.delete(url, **kwargs)
73
+
74
+ def upload_file(
75
+ self, file_path: str, folder_id: int) -> int | None:
76
+ """Uploads a file to the server.
77
+
78
+ Args:
79
+ file_path: File contents.
80
+ folder_id: An existing OpenRelik folder identifier.
81
+
82
+ Returns:
83
+ file_id of the uploaded file or None otherwise.
84
+
85
+ Raise:
86
+ FileNotFoundError: if file_path is not found.
87
+ """
88
+ file_id = None
89
+ response = None
90
+ endpoint = "/files/upload"
91
+ chunk_size = 1024000 # 1 MB
92
+ resumableTotalChunks = 0
93
+ resumableChunkNumber = 0
94
+ resumableIdentifier = uuid4().hex
95
+ file_path = Path(file_path)
96
+ resumableFilename = file_path.name
97
+ if not file_path.exists():
98
+ raise FileNotFoundError(f"File {file_path} not found.")
99
+
100
+ if folder_id:
101
+ response = self.session.get(f"{self.base_url}/folders/{folder_id}")
102
+ if response.status_code == 404:
103
+ return file_id
104
+
105
+ with open(file_path, "rb") as fh:
106
+ total_size = Path(file_path).stat().st_size
107
+ resumableTotalChunks = math.ceil(total_size / chunk_size)
108
+ while chunk := fh.read(chunk_size):
109
+ resumableChunkNumber += 1
110
+ params = {
111
+ "resumableChunkNumber": str(resumableChunkNumber),
112
+ "resumableTotalChunks": str(resumableTotalChunks),
113
+ "resumableIdentifier": resumableIdentifier,
114
+ "resumableFilename": resumableFilename,
115
+ "folder_id": str(folder_id),
116
+ }
117
+ encoder = MultipartEncoder(
118
+ {"file": (file_path.name, chunk,
119
+ "application/octet-stream")}
120
+ )
121
+ headers = {"Content-Type": encoder.content_type}
122
+ response = self.session.post(
123
+ f"{self.base_url}{endpoint}",
124
+ headers=headers,
125
+ data=encoder.to_string(),
126
+ params=params,
127
+ )
128
+ if response and response.status_code == 201:
129
+ file_id = response.json().get('id')
130
+ return file_id
131
+
132
+
133
+ class TokenRefreshSession(requests.Session):
134
+ """Custom session class that handles automatic token refresh on 401 responses."""
135
+
136
+ def __init__(self, api_server_url, api_key):
137
+ """
138
+ Initializes the TokenRefreshSession with the API server URL and refresh token.
139
+
140
+ Args:
141
+ api_server_url (str): The URL of the API server.
142
+ refresh_token (str): The refresh token.
143
+ """
144
+ super().__init__()
145
+ self.api_server_url = api_server_url
146
+ if api_key:
147
+ self.headers["x-openrelik-refresh-token"] = api_key
148
+
149
+ def request(self, method, url, **kwargs):
150
+ """Intercepts the request to handle token expiration.
151
+
152
+ Args:
153
+ method (str): The HTTP method.
154
+ url (str): The URL of the request.
155
+ **kwargs: Additional keyword arguments for the request.
156
+
157
+ Returns:
158
+ Response: The response object.
159
+
160
+ Raises:
161
+ Exception: If the token refresh fails.
162
+ """
163
+ response = super().request(method, url, **kwargs)
164
+
165
+ if response.status_code == 401:
166
+ if self._refresh_token():
167
+ # Retry the original request with the new token
168
+ response = super().request(method, url, **kwargs)
169
+ else:
170
+ raise Exception("Token refresh failed")
171
+
172
+ return response
173
+
174
+ def _refresh_token(self):
175
+ """Refreshes the access token using the refresh token."""
176
+ refresh_url = f"{self.api_server_url}/auth/refresh"
177
+ try:
178
+ response = self.get(refresh_url)
179
+ response.raise_for_status()
180
+ # Update session headers with the new access token
181
+ new_access_token = response.json().get("new_access_token")
182
+ self.headers["x-openrelik-access-token"] = new_access_token
183
+ return True
184
+ except RequestException as e:
185
+ print(f"Failed to refresh token: {e}")
186
+ return False
@@ -0,0 +1,83 @@
1
+ # Copyright 2024 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ from openrelik_api_client.api_client import APIClient
16
+
17
+
18
+ class FoldersAPI:
19
+
20
+ def __init__(self, api_client: APIClient):
21
+ super().__init__()
22
+ self.api_client = api_client
23
+
24
+ def create_root_folder(self, display_name: str) -> int | None:
25
+ """Create a root folder.
26
+
27
+ Args:
28
+ display_name (str): Folder display name.
29
+
30
+ Returns:
31
+ int: Folder ID for the new root folder, or None otherwise.
32
+
33
+ Raises:
34
+ HTTPError: If the API request failed.
35
+ """
36
+ folder_id = None
37
+ endpoint = f"{self.api_client.base_url}/folders/"
38
+ params = {"display_name": display_name}
39
+ response = self.api_client.session.post(endpoint, json=params)
40
+ response.raise_for_status()
41
+ if response.status_code == 201:
42
+ folder_id = response.json().get('id')
43
+ return folder_id
44
+
45
+ def create_subfolder(
46
+ self, folder_id: int, display_name: str) -> int | None:
47
+ """Create a subfolder within the given folder ID.
48
+
49
+ Args:
50
+ folder_id: The ID of the parent folder.
51
+ display_name: The name of the subfolder to check.
52
+
53
+ Returns:
54
+ int: Folder ID for the new root folder, or None.
55
+
56
+ Raises:
57
+ HTTPError: If the API request failed.
58
+ """
59
+ folder_id = None
60
+ endpoint = f"{self.api_client.base_url}/folders/{folder_id}/folders"
61
+ data = {"display_name": display_name}
62
+ response = self.api_client.session.post(endpoint, json=data)
63
+ response.raise_for_status()
64
+ if response.status_code == 201:
65
+ folder_id = response.json().get("id")
66
+ return folder_id
67
+
68
+ def folder_exists(self, folder_id: int) -> bool:
69
+ """Checks if a folder with the given ID exists.
70
+
71
+ Args:
72
+ folder_id: The ID of the folder to check.
73
+
74
+ Returns:
75
+ True if the folder exists, False otherwise.
76
+
77
+ Raises:
78
+ HTTPError: If the API request failed.
79
+ """
80
+ endpoint = f"{self.api_client.base_url}/folders/{folder_id}"
81
+ response = self.api_client.session.get(endpoint)
82
+ response.raise_for_status()
83
+ return response.status_code == 200
@@ -0,0 +1,136 @@
1
+ # Copyright 2024 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ import json
16
+
17
+ from openrelik_api_client.api_client import APIClient
18
+
19
+
20
+ class WorkflowsAPI:
21
+ def __init__(self, api_client: APIClient):
22
+ super().__init__()
23
+ self.api_client = api_client
24
+
25
+ def create_workflow(
26
+ self, folder_id: int, file_ids: list, template_id: int = None) -> int | None:
27
+ """Creates a new workflow.
28
+
29
+ Args:
30
+ folder_id: The ID of the folder to create the workflow in.
31
+ file_ids: A list of file IDs to associate with the workflow.
32
+ template_id: The ID of the workflow template to use.
33
+
34
+ Returns:
35
+ The ID of the created workflow. None otherwise
36
+
37
+ Raises:
38
+ HTTPError: If the API request failed.
39
+ """
40
+ workflow_id = None
41
+ endpoint = f"{self.api_client.base_url}/folders/{folder_id}/workflows/"
42
+ data = {"folder_id": folder_id,
43
+ "file_ids": file_ids, "template_id": template_id}
44
+ response = self.api_client.session.post(endpoint, json=data)
45
+ response.raise_for_status()
46
+ if response.status_code == 200:
47
+ workflow_id = response.json().get("id")
48
+ return workflow_id
49
+
50
+ def get_workflow(self, folder_id: int, workflow_id: int):
51
+ """Retrieves a workflow by ID.
52
+
53
+ Args:
54
+ folder_id: The ID of the folder where the workflow exists.
55
+ workflow_id: The ID of the workflow to retrieve.
56
+
57
+ Returns:
58
+ The workflow data.
59
+
60
+ Raises:
61
+ HTTPError: If the API request failed.
62
+ """
63
+ endpoint = f"{
64
+ self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
65
+ response = self.api_client.session.get(endpoint)
66
+ response.raise_for_status()
67
+ if response.status_code == 200:
68
+ return response.json()
69
+
70
+ def update_workflow(self, folder_id: int, workflow_id: int, workflow_data: dict):
71
+ """Updates an existing workflow.
72
+
73
+ Args:
74
+ folder_id: The ID of the folder containing the workflow.
75
+ workflow_id: The ID of the workflow to update.
76
+ workflow_data: The updated workflow data.
77
+
78
+ Returns:
79
+ The updated workflow data, or None.
80
+
81
+ Raises:
82
+ HTTPError: If the API request failed.
83
+ """
84
+ workflow = None
85
+ endpoint = f"{
86
+ self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
87
+ response = self.api_client.session.patch(endpoint, json=workflow_data)
88
+ response.raise_for_status()
89
+ if response.status_code == 200:
90
+ workflow = response.json()
91
+ return workflow
92
+
93
+ def delete_workflow(self, folder_id, workflow_id) -> bool:
94
+ """Deletes a workflow.
95
+
96
+ Args:
97
+ folder_id: The ID of the folder containing the workflow.
98
+ workflow_id: The ID of the workflow to delete.
99
+
100
+ Returns:
101
+ True if the request was successful.
102
+
103
+ Raises:
104
+ HTTPError: If the API request failed.
105
+ """
106
+ endpoint = f"{
107
+ self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}"
108
+ response = self.api_client.session.delete(endpoint)
109
+ response.raise_for_status()
110
+ return response.status_code == 204
111
+
112
+ def run_workflow(self, folder_id: int, workflow_id: int):
113
+ """Runs an existing workflow.
114
+
115
+ Args:
116
+ folder_id: The ID of the folder containing the workflow.
117
+ workflow_id: The ID of the workflow to run.
118
+ run_data: Optional data to pass to the workflow run.
119
+
120
+ Returns:
121
+ A workflow object.
122
+
123
+ Raises:
124
+ HTTPError: If the API request failed.
125
+ """
126
+ workflow = None
127
+ endpoint = f"{
128
+ self.api_client.base_url}/folders/{folder_id}/workflows/{workflow_id}/run/"
129
+ workflow = self.get_workflow(folder_id, workflow_id)
130
+ spec = json.loads(workflow.get('spec_json'))
131
+ data = {'workflow_spec': spec}
132
+ response = self.api_client.session.post(endpoint, json=data)
133
+ response.raise_for_status()
134
+ if response.status_code == 200:
135
+ workflow = response.json()
136
+ return workflow
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,56 @@
1
+ Metadata-Version: 2.1
2
+ Name: openrelik-api-client
3
+ Version: 0.2.0
4
+ Summary: API client that automatically handles token refresh
5
+ Author: Johan Berggren
6
+ Author-email: jberggren@gmail.com
7
+ Requires-Python: >=3.10,<4.0
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Programming Language :: Python :: 3.10
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Requires-Dist: requests (>=2.32.3,<3.0.0)
13
+ Requires-Dist: requests_toolbelt (>=1.0.0,<2.0.0)
14
+ Description-Content-Type: text/markdown
15
+
16
+ ## OpenRelik API Client
17
+
18
+ This Python package provides a simple API client (`APIClient`) that automatically handles token refresh on 401 (Unauthorized) responses.
19
+
20
+ * **Automatic token refresh:** Seamlessly refreshes expired access tokens using a refresh token.
21
+ * **Easy-to-use interface:** Simple methods for common HTTP requests (GET, POST, PUT, DELETE).
22
+ * **Customizable:** Allows you to specify the API server URL, API key, and API version.
23
+
24
+ ## Installation
25
+
26
+ ```bash
27
+ pip install openrelik-api-client
28
+ ```
29
+
30
+ **Example:**
31
+ ```python
32
+ import os
33
+ from openrelik_api_client.api_client import APIClient
34
+
35
+ # Initialize the API client
36
+ api_server_url = "http://localhost:8710"
37
+
38
+ # API key from environment variable
39
+ api_key = os.getenv("OPENRELIK_API_KEY")
40
+
41
+ # Create the API client. It will handle token refreshes automatically.
42
+ api_client = APIClient(api_server_url, api_key)
43
+
44
+ # Example GET request
45
+ response = api_client.get("/users/me/")
46
+ print(response.json())
47
+ ```
48
+
49
+
50
+ **How it works:**
51
+
52
+ The `APIClient` utilizes a custom session class (`TokenRefreshSession`) that intercepts requests and checks for 401 responses. If a 401 response is encountered, it automatically attempts to refresh the access token using the provided refresh token. If the refresh is successful, the original request is retried with the new access token.
53
+
54
+ ##### Obligatory Fine Print
55
+ This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.
56
+
@@ -0,0 +1,8 @@
1
+ openrelik_api_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ openrelik_api_client/api_client.py,sha256=omf6Bwo9-ounH04tb3GJAVkSatGUbjMMI6rTcaYyuFY,6765
3
+ openrelik_api_client/folders.py,sha256=VWQ3SYTpo5zU1aZ0c50rSqgpBySNHBTKKXmp4z0mrRA,2796
4
+ openrelik_api_client/workflows.py,sha256=P-1B0MQDujcMmI8R2SmzHtmpeYYoZGwLroZko-HNnd4,4771
5
+ openrelik_api_client-0.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
6
+ openrelik_api_client-0.2.0.dist-info/METADATA,sha256=XZBiBVOtWNXQoT94rqEiRBB3nVX2PsH73sqDHCeoz5Y,2063
7
+ openrelik_api_client-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
8
+ openrelik_api_client-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: poetry-core 1.9.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any