astrocoins 2.0.0__tar.gz

astrocoins-2.0.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: astrocoins
+Version: 2.0.0
+Summary: Client SDK for the AstroCoins economy API
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.31

astrocoins-2.0.0/astrocoins/__init__.py

@@ -0,0 +1,21 @@
+from .client import AstroCoinsClient
+from .exceptions import (
+    AstroCoinsError,
+    ConfigurationError,
+    APIError,
+    InsufficientFundsError,
+    RateLimitError,
+    AuthenticationError,
+)
+
+__all__ = [
+    "AstroCoinsClient",
+    "AstroCoinsError",
+    "ConfigurationError",
+    "APIError",
+    "InsufficientFundsError",
+    "RateLimitError",
+    "AuthenticationError",
+]
+
+__version__ = "2.0.0"

astrocoins-2.0.0/astrocoins/client.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import os
+from typing import Optional
+
+import requests
+
+from .exceptions import (
+    AuthenticationError,
+    ConfigurationError,
+    InsufficientFundsError,
+    RateLimitError,
+    APIError,
+)
+
+_ENV_API_KEY = "ASTROCOINS_API_KEY"
+_ENV_BASE_URL = "ASTROCOINS_BASE_URL"
+
+_DEFAULT_BASE_URL = "https://astrobot.adevs.site/api/coins"
+
+
+class AstroCoinsClient:
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        *,
+        base_url: Optional[str] = None,
+        timeout: float = 8.0,
+    ):
+        self.api_key = api_key or os.environ.get(_ENV_API_KEY)
+        if not self.api_key:
+            raise ConfigurationError(
+                "An API key is required: pass api_key=... or set the "
+                f"{_ENV_API_KEY} environment variable. You can get a key "
+                "from an AstroCoins administrator."
+            )
+        self.base_url = (base_url or os.environ.get(_ENV_BASE_URL) or _DEFAULT_BASE_URL).rstrip("/")
+        self._timeout = timeout
+        self._session = requests.Session()
+        self._session.headers.update({"X-API-Key": self.api_key})
+
+    def _request(self, method: str, path: str, **kwargs) -> dict:
+        try:
+            resp = self._session.request(
+                method, f"{self.base_url}{path}", timeout=self._timeout, **kwargs
+            )
+        except requests.RequestException as exc:
+            raise APIError(0, f"Could not connect to the AstroCoins server: {exc}") from exc
+
+        if resp.status_code == 401:
+            raise AuthenticationError("The API key is invalid or has been revoked.")
+        if resp.status_code == 429:
+            raise RateLimitError("Daily limit for this key has been exceeded.")
+        if resp.status_code == 400 and "user_id" in kwargs.get("json", {}):
+            body = self._safe_json(resp)
+            raise InsufficientFundsError(
+                kwargs["json"]["user_id"],
+                kwargs["json"].get("amount", 0),
+                body.get("current_balance", 0),
+            )
+        if not resp.ok:
+            body = self._safe_json(resp)
+            raise APIError(resp.status_code, body.get("detail", resp.text))
+
+        return self._safe_json(resp)
+
+    @staticmethod
+    def _safe_json(resp) -> dict:
+        try:
+            return resp.json()
+        except ValueError:
+            return {}
+
+    def get_balance(self, user_id: int) -> int:
+        data = self._request("GET", f"/balance/{int(user_id)}")
+        return int(data.get("balance", 0))
+
+    def add_coins(self, user_id: int, amount: int, reason: str = "") -> int:
+        data = self._request(
+            "POST",
+            "/add",
+            json={"user_id": int(user_id), "amount": int(amount), "reason": reason},
+        )
+        return int(data.get("balance", 0))
+
+    def remove_coins(self, user_id: int, amount: int, reason: str = "") -> int:
+        data = self._request(
+            "POST",
+            "/remove",
+            json={"user_id": int(user_id), "amount": int(amount), "reason": reason},
+        )
+        return int(data.get("balance", 0))

astrocoins-2.0.0/astrocoins/exceptions.py

@@ -0,0 +1,32 @@
+class AstroCoinsError(Exception):
+    pass
+
+
+class ConfigurationError(AstroCoinsError):
+    pass
+
+
+class AuthenticationError(AstroCoinsError):
+    pass
+
+
+class InsufficientFundsError(AstroCoinsError):
+    def __init__(self, user_id: int, requested: int, available: int):
+        self.user_id = user_id
+        self.requested = requested
+        self.available = available
+        super().__init__(
+            f"User {user_id} has {available} coins, which is not enough "
+            f"to cover {requested}."
+        )
+
+
+class RateLimitError(AstroCoinsError):
+    pass
+
+
+class APIError(AstroCoinsError):
+    def __init__(self, status_code: int, detail: str):
+        self.status_code = status_code
+        self.detail = detail
+        super().__init__(f"AstroCoins API error ({status_code}): {detail}")

astrocoins-2.0.0/astrocoins.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: astrocoins
+Version: 2.0.0
+Summary: Client SDK for the AstroCoins economy API
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.31

astrocoins-2.0.0/astrocoins.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+pyproject.toml
+astrocoins/__init__.py
+astrocoins/client.py
+astrocoins/exceptions.py
+astrocoins.egg-info/PKG-INFO
+astrocoins.egg-info/SOURCES.txt
+astrocoins.egg-info/dependency_links.txt
+astrocoins.egg-info/requires.txt
+astrocoins.egg-info/top_level.txt

astrocoins-2.0.0/astrocoins.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

astrocoins-2.0.0/astrocoins.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.31

astrocoins-2.0.0/astrocoins.egg-info/top_level.txt

@@ -0,0 +1 @@
+astrocoins

astrocoins-2.0.0/pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "astrocoins"
+version = "2.0.0"
+description = "Client SDK for the AstroCoins economy API"
+requires-python = ">=3.9"
+dependencies = [
+    "requests>=2.31",
+]
+
+[tool.setuptools]
+packages = ["astrocoins"]

astrocoins-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+