nsarchive 2.0.0b2__tar.gz → 3.0.0a2__tar.gz

nsarchive-3.0.0a2/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: nsarchive
+Version: 3.0.0a2
+Summary: API-wrapper pour récupérer des données liées à Nation
+License: GPL-3.0
+Author: happex
+Author-email: 110610727+okayhappex@users.noreply.github.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pillow (>=10.4,<11.0)
+Description-Content-Type: text/markdown
+
+# NSArchive
+
+Documentation pas disponible pour l'instant

nsarchive-3.0.0a2/README.md

@@ -0,0 +1,3 @@
+# NSArchive
+
+Documentation pas disponible pour l'instant

{nsarchive-2.0.0b2 → nsarchive-3.0.0a2}/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-2.0.0b2 → nsarchive-3.0.0a2}/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-3.0.0a2/nsarchive/cls/base.py

@@ -0,0 +1,237 @@
+import io
+import json
+import requests
+import typing
+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"
+    court = "3"
+    assembly = "4"
+    office = "5"
+    hexabank = "6"
+    archives = "7"
+
+    maintenance_com = "101"
+    audiovisual_dept = "102"
+    interior_dept = "103"
+    justice_dept = "104"
+    egalitary_com = "105"
+    antifraud_dept = "106"
+
+    def __new__(cls, value):
+        if type(value) == int:
+            value = hex(value)
+        elif type(value) in (str, NSID):
+            value = hex(int(value, 16))
+        else:
+            raise TypeError(f"<{value}> is not NSID serializable")
+
+        if value.startswith("0x"):
+            value = value[2:]
+
+        instance = super(NSID, cls).__new__(cls, value.upper())
+        return instance
+
+class Instance:
+    """
+    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 _get_item(self, endpoint: str, body: dict = None, headers: dict = None) -> dict:
+        """
+        Récupère des données JSON depuis l'API
+
+        ## Paramètres
+        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 not headers:
+            headers = self.default_headers
+
+        res = requests.get(f"{self.url}/{endpoint}", headers = headers, json = body, timeout = 5)
+
+        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']}")
+
+    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, endpoint: str, body: dict, headers: dict = None, use_PUT: bool = False) -> None:
+        """
+        Publie des données JSON dans une table nation-db.
+
+        ## Paramètres
+        endpoint: `str`
+            Endpoint de l'URL
+        body: `dict`
+            Données à envoyer
+        headers: `dict` (optionnel)
+            Headers à envoyer
+        """
+
+        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)
+
+        if 200 <= res.status_code < 300:
+            return res.json()
+        else:
+            print(res.text)
+            res.raise_for_status()
+
+    def _delete(self, _class: str, ids: list[NSID]) -> None:
+        """
+        Supprime des données JSON dans une table nation-db.
+
+        ## Paramètres
+        _class: `str`
+            Classe des entités à supprimer
+        ids: `list[NSID]`
+            ID des entités à supprimer
+        """
+
+        res = requests.post(f"{self.url}/delete_{_class}", json = { "ids": ids })
+
+        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']}")
+
+    def _delete_by_ID(self, _class: str, id: NSID):
+        warnings.showwarning("Method '_delete_by_id' is deprecated. Use '_delete' instead.")
+        self._delete(_class, id)
+
+    def fetch(self, _class: str, **query: typing.Any) -> list:
+        res = requests.get(f"{self.url}/fetch/{_class}", params = query)
+
+        if res.status_code == 200:
+            matches = res.json()
+        elif res.status_code in (401, 403):
+            matches = []
+        else:
+            res.raise_for_status()
+
+        return matches
+
+
+    def _upload_file(self, bucket: str, name: str, data: bytes, overwrite: bool = False, headers: dict = None) -> dict:
+        """
+        Envoie un fichier dans un bucket nation-db.
+
+        ## Paramètres
+        bucket: `str`
+            Nom du bucket où le fichier sera stocké
+        name: `str`
+            Nom du fichier dans le drive
+        data: `bytes`
+            Données à uploader
+        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
+        """
+
+        if not headers:
+            headers = self.default_headers
+            headers['Content-Type'] = 'image/png'
+
+        body = {
+            "name": name,
+            "overwrite": json.dumps(overwrite)
+        }
+
+        file = ("file", "image/png", data)
+
+        res = requests.put(f"{self.url}/upload_file/{bucket}", headers = headers, json = body, files = [ file ])
+
+        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, headers: dict = None) -> bytes:
+        """
+        Télécharge un fichier depuis le stockage nation-db.
+
+        ## Paramètres
+        bucket: `str`\n
+            Nom du bucket où il faut chercher le fichier 
+        path: `str`\n
+            Chemin du fichier dans le bucket
+
+        ## Renvoie
+        - Le fichier demandé en `bytes`
+        """
+
+        if not headers:
+            headers = self.default_headers
+
+        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-3.0.0a2/nsarchive/cls/economy.py

@@ -0,0 +1,100 @@
+from .base import NSID
+
+class BankAccount:
+    """
+    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: NSID = NSID("6")
+
+        self.income: int = 0
+
+class Item:
+    """
+    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] = {}
+
+    def append(self, item: Item, quantity: int = 1):
+        if item.id in self.objects.keys():
+            self.objects[item.id] += quantity
+        else:
+            self.objects[item.id] = quantity
+
+    def throw(self, item: Item, quantity: int = 1):
+        if item.id in self.objects.keys():
+            if self.objects[item.id] > quantity:
+                self.objects[item.id] -= quantity
+            else:
+                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)
+        self.quantity: int = 1
+
+        self.price: int = 0
+        self.seller_id: NSID = NSID('0')