nsarchive 3.0.0a1__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/base.py

@@ -1,7 +1,8 @@
+import io
 import json
+import requests
 import typing
-
-from supabase import Client
+import warnings
 
 class NSID(str):
     """
@@ -43,134 +44,175 @@ class Instance:
     """
     Instance qui servira de base à toutes les instances.
     """
-    def __init__(self, client: Client):
-        self.db = client
 
-    def _select_from_db(self, table: str, key: str = None, value: str = None) -> list:
+    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 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
@@ -182,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/entities.py

@@ -1,36 +1,56 @@
+import requests
 import time
+import typing
+import urllib.parse
 
-from .exceptions import *
 from .base import NSID
 
 from .. import utils
 
+default_headers = {}
+
+class Permission:
+    def __init__(self, initial: str = "----"):
+        self.append: bool
+        self.manage: bool
+        self.edit: bool
+        self.read: bool
+
+        self.load(initial)
+
+    def load(self, val: str) -> None:
+        if 'a' in val: self.append = True
+        if 'm' in val: self.manage = True
+        if 'e' in val: self.edit = True
+        if 'r' in val: self.read = True
+
 class PositionPermissions:
     """
     Permissions d'une position à l'échelle du serveur. Certaines sont attribuées selon l'appartenance à divers groupes ayant une position précise
     """
 
     def __init__(self) -> None:
-        # Membres
-        self.approve_laws = False # Approuver ou désapprouver les lois proposées (vaut aussi pour la Constitution)
-        self.buy_items = False # Acheter des items depuis le marketplace
-        self.create_organizations = False # Créer une organisation
-        self.edit_constitution = False # Proposer une modification de la Constitution
-        self.edit_laws = False # Proposer une modification des différents textes de loi
-        self.manage_entities = False # Gérer les membres et les organisations
-        self.manage_national_channel = False # Prendre la parole sur la chaîne nationale et avoir une priorité de passage sur les autres chaînes
-        self.manage_reports = False # Accepter ou refuser une plainte
-        self.manage_state_budgets = False # Gérer les différents budgets de l'État
-        self.moderate_members = False # Envoyer des membres en garde à vue, en détention ou toute autre sanction non présente sur le client Discord
-        self.propose_new_laws = self.edit_constitution # Proposer un nouveau texte de loi pris en charge par la Constitution
-        self.publish_official_messages = False # Publier un message sous l'identité du bot Serveur
-        self.sell_items = False # Vendre des objets ou services sur le marketplace
-        self.vote_president = False # Participer aux élections présidentielles
-        self.vote_representatives = False # Participer aux élections législatives
+        self.bank_accounts = Permission("a---") # APPEND = ouvrir un ou plusieurs comptes, MANAGE = voir les infos globales concernant les comptes en banque, EDIT = gérer des comptes en banque, READ = voir les infos d'un compte en banque individuel
+        self.bots = Permission() # APPEND = publier un message sous l'identité d'un bot, MANAGE = proposer d'héberger un bot, EDIT = changer les paramètres d'un bot, READ = /
+        self.constitution = Permission() # APPEND = laws.append, MANAGE = laws.manage, EDIT = modifier la constitution, READ = /
+        self.database = Permission() # APPEND = créer des sous-bases de données, MANAGE = gérer la abse de données, EDIT = modifier les éléments, READ = avoir accès à toutes les données sans exception
+        self.items = Permission("---r") # APPEND = vendre, MANAGE = gérer des items dont on n'est pas propriétaire (hors marketplace), EDIT = gérer des items dont on n'est pas propriétaire (dans le marketplace), READ = accéder au marketplace
+        self.laws = Permission() # APPEND = proposer un texte de loi, MANAGE = accepter ou refuser une proposition, EDIT = modifier un texte, READ = /
+        self.members = Permission("---r") # APPEND = créer des entités, MANAGE = modérer des entités (hors Discord), EDIT = modifier des entités, READ = voir le profil des entités
+        self.national_channel = Permission() # APPEND = prendre la parole sur la chaîne nationale, MANAGE = voir qui peut prendre la parole, EDIT = modifier le planning de la chaîne nationale, READ = /
+        self.organizations = Permission("---r") # APPEND = créer une nouvelle organisation, MANAGE = exécuter des actions administratives sur les organisations, EDIT = modifier des organisations, READ = voir le profil de n'importe quelle organisation
+        self.reports = Permission() # APPEND = déposer plainte, MANAGE = accépter ou refuser une plainte, EDIT = /, READ = accéder à des infos supplémentaires pour une plainte
+        self.state_budgets = Permission() # APPEND = débloquer un nouveau budget, MANAGE = gérer les budjets, EDIT = gérer les sommes pour chaque budjet, READ = accéder aux infos concernant les budgets
+        self.votes = Permission() # APPEND = déclencher un vote, MANAGE = fermer un vote, EDIT = /, READ = lire les propriétés d'un vote avant sa fermeture
+
+    def merge(self, permissions: dict[str, str] | typing.Self):
+        if isinstance(permissions, PositionPermissions):
+            permissions = permissions.__dict__
+
+        for key, val in permissions.items():
+            perm: Permission = self.__getattribute__(key)
+            perm.load(val)
 
-    def edit(self, **permissions: bool) -> None:
-        for perm in permissions.items():
-            self.__setattr__(*perm)
 
 class Position:
     """
@@ -71,7 +91,9 @@ class Entity:
     """
 
     def __init__(self, id: NSID) -> None:
-        self.id: NSID = NSID(id) # ID hexadécimal de l'entité (ou nom dans le cas de l'entreprise)
+        self._url = "" # URL de l'entité pour une requête GET
+
+        self.id: NSID = NSID(id) # ID hexadécimal de l'entité
         self.name: str = "Entité Inconnue"
         self.registerDate: int = 0
         self.position: Position = Position()
@@ -79,19 +101,55 @@ class Entity:
 
     def set_name(self, new_name: str) -> None:
         if len(new_name) > 32:
-            raise NameTooLongError(f"Name length mustn't exceed 32 characters.")
+            raise ValueError(f"Name length mustn't exceed 32 characters.")
+
+        res = requests.post(f"{self._url}/rename?name={new_name}", headers = default_headers)
 
-        self.name = new_name
+        if res.status_code == 200:
+            self.name = new_name
+        else:
+            print(res.status_code)
+            res.raise_for_status()
 
     def set_position(self, position: Position) -> None:
-        self.position = position
+        res = requests.post(f"{self._url}/change_position?position={position.id}", headers = default_headers)
+
+        if res.status_code == 200:
+            self.position = position
+        else:
+            res.raise_for_status()
 
     def add_link(self, key: str, value: str | int) -> None:
-        if isinstance(value, str) or isinstance(value, int):
+        if isinstance(value, str):
+            _class = "string"
+        elif isinstance(value, int):
+            _class = "integer"
+        else:
+            raise TypeError("Only strings and integers can be recorded as an additional link")
+
+        params = {
+            "link": key,
+            "value": value,
+            "type": _class
+        }
+
+        query = "&".join(f"{k}={ urllib.parse.quote(v) }" for k, v in params.items())
+
+        res = requests.post(f"{self._url}/add_link?{query}", headers = default_headers)
+
+        if res.status_code == 200:
             self.additional[key] = value
+        else:
+            print(res.text)
+            res.raise_for_status()
 
     def unlink(self, key: str) -> None:
-        del self.additional[key]
+        res = requests.post(f"{self._url}/remove_link?link={urllib.parse.quote(key)}", headers = default_headers)
+
+        if res.status_code == 200:
+            del self.additional[key]
+        else:
+            res.raise_for_status()
 
 class User(Entity):
     """
@@ -102,9 +160,7 @@ class User(Entity):
     - xp: `int`\n
         Points d'expérience de l'entité
     - boosts: `dict[str, int]`\n
-        Ensemble des boosts dont bénéficie l'entité
-    - permissions: `.PositionPermissions`\n
-        Fusion des permissions offertes par la position et les groupes
+        Ensemble des boosts dont bénéficie l'entité 
     - votes: `list[NSID]`\n
         Liste des votes auxquels a participé l'entité
     """
@@ -114,11 +170,7 @@ class User(Entity):
 
         self.xp: int = 0
         self.boosts: dict[str, int] = {}
-        self.permissions: PositionPermissions = PositionPermissions() # Elles seront définies en récupérant les permissions de sa position
-        self.votes: list[str] = []
-
-    def add_vote(self, id: NSID):
-        self.votes.append(NSID(id))
+        self.groups: list[NSID] = []
 
     def get_level(self) -> None:
         i = 0
@@ -128,15 +180,24 @@ class User(Entity):
         return i
 
     def add_xp(self, amount: int) -> None:
-        boost = 0 if 0 in self.boosts.values() else max(list(self.boosts.values()) + [ 1 ])
+        boost = 0 if 0 in self.boosts.values() or amount <= 0 else max(list(self.boosts.values()) + [ 1 ])
+        res = requests.post(f"{self._url}/add_xp?amount={amount * boost}", headers = default_headers)
 
-        self.xp += amount * boost
+        if res.status_code == 200:
+            self.xp += amount * boost
+        else:
+            res.raise_for_status()
 
     def edit_boost(self, name: str, multiplier: int = -1) -> None:
-        if multiplier >= 0:
-            self.boosts[name] = multiplier
+        res = requests.post(f"{self._url}/edit_boost?boost={name}&multiplier={multiplier}", headers = default_headers)
+
+        if res.status_code == 200:
+            if multiplier >= 0:
+                self.boosts[name] = multiplier
+            else:
+                del self.boosts[name]
         else:
-            del self.boosts[name]
+            res.raise_for_status()
 
 class MemberPermissions:
     """
@@ -145,46 +206,55 @@ class MemberPermissions:
 
     def __init__(self) -> None:
         self.manage_organization = False # Renommer l'organisation, changer le logo
-        self.manage_roles = False # Changer les rôles des membres
         self.manage_shares = False # Revaloriser les actions
+        self.manage_roles = False # Changer les rôles des membres
         self.manage_members = False # Virer quelqu'un d'une entreprise, l'y inviter
 
     def edit(self, **permissions: bool) -> None:
         for perm in permissions.values():
             self.__setattr__(*perm)
 
-class GroupMember(User):
+class GroupMember:
     """
     Membre au sein d'une entité collective
 
     ## Attributs
-    - Tous les attributs de la classe `.User`
-    - permission_level: `int`\n
+    - permission_level: `dict[str, int]`\n
         Niveau d'accréditation du membre (0 = salarié, 4 = administrateur)
     """
 
     def __init__(self, id: NSID) -> None:
-        super().__init__(id)
-
-        self.permission_level: int = 0
+        self.id = id
+        self.permission_level: dict = { # Échelle de permissions selon le groupe de travail
+            "general": 0 
+        }
 
-    def group_permissions(self) -> MemberPermissions:
+    def group_permissions(self, team: str = "general") -> MemberPermissions:
         p = MemberPermissions()
+        team_perms = self.permission_level[team]
 
-        if self.permission_level >= 1:
+        if team_perms >= 1: # Responsable
             p.manage_members = True
 
-        if self.permission_level >= 2:
-            p.manage_shares = True
-
-        if self.permission_level >= 3:
+        if team_perms >= 2: # Superviseur
             p.manage_roles = True
 
-        if self.permission_level >= 4:
+        if team_perms >= 3: # Chef d'équipe
+            pass
+
+        if team_perms >= 4: # Directeur
+            p.manage_shares = True
             p.manage_organization = True
 
         return p
 
+class GroupInvite:
+    def __init__(self, id: NSID):
+        self.id: NSID = id
+        self.team: str = "general"
+        self.level: str = 0
+        self._expires: int = round(time.time()) + 604800
+
 class Share:
     """
     Action d'une entreprise
@@ -242,32 +312,49 @@ class Organization(Entity):
 
         self.certifications: dict = {}
         self.members: list[GroupMember] = []
+        self.invites: dict[GroupInvite] = []
 
         self.parts: list[Share] = 50 * [ Share(self.owner.id, 0) ]
 
-    def add_certification(self, certification: str) -> None:
-        self.certifications[certification] = round(time.time())
+    def add_certification(self, certification: str, __expires: int = 2419200) -> None:
+        res = requests.post(f"{self._url}/add_certification?name={certification}&duration={__expires}", headers = default_headers)
+
+        if res.status_code == 200:
+            self.certifications[certification] = int(round(time.time()) + __expires)
+        else:
+            res.raise_for_status()
 
     def has_certification(self, certification: str) -> bool:
         return certification in self.certifications.keys()
 
     def remove_certification(self, certification: str) -> None:
-        del self.certifications[certification]
+        res = requests.post(f"{self._url}/remove_certification?name={certification}", headers = default_headers)
+
+        if res.status_code == 200:
+            del self.certifications[certification]
+        else:
+            res.raise_for_status()
+
+    def invite_member(self, member: NSID, level: int = 0, team: str = "general") -> None:
+        if not isinstance(member, NSID):
+            raise TypeError("L'entrée membre doit être de type NSID")
 
-    def add_member(self, member: GroupMember) -> None:
-        if not isinstance(member, GroupMember):
-            raise TypeError("Le membre doit être de type GroupMember")
+        res = requests.post(f"{self._url}/invite_member?id={member}&level={level}&team={team}", headers = default_headers)
 
-        self.members.append(member)
+        if res.status_code == 200:
+            invite = GroupInvite(member)
+            invite.team = team
+            invite.level = level
+
+            self.invites.append(invite)
+        else:
+            res.raise_for_status()
 
     def remove_member(self, member: GroupMember) -> None:
         for _member in self.members:
             if _member.id == member.id:
                 self.members.remove(_member)
 
-    def append(self, member: GroupMember) -> None:
-        self.add_member(member)
-
     def remove(self, member: GroupMember) -> None:
         self.remove_member(member)
 
@@ -296,4 +383,10 @@ class Organization(Entity):
                 else:
                     shares[share.owner] = 1
 
-        return shares
+        return shares
+
+    def save_avatar(self, data: bytes = None):
+        if not data:
+            return
+
+        self.avatar = data