import json
import time
from typing import Any, Iterator, Optional
import requests
class CamposCloudError(Exception):
"""The API answered with an error status."""
def __init__(self, status: int, message: str):
super().__init__(f"{status}: {message}")
self.status = status
self.message = message
class CamposCloud:
def __init__(
self,
api_token: str,
base_url: str = "https://api.camposcloud.com/v1",
timeout: float = 30,
max_retries: int = 3,
):
if not api_token:
raise ValueError("api_token is required")
self.base_url = base_url.rstrip("/")
self.timeout = timeout
self.max_retries = max_retries
self.session = requests.Session()
self.session.headers["Authorization"] = f"Bearer {api_token}"
def _request(self, method: str, path: str, *, binary: bool = False, **kwargs: Any) -> Any:
for attempt in range(self.max_retries + 1):
response = self.session.request(method, f"{self.base_url}{path}", timeout=self.timeout, **kwargs)
# A 429 means the request was refused, so it is safe to send it again after waiting.
if response.status_code == 429 and attempt < self.max_retries:
time.sleep(float(response.headers.get("Retry-After", "1")))
if "files" in kwargs:
for _, value in kwargs["files"].items():
value.seek(0)
continue
if not response.ok:
try:
message = response.json().get("error", response.text)
except ValueError:
message = response.text
raise CamposCloudError(response.status_code, message)
return response.content if binary else response.json()
# Account
def get_me(self) -> dict:
return self._request("GET", "/users/@me")["user"]
# Applications
def list_apps(self, page: int = 1, limit: int = 10, team: Optional[str] = None, name: Optional[str] = None) -> dict:
params = {"page": page, "limit": limit, "team": team, "name": name}
return self._request("GET", "/apps", params={k: v for k, v in params.items() if v is not None})
def iter_apps(self, **filters: Any) -> Iterator[dict]:
"""Every application, page after page."""
page = 1
while True:
result = self.list_apps(page=page, **filters)
yield from result["applications"]
if not result["pagination"]["hasNextPage"]:
return
page += 1
def get_app(self, app_id: str) -> dict:
return self._request("GET", f"/apps/{app_id}")
def create_app(self, zip_path: str, app_name: str, runtime: str, memory_mb: int, **fields: Any) -> dict:
"""Extra fields use the names of the API: mainFile, startupCommand, exposedViaWeb, port,
assignedSubdomain, autoRestartEnabled, team and environmentVariables (a list of {key, value})."""
data = {"appName": app_name, "runtimeEnvironment": runtime, "memoryMB": memory_mb}
for key, value in fields.items():
if value is None:
continue
if key == "environmentVariables":
data[key] = json.dumps(value)
elif isinstance(value, bool):
data[key] = "true" if value else "false"
else:
data[key] = value
with open(zip_path, "rb") as zip_file:
return self._request("POST", "/apps/create", files={"file": zip_file}, data=data)
def update_app(self, app_id: str, **fields: Any) -> dict:
"""Only the fields you pass are changed. Check `restartRequired` in the result."""
return self._request("POST", f"/apps/{app_id}/update", json=fields)
def start_app(self, app_id: str) -> dict:
return self._request("POST", f"/apps/{app_id}/start")
def stop_app(self, app_id: str) -> dict:
return self._request("POST", f"/apps/{app_id}/stop")
def restart_app(self, app_id: str) -> dict:
return self._request("POST", f"/apps/{app_id}/restart")
def delete_app(self, app_id: str) -> dict:
return self._request("DELETE", f"/apps/{app_id}/delete")
# Files
def upload(self, app_id: str, zip_path: str, path: str = "/") -> dict:
with open(zip_path, "rb") as zip_file:
return self._request("POST", f"/apps/{app_id}/upload", params={"path": path}, files={"file": zip_file})
def download(self, app_id: str, path: Optional[str] = None) -> bytes:
"""A zip archive, even when `path` is a single file."""
params = {"path": path} if path else None
return self._request("GET", f"/apps/{app_id}/download", params=params, binary=True)
# Teams
def list_teams(self) -> list:
return self._request("GET", "/teams")
def get_team(self, team_id: str) -> dict:
return self._request("GET", f"/teams/{team_id}")
# Databases
def list_databases(self, page: int = 1, limit: int = 10) -> dict:
return self._request("GET", "/databases", params={"page": page, "limit": limit})
def get_database(self, database_id: str) -> dict:
return self._request("GET", f"/databases/{database_id}")
def create_database(self, **fields: Any) -> dict:
return self._request("POST", "/databases/create", json=fields)
def start_database(self, database_id: str) -> dict:
return self._request("POST", f"/databases/{database_id}/start")
def stop_database(self, database_id: str) -> dict:
return self._request("POST", f"/databases/{database_id}/stop")
def restart_database(self, database_id: str) -> dict:
return self._request("POST", f"/databases/{database_id}/restart")
def delete_database(self, database_id: str) -> dict:
return self._request("DELETE", f"/databases/{database_id}")