-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathyepcode_api.py
More file actions
642 lines (540 loc) · 23.4 KB
/
yepcode_api.py
File metadata and controls
642 lines (540 loc) · 23.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
import base64
import json
from typing import Optional, Dict, Any, List, Union
from datetime import datetime, timezone
import requests
from urllib.parse import urljoin
import mimetypes
import re
from .types import (
YepCodeApiConfig,
Process,
Execution,
ExecutionId,
ExecutionsPaginatedResult,
ExecutionLogsPaginatedResult,
ProcessesPaginatedResult,
Schedule,
SchedulesPaginatedResult,
TeamVariable,
TeamVariablesPaginatedResult,
VersionedProcess,
VersionedProcessesPaginatedResult,
VersionedProcessAlias,
VersionedProcessAliasesPaginatedResult,
Module,
ModulesPaginatedResult,
VersionedModule,
VersionedModulesPaginatedResult,
VersionedModuleAlias,
VersionedModuleAliasesPaginatedResult,
CreateProcessInput,
UpdateProcessInput,
CreateTeamVariableInput,
UpdateTeamVariableInput,
CreateModuleInput,
UpdateModuleInput,
PublishProcessInput,
PublishModuleInput,
VersionedProcessAliasInput,
VersionedModuleAliasInput,
ScheduledProcessInput,
CreateStorageObjectInput,
StorageObject,
ServiceAccount,
ServiceAccountInput,
ProgrammingLanguage,
ProgrammingLanguageManifest,
UpdateTeamDependenciesInput,
Team,
UpdateTeamInput,
Sandbox,
CreateSandboxInput,
UpdateSandboxInput,
)
class YepCodeApiError(Exception):
def __init__(self, message: str, status: int):
super().__init__(message)
self.status = status
self.name = "YepCodeApiError"
class YepCodeApi:
def __init__(self, config: YepCodeApiConfig = None):
config = config or YepCodeApiConfig()
config_dict = (
{k: v for k, v in config.__dict__.items() if v is not None}
if config
else {}
)
final_config = {
"api_host": "https://cloud.yepcode.io",
"timeout": 60000,
**config_dict,
}
if (
not final_config.get("access_token")
and not final_config.get("api_token")
and (
not final_config.get("client_id")
or not final_config.get("client_secret")
)
):
raise ValueError(
"Invalid configuration. Please provide either: access_token, api_token or client_id and client_secret."
)
if final_config.get("api_token"):
try:
api_token = final_config["api_token"]
if api_token.startswith("sk-"):
decoded_token = base64.b64decode(api_token[3:]).decode()
client_id, client_secret = decoded_token.split(":")
if not client_id or not client_secret:
raise ValueError()
final_config["client_id"] = client_id
final_config["client_secret"] = client_secret
else:
# Legacy apiToken format
decoded_token = base64.b64decode(api_token).decode()
token_data = json.loads(decoded_token)
if not token_data.get("clientId") or not token_data.get(
"clientSecret"
):
raise ValueError()
final_config["client_id"] = token_data["clientId"]
final_config["client_secret"] = token_data["clientSecret"]
except Exception as e:
raise ValueError(
f"Invalid apiToken format: {final_config['api_token']}"
)
self.api_host = final_config.get("api_host")
self.client_id = final_config.get("client_id")
self.client_secret = final_config.get("client_secret")
self.api_token = final_config.get("api_token")
self.team_id = final_config.get("team_id")
self.access_token = final_config.get("access_token")
self.timeout = final_config.get("timeout")
if not self.client_id and self.access_token:
self.client_id = self._client_id_from_access_token()
if not self.team_id and self.client_id:
self.team_id = self._team_id_from_client_id()
def get_client_id(self) -> str:
if not self.client_id:
raise ValueError("Client ID is not set")
return self.client_id
def get_team_id(self) -> str:
if not self.team_id:
raise ValueError("Team ID is not set")
return self.team_id
def _client_id_from_access_token(self) -> str:
if not self.access_token:
raise ValueError("Access token is not set")
try:
payload = self.access_token.split(".")[1]
payload += "=" * ((4 - len(payload) % 4) % 4)
decoded_payload = json.loads(base64.b64decode(payload).decode())
return decoded_payload["client_id"]
except Exception as e:
raise ValueError(f"Failed to extract client_id from access token: {e}")
def _team_id_from_client_id(self) -> str:
if not self.client_id:
raise ValueError("Client ID is not set")
if self.client_id.startswith("yc-storage-api-sa"):
return self.client_id[18:]
match = re.match(r"^sa-(.*)-[a-z0-9]{8}$", self.client_id)
if not match:
raise ValueError(
"Client ID is not valid. It must be in the format sa-<teamId>-<8randomCharsOrDigits>"
)
return match.group(1)
def _get_base_url(self) -> str:
return f"{self.api_host}/api/{self.team_id}/rest"
def _get_auth_url(self) -> str:
return f"{self._get_base_url()}/auth/token"
def _get_access_token(self) -> str:
if not self.api_token and (not self.client_id or not self.client_secret):
raise ValueError(
"AccessToken has expired. Provide a new one or enable automatic refreshing by providing an apiToken or clientId and clientSecret."
)
try:
credentials = f"{self.client_id}:{self.client_secret}"
api_token = (
self.api_token
or f"sk-{base64.b64encode(credentials.encode()).decode()}"
)
response = requests.post(
self._get_auth_url(),
headers={
"x-api-token": api_token,
},
timeout=self.timeout,
)
if not response.ok:
raise ValueError(f"HTTP error! status: {response.status_code}")
data = response.json()
self.access_token = data["access_token"]
if not self.access_token:
raise ValueError("No access token received from server")
return self.access_token
except Exception as error:
raise ValueError(f"Authentication failed: {str(error)}")
def _is_access_token_expired(self, access_token: str) -> bool:
token_payload = access_token.split(".")[1]
if not token_payload:
return True
try:
token_payload += "=" * ((4 - len(token_payload) % 4) % 4)
decoded_token_payload = json.loads(base64.b64decode(token_payload).decode())
expiration_time = decoded_token_payload["exp"]
return (
expiration_time is not None
and expiration_time < datetime.now(timezone.utc).timestamp()
)
except Exception as e:
return True
def _request(
self, method: str, endpoint: str, options: Optional[Dict[str, Any]] = None
) -> Any:
if options is None:
options = {}
if not self.access_token or self._is_access_token_expired(self.access_token):
self._get_access_token()
headers = {
"Authorization": f"Bearer {self.access_token}",
"Content-Type": "application/json",
**(options.get("headers", {})),
}
endpoint = endpoint.lstrip("/")
url = urljoin(f"{self._get_base_url()}/", endpoint)
request_kwargs = {"headers": headers, "timeout": self.timeout / 1000}
if data := options.get("data"):
request_kwargs["json"] = data
if params := options.get("params"):
request_kwargs["params"] = {
k: str(v) for k, v in params.items() if v is not None
}
response = requests.request(method, url, **request_kwargs)
if response.status_code == 401:
self._get_access_token()
return self._request(method, endpoint, options)
if not response.ok:
try:
error_response = response.json()
message = error_response.get("message", response.reason)
except ValueError:
message = response.reason
raise YepCodeApiError(
f"HTTP error {response.status_code} in endpoint {method} {endpoint}: {message}",
response.status_code,
)
try:
return response.json()
except ValueError:
return response.text
@staticmethod
def _sanitize_date_param(date: Union[datetime, str, None]) -> Optional[str]:
if not date:
return None
if isinstance(date, datetime):
return date.isoformat().split(".")[0]
if isinstance(date, str) and not re.match(
r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$", date
):
raise ValueError(
"Invalid date format. It must be a valid ISO 8601 date (ie: 2025-01-01T00:00:00)"
)
return date
def create_process(self, data: CreateProcessInput) -> Process:
return self._request("POST", "/processes", {"data": data})
def get_process(self, id: str) -> Process:
return self._request("GET", f"/processes/{id}")
def update_process(
self, process_identifier: str, data: UpdateProcessInput
) -> Process:
return self._request(
"PATCH", f"/processes/{process_identifier}", {"data": data}
)
def delete_process(self, process_identifier: str) -> None:
self._request("DELETE", f"/processes/{process_identifier}")
def get_process_versions(
self, process_id: str, params: Optional[Dict[str, Any]] = None
) -> VersionedProcessesPaginatedResult:
return self._request(
"GET", f"/processes/{process_id}/versions", {"params": params or {}}
)
def publish_process_version(
self, process_id: str, data: PublishProcessInput
) -> VersionedProcess:
return self._request(
"POST", f"/processes/{process_id}/versions", {"data": data}
)
def get_process_version_aliases(
self, process_id: str, params: Optional[Dict[str, Any]] = None
) -> VersionedProcessAliasesPaginatedResult:
return self._request(
"GET", f"/processes/{process_id}/aliases", {"params": params or {}}
)
def create_process_version_alias(
self, process_id: str, data: VersionedProcessAliasInput
) -> VersionedProcessAlias:
return self._request("POST", f"/processes/{process_id}/aliases", {"data": data})
def get_processes(
self, params: Optional[Dict[str, Any]] = None
) -> ProcessesPaginatedResult:
return self._request("GET", "/processes", {"params": params or {}})
def execute_process_async(
self,
process_id_or_slug: str,
parameters: Optional[Dict[str, Any]] = None,
options: Optional[Dict[str, Any]] = None,
) -> ExecutionId:
headers = {}
if options and options.get("initiatedBy"):
headers["Yep-Initiated-By"] = options["initiatedBy"]
data = {
"parameters": json.dumps(parameters or {}),
"tag": options.get("tag") if options else None,
"comment": options.get("comment") if options else None,
"settings": options.get("settings") if options else None,
}
return self._request(
"POST",
f"/processes/{process_id_or_slug}/execute",
{"data": data, "headers": headers},
)
def execute_process_sync(
self,
process_id_or_slug: str,
parameters: Optional[Dict[str, Any]] = None,
options: Optional[Dict[str, Any]] = None,
) -> Any:
headers = {}
if options and options.get("initiatedBy"):
headers["Yep-Initiated-By"] = options["initiatedBy"]
data = {
"parameters": json.dumps(parameters or {}),
"tag": options.get("tag") if options else None,
"comment": options.get("comment") if options else None,
"settings": options.get("settings") if options else None,
}
return self._request(
"POST",
f"/processes/{process_id_or_slug}/execute-sync",
{"data": data, "headers": headers},
)
def create_schedule(
self, process_id_or_slug: str, data: ScheduledProcessInput
) -> Schedule:
return self._request(
"POST", f"/processes/{process_id_or_slug}/schedule", {"data": data}
)
def get_executions(
self, params: Optional[Dict[str, Any]] = None
) -> ExecutionsPaginatedResult:
if params:
sanitized_params = {
**params,
"from": self._sanitize_date_param(params.get("from")),
"to": self._sanitize_date_param(params.get("to")),
}
else:
sanitized_params = {}
return self._request("GET", "/executions", {"params": sanitized_params})
def get_execution(self, id: str) -> Execution:
return self._request("GET", f"/executions/{id}")
def get_execution_logs(
self, id: str, params: Optional[Dict[str, Any]] = None
) -> ExecutionLogsPaginatedResult:
return self._request("GET", f"/executions/{id}/logs", {"params": params or {}})
def rerun_execution(self, id: str) -> str:
response = self._request("POST", f"/executions/{id}/rerun")
return response["executionId"]
def kill_execution(self, id: str) -> None:
self._request("PUT", f"/executions/{id}/kill")
def get_schedules(
self, params: Optional[Dict[str, Any]] = None
) -> SchedulesPaginatedResult:
return self._request("GET", "/schedules", {"params": params or {}})
def get_schedule(self, id: str) -> Schedule:
return self._request("GET", f"/schedules/{id}")
def delete_schedule(self, id: str) -> None:
self._request("DELETE", f"/schedules/{id}")
def pause_schedule(self, id: str) -> None:
self._request("PUT", f"/schedules/{id}/pause")
def resume_schedule(self, id: str) -> None:
self._request("PUT", f"/schedules/{id}/resume")
def get_variables(
self, params: Optional[Dict[str, Any]] = None
) -> TeamVariablesPaginatedResult:
return self._request("GET", "/variables", {"params": params or {}})
def create_variable(self, data: CreateTeamVariableInput) -> TeamVariable:
return self._request("POST", "/variables", {"data": data})
def update_variable(self, id: str, data: UpdateTeamVariableInput) -> TeamVariable:
return self._request("PATCH", f"/variables/{id}", {"data": data})
def delete_variable(self, id: str) -> None:
self._request("DELETE", f"/variables/{id}")
def get_modules(
self, params: Optional[Dict[str, Any]] = None
) -> ModulesPaginatedResult:
return self._request("GET", "/modules", {"params": params or {}})
def create_module(self, data: CreateModuleInput) -> Module:
return self._request("POST", "/modules", {"data": data})
def get_module(self, id: str) -> Module:
return self._request("GET", f"/modules/{id}")
def update_module(self, id: str, data: UpdateModuleInput) -> Module:
return self._request("PATCH", f"/modules/{id}", {"data": data})
def delete_module(self, id: str) -> None:
self._request("DELETE", f"/modules/{id}")
def get_module_versions(
self, module_id: str, params: Optional[Dict[str, Any]] = None
) -> VersionedModulesPaginatedResult:
return self._request(
"GET", f"/modules/{module_id}/versions", {"params": params or {}}
)
def publish_module_version(
self, module_id: str, data: PublishModuleInput
) -> VersionedModule:
return self._request("POST", f"/modules/{module_id}/versions", {"data": data})
def get_module_version_aliases(
self, module_id: str, params: Optional[Dict[str, Any]] = None
) -> VersionedModuleAliasesPaginatedResult:
return self._request(
"GET", f"/modules/{module_id}/aliases", {"params": params or {}}
)
def create_module_version_alias(
self, module_id: str, data: VersionedModuleAliasInput
) -> VersionedModuleAlias:
return self._request("POST", f"/modules/{module_id}/aliases", {"data": data})
def get_module_version(self, module_id: str, version_id: str) -> VersionedModule:
return self._request("GET", f"/modules/{module_id}/versions/{version_id}")
def delete_module_version(self, module_id: str, version_id: str) -> None:
self._request("DELETE", f"/modules/{module_id}/versions/{version_id}")
def get_module_version_alias(
self, module_id: str, alias_id: str
) -> VersionedModuleAlias:
return self._request("GET", f"/modules/{module_id}/aliases/{alias_id}")
def update_module_version_alias(
self, module_id: str, alias_id: str, data: VersionedModuleAliasInput
) -> VersionedModuleAlias:
return self._request(
"PATCH", f"/modules/{module_id}/aliases/{alias_id}", {"data": data}
)
def delete_module_version_alias(self, module_id: str, alias_id: str) -> None:
self._request("DELETE", f"/modules/{module_id}/aliases/{alias_id}")
def get_process_version(
self, process_id: str, version_id: str
) -> VersionedProcess:
return self._request("GET", f"/processes/{process_id}/versions/{version_id}")
def delete_process_version(self, process_id: str, version_id: str) -> None:
self._request("DELETE", f"/processes/{process_id}/versions/{version_id}")
def get_process_version_alias(
self, process_id: str, alias_id: str
) -> VersionedProcessAlias:
return self._request("GET", f"/processes/{process_id}/aliases/{alias_id}")
def update_process_version_alias(
self, process_id: str, alias_id: str, data: VersionedProcessAliasInput
) -> VersionedProcessAlias:
return self._request(
"PATCH", f"/processes/{process_id}/aliases/{alias_id}", {"data": data}
)
def delete_process_version_alias(self, process_id: str, alias_id: str) -> None:
self._request("DELETE", f"/processes/{process_id}/aliases/{alias_id}")
def update_schedule(self, id: str, data: ScheduledProcessInput) -> Schedule:
return self._request("PATCH", f"/schedules/{id}", {"data": data})
def get_service_accounts(self) -> List[ServiceAccount]:
return self._request("GET", "/auth/service-accounts")
def create_service_account(self, data: ServiceAccountInput) -> ServiceAccount:
return self._request("POST", "/auth/service-accounts", {"data": data})
def delete_service_account(self, id: str) -> None:
self._request("DELETE", f"/auth/service-accounts/{id}")
def get_team_dependencies(
self, language: ProgrammingLanguage
) -> ProgrammingLanguageManifest:
return self._request("GET", f"/dependencies/{language.value}")
def update_team_dependencies(
self, language: ProgrammingLanguage, data: UpdateTeamDependenciesInput
) -> ProgrammingLanguageManifest:
return self._request(
"PUT", f"/dependencies/{language.value}", {"data": data}
)
def install_team_dependencies(
self, language: ProgrammingLanguage
) -> ProgrammingLanguageManifest:
return self._request("POST", f"/dependencies/{language.value}/install")
def discard_team_dependencies_installation(
self, language: ProgrammingLanguage
) -> None:
self._request("DELETE", f"/dependencies/{language.value}/install")
def get_team(self) -> Team:
return self._request("GET", "/team")
def update_team(self, data: UpdateTeamInput) -> Team:
return self._request("PATCH", "/team", {"data": data})
def create_sandbox(self, data: CreateSandboxInput) -> Sandbox:
return self._request("POST", "/sandboxes", {"data": data})
def update_sandbox(self, sandbox_id: str, data: UpdateSandboxInput) -> Sandbox:
return self._request("POST", f"/sandboxes/{sandbox_id}", {"data": data})
def kill_sandbox(self, sandbox_id: str) -> None:
self._request("POST", f"/sandboxes/{sandbox_id}/kill")
def get_objects(self, params: Optional[Dict[str, Any]] = None) -> List[StorageObject]:
response = self._request("GET", "/storage/objects", {"params": params or {}})
return [StorageObject.from_dict(obj) for obj in response]
def get_object(self, name: str) -> requests.Response:
if not self.access_token:
self._get_access_token()
headers = {
"Authorization": f"Bearer {self.access_token}",
}
endpoint = f"/storage/objects/{name}"
url = urljoin(f"{self._get_base_url()}/", endpoint.lstrip("/"))
response = requests.get(
url, headers=headers, stream=True, timeout=self.timeout / 1000
)
response.raise_for_status()
return response
def create_object(self, data: CreateStorageObjectInput) -> StorageObject:
if not data.file:
raise ValueError("File or stream is required")
if not self.access_token:
self._get_access_token()
headers = {
"Authorization": f"Bearer {self.access_token}",
}
endpoint = f"/storage/objects?name={requests.utils.quote(data.name)}"
url = urljoin(f"{self._get_base_url()}/", endpoint.lstrip("/"))
# Detect content type
content_type, _ = mimetypes.guess_type(data.name)
files = {
"file": (data.name, data.file, content_type or "application/octet-stream")
}
response = requests.post(
url, headers=headers, files=files, timeout=self.timeout / 1000
)
if not response.ok:
try:
error_response = response.json()
message = error_response.get("message", response.reason)
except ValueError:
message = response.reason
raise YepCodeApiError(
f"HTTP error {response.status_code} in endpoint POST {endpoint}: {message}",
response.status_code,
)
return StorageObject.from_dict(response.json())
def delete_object(self, name: str) -> None:
if not self.access_token:
self._get_access_token()
headers = {
"Authorization": f"Bearer {self.access_token}",
}
endpoint = f"/storage/objects/{requests.utils.quote(name)}"
url = urljoin(f"{self._get_base_url()}/", endpoint.lstrip("/"))
response = requests.delete(url, headers=headers, timeout=self.timeout / 1000)
if not response.ok:
try:
error_response = response.json()
message = error_response.get("message", response.reason)
except ValueError:
message = response.reason
raise YepCodeApiError(
f"HTTP error {response.status_code} in endpoint DELETE {endpoint}: {message}",
response.status_code,
)
return None