nsarchive 3.0.0a8__py3-none-any.whl → 3.0.0b2__py3-none-any.whl

nsarchive/models/republic.py

@@ -1,8 +1,11 @@
+import json
 import requests
 import time
 
 from .base import NSID
 
+from .. import errors
+
 # Votes
 
 class VoteOption:
@@ -18,10 +21,19 @@ class VoteOption:
         Nombre de sympathisants pour cette option
     """
 
-    def __init__(self, id: str, title: str = None, count: int = 0):
-        self.id = id
-        self.title = title if title else id
-        self.count = count
+    def __init__(self, title: str, count: int = 0):
+        self.title: str = title
+        self.count: int = count
+
+    def __repr__(self) -> dict:
+        return json.dumps({
+            'title': self.title,
+            'count': self.count
+        })
+
+    def _load(self, _data: dict):
+        self.title = str(_data['title'])
+        self.count = int(_data['count'])
 
 class Vote:
     """
@@ -32,7 +44,7 @@ class Vote:
         Identifiant du vote
     - title: `str`\n
         Titre du vote
-    - options: list[.VoteOption]\n
+    - options: dict[str, .VoteOption]\n
         Liste des choix disponibles
     - author: `NSID`\n
         Identifiant de l'auteur du vote
@@ -53,31 +65,29 @@ class Vote:
         self.startDate: int = round(time.time())
         self.endDate: int = 0
 
-        self.options: list[VoteOption] = []
+        self.options: dict[str, VoteOption] = {}
 
     def _load(self, _data: dict, url: str, headers: dict) -> None:
-        self._url = url + '/votes/' + _data['id']
+        self._url = url
         self._headers = headers
 
         self.id = NSID(_data['id'])
         self.title = _data['title']
-        self.author = _data['author_id']
+        self.author = _data['author']
 
-        self.startDate = _data['start_date']
-        self.endDate = _data['end_date']
+        self.startDate = _data['start']
+        self.endDate = _data['end']
 
-        self.options = []
+        self.options = {}
 
-        for opt in _data['options']:
-            option = VoteOption(opt["id"], opt["title"])
-            option.count = opt["count"]
+        for _opt_id, opt in _data['options'].items():
+            option = VoteOption(*tuple(opt.values()))
 
-            self.options.append(option)
+            self.options[_opt_id] = option
 
     def get(self, id: str) -> VoteOption:
-        for opt in self.options:
-            if opt.id == id:
-                return opt
+        if id in self.options.keys():
+            return self.options[id]
         else:
             raise ValueError(f"Option {id} not found in vote {self.id}")
 
@@ -86,17 +96,31 @@ class Vote:
         Ajoute un vote à l'option spécifiée
         """
 
-        res = requests.post(f"{self._url}/vote?choice={id}", headers = self._headers)
+        res = requests.post(f"{self._url}/vote?option={id}", headers = self._headers)
 
         if res.status_code == 200:
-            for opt in self.options:
-                if opt.id == id:
-                    opt.count += 1
-                    break
-            else:
-                raise ValueError(f"Option {id} not found in vote {self.id}")
-        else:
-            res.raise_for_status()
+            self.get(id).count += 1
+        elif 500 <= res.status_code < 600:
+            raise errors.globals.ServerDownError()
+
+        _data = res.json()
+
+        if res.status_code == 400:
+            if _data['message'] == "MissingParam":
+                raise errors.globals.MissingParamError(f"Missing parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidParam":
+                raise errors.globals.InvalidParamError(f"Invalid parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidToken":
+                raise errors.globals.AuthError("Token is not valid.")
+
+        elif res.status_code == 401:
+            raise errors.globals.AuthError(_data['message'])
+
+        elif res.status_code == 403:
+            raise errors.globals.PermissionError(_data['message'])
+
+        elif res.status_code == 404:
+            raise errors.globals.NotFoundError(_data['message'])
 
     def close(self):
         """
@@ -107,8 +131,27 @@ class Vote:
 
         if res.status_code == 200:
             self.endDate = round(time.time())
-        else:
-            res.raise_for_status()
+        elif 500 <= res.status_code < 600:
+            raise errors.globals.ServerDownError()
+
+        _data = res.json()
+
+        if res.status_code == 400:
+            if _data['message'] == "MissingParam":
+                raise errors.globals.MissingParamError(f"Missing parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidParam":
+                raise errors.globals.InvalidParamError(f"Invalid parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidToken":
+                raise errors.globals.AuthError("Token is not valid.")
+
+        elif res.status_code == 401:
+            raise errors.globals.AuthError(_data['message'])
+
+        elif res.status_code == 403:
+            raise errors.globals.PermissionError(_data['message'])
+
+        elif res.status_code == 404:
+            raise errors.globals.NotFoundError(_data['message'])
 
 class LawsuitVote(Vote):
     """

nsarchive/models/state.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 import requests
 
 from .base import NSID
 from .republic import Vote
+from .. import errors
 
 class Party:
     def __init__(self, org_id: NSID):
@@ -13,7 +16,7 @@ class Party:
         self.color: int = 0x000000
         self.motto: str = None
         self.scale: dict = {}
-        self.last_elected: int = None
+        self.last_election: int = None
 
     def _load(self, _data: dict, url: str = None, headers: dict = None):
         self._url = url
@@ -24,7 +27,10 @@ class Party:
         self.color = _data['color']
         self.motto = _data['motto']
         self.scale = _data['politiscales']
-        self.last_elected = _data['last_elected']
+        self.last_election = _data['last_election']
+
+    def cancel_candidacy(self, election: Election):
+        election.cancel_candidacy()
 
 class Election:
     def __init__(self, id: NSID):
@@ -35,25 +41,74 @@ class Election:
         self.type: str = 'full' # Partial = législatives, full = totales
         self.vote: Vote = None
 
-        self.add_vote = self.vote.add_vote
-        self.close = self.vote.close
-
     def _load(self, _data: dict, url: str = None, headers: str = None):
         self._url = url
         self._headers = headers
 
         self.id = _data['id']
         self.type = _data['type']
+
+        self.vote = Vote(_data['vote']['id'])
         self.vote._load(_data['vote'], url, headers)
 
+    def close(self):
+        if self.vote:
+            self.vote.close()
+        else:
+            return
+
+    def add_vote(self, id: str):
+        if self.vote:
+            self.vote.add_vote(id)
+        else:
+            return
+
     def submit_candidacy(self):
         res = requests.put(f"{self._url}/submit")
 
-        if res.status_code != 200:
-            res.raise_for_status()
+        if 500 <= res.status_code < 600:
+            raise errors.globals.ServerDownError()
+
+        _data = res.json()
+
+        if res.status_code == 400:
+            if _data['message'] == "MissingParam":
+                raise errors.globals.MissingParamError(f"Missing parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidParam":
+                raise errors.globals.InvalidParamError(f"Invalid parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidToken":
+                raise errors.globals.AuthError("Token is not valid.")
+
+        elif res.status_code == 401:
+            raise errors.globals.AuthError(_data['message'])
+
+        elif res.status_code == 403:
+            raise errors.globals.PermissionError(_data['message'])
+
+        elif res.status_code == 404:
+            raise errors.globals.NotFoundError(_data['message'])
 
     def cancel_candidacy(self):
         res = requests.put(f"{self._url}/cancel_candidacy")
 
-        if res.status_code != 200:
-            res.raise_for_status()
+        if 500 <= res.status_code < 600:
+            raise errors.globals.ServerDownError()
+
+        _data = res.json()
+
+        if res.status_code == 400:
+            if _data['message'] == "MissingParam":
+                raise errors.globals.MissingParamError(f"Missing parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidParam":
+                raise errors.globals.InvalidParamError(f"Invalid parameter '{_data['param']}'.")
+            elif _data['message'] == "InvalidToken":
+                raise errors.globals.AuthError("Token is not valid.")
+
+        elif res.status_code == 401:
+            raise errors.globals.AuthError(_data['message'])
+
+        elif res.status_code == 403:
+            raise errors.globals.PermissionError(_data['message'])
+
+        elif res.status_code == 404:
+            raise errors.globals.NotFoundError(_data['message'])

nsarchive-3.0.0b2.dist-info/METADATA

@@ -0,0 +1,90 @@
+Metadata-Version: 2.3
+Name: nsarchive
+Version: 3.0.0b2
+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
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pillow (>=10.4,<11.0)
+Requires-Dist: requests (>=2.31,<3.0)
+Description-Content-Type: text/markdown
+
+# NSArchive v3
+
+## Pré-requis
+
+- Python 3.10 ou + (Python 3.13 si possible)
+- Un serveur avec [nation.db](https://github.com/1nserv/nation-db)
+- Deux barres de Twix ou une tasse de thé
+
+
+## Avant de démarrer
+
+Dans la documentation, vous croiserez souvent des noms de classes comme `.User` ou autres similaires. Le «.» devant le nom de la classe signfie qu'elle appartient au module NSAv3, et qu'il faut donc les interprêter comme `nsarchive.User`. La seule exception est `NSID` qui ne sera pas précédé d'un point mais devra être interprêté de la même manière.
+
+
+## Installation
+
+L'installation de NSAv3 se fait via pip:
+
+```sh
+pip install nsarchive
+```
+
+La dernière version de nsarchive devrait s'installer. Les dépendances requises pour nsarchive sont `pillow` et `requests` mais celles-ci devraient s'installer en même temps que le module. Vous pourriez également avoir besoin des modules `bcrypt` et `python-dotenv`, ceux-ci devront être installés manuellement.
+
+
+### Bonus: Environnement virtuel
+
+Il est recommandé mais non obligatoire d'avoir un environnement virtuel (venv) pour votre projet. Sa création se fait comme ceci:
+
+```sh
+python -m venv .venv
+```
+
+N'oubliez pas de l'activer via cette commande pour powershell...
+
+```ps1
+.venv\Scripts\Activate
+```
+
+...ou cette commande pour les terminaux type UNIX (Bash par exemple)
+
+```sh
+source .venv/Scripts/Activate
+```
+
+## Prise en main
+
+### Identifier les objets
+
+Les objets sont tous identifiables sur NSAv3. Ils ont un identifiant commun appelé NSID (`from nsarchive import NSID`). Cet identifiant n'est rien de plus qu'un nombre hexadécimal. Il peut être utilisé comme un string, dans un print ou un f-string par exemple. Cet identifiant est communément basé sur plusieurs valeurs fixes ou universelles, dont les deux plus fréquentes sont:
+- L'ID Discord de l'objet concerné, dans le cas d'un utilisateur par exemple
+- Le timestamp (secondes depuis 1970) du moment où il a été créé, dans le cas de la plupart des autres objets
+
+
+### Interfaces
+
+Le module nsarchive est divisé en **4 interfaces**:
+- [Entités](/docs/interfaces/entities.md) (membres, groupes, positions)
+- [Économie](/docs/interfaces/economy.md) (comptes en banque, dettes)
+- [Justice](/docs/interfaces/justice.md) (signalements, procès, sanctions)
+- [État](/docs/interfaces/state.md) (votes, élections)
+
+> Les interfaces État et Justice peuvent être confondues et désignées comme République, comme c'était le cas dans les versions précédentes.
+
+
+Les interfaces ont toutes quatre rôles en commun:
+- Vous authentifier
+- Récupérer des objets
+- Créer des objets
+- Supprimer des objets (Entités uniquement)
+
+Une documentation plus détaillée est disponible [ici](/docs/interfaces/README.md).

nsarchive-3.0.0b2.dist-info/RECORD

@@ -0,0 +1,21 @@
+nsarchive/__init__.py,sha256=8Cssxv2lkW3eJStVoTg0y84_E7mPm0y4-oLe_nA42A0,877
+nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
+nsarchive/errors/__init__.py,sha256=rjyE5B4WmJI-_ILUtCP6wk4HhpmvLahkFTFyWwTlulw,33
+nsarchive/errors/_globals.py,sha256=e3EvZ2HoCwfKbRkn7uYmqFkyE3013b4jkaZCvoAErkU,749
+nsarchive/interfaces/_economy.py,sha256=wkmPvj3GVy7Et2Z-cJMQ9BBem1tKcIfeJmNaB03xspc,3072
+nsarchive/interfaces/_entities.py,sha256=oPGkcnpXLOQfQpoqrvhjXhQq6nDCQ-nKwYSwnb1lze8,9384
+nsarchive/interfaces/_justice.py,sha256=J8rLJ9STAax7uvnuMqwO0RdbzrsQcFzjUwkQaEEA1kU,8683
+nsarchive/interfaces/_state.py,sha256=CYnwLO5Ihv27tc5-bn_w6y7SjMZG3kQsv3AfozP4nfw,10462
+nsarchive/mandate.py,sha256=-CF6HMbDge2JYZIHT4WtAkUo6Cvc5WrsYhbrdKrriyA,2117
+nsarchive/models/base.py,sha256=Hl19C00pXD76KwcUsbfqZDxMfGghLxEAYTBSLUG_l34,10464
+nsarchive/models/economy.py,sha256=EkGfwWlvNlF8Ho9oOYS-eXybiHjsmqBoJxNObeOMRPE,6715
+nsarchive/models/entities.py,sha256=OQPgaqybw7dr1lbNplV-EsWqZH4MwBfYTWtI_Yt8ulo,27412
+nsarchive/models/justice.py,sha256=aHlDQ04agLJDSr13NXq-0RUaICM3_ZUok3mtEGPXbPY,4301
+nsarchive/models/republic.py,sha256=CRpZQEKM-nx_DFy1r0QPK3u9xTNQ7sdOsKw2zb75J4o,4997
+nsarchive/models/scale.py,sha256=ukh6wiE4mBcqbqtAC9GvCyTVUnwYUp3jla03Nohnsck,751
+nsarchive/models/state.py,sha256=KhEv1F9g6RBvdfuw-uO3ruyuTfn9PGdeA1nMMABN2qU,3652
+nsarchive/utils.py,sha256=L37Dm8aO0Sm3FDLPf2tP6fo-1lodDq7JIz-WXttNuJg,684
+nsarchive-3.0.0b2.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
+nsarchive-3.0.0b2.dist-info/METADATA,sha256=f3WgdYrnXXYpuk7Df-8MaeM2UffweQgo0rIfQrmsMsg,3457
+nsarchive-3.0.0b2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+nsarchive-3.0.0b2.dist-info/RECORD,,

nsarchive-3.0.0a8.dist-info/METADATA

@@ -1,21 +0,0 @@
-Metadata-Version: 2.3
-Name: nsarchive
-Version: 3.0.0a8
-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
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: pillow (>=10.4,<11.0)
-Requires-Dist: requests (>=2.31,<3.0)
-Description-Content-Type: text/markdown
-
-# NSArchive
-
-Documentation pas disponible pour l'instant

nsarchive-3.0.0a8.dist-info/RECORD

@@ -1,19 +0,0 @@
-nsarchive/__init__.py,sha256=QyFBy5jIe_cJBpTdNj-q_0nLqLfKoGC7m4D8LjCOpQo,823
-nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
-nsarchive/interfaces/_economy.py,sha256=54TpYKRw07HIryd3EDifA9Hs3s6O7aHcrtV4P8qY0QY,9348
-nsarchive/interfaces/_entities.py,sha256=FSFHtM2ygDGLWMU32zJej-BO2rVbrMYhxaJoXymdHMA,6480
-nsarchive/interfaces/_justice.py,sha256=perTRdhI7g7he2hcJ0kW9g8plt_BSHD8rMcR6FzBqG0,1382
-nsarchive/interfaces/_state.py,sha256=OCpSx4i_lqkJQ2FWZpFBKp2HIlwVCqsQOG42d8yCmO0,3747
-nsarchive/mandate.py,sha256=U0RE9Gpr3XawSWyr99X__GUoiwJAwKbOP4v_I2Z97Oc,1609
-nsarchive/models/base.py,sha256=yu04x3-vwPeda5R1DviHsDjP-44vIGZIpriX_c6czIY,8698
-nsarchive/models/economy.py,sha256=TA6QewVdhNYn4VuhsGaCkjSlJojDO59sgfLtCE5mgPE,7710
-nsarchive/models/entities.py,sha256=W6kXMsBlrIAfSOerRJEzVNtufHdNjXv2QNvXDwnVfTM,17426
-nsarchive/models/justice.py,sha256=kr3g3UqA7eexVqjiWSaT_O49NIJ84g_7z8vCXjTrLhA,3411
-nsarchive/models/republic.py,sha256=7KfNCzj6mNe389csKhHuTFqlAT60HeikhQbMWwPwnBk,3292
-nsarchive/models/scale.py,sha256=ukh6wiE4mBcqbqtAC9GvCyTVUnwYUp3jla03Nohnsck,751
-nsarchive/models/state.py,sha256=iP13C4IP0e0P-f1rkPwzTVe6j_QVM-ZRMDILlVVEUU8,1622
-nsarchive/utils.py,sha256=L37Dm8aO0Sm3FDLPf2tP6fo-1lodDq7JIz-WXttNuJg,684
-nsarchive-3.0.0a8.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
-nsarchive-3.0.0a8.dist-info/METADATA,sha256=A9g3R24rXcBYUFS2xVqptNBY9DwdyxOagaL7NyGyvG0,746
-nsarchive-3.0.0a8.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-nsarchive-3.0.0a8.dist-info/RECORD,,