|
|
|
|
@ -4,7 +4,7 @@ from dataclasses import dataclass |
|
|
|
|
from time import sleep |
|
|
|
|
from typing import Any, Dict, Optional |
|
|
|
|
|
|
|
|
|
import requests |
|
|
|
|
import httpx |
|
|
|
|
|
|
|
|
|
from . import __version__, api, exceptions |
|
|
|
|
|
|
|
|
|
@ -23,15 +23,14 @@ GET_TIMEOUT = 60 |
|
|
|
|
POST_TIMEOUT = 90 |
|
|
|
|
USE_TOR_PROXY = "auto" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
session = requests.Session() |
|
|
|
|
HEADERS = {"User-Agent": f"sporestack-python/{__version__}"} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _get_tor_proxy() -> str: |
|
|
|
|
""" |
|
|
|
|
This makes testing easier. |
|
|
|
|
""" |
|
|
|
|
return os.getenv("TOR_PROXY", "socks5h://127.0.0.1:9050") |
|
|
|
|
return os.getenv("TOR_PROXY", "socks5://127.0.0.1:9050") |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# For requests module |
|
|
|
|
@ -59,81 +58,77 @@ def _is_onion_url(url: str) -> bool: |
|
|
|
|
return False |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _api_request( |
|
|
|
|
url: str, |
|
|
|
|
empty_post: bool = False, |
|
|
|
|
json_params: Optional[Dict[str, Any]] = None, |
|
|
|
|
retry: bool = False, |
|
|
|
|
) -> Any: |
|
|
|
|
headers = {"User-Agent": f"sporestack-python/{__version__}"} |
|
|
|
|
proxies = {} |
|
|
|
|
if _is_onion_url(url) is True: |
|
|
|
|
log.debug("Got a .onion API endpoint, using local Tor SOCKS proxy.") |
|
|
|
|
proxies = TOR_PROXY_REQUESTS |
|
|
|
|
@dataclass |
|
|
|
|
class APIClient: |
|
|
|
|
api_endpoint: str = API_ENDPOINT |
|
|
|
|
|
|
|
|
|
try: |
|
|
|
|
if empty_post is True: |
|
|
|
|
request = session.post( |
|
|
|
|
url, timeout=POST_TIMEOUT, proxies=proxies, headers=headers |
|
|
|
|
) |
|
|
|
|
elif json_params is None: |
|
|
|
|
request = session.get( |
|
|
|
|
url, timeout=GET_TIMEOUT, proxies=proxies, headers=headers |
|
|
|
|
) |
|
|
|
|
else: |
|
|
|
|
request = session.post( |
|
|
|
|
url, |
|
|
|
|
json=json_params, |
|
|
|
|
timeout=POST_TIMEOUT, |
|
|
|
|
proxies=proxies, |
|
|
|
|
headers=headers, |
|
|
|
|
) |
|
|
|
|
except Exception as e: |
|
|
|
|
if retry is True: |
|
|
|
|
log.warning(f"Got an error, but retrying: {e}") |
|
|
|
|
sleep(5) |
|
|
|
|
# Try again. |
|
|
|
|
return _api_request( |
|
|
|
|
url, |
|
|
|
|
empty_post=empty_post, |
|
|
|
|
json_params=json_params, |
|
|
|
|
retry=retry, |
|
|
|
|
) |
|
|
|
|
else: |
|
|
|
|
raise |
|
|
|
|
def __post_init__(self) -> None: |
|
|
|
|
headers = httpx.Headers(HEADERS) |
|
|
|
|
proxy = None |
|
|
|
|
if _is_onion_url(self.api_endpoint): |
|
|
|
|
proxy = _get_tor_proxy() |
|
|
|
|
self._httpx_client = httpx.Client(headers=headers, proxies=proxy) |
|
|
|
|
|
|
|
|
|
status_code_first_digit = request.status_code // 100 |
|
|
|
|
if status_code_first_digit == 2: |
|
|
|
|
def _api_request( |
|
|
|
|
self, |
|
|
|
|
url: str, |
|
|
|
|
empty_post: bool = False, |
|
|
|
|
json_params: Optional[Dict[str, Any]] = None, |
|
|
|
|
params: Optional[Dict[str, Any]] = None, |
|
|
|
|
retry: bool = False, |
|
|
|
|
) -> Any: |
|
|
|
|
try: |
|
|
|
|
return request.json() |
|
|
|
|
except Exception: |
|
|
|
|
return request.content |
|
|
|
|
elif status_code_first_digit == 4: |
|
|
|
|
log.debug("HTTP status code: {request.status_code}") |
|
|
|
|
raise exceptions.SporeStackUserError(request.content.decode("utf-8")) |
|
|
|
|
elif status_code_first_digit == 5: |
|
|
|
|
if retry is True: |
|
|
|
|
log.warning(request.content.decode("utf-8")) |
|
|
|
|
log.warning("Got a 500, retrying in 5 seconds...") |
|
|
|
|
sleep(5) |
|
|
|
|
# Try again if we get a 500 |
|
|
|
|
return _api_request( |
|
|
|
|
url, |
|
|
|
|
empty_post=empty_post, |
|
|
|
|
json_params=json_params, |
|
|
|
|
retry=retry, |
|
|
|
|
) |
|
|
|
|
if empty_post is True: |
|
|
|
|
request = self._httpx_client.post(url, timeout=POST_TIMEOUT) |
|
|
|
|
elif json_params is None: |
|
|
|
|
request = self._httpx_client.get(url, timeout=GET_TIMEOUT) |
|
|
|
|
else: |
|
|
|
|
request = self._httpx_client.post( |
|
|
|
|
url, |
|
|
|
|
json=json_params, |
|
|
|
|
timeout=POST_TIMEOUT, |
|
|
|
|
) |
|
|
|
|
except Exception as e: |
|
|
|
|
if retry is True: |
|
|
|
|
log.warning(f"Got an error, but retrying: {e}") |
|
|
|
|
sleep(5) |
|
|
|
|
# Try again. |
|
|
|
|
return self._api_request( |
|
|
|
|
url, |
|
|
|
|
empty_post=empty_post, |
|
|
|
|
json_params=json_params, |
|
|
|
|
retry=retry, |
|
|
|
|
) |
|
|
|
|
else: |
|
|
|
|
raise |
|
|
|
|
|
|
|
|
|
status_code_first_digit = request.status_code // 100 |
|
|
|
|
if status_code_first_digit == 2: |
|
|
|
|
try: |
|
|
|
|
return request.json() |
|
|
|
|
except Exception: |
|
|
|
|
return request.content |
|
|
|
|
elif status_code_first_digit == 4: |
|
|
|
|
log.debug("HTTP status code: {request.status_code}") |
|
|
|
|
raise exceptions.SporeStackUserError(request.content.decode("utf-8")) |
|
|
|
|
elif status_code_first_digit == 5: |
|
|
|
|
if retry is True: |
|
|
|
|
log.warning(request.content.decode("utf-8")) |
|
|
|
|
log.warning("Got a 500, retrying in 5 seconds...") |
|
|
|
|
sleep(5) |
|
|
|
|
# Try again if we get a 500 |
|
|
|
|
return self._api_request( |
|
|
|
|
url, |
|
|
|
|
empty_post=empty_post, |
|
|
|
|
json_params=json_params, |
|
|
|
|
retry=retry, |
|
|
|
|
) |
|
|
|
|
else: |
|
|
|
|
raise exceptions.SporeStackServerError(str(request.content)) |
|
|
|
|
else: |
|
|
|
|
raise exceptions.SporeStackServerError(str(request.content)) |
|
|
|
|
else: |
|
|
|
|
# Not sure why we'd get this. |
|
|
|
|
request.raise_for_status() |
|
|
|
|
raise Exception("Stuff broke strangely. Please contact SporeStack support.") |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass |
|
|
|
|
class APIClient: |
|
|
|
|
api_endpoint: str = API_ENDPOINT |
|
|
|
|
# Not sure why we'd get this. |
|
|
|
|
request.raise_for_status() |
|
|
|
|
raise Exception("Stuff broke strangely. Please contact SporeStack support.") |
|
|
|
|
|
|
|
|
|
def server_launch( |
|
|
|
|
self, |
|
|
|
|
@ -144,10 +139,10 @@ class APIClient: |
|
|
|
|
ssh_key: str, |
|
|
|
|
token: str, |
|
|
|
|
region: Optional[str] = None, |
|
|
|
|
quote: bool = False, |
|
|
|
|
hostname: str = "", |
|
|
|
|
autorenew: bool = False, |
|
|
|
|
) -> api.ServerLaunch.Response: |
|
|
|
|
) -> None: |
|
|
|
|
"""Launch a server.""" |
|
|
|
|
request = api.ServerLaunch.Request( |
|
|
|
|
days=days, |
|
|
|
|
token=token, |
|
|
|
|
@ -155,31 +150,36 @@ class APIClient: |
|
|
|
|
region=region, |
|
|
|
|
operating_system=operating_system, |
|
|
|
|
ssh_key=ssh_key, |
|
|
|
|
quote=quote, |
|
|
|
|
hostname=hostname, |
|
|
|
|
autorenew=autorenew, |
|
|
|
|
) |
|
|
|
|
url = self.api_endpoint + api.ServerLaunch.url.format(machine_id=machine_id) |
|
|
|
|
response = _api_request(url=url, json_params=request.dict()) |
|
|
|
|
response_object = api.ServerLaunch.Response.parse_obj(response) |
|
|
|
|
assert response_object.machine_id == machine_id |
|
|
|
|
return response_object |
|
|
|
|
self._api_request(url=url, json_params=request.dict()) |
|
|
|
|
|
|
|
|
|
def server_topup( |
|
|
|
|
self, |
|
|
|
|
machine_id: str, |
|
|
|
|
days: int, |
|
|
|
|
token: str, |
|
|
|
|
) -> api.ServerTopup.Response: |
|
|
|
|
""" |
|
|
|
|
Topup a server. |
|
|
|
|
""" |
|
|
|
|
) -> None: |
|
|
|
|
"""Topup a server.""" |
|
|
|
|
request = api.ServerTopup.Request(days=days, token=token) |
|
|
|
|
url = self.api_endpoint + api.ServerTopup.url.format(machine_id=machine_id) |
|
|
|
|
response = _api_request(url=url, json_params=request.dict()) |
|
|
|
|
response_object = api.ServerTopup.Response.parse_obj(response) |
|
|
|
|
assert response_object.machine_id == machine_id |
|
|
|
|
return response_object |
|
|
|
|
self._api_request(url=url, json_params=request.dict()) |
|
|
|
|
|
|
|
|
|
def server_quote(self, days: int, flavor: str) -> api.ServerQuote.Response: |
|
|
|
|
"""Get a quote for how much a server will cost.""" |
|
|
|
|
|
|
|
|
|
url = self.api_endpoint + api.ServerQuote.url |
|
|
|
|
response = self._httpx_client.get( |
|
|
|
|
url=url, |
|
|
|
|
params={"days": days, "flavor": flavor}, |
|
|
|
|
) |
|
|
|
|
if response.status_code == 422: |
|
|
|
|
raise exceptions.SporeStackUserError(response.json()["detail"]) |
|
|
|
|
|
|
|
|
|
response.raise_for_status() |
|
|
|
|
return api.ServerQuote.Response.parse_obj(response.json()) |
|
|
|
|
|
|
|
|
|
def autorenew_enable(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
@ -188,7 +188,7 @@ class APIClient: |
|
|
|
|
url = self.api_endpoint + api.ServerEnableAutorenew.url.format( |
|
|
|
|
machine_id=machine_id |
|
|
|
|
) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def autorenew_disable(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
@ -197,35 +197,35 @@ class APIClient: |
|
|
|
|
url = self.api_endpoint + api.ServerDisableAutorenew.url.format( |
|
|
|
|
machine_id=machine_id |
|
|
|
|
) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_start(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
Power on the server. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerStart.url.format(machine_id=machine_id) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_stop(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
Power off the server. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerStop.url.format(machine_id=machine_id) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_delete(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
Delete the server. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerDelete.url.format(machine_id=machine_id) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_forget(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
Forget about a destroyed/deleted server. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerForget.url.format(machine_id=machine_id) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_rebuild(self, machine_id: str) -> None: |
|
|
|
|
""" |
|
|
|
|
@ -234,16 +234,15 @@ class APIClient: |
|
|
|
|
Deletes all of the data on the server! |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerRebuild.url.format(machine_id=machine_id) |
|
|
|
|
_api_request(url, empty_post=True) |
|
|
|
|
self._api_request(url, empty_post=True) |
|
|
|
|
|
|
|
|
|
def server_info(self, machine_id: str) -> api.ServerInfo.Response: |
|
|
|
|
""" |
|
|
|
|
Returns info about the server. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServerInfo.url.format(machine_id=machine_id) |
|
|
|
|
response = _api_request(url) |
|
|
|
|
response = self._api_request(url) |
|
|
|
|
response_object = api.ServerInfo.Response.parse_obj(response) |
|
|
|
|
assert response_object.machine_id == machine_id |
|
|
|
|
return response_object |
|
|
|
|
|
|
|
|
|
def servers_launched_from_token( |
|
|
|
|
@ -253,25 +252,21 @@ class APIClient: |
|
|
|
|
Returns info of servers launched from a given token. |
|
|
|
|
""" |
|
|
|
|
url = self.api_endpoint + api.ServersLaunchedFromToken.url.format(token=token) |
|
|
|
|
response = _api_request(url) |
|
|
|
|
response = self._api_request(url) |
|
|
|
|
response_object = api.ServersLaunchedFromToken.Response.parse_obj(response) |
|
|
|
|
return response_object |
|
|
|
|
|
|
|
|
|
def flavors(self) -> api.Flavors.Response: |
|
|
|
|
""" |
|
|
|
|
Returns available flavors. |
|
|
|
|
""" |
|
|
|
|
"""Returns available flavors (server sizes).""" |
|
|
|
|
url = self.api_endpoint + api.Flavors.url |
|
|
|
|
response = _api_request(url) |
|
|
|
|
response = self._api_request(url) |
|
|
|
|
response_object = api.Flavors.Response.parse_obj(response) |
|
|
|
|
return response_object |
|
|
|
|
|
|
|
|
|
def operating_systems(self) -> api.OperatingSystems.Response: |
|
|
|
|
""" |
|
|
|
|
Returns available operating systems. |
|
|
|
|
""" |
|
|
|
|
"""Returns available operating systems.""" |
|
|
|
|
url = self.api_endpoint + api.OperatingSystems.url |
|
|
|
|
response = _api_request(url) |
|
|
|
|
response = self._api_request(url) |
|
|
|
|
response_object = api.OperatingSystems.Response.parse_obj(response) |
|
|
|
|
return response_object |
|
|
|
|
|
|
|
|
|
@ -282,16 +277,16 @@ class APIClient: |
|
|
|
|
currency: str, |
|
|
|
|
retry: bool = False, |
|
|
|
|
) -> api.TokenAdd.Response: |
|
|
|
|
"""Add balance (money) to a token.""" |
|
|
|
|
request = api.TokenAdd.Request(dollars=dollars, currency=currency) |
|
|
|
|
url = self.api_endpoint + api.TokenAdd.url.format(token=token) |
|
|
|
|
response = _api_request(url=url, json_params=request.dict(), retry=retry) |
|
|
|
|
response = self._api_request(url=url, json_params=request.dict(), retry=retry) |
|
|
|
|
response_object = api.TokenAdd.Response.parse_obj(response) |
|
|
|
|
assert response_object.token == token |
|
|
|
|
return response_object |
|
|
|
|
|
|
|
|
|
def token_balance(self, token: str) -> api.TokenBalance.Response: |
|
|
|
|
"""Return a token's balance.""" |
|
|
|
|
url = self.api_endpoint + api.TokenBalance.url.format(token=token) |
|
|
|
|
response = _api_request(url=url) |
|
|
|
|
response = self._api_request(url=url) |
|
|
|
|
response_object = api.TokenBalance.Response.parse_obj(response) |
|
|
|
|
assert response_object.token == token |
|
|
|
|
return response_object |
|
|
|
|
|
SporeStack
2 months ago