square-authentication 1.0.0__tar.gz → 3.0.0__tar.gz

square_authentication-3.0.0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.1
+Name: square_authentication
+Version: 3.0.0
+Summary: authentication layer for my personal server.
+Home-page: https://github.com/thepmsquare/square_authentication
+Author: thePmSquare
+Author-email: thepmsquare@gmail.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+
+# square_authentication
+
+## about
+
+authentication layer for my personal server.
+
+## Installation
+
+```shell
+pip install square_authentication
+```
+
+## env
+
+- python>=3.12.0
+
+## changelog
+
+### v3.0.0
+
+- added new endpoints
+    - /update_username/v0
+    - /delete_user/v0
+    - /update_password/v0
+- move data in password related endpoints to request body from params.
+- /register_username/v0 now takes in app_id as optional parameter to assign user to that app and create session for it.
+- /generate_access_token/v0 now only needs refresh token (removed validation).
+- /logout/v0 now only needs refresh token (removed validation).
+- /update_user_app_ids/v0 now only updates ids for self (user). added access token as input param and removed user_id.
+- /get_user_app_ids/v0 is now /get_user_details/v0 with access token as the only input param.
+
+### v2.0.0
+
+- authentication module needs to be used across applications so
+    - register_username: will not create sessions and therefore will not auto login.
+    - login: added validation if app is assigned to user before assigning it and added app_id in session row.
+    - logout: added app_id as new parameter and validation for that.
+    - generate_access_token: added app_id as new parameter and validation for that.
+- added 2 new endpoints
+    - get user app ids: **access token validation pending**.
+    - change user app ids: **access token validation pending**.
+- add versions for all endpoint paths.
+- make it compatible with square_database_helper 2.x.
+- username in database will always be lowercase.
+- standardise output formats for all api.
+
+### v1.0.0
+
+- initial implementation.
+
+## Feedback is appreciated. Thank you!
+

square_authentication-3.0.0/README.md

@@ -0,0 +1,51 @@
+# square_authentication
+
+## about
+
+authentication layer for my personal server.
+
+## Installation
+
+```shell
+pip install square_authentication
+```
+
+## env
+
+- python>=3.12.0
+
+## changelog
+
+### v3.0.0
+
+- added new endpoints
+    - /update_username/v0
+    - /delete_user/v0
+    - /update_password/v0
+- move data in password related endpoints to request body from params.
+- /register_username/v0 now takes in app_id as optional parameter to assign user to that app and create session for it.
+- /generate_access_token/v0 now only needs refresh token (removed validation).
+- /logout/v0 now only needs refresh token (removed validation).
+- /update_user_app_ids/v0 now only updates ids for self (user). added access token as input param and removed user_id.
+- /get_user_app_ids/v0 is now /get_user_details/v0 with access token as the only input param.
+
+### v2.0.0
+
+- authentication module needs to be used across applications so
+    - register_username: will not create sessions and therefore will not auto login.
+    - login: added validation if app is assigned to user before assigning it and added app_id in session row.
+    - logout: added app_id as new parameter and validation for that.
+    - generate_access_token: added app_id as new parameter and validation for that.
+- added 2 new endpoints
+    - get user app ids: **access token validation pending**.
+    - change user app ids: **access token validation pending**.
+- add versions for all endpoint paths.
+- make it compatible with square_database_helper 2.x.
+- username in database will always be lowercase.
+- standardise output formats for all api.
+
+### v1.0.0
+
+- initial implementation.
+
+## Feedback is appreciated. Thank you!

{square_authentication-1.0.0 → square_authentication-3.0.0}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_authentication"
 
 setup(
     name=package_name,
-    version="1.0.0",
+    version="3.0.0",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],
@@ -17,10 +17,10 @@ setup(
         "pyjwt>=2.8.0",
         "requests>=2.32.3",
         "cryptography>=42.0.7",
-        "square_commons>=0.0.1",
+        "square_commons>=1.0.0",
         "square_logger>=1.0.0",
-        "square_database_helper>=0.0.5",
-        "square_database_structure>=0.0.11",
+        "square_database_helper>=2.0.0",
+        "square_database_structure>=1.0.0",
     ],
     extras_require={},
     author="thePmSquare",

{square_authentication-1.0.0 → square_authentication-3.0.0}/square_authentication/configuration.py

@@ -6,11 +6,11 @@ from square_logger.main import SquareLogger
 
 try:
     config_file_path = (
-            os.path.dirname(os.path.abspath(__file__))
-            + os.sep
-            + "data"
-            + os.sep
-            + "config.ini"
+        os.path.dirname(os.path.abspath(__file__))
+        + os.sep
+        + "data"
+        + os.sep
+        + "config.ini"
     )
     ldict_configuration = ConfigReader(config_file_path).read_configuration()
 

{square_authentication-1.0.0 → square_authentication-3.0.0}/square_authentication/main.py

@@ -3,6 +3,7 @@ import os.path
 from fastapi import FastAPI, status
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse
+from square_commons import get_api_output_in_standard_format
 from uvicorn import run
 
 from square_authentication.configuration import (
@@ -31,15 +32,14 @@ app.include_router(utility.router)
 @app.get("/")
 @global_object_square_logger.async_auto_logger
 async def root():
-    return JSONResponse(
-        status_code=status.HTTP_200_OK, content={"text": config_str_module_name}
-    )
+    output_content = get_api_output_in_standard_format(log=config_str_module_name)
+    return JSONResponse(status_code=status.HTTP_200_OK, content=output_content)
 
 
 if __name__ == "__main__":
     try:
         if os.path.exists(config_str_ssl_key_file_path) and os.path.exists(
-                config_str_ssl_crt_file_path
+            config_str_ssl_crt_file_path
         ):
             run(
                 app,

square_authentication-3.0.0/square_authentication/messages.py

@@ -0,0 +1,17 @@
+messages = {
+    "REGISTRATION_SUCCESSFUL": "registration was successful. welcome aboard!",
+    "LOGIN_SUCCESSFUL": "you have logged in successfully.",
+    "LOGOUT_SUCCESSFUL": "you have logged out successfully.",
+    "INCORRECT_USERNAME": "the username you entered does not exist.",
+    "INCORRECT_PASSWORD": "the password you entered is incorrect. please try again.",
+    "INCORRECT_USER_ID": "the user ID you provided does not exist or is invalid.",
+    "USERNAME_ALREADY_EXISTS": "the username you entered is already taken. please choose a different one.",
+    "INCORRECT_ACCESS_TOKEN": "the access token provided is invalid or expired.",
+    "INCORRECT_REFRESH_TOKEN": "the refresh token provided is invalid or expired.",
+    "GENERIC_CREATION_SUCCESSFUL": "records created successfully.",
+    "GENERIC_READ_SUCCESSFUL": "data retrieved successfully.",
+    "GENERIC_UPDATE_SUCCESSFUL": "your information has been updated successfully.",
+    "GENERIC_DELETE_SUCCESSFUL": "your records have been deleted successfully.",
+    "GENERIC_400": "the request is invalid or cannot be processed.",
+    "GENERIC_500": "an internal server error occurred. please try again later.",
+}

square_authentication-3.0.0/square_authentication/pydantic_models/core.py

@@ -0,0 +1,24 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class RegisterUsernameV0(BaseModel):
+    username: str
+    password: str
+    app_id: Optional[int] = None
+
+
+class LoginUsernameV0(BaseModel):
+    username: str
+    password: str
+    app_id: int
+
+
+class DeleteUserV0(BaseModel):
+    password: str
+
+
+class UpdatePasswordV0(BaseModel):
+    old_password: str
+    new_password: str