kisa-utils 0.37.18__py3-none-any.whl → 0.37.20__py3-none-any.whl

kisa_utils/functionUtils.py

@@ -6,14 +6,11 @@ from kisa_utils.response import Response, Ok, Error
 from kisa_utils.storage import Path
 from kisa_utils.structures.validator import Value, validateWithResponse
 import copy
-from typing import Any, get_args, Callable, Generic, ParamSpec, TypeVar
+from typing import Any, get_args, Callable
 
-P = ParamSpec('P')
-T = TypeVar('T')
-
-class Definition(Generic[T]):
+class Definition:
     @staticmethod
-    def __class_getitem__(structure:type[T]) -> Any:
+    def __class_getitem__(structure:Any) -> Any:
         return structure
 
 def private(func:Callable) -> Callable:
@@ -63,6 +60,9 @@ def protected(func:Callable) -> Callable:
     return wrapper
 
 # ------------------------------------------------------------------------------
+from typing import ParamSpec, TypeVar
+P = ParamSpec('P')
+T = TypeVar('T')
 
 def enforceRequirements(func:Callable[P, T]) -> Callable[P, T]:
     '''

kisa_utils/token.py

@@ -19,6 +19,8 @@ from typing import Any
 
 from kisa_utils.storage import encodeJSON, decodeJSON
 from kisa_utils.encryption import xor
+from kisa_utils.response import Response, Ok, Error
+from kisa_utils.functionUtils import enforceRequirements
 
 __VERSIONS = {
     'v1': {
@@ -135,7 +137,8 @@ def __create(jsonString: str, signature: bytearray, expiryTime: int) -> bytearra
 
     return byte_array
 
-def new(payload:Any, secondsToExpire:int, version:str='v1') -> dict[str, bool|str|str]:
+@enforceRequirements
+def new(payload:str|int|float|dict|list|bool, secondsToExpire:int, version:str='v1', /) -> Response:
     '''
     attempt to create a kisa-token
     Args:
@@ -144,41 +147,28 @@ def new(payload:Any, secondsToExpire:int, version:str='v1') -> dict[str, bool|st
         version(str): the token version to use. leave this the fuck alone if you dont know what you're doing
     
     Returns:
-        dict in form
-        ```
-        {
-            'status': bool,
-            'log': str,
-            'token': str
-        }
-        ```
+        KISA Response object
     '''
 
-    reply = {'status':False, 'log':'', 'token':''}
     try:
         payload = encodeJSON(payload)
     except:
-        reply['log'] = 'failed to serialize payload into JSON'
-        return reply
+        return Error('failed to serialize payload into JSON')
 
     if secondsToExpire<=0:
-        reply['log'] = 'invalid `secondsToExpire` given for token'
-        return reply
+        return Error('invalid `secondsToExpire` given for token')
 
     if version not in __VERSIONS:
-        reply["log"] = f'unknown version {version}'
-        return reply
+        return Error(f'unknown version {version}')
 
     _token = __create(payload, signature=__VERSIONS[version]['signature'], expiryTime=secondsToExpire)
 
     __encrypt(_token,version)
 
-    reply["token"] = _token.hex()
-
-    reply["status"] = True
-    return reply
+    return Ok(_token.hex())
 
-def read(token:str, version:str='v1') -> dict:
+@enforceRequirements
+def read(token:str, version:str='v1', /) -> Response:
     '''
     attempt to read a token
     Args:
@@ -186,34 +176,21 @@ def read(token:str, version:str='v1') -> dict:
         version(str): the token version to use. leave this the fuck alone if you dont know what you're doing
 
     Returns:
-        dict in form
-        ```
-        {
-            'status': bool,
-            'log': str,
-            'data': Any
-        }
-        ```
+        KISA REsponse object
     '''
-    reply = {'status':False, 'log':'', 'data':None}
-
     if not isinstance(token,str):
-        reply["log"] = '[ET01] invalid token given'
-        return reply
+        return Error('[ET01] invalid token given')
 
     try: token = bytearray.fromhex(token)
     except:
-        reply["log"] = '[ET02] invalid token given'
-        return reply
+        return Error('[ET02] invalid token given')
 
     if version not in __VERSIONS:
-        reply["log"] = f'[ET03] unknown version {version}'
-        return reply
+        return Error(f'[ET03] unknown version {version}')
 
     if 'v1'==version:
         if len(token) < 21 + 2: # head:21, checksum:2 bytes
-            reply["log"] = '[ET03] invalid token given'
-            return reply
+            return Error('[ET03] invalid token given')
 
         __decrypt(token, version)
 
@@ -225,33 +202,27 @@ def read(token:str, version:str='v1') -> dict:
         currentEpochTime = int(time.time())
 
         if _signature != __VERSIONS["v1"]['signature']:
-            reply['log'] = '[ETV01] invalid token tiven'
-            return reply
+            return Error('[ETV01] invalid token tiven')
 
         if _checksum != calculatedChecksum:
-            reply['log'] = '[ETV02] invalid token tiven'
-            return reply
+            return Error('[ETV02] invalid token tiven')
 
         if _timestamp < currentEpochTime:
-            reply['log'] = '[ETV03] invalid token tiven'
-            return reply
+            return Error('[ETV03] invalid token tiven')
 
         if _payloadLength != len(token) - 21 - 2:
-            print(token[17 : 17+4],_payloadLength,  len(token) - 21 - 2)
-            reply['log'] = '[ETV04] invalid token tiven'
-            return reply
+            # print(token[17 : 17+4],_payloadLength,  len(token) - 21 - 2)
+            return Error('[ETV04] invalid token tiven')
 
         _data = token[21:-2].decode('utf-8')
 
         try:
-            reply["data"] = decodeJSON(_data)
+            return Ok(decodeJSON(_data))
         except Exception as e:
-            print(e)
-            reply["log"] = '[ETV05] invalid token given'
-            return reply
+            # print(e)
+            return Error('[ETV05] invalid token given')
 
-    reply["status"] = True
-    return reply
+    return Error('unknown/unsupported token version provided')
 
 if __name__ == "__main__":
     data = {
@@ -266,12 +237,14 @@ if __name__ == "__main__":
         }
     }
 
+    data = '123456789ABC:123456789012345'
+
     print('---data----'); print(data)
-    reply = new(data, 10)
-    _token = reply['token']
+    reply = new(data, 10); print(reply)
+    _token = reply.data
     print('\n---token----'); print(_token)
 
     reply = read(_token)
-    print('\n---decoded token----'); print(reply['data'])
+    print('\n---decoded token----'); print(reply.data)
 
-    print('\n---decoded token == data?----'); print(reply['data']==data)
+    print('\n---decoded token == data?----'); print(reply.data==data)

{kisa_utils-0.37.18.dist-info → kisa_utils-0.37.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kisa-utils
-Version: 0.37.18
+Version: 0.37.20
 Summary: Utility functions and modules for KISA Developers
 Author: Tom Bukenya
 Author-email: glayn2bukman@gmail.com

{kisa_utils-0.37.18.dist-info → kisa_utils-0.37.20.dist-info}/RECORD

@@ -7,7 +7,7 @@ kisa_utils/db.py,sha256=QH9nvwc3Lr-NyUA-47Rae-s2xeMIE6m2rNGozcpr2jg,48950
 kisa_utils/encryption.py,sha256=nFzNpzWV_D9uSEq4FsgCnlS7FQtqWP9fvM_81rsfcLo,4218
 kisa_utils/enqueue.py,sha256=VIliaMvw4MUdOqts0dXdZCYNxs-QrOVjIRAR3scGrRM,11786
 kisa_utils/figures.py,sha256=pYIpQzu1OXRSsY1d98GhgPifnIRmgl-r7S32ai-Ms0c,3731
-kisa_utils/functionUtils.py,sha256=I33ZeDNcQsumhgWyFWodj0D3RKkwfiUFZfCGwmAkDYo,6561
+kisa_utils/functionUtils.py,sha256=PlXjnmU1uJWNdISlJJ3SCgavTsgNBoebaa9dtWSFhRA,6553
 kisa_utils/log.py,sha256=0TYdxcIBts026RCSuVIQBcZ-CW1ES7n3M1nEIjmeLTM,2295
 kisa_utils/queues.py,sha256=9QqPtDujw6tbWk7uUiXrsd0rVBTIkzeQw9b45l5Fo3k,6502
 kisa_utils/remote.py,sha256=0RDrfC4RUW4m6JLziC0_EXJYqzWp38Rw8NDroJ0MuqI,2149
@@ -15,7 +15,7 @@ kisa_utils/response.py,sha256=FusfDTBn7gOMqt34XkiUf4d1lWn42_c1n_61wJoPKYU,4182
 kisa_utils/standardize.py,sha256=nt-uzHQFoKxGscD_MpDYXw65Teg3724whAqa6Kh_zhE,2231
 kisa_utils/storage.py,sha256=8-NgrY6BpIo-B9IJNTd-TqMB0m9BY1PuQgZ9WL1z8SM,7683
 kisa_utils/threads.py,sha256=qQqsf64YHMyLpboq5AEXKxYqf3iXUhxiJe6Ymg-vlxI,12840
-kisa_utils/token.py,sha256=RUdov01FlCfxMPY0onj0kvPkXTOxutvS96xQN1bhPBE,8282
+kisa_utils/token.py,sha256=Y2qglWYWpmHxoXBh-TH0r1as0uPV5LLqMNcunLvM4vM,7850
 kisa_utils/permissions/__config__.py,sha256=i3ELkOydDnjKx2ozQTxLZdZ8DXSeUncnl2kRxANjFmM,613
 kisa_utils/permissions/__init__.py,sha256=q7LGl26f-MPXkLS6nxBKDotW3xdB8y7pI5S_Oo5fPOw,47976
 kisa_utils/servers/__init__.py,sha256=lPqDyGTrFo0qwPZ2WA9Xtcpc5D8AIU4huqgFx1iZf68,19
@@ -23,7 +23,7 @@ kisa_utils/servers/flask.py,sha256=o76cJKlQ3L8EOVdHUF092qwoAZMzgttuLt0mMhtCsGI,4
 kisa_utils/structures/__init__.py,sha256=JBU1j3A42jQ62ALKnsS1Hav9YXcYwjDw1wQJtohXPbU,83
 kisa_utils/structures/utils.py,sha256=665rXIapGwFqejizeJwy3DryeskCQOdgP25BCdLkGvk,2898
 kisa_utils/structures/validator.py,sha256=Y4UmB4TH7N-GkK22EV1WOsPWjTeqxVWLTentl1keZD4,4053
-kisa_utils-0.37.18.dist-info/METADATA,sha256=gTcrLt0Vr8OPx_6bCHDe_Zs0sAh2hqlriAeJg41LFGA,478
-kisa_utils-0.37.18.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-kisa_utils-0.37.18.dist-info/top_level.txt,sha256=URxY4sRuqmirOxWtztpVmPoGQdksEMYO6hmYsEDGz2Y,75
-kisa_utils-0.37.18.dist-info/RECORD,,
+kisa_utils-0.37.20.dist-info/METADATA,sha256=01cNCPOuqmY6hTmZ3KYeOqf3XkVDSi8GyvQRdyigNSY,478
+kisa_utils-0.37.20.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+kisa_utils-0.37.20.dist-info/top_level.txt,sha256=URxY4sRuqmirOxWtztpVmPoGQdksEMYO6hmYsEDGz2Y,75
+kisa_utils-0.37.20.dist-info/RECORD,,