nsarchive 3.0.0a3__tar.gz → 3.0.0a5__tar.gz

{nsarchive-3.0.0a3 → nsarchive-3.0.0a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nsarchive
-Version: 3.0.0a3
+Version: 3.0.0a5
 Summary: API-wrapper pour récupérer des données liées à Nation
 License: GPL-3.0
 Author: happex

{nsarchive-3.0.0a3 → nsarchive-3.0.0a5}/nsarchive/__init__.py

@@ -1,7 +1,7 @@
 """
 nsarchive - API-wrapper pour récupérer des données liées à Nation.
 
-Version: 3.0.0a3
+Version: 3.0.0a5
 License: GPL-3.0
 Auteur : happex <110610727+okayhappex@users.noreply.github.com>
 

{nsarchive-3.0.0a3 → nsarchive-3.0.0a5}/nsarchive/cls/base.py

@@ -2,7 +2,10 @@ import io
 import json
 import requests
 import typing
-import warnings
+
+from .. import utils
+
+VERSION = 300
 
 class NSID(str):
     """
@@ -54,6 +57,20 @@ class Instance:
             "Content-Type": "application/json",
         }
 
+        try:
+            test_res = requests.get(f'{self.url}/ping')
+
+            if test_res.status_code == 200:
+                ndb_ver = test_res.json()['_version']
+                _litt = lambda x: '.'.join((str(x // 100), str(x % 100)))
+
+                if ndb_ver != VERSION:
+                    utils.warn(f"NationDB (v{_litt(ndb_ver)}) and NSArchive (v{_litt(VERSION)}) versions do not match. Some bugs may appear.")
+            else:
+                utils.warn("Something went wrong with the server.")
+        except:
+            utils.warn("NationDB is not responding.")
+
     def request_token(self, username: str, password: str) -> str | None:
         res = requests.post(f"{self.url}/auth/login", json = {
             "username": username,
@@ -151,7 +168,7 @@ class Instance:
             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.")
+        utils.warn("Method '_delete_by_id' is deprecated. Use '_delete' instead.")
         self._delete(_class, id)
 
     def fetch(self, _class: str, **query: typing.Any) -> list:

nsarchive-3.0.0a5/nsarchive/cls/economy.py

@@ -0,0 +1,230 @@
+import requests
+import time
+import urllib
+
+from .base import NSID
+
+default_headers = {}
+
+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, owner_id: NSID) -> None:
+        self._url: str = ""
+
+        self.id: NSID = NSID(owner_id)
+        self.owner_id: NSID = NSID(owner_id)
+        self.register_date: int = round(time.time())
+        self.tag: str = "inconnu"
+        self.bank: str = "HexaBank"
+
+        self.amount: int = 0
+        self.income: int = 0
+
+        self.frozen: bool = False
+        self.flagged: bool = False
+
+    def _load(self, _data: dict):
+        self.owner_id = NSID(_data['owner_id'])
+        self.register_date = _data['register_date']
+        self.tag = _data['tag']
+        self.bank = _data['bank']
+
+        self.amount = _data['amount']
+        self.income = _data['income']
+
+        self.frozen = _data['frozen']
+        self.flagged = _data['flagged']
+
+    def freeze(self, frozen: bool = True, reason: str = None) -> None:
+        res = requests.post(f"{self._url}/freeze?frozen={str(frozen).lower()}", headers = default_headers, json = {
+            "reason": reason
+        })
+
+        if res.status_code == 200:
+            self.frozen = frozen
+        else:
+            print(res.text)
+            res.raise_for_status()
+
+    def flag(self, flagged: bool = True, reason: str = None) -> None:
+        res = requests.post(f"{self._url}/flag?flagged={str(flagged).lower()}", headers = default_headers, json = {
+            "reason": reason
+        })
+
+        if res.status_code == 200:
+            self.flagged = flagged
+        else:
+            res.raise_for_status()
+
+    def debit(self, amount: int, reason: str = None, target: NSID = None, loan: NSID = None, digicode: str = None) -> None:
+        _target_query = f"&target={target}"
+        _loan_query = f"&loan_id={loan}"
+
+        res = requests.post(f"{self._url}/debit?amount={amount}{_target_query if target else ''}{_loan_query if loan else ''}", headers = default_headers, json = {
+            "reason": reason,
+            "digicode": digicode
+        })
+
+        if res.status_code == 200:
+            self.amount -= amount
+        else:
+            res.raise_for_status()
+
+    def deposit(self, amount: int, reason: str = None) -> None:
+        res = requests.post(f"{self._url}/deposit?amount={amount}", headers = default_headers, json = {
+            "reason": reason,
+        })
+
+        if res.status_code == 200:
+            self.amount -= amount
+        else:
+            res.raise_for_status()
+
+class Item:
+    """
+    Article d'inventaire qui peut circuler sur le serveur
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de l'objet
+    - name: `str`\n
+        Nom de l'objet
+    - emoji: `str`\n
+        Emoji lié à l'objet
+    """
+
+    def __init__(self) -> None:
+        self.id: NSID = NSID(round(time.time()))
+        self.name: str = "Unknown Object"
+        self.emoji: str = ":light_bulb:"
+        self.category: str = "common"
+        self.craft: dict = {}
+
+    def _load(self, _data: dict):
+        self.name = _data['name']
+        self.emoji = _data['emoji']
+        self.category = _data['category']
+        self.craft = _data['craft']
+
+    def rename(self, new_name: str):
+        res = requests.post(f"{self._url}/rename?name={new_name}", headers = default_headers)
+
+        if res.status_code == 200:
+            self.name = new_name
+        else:
+            res.raise_for_status()
+
+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, item: Item) -> None:
+        self._url: str = ""
+
+        self.id: NSID = NSID(round(time.time()))
+        self.open: bool = True
+        self.seller_id: NSID = NSID('0')
+
+        self.item_id: NSID = NSID(item.id)
+        self.quantity: int = 1
+        self.price: int = 0
+
+    def _load(self, _data: dict):
+        self.id = _data['json']
+        self.open = _data['open']
+        self.seller_id = NSID(_data['seller_id'])
+
+        self.item_id = NSID(_data['item_id'])
+        self.quantity = _data['quantity']
+        self.price = _data['price']
+
+class Inventory:
+    """
+    Inventaire d'un membre
+
+    ## Attributs
+    - id: `NSID`\n
+        ID de l'inventaire
+    - owner_id: `NSID`\n
+        ID du propriétaire de l'inventaire
+    - tag: `str`\n
+        Étiquette de l'inventaire
+    - register_date: `int`\n
+        Date (timestamp) de création de l'inventaire
+    - items: `dict[NSID, int]`\n
+        Collection d'objets et leur quantité
+    """
+
+    def __init__(self, owner_id: NSID) -> None:
+        self._url: str = ""
+
+        self.id: NSID = NSID(owner_id)
+        self.owner_id: NSID = NSID(owner_id)
+
+        self.tag: str = "inconnu"
+        self.register_date: int = 0
+
+        self.items: dict[NSID, int] = {}
+
+    def _load(self, _data: dict):
+        self.id = NSID(_data['id'])
+        self.owner_id = NSID(_data['owner_id'])
+
+        self.tag = _data['tag']
+        self.register_date = _data['register_date']
+
+        self.items = _data['items']
+
+    def deposit_item(self, item: Item, giver: NSID = None, quantity: int = 1, digicode: str = None):
+        res = requests.post(f"{self._url}/deposit?item={item.id}&amount={quantity}", headers = default_headers, json = {
+            "giver": giver,
+            "digicode": digicode
+        })
+
+        if res.status_code == 200:
+            if self.objects[item.id] > quantity:
+                self.objects[item.id] -= quantity
+            else:
+                self.objects[item.id] = 0
+        else:
+            res.raise_for_status()
+
+    def sell_item(self, item: Item, price: int, quantity: int = 1, digicode: str = None) -> NSID:
+        res = requests.post(f"{self._url}/sell_item?item={item.id}&quantity={quantity}&price={price}", headers = default_headers, json = {
+            "digicode": digicode
+        })
+
+        if res.status_code == 200:
+            return NSID(res.json()['sale_id'])
+        else:
+            res.raise_for_status()

{nsarchive-3.0.0a3 → nsarchive-3.0.0a5}/nsarchive/cls/entities.py

@@ -31,17 +31,20 @@ class PositionPermissions:
     """
 
     def __init__(self) -> None:
-        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.bots = Permission() # APPEND = /, MANAGE = proposer d'héberger un bot, EDIT = changer les paramètres d'un bot, READ = /
+        self.constitution = Permission() # APPEND = /, MANAGE = /, EDIT = modifier la constitution, READ = /
+        self.database = Permission() # APPEND = créer des sous-bases de données, MANAGE = gérer la base de données, EDIT = modifier les éléments, READ = avoir accès à toutes les données sans exception
+        self.inventories = Permission("a---") # APPEND = ouvrir un ou plusieurs comptes/inventaires, MANAGE = voir les infos globales concernant les comptes en banque ou inventaires, EDIT = gérer des comptes en banque (ou inventaires), READ = voir les infos d'un compte en banque ou inventaire
+        self.items = Permission("---r") # APPEND = créer un item, MANAGE = gérer les items, EDIT = modifier des items, READ = voir tous les items
         self.laws = Permission() # APPEND = proposer un texte de loi, MANAGE = accepter ou refuser une proposition, EDIT = modifier un texte, READ = /
+        self.loans = Permission() # APPEND = prélever de l'argent sur un compte, MANAGE = gérer les prêts/prélèvements, EDIT = modifier les prêts, READ = voir tous les prêts
         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.mines = Permission("----") # APPEND = générer des matières premières, MANAGE = gérer les accès aux réservoirs, EDIT = créer un nouveau réservoir, READ = récupérer des matières premières
+        self.money = Permission("----") # APPEND = générer ou supprimer de la monnaie, MANAGE = /, EDIT = /, READ = /
         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.sales = Permission("---r") # APPEND = vendre, MANAGE = gérer les ventes, EDIT = modifier des ventes, READ = accéder au marketplace
         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
 
@@ -71,10 +74,28 @@ class Position:
         self.name: str = "Inconnue"
         self.id = id
         self.permissions: PositionPermissions = PositionPermissions()
+        self.manager_permissions: PositionPermissions = PositionPermissions()
+
+        self._url: str = ""
 
     def __repr__(self):
         return self.id
 
+    def update_permisions(self, **permissions: str):
+        query = "&".join(f"{k}={ urllib.parse.quote(v) }" for k, v in permissions.items())
+
+        res = requests.post(f"{self._url}/update_permissions?{query}", headers = default_headers)
+
+        if res.status_code == 200:
+            self.permissions.merge(permissions)
+        else:
+            res.raise_for_status()
+
+    def _load(self, _data: dict):
+        self.name = _data['name']
+        self.permissions.merge(_data['permissions'])
+        self.manager_permissions.merge(_data['manager_permissions'])
+
 class Entity:
     """
     Classe de référence pour les entités
@@ -110,7 +131,6 @@ class Entity:
         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:
@@ -285,19 +305,14 @@ class Organization(Entity):
         super().__init__(NSID(id))
 
         self.owner: Entity = User(NSID(0x0))
-        self.avatar: bytes = utils.open_asset('default_avatar.png')
+        self.avatar_url: str = self._url + '/avatar'
 
         self.certifications: dict = {}
         self.members: list[GroupMember] = []
         self.invites: dict[GroupInvite] = []
 
     def _load(self, _data: dict):
-        res = requests.get(f"{self._url}/avatar")
-
-        if res.status_code == 200:
-            self.avatar = res.content
-        else:
-            warnings.warn(f"Failed to get avatar for {self.id}")
+        self.avatar_url = self._url + '/avatar'
 
         for _member in _data['members']:
             member = GroupMember(_member['id'])
@@ -356,7 +371,4 @@ class Organization(Entity):
         return [ member.__getattribute__(attribute) for member in self.members ]
 
     def save_avatar(self, data: bytes = None):
-        if not data:
-            return
-
-        self.avatar = data
+        pass