nsarchive 3.0.0a1__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nsarchive/cls/entities.py

@@ -1,36 +1,58 @@
+import requests
 import time
+import typing
+import urllib
+import warnings
 
-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.money = 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 +93,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 +103,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.")
 
-        self.name = new_name
+        res = requests.post(f"{self._url}/rename?name={new_name}", headers = default_headers)
+
+        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 +162,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 +172,13 @@ 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] = []
+        self.votes: list[NSID] = []
+
+    def _load(self, _data: dict):
+        self.xp = _data['xp']
+        self.boosts = _data['boosts']
 
-    def add_vote(self, id: NSID):
-        self.votes.append(NSID(id))
+        self.votes = [ NSID(vote) for vote in _data['votes'] ]
 
     def get_level(self) -> None:
         i = 0
@@ -128,15 +188,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,76 +214,54 @@ 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 Share:
-    """
-    Action d'une entreprise
-
-    ## Attributs
-    - owner: `NSID`\n
-        Identifiant du titulaire de l'action
-    - price: `int`\n
-        Prix de l'action
-    """
-
-    def __getstate__(self) -> dict:
-        return {
-            "owner": self.owner,
-            "price": self.price
-        }
-
-    def __setstate__(self, state: dict):
-        self.owner: NSID = state['owner']
-        self.price: int = state['price']
-
-    def __init__(self, owner: NSID = NSID(0x0), price: int = 10):
-        self.owner: NSID = owner
-        self.price: int = price
-
-    def assign_owner(self, owner: NSID):
-        self.owner = owner
-
-    def set_price(self, price: int):
-        self.price = price
+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 Organization(Entity):
     """
@@ -242,32 +289,63 @@ 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 _load(self, _data: dict):
+        res = requests.get(f"{self._url}/avatar")
 
-    def add_certification(self, certification: str) -> None:
-        self.certifications[certification] = round(time.time())
+        if res.status_code == 200:
+            self.avatar = res.content
+        else:
+            warnings.warn(f"Failed to get avatar for {self.id}")
+
+        for _member in _data['members']:
+            member = GroupMember(_member['id'])
+            member.permission_level = _member['level']
+
+            self.members.append(member)
+
+        self.certifications = _data['certifications']
+
+    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)
 
-    def add_member(self, member: GroupMember) -> None:
-        if not isinstance(member, GroupMember):
-            raise TypeError("Le membre doit être de type GroupMember")
+        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")
 
-        self.members.append(member)
+        res = requests.post(f"{self._url}/invite_member?id={member}&level={level}&team={team}", headers = default_headers)
+
+        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)
 
@@ -277,23 +355,8 @@ class Organization(Entity):
     def get_members_by_attr(self, attribute: str = "id") -> list[str]:
         return [ member.__getattribute__(attribute) for member in self.members ]
 
-    def get_shares(self, include_worth: bool = False) -> dict[str, int] | dict[str, dict[str, int]]:
-        shares = {}
-
-        for share in self.parts:
-            if include_worth:
-                if share.owner in shares.keys():
-                    shares[share.owner]['count'] += 1
-                    shares[share.owner]['worth'] += share.price
-                else:
-                    shares[share.owner] = {
-                        'count': 1,
-                        'worth': share.price
-                    }
-            else:
-                if share.owner in shares.keys():
-                    shares[share.owner] += 1
-                else:
-                    shares[share.owner] = 1
+    def save_avatar(self, data: bytes = None):
+        if not data:
+            return
 
-        return shares
+        self.avatar = data

nsarchive/instances/_economy.py

@@ -1,18 +1,14 @@
 import time
 
-from supabase import create_client
-
 from ..cls.base import *
 from ..cls.archives import *
 from ..cls.economy import *
 
-from ..cls.exceptions import *
-
 class EconomyInstance(Instance):
-    """Gère les interactions avec les comptes bancaires, les transactions, et le marché."""
+    """Indisponible dans cette version."""
 
-    def __init__(self, id: str, token: str) -> None:
-        super().__init__(create_client(f"https://{id}.supabase.co", token))
+    def __init__(self, url: str, token: str) -> None:
+        super().__init__(url, token)
 
     """
     ---- COMPTES EN BANQUE ----
@@ -20,6 +16,7 @@ class EconomyInstance(Instance):
 
     def get_account(self, id: NSID) -> BankAccount:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupère les informations d'un compte bancaire.
 
         ## Paramètres
@@ -30,6 +27,8 @@ class EconomyInstance(Instance):
         - `.BankAccount`
         """
 
+        return BankAccount(NSID(id)) # Provisoire
+
         id = NSID(id)
         _data = self._get_by_ID('accounts', id)
 
@@ -47,6 +46,7 @@ class EconomyInstance(Instance):
 
     def save_account(self, account: BankAccount):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Sauvegarde un compte bancaire dans la base de données.
 
         ## Paramètres
@@ -54,6 +54,8 @@ class EconomyInstance(Instance):
             Compte à sauvegarder
         """
 
+        return # Provisoire
+
         _data = {
             'id': NSID(account.id),
             'amount': account.amount,
@@ -67,6 +69,7 @@ class EconomyInstance(Instance):
 
     def freeze_account(self, account: BankAccount):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Gèle un compte bancaire pour empêcher toute transaction.
 
         ## Paramètres
@@ -74,6 +77,8 @@ class EconomyInstance(Instance):
             Compte à geler
         """
 
+        return # Provisoire
+
         account.id = NSID(account.id)
         account.frozen = True
 
@@ -85,6 +90,7 @@ class EconomyInstance(Instance):
 
     def save_item(self, item: Item):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Sauvegarde des infos à propos d'un item.
 
         ## Paramètres
@@ -92,11 +98,14 @@ class EconomyInstance(Instance):
             Article à sauvegarder
         """
 
+        return # Provisoire
+
         _item = item.__dict__
         self._put_in_db('items', _item)
 
     def get_item(self, id: NSID) -> Item | None:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupère des informations à propos d'un item.
 
         ## Paramètres
@@ -108,6 +117,8 @@ class EconomyInstance(Instance):
         - `None`
         """
 
+        return Item(NSID(id)) # Provisoire
+
         _item = self._get_by_ID('items', id)
 
         if _item is None:
@@ -121,6 +132,7 @@ class EconomyInstance(Instance):
 
     def delete_item(self, item: Item):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Annule le référencement d'un item.
 
         ## Paramètres
@@ -128,10 +140,13 @@ class EconomyInstance(Instance):
             Item à supprimer
         """
 
+        return # Provisoire
+
         self._delete_by_ID('items', item.id)
 
     def get_sale(self, id: NSID) -> Sale | None:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupère une vente disponible sur le marketplace.
 
         ## Paramètres
@@ -142,6 +157,8 @@ class EconomyInstance(Instance):
         - `.Sale | None`: Le résultat de la vente
         """
 
+        return Sale(NSID(id), Item(NSID(id))) # Provisoire
+
         id = NSID(id)
 
         _data = self._get_by_ID('market', id)
@@ -158,6 +175,7 @@ class EconomyInstance(Instance):
 
     def sell_item(self, item: Item, quantity: int, price: int, seller: NSID):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Vend un item sur le marché.
 
         ## Paramètres
@@ -171,6 +189,8 @@ class EconomyInstance(Instance):
             ID de l'auteur de la vente
         """
 
+        return # Provisoire
+
         sale = Sale(NSID(round(time.time()) * 16 ** 3), item)
         sale.quantity = quantity
         sale.price = price
@@ -181,7 +201,12 @@ class EconomyInstance(Instance):
         self._put_in_db('market', _data)
 
     def delete_sale(self, sale: Sale) -> None:
-        """Annule une vente sur le marketplace."""
+        """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
+        Annule une vente sur le marketplace.
+        """
+
+        return # Provisoire
 
         sale.id = NSID(sale.id)
         self._delete_by_ID('market', NSID(sale.id))
@@ -192,6 +217,7 @@ class EconomyInstance(Instance):
 
     def get_inventory(self, id: NSID) -> Inventory | None:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupérer un inventaire dans la base des inventaires.
 
         ## Paramètres
@@ -202,6 +228,8 @@ class EconomyInstance(Instance):
         - `.Inventory | None`: L'inventaire s'il a été trouvé
         """
 
+        return Inventory(NSID(id)) # Provisoire
+
         _data = self._get_by_ID('inventories', id)
 
         if _data is None:
@@ -218,6 +246,7 @@ class EconomyInstance(Instance):
 
     def save_inventory(self, inventory: Inventory):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Sauvegarder un inventaire
 
         ## Paramètres
@@ -225,12 +254,15 @@ class EconomyInstance(Instance):
             Inventaire à sauvegarder
         """
 
+        return # Provisoire
+
         _data = inventory.__dict__
 
         self._put_in_db('inventories', _data)
 
     def delete_inventory(self, inventory: Inventory):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Supprime un inventaire
 
         ## Paramètres
@@ -238,6 +270,8 @@ class EconomyInstance(Instance):
             Inventaire à supprimer
         """
 
+        return # Provisoire
+
         self._delete_by_ID('inventories', inventory.owner_id)
 
     """
@@ -246,6 +280,7 @@ class EconomyInstance(Instance):
 
     def _add_archive(self, archive: Archive):
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Ajoute une archive d'une transaction ou d'une vente dans la base de données.
 
         ## Paramètres
@@ -253,6 +288,8 @@ class EconomyInstance(Instance):
             Archive à ajouter
         """
 
+        return # Provisoire
+
         archive.id = NSID(archive.id)
         archive.author = NSID(archive.author)
         archive.target = NSID(archive.target)
@@ -268,6 +305,7 @@ class EconomyInstance(Instance):
 
     def _get_archive(self, id: NSID) -> Archive | Transaction:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupère une archive spécifique.
 
         ## Paramètres
@@ -278,6 +316,8 @@ class EconomyInstance(Instance):
         - `.Archive | .Transaction`
         """
 
+        return Archive() # Provisoire
+
         id = NSID(id)
         _data = self._get_by_ID('archives', id)
 
@@ -298,6 +338,7 @@ class EconomyInstance(Instance):
 
     def _fetch_archives(self, **query) -> list[ Archive | Transaction ]:
         """
+        *INDISPONIBLE DANS CETTE VERSION.*\n
         Récupère une liste d'archives correspondant à la requête.
 
         ## Paramètres
@@ -308,6 +349,8 @@ class EconomyInstance(Instance):
         - `list[.Archive | .Transaction]`
         """
 
+        return [] # Provisoire
+
         _res = self.fetch('archives', **query)
 
         return [ self._get_archive(archive['id']) for archive in _res ]