nsarchive 2.0.0b2__py3-none-any.whl → 3.0.0a2__py3-none-any.whl

nsarchive/__init__.py

@@ -1,27 +1,24 @@
 """
 nsarchive - API-wrapper pour récupérer des données liées à Nation.
 
-Version: 2.0.0
+Version: 3.0.0a2
 License: GPL-3.0
 Auteur : happex <110610727+okayhappex@users.noreply.github.com>
 
 Dependencies:
 - Python ^3.10
-- supabase ^2.9.1
 - pillow ^10.4
 
 Le fichier README.md fournit des détails supplémentaires pour l'utilisation.
 """
 
-# Import des types et des exceptions 
+# Import des types 
 from .cls.base import NSID
 from .cls.archives import *
 from .cls.entities import *
 from .cls.republic import *
 from .cls.economy import *
 
-from .cls.exceptions import *
-
 # Import des instances
 from .instances._economy import EconomyInstance
 from .instances._entities import EntityInstance

nsarchive/cls/archives.py

@@ -3,7 +3,24 @@ import time
 from .base import *
 
 class Archive:
-    def __init__(self, author: str | NSID = '0', target: str | NSID = '0') -> None:
+    def __init__(self, author: NSID = '0', target: NSID = '0'):
+        """
+        Classe de référence pour toutes les archives.
+
+        ## Attributs de base
+        - date: `int`\n
+            Date (timestamp) de l'exécution de l'archive
+        - id: `NSID`\n
+            Clé d'identification des archives (basée sur la date)
+        - author: `NSID`\n
+            ID de l'auteur de l'action
+        - target: `NSID`:
+            ID de la cible de l'action
+        - action: `str`:\n
+            Action effectuée
+        - details: `dict`\n
+            Ensemble de détails que les différents bots peuvent utiliser
+        """
         self.date: int = round(time.time())
 
         self.id: NSID = NSID(self.date)
@@ -19,7 +36,7 @@ class Archive:
 # Entities
 
 class Sanction(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details: dict = {
@@ -29,7 +46,7 @@ class Sanction(Archive):
         }
 
 class Report(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details: dict = {
@@ -41,7 +58,7 @@ class Report(Archive):
 # Community
 
 class Election(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
+    def __init__(self, author: NSID, target: NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.details = {
@@ -51,7 +68,7 @@ class Election(Archive):
         }
 
 class Promotion(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
+    def __init__(self, author: NSID, target: NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.details = {
@@ -59,14 +76,14 @@ class Promotion(Archive):
         }
 
 class Demotion(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
 
 # Bank
 
 class Transaction(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details = {

nsarchive/cls/base.py

@@ -1,9 +1,15 @@
+import io
 import json
+import requests
 import typing
-
-from supabase import Client
+import warnings
 
 class NSID(str):
+    """
+    Nation Server ID
+
+    ID unique et universel pour l'ensemble des entités et évènements. Il prend les `int`, les `str` et les autres instances `NSID` pour les convertir en un identifiant hexadécimal.
+    """
     unknown = "0"
     admin = "1"
     gov = "2"
@@ -35,134 +41,178 @@ class NSID(str):
         return instance
 
 class Instance:
-    def __init__(self, client: Client):
-        self.db = client
+    """
+    Instance qui servira de base à toutes les instances.
+    """
+
+    def __init__(self, url: str, token: str = None):
+        self.url = url
+        self.token = token
+
+        self.default_headers = {
+            "Authorization": f"Bearer {self.token}",
+            "Content-Type": "application/json",
+        }
+
+    def request_token(self, username: str, password: str) -> str | None:
+        res = requests.post(f"{self.url}/auth/login", json = {
+            "username": username,
+            "password": password
+        })
+
+        if res.status_code == 200:
+            return res.json()["token"]
+        elif res.status_code in (401, 403):
+            raise PermissionError(res.json()['message'])
+        else:
+            raise Exception(f"Error {res.status_code}: {res.json()['message']}")
 
-    def _select_from_db(self, table: str, key: str = None, value: str = None) -> list:
+    def _get_item(self, endpoint: str, body: dict = None, headers: dict = None) -> dict:
         """
-        Récupère des données JSON d'une table Supabase en fonction de l'ID.
+        Récupère des données JSON depuis l'API
 
         ## Paramètres
-        table: `str`:\n
-            Nom de la base
-        key: `str`\n
-            Clé à vérifier
-        value: `str`\n
-            Valeur de la clé à vérifier
+        endpoint: `str`:
+            Endpoint de l'URL
+        headers: `dict` (optional)
+            Headers à envoyer
+        body: `dict` (optional)
+            Données à envoyer
 
         ## Renvoie
         - `list` de tous les élements correspondants
         - `None` si aucune donnée n'est trouvée
         """
 
-        if key and value:
-            res = self.db.from_(table).select("*").eq(key, value).execute()
-        else:
-            res = self.db.from_(table).select("*").execute()
+        if not headers:
+            headers = self.default_headers
 
-        if res.data:
-            return res.data
-        else:
-            return None
+        res = requests.get(f"{self.url}/{endpoint}", headers = headers, json = body, timeout = 5)
 
-    def _get_by_ID(self, table: str, id: NSID) -> dict:
-        _data = self._select_from_db(table, 'id', id)
+        if 200 <= res.status_code < 300:
+            return res.json()
+        elif res.status_code == 404:
+            return
+        elif res.status_code in (403, 401):
+            raise PermissionError(res.json()['message'])
+        else:
+            raise Exception(f"Error {res.status_code}: {res.json()['message']}")
 
-        if _data is not None:
-            _data = _data[0]
+    def _get_by_ID(self, _class: str, id: NSID) -> dict:
+        _data = self._get_item(f"/model/{_class}/{id}")
 
         return _data
 
-    def _put_in_db(self, table: str, data: dict) -> None:
+    def _put_in_db(self, endpoint: str, body: dict, headers: dict = None, use_PUT: bool = False) -> None:
         """
-        Publie des données JSON dans une table Supabase en utilisant le client Supabase.
+        Publie des données JSON dans une table nation-db.
 
-        :param table: Nom de la table dans laquelle les données doivent être insérées
-        :param data: Dictionnaire contenant les données à publier
-        :return: Résultat de l'insertion
+        ## Paramètres
+        endpoint: `str`
+            Endpoint de l'URL
+        body: `dict`
+            Données à envoyer
+        headers: `dict` (optionnel)
+            Headers à envoyer
         """
 
-        res = self.db.from_(table).upsert(data).execute()
+        if not headers:
+            headers = headers
+
+        if use_PUT:
+            res = requests.put(f"{self.url}/{endpoint}", headers = headers, json = body)
+        else:
+            res = requests.post(f"{self.url}/{endpoint}", headers = headers, json = body)
 
-        return res
+        if 200 <= res.status_code < 300:
+            return res.json()
+        else:
+            print(res.text)
+            res.raise_for_status()
 
-    def _delete_from_db(self, table: str, key: str, value: str):
+    def _delete(self, _class: str, ids: list[NSID]) -> None:
         """
-        Supprime un enregistrement d'une table Supabase en fonction d'une clé et de sa valeur.
+        Supprime des données JSON dans une table nation-db.
 
         ## Paramètres
-        table: `str`
-            Nom de la table dans laquelle les données doivent être supprimées
-        key: `str`
-            Clé à vérifier (par exemple "id" ou autre clé unique)
-        value: `str`
-            Valeur de la clé à vérifier pour trouver l'enregistrement à supprimer
-
-        ## Renvoie
-        - `True` si la suppression a réussi
-        - `False` si aucune donnée n'a été trouvée ou si la suppression a échoué
+        _class: `str`
+            Classe des entités à supprimer
+        ids: `list[NSID]`
+            ID des entités à supprimer
         """
 
-        res = self.db.from_(table).delete().eq(key, value).execute()
+        res = requests.post(f"{self.url}/delete_{_class}", json = { "ids": ids })
 
-        return res
-
-    def _delete_by_ID(self, table: str, id: NSID):
-        res = self._delete_from_db(table, 'id', id)
-
-        return res
-
-    def fetch(self, table: str, **query: typing.Any) -> list:
-        matches = []
-
-        for key, value in query.items():
-            entity = self._select_from_db(table, key, value)
+        if 200 <= res.status_code < 300:
+            return res.json()
+        elif res.status_code in (403, 401):
+            raise PermissionError(res.json()['message'])
+        else:
+            raise Exception(f"Error {res.status_code}: {res.json()['message']}")
 
-            if entity is not None:
-                matches.append(entity)
+    def _delete_by_ID(self, _class: str, id: NSID):
+        warnings.showwarning("Method '_delete_by_id' is deprecated. Use '_delete' instead.")
+        self._delete(_class, id)
 
-        if query == {}:
-            matches = [ self._select_from_db(table) ]
+    def fetch(self, _class: str, **query: typing.Any) -> list:
+        res = requests.get(f"{self.url}/fetch/{_class}", params = query)
 
-        if not matches or (len(matches) != len(query) and query != {}):
-            return []
+        if res.status_code == 200:
+            matches = res.json()
+        elif res.status_code in (401, 403):
+            matches = []
+        else:
+            res.raise_for_status()
 
-        _res = [ item for item in matches[0] if all(item in match for match in matches[1:]) ]
+        return matches
 
-        return _res
 
-    def _upload_to_storage(self, bucket: str, data: bytes, path: str, overwrite: bool = False, options: dict = {'content-type': 'image/png'}) -> dict:
+    def _upload_file(self, bucket: str, name: str, data: bytes, overwrite: bool = False, headers: dict = None) -> dict:
         """
-        Envoie un fichier dans un bucket Supabase.
+        Envoie un fichier dans un bucket nation-db.
 
         ## Paramètres
-        bucket: `str`\n
+        bucket: `str`
             Nom du bucket où le fichier sera stocké
-        data: `bytes`\n
+        name: `str`
+            Nom du fichier dans le drive
+        data: `bytes`
             Données à uploader
-        path: `str`\n
-            Chemin dans le bucket où le fichier sera stocké
+        overwrite: `bool` (optional)
+            Overwrite ou non
+        headers: `dict` (optional)
+            Headers à envoyer
 
         ## Renvoie
         - `dict` contenant les informations de l'upload si réussi
         - `None` en cas d'échec
         """
 
-        options["upsert"] = json.dumps(overwrite)
+        if not headers:
+            headers = self.default_headers
+            headers['Content-Type'] = 'image/png'
 
-        if len(data) > 5 * 1000 ** 3:
-            raise ValueError("La limite d'un fichier à upload est de 1Mo")
+        body = {
+            "name": name,
+            "overwrite": json.dumps(overwrite)
+        }
 
-        res = self.db.storage.from_(bucket).upload(path, data, options)
+        file = ("file", "image/png", data)
 
-        if res.json().get("error"):
-            print("Erreur lors de l'upload:", res["error"])
+        res = requests.put(f"{self.url}/upload_file/{bucket}", headers = headers, json = body, files = [ file ])
 
-        return res
+        if res.status_code == 200:
+            return res.json()
+        elif res.status_code in (403, 401):
+            raise PermissionError(res.json()['message'])
+        elif res.status_code == 409:
+            raise FileExistsError(res.json()['message'])
+        else:
+            raise Exception(f"Error {res.status_code}: {res.json()['message']}") 
 
-    def _download_from_storage(self, bucket: str, path: str) -> bytes:
+    def _download_from_storage(self, bucket: str, path: str, headers: dict = None) -> bytes:
         """
-        Télécharge un fichier depuis le stockage Supabase.
+        Télécharge un fichier depuis le stockage nation-db.
 
         ## Paramètres
         bucket: `str`\n
@@ -174,6 +224,14 @@ class Instance:
         - Le fichier demandé en `bytes`
         """
 
-        res = self.db.storage.from_(bucket).download(path)
+        if not headers:
+            headers = self.default_headers
 
-        return res
+        res = requests.get(f"{self.url}/drive/{bucket}/{path}", headers = headers)
+
+        if res.status_code == 200:
+            return res.json()
+        elif res.status_code in (403, 401):
+            raise PermissionError(res.json()['message'])
+        else:
+            raise Exception(f"Error {res.status_code}: {res.json()['message']}") 

nsarchive/cls/economy.py

@@ -1,22 +1,62 @@
 from .base import NSID
 
 class BankAccount:
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Compte en banque d'une entité, individuelle ou collective.
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant du compte
+    - owner: `NSID`\n
+        Identifiant du titulaire du compte
+    - amount: `int`\n
+        Somme d'argent totale sur le compte
+    - frozen: `bool`\n
+        État gelé ou non du compte
+    - bank: `NSID`\n
+        Identifiant de la banque qui détient le compte
+    - income: `int`\n
+        Somme entrante sur le compte depuis la dernière réinitialisation (tous les ~ 28 jours)
+    """
+
+    def __init__(self, id: NSID) -> None:
         self.id: NSID = NSID(id)
         self.owner: NSID = NSID(0)
         self.amount: int = 0
         self.frozen: bool = False
-        self.bank: str = "HexaBank"
+        self.bank: NSID = NSID("6")
 
         self.income: int = 0
 
 class Item:
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Article d'inventaire qui peut circuler sur le serveur
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de l'objet
+    - title: `str`\n
+        Nom de l'objet
+    - emoji: `str`\n
+        Emoji lié à l'objet
+    """
+
+    def __init__(self, id: NSID) -> None:
         self.id: NSID = NSID(id)
         self.title: str = "Unknown Object"
         self.emoji: str = ":light_bulb:"
 
 class Inventory:
+    """
+    Inventaire d'un membre
+
+    ## Attributs
+    - owner_id: `NSID`\n
+        ID du propriétaire de l'inventaire
+    - objects: `dict[str, NSID]`\n
+        Collection d'objets et leur quantité
+    """
+
     def __init__(self, owner_id: NSID) -> None:
         self.owner_id: NSID = NSID(owner_id)
         self.objects: dict[str, NSID] = {}
@@ -35,6 +75,22 @@ class Inventory:
                 self.objects[item.id] = 0
 
 class Sale:
+    """
+    Vente mettant en jeu un objet
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de la vente
+    - item: `NSID`\n
+        Identifiant de l'objet mis en vente
+    - quantity: `int`\n
+        Quantité d'objets mis en vente
+    - price: `int`\n
+        Prix total du lot
+    - seller_id: `NSID`\n
+        Identifiant du vendeur
+    """
+
     def __init__(self, id: NSID, item: Item) -> None:
         self.id: NSID = NSID(id)
         self.item: NSID = NSID(item.id)