square-authentication 5.1.4__tar.gz → 5.2.0__tar.gz

{square_authentication-5.1.4 → square_authentication-5.2.0}/PKG-INFO

@@ -1,18 +1,39 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: square_authentication
-Version: 5.1.4
+Version: 5.2.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
+Requires-Dist: uvicorn>=0.24.0.post1
+Requires-Dist: fastapi>=0.104.1
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: bcrypt>=4.1.2
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: cryptography>=42.0.7
+Requires-Dist: square_commons>=1.0.0
+Requires-Dist: square_logger>=2.0.0
+Requires-Dist: square_database_helper>=2.0.0
+Requires-Dist: square_database_structure>=2.3.1
+Requires-Dist: square_file_store_helper>=2.1.0
+Requires-Dist: pytest>=8.0.0
+Requires-Dist: httpx>=0.27.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
 
 # square_authentication
 
@@ -32,6 +53,22 @@ pip install square_authentication
 
 ## changelog
 
+### v5.2.0
+
+- add temp folder to .gitignore.
+- add square_file_store_helper as a dependency.
+- config
+    - add config section for file store helper.
+- initialise file store helper and database helper in config.py
+- add profile router
+- profile
+    - add update_profile_photo/v0
+- update messages.
+
+### v5.1.5
+
+- bump square_logger to >=2.0.0.
+
 ### v5.1.4
 
 - re bug fix v5.1.3
@@ -139,5 +176,3 @@ pip install square_authentication
 - initial implementation.
 
 ## Feedback is appreciated. Thank you!
-
-

{square_authentication-5.1.4 → square_authentication-5.2.0}/README.md

@@ -16,6 +16,22 @@ pip install square_authentication
 
 ## changelog
 
+### v5.2.0
+
+- add temp folder to .gitignore.
+- add square_file_store_helper as a dependency.
+- config
+    - add config section for file store helper.
+- initialise file store helper and database helper in config.py
+- add profile router
+- profile
+    - add update_profile_photo/v0
+- update messages.
+
+### v5.1.5
+
+- bump square_logger to >=2.0.0.
+
 ### v5.1.4
 
 - re bug fix v5.1.3

{square_authentication-5.1.4 → square_authentication-5.2.0}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_authentication"
 
 setup(
     name=package_name,
-    version="5.1.4",
+    version="5.2.0",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],
@@ -12,15 +12,17 @@ setup(
     install_requires=[
         "uvicorn>=0.24.0.post1",
         "fastapi>=0.104.1",
+        "python-multipart>=0.0.6",
         "pydantic>=2.5.3",
         "bcrypt>=4.1.2",
         "pyjwt>=2.8.0",
         "requests>=2.32.3",
         "cryptography>=42.0.7",
         "square_commons>=1.0.0",
-        "square_logger>=1.0.0",
+        "square_logger>=2.0.0",
         "square_database_helper>=2.0.0",
         "square_database_structure>=2.3.1",
+        "square_file_store_helper>=2.1.0",
         "pytest>=8.0.0",
         "httpx>=0.27.2",
     ],

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/configuration.py

@@ -2,6 +2,8 @@ import os
 import sys
 
 from square_commons import ConfigReader
+from square_database_helper import SquareDatabaseHelper
+from square_file_store_helper import SquareFileStoreHelper
 from square_logger.main import SquareLogger
 
 try:
@@ -67,6 +69,20 @@ try:
         ldict_configuration["SQUARE_DATABASE_HELPER"]["SQUARE_DATABASE_PORT"]
     )
     # ===========================================
+
+    # ===========================================
+    # square_file_store_helper
+
+    config_str_square_file_store_protocol = ldict_configuration[
+        "SQUARE_FILE_STORE_HELPER"
+    ]["SQUARE_FILE_STORE_PROTOCOL"]
+    config_str_square_file_store_ip = ldict_configuration["SQUARE_FILE_STORE_HELPER"][
+        "SQUARE_FILE_STORE_IP"
+    ]
+    config_int_square_file_store_port = int(
+        ldict_configuration["SQUARE_FILE_STORE_HELPER"]["SQUARE_FILE_STORE_PORT"]
+    )
+    # ===========================================
     # Initialize logger
     global_object_square_logger = SquareLogger(
         pstr_log_file_name=config_str_log_file_name,
@@ -74,6 +90,16 @@ try:
         pstr_log_path=config_str_log_path,
         pint_log_backup_count=config_int_log_backup_count,
     )
+    global_object_square_database_helper = SquareDatabaseHelper(
+        param_str_square_database_ip=config_str_square_database_ip,
+        param_int_square_database_port=config_int_square_database_port,
+        param_str_square_database_protocol=config_str_square_database_protocol,
+    )
+    global_object_square_file_store_helper = SquareFileStoreHelper(
+        param_str_square_file_store_protocol=config_str_square_file_store_protocol,
+        param_str_square_file_store_ip=config_str_square_file_store_ip,
+        param_int_square_file_store_port=config_int_square_file_store_port,
+    )
 except Exception as e:
     print(
         "\033[91mMissing or incorrect config.ini file.\n"

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/data/config.ini

@@ -39,4 +39,10 @@ LOG_BACKUP_COUNT = 3
 
 SQUARE_DATABASE_PROTOCOL = http
 SQUARE_DATABASE_IP = localhost
-SQUARE_DATABASE_PORT = 10010
+SQUARE_DATABASE_PORT = 10010
+
+[SQUARE_FILE_STORE_HELPER]
+
+SQUARE_FILE_STORE_PROTOCOL = http
+SQUARE_FILE_STORE_IP = localhost
+SQUARE_FILE_STORE_PORT = 10100

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/main.py

@@ -14,7 +14,7 @@ from square_authentication.configuration import (
     config_str_ssl_key_file_path,
     config_str_ssl_crt_file_path,
 )
-from square_authentication.routes import core, utility
+from square_authentication.routes import core, utility, profile
 
 app = FastAPI()
 
@@ -28,10 +28,11 @@ app.add_middleware(
 
 app.include_router(core.router)
 app.include_router(utility.router)
+app.include_router(profile.router)
 
 
 @app.get("/")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def root():
     output_content = get_api_output_in_standard_format(log=config_str_module_name)
     return JSONResponse(status_code=status.HTTP_200_OK, content=output_content)

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/messages.py

@@ -14,4 +14,6 @@ messages = {
     "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.",
+    "INVALID_FILE_FORMAT": "the file format is not supported. please upload a valid file.",
+    "FILE_SIZE_EXCEEDS_LIMIT": "the file size exceeds the limit. please upload a smaller file.",
 }

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/routes/core.py

@@ -8,7 +8,6 @@ from fastapi.params import Query
 from fastapi.responses import JSONResponse
 from requests import HTTPError
 from square_commons import get_api_output_in_standard_format
-from square_database_helper.main import SquareDatabaseHelper
 from square_database_helper.pydantic_models import FilterConditionsV0, FiltersV0
 from square_database_structure.square import global_string_database_name
 from square_database_structure.square.authentication import global_string_schema_name
@@ -27,12 +26,10 @@ from square_database_structure.square.public.tables import App
 from square_authentication.configuration import (
     config_int_access_token_valid_minutes,
     config_int_refresh_token_valid_minutes,
-    config_int_square_database_port,
     config_str_secret_key_for_access_token,
     config_str_secret_key_for_refresh_token,
-    config_str_square_database_ip,
-    config_str_square_database_protocol,
     global_object_square_logger,
+    global_object_square_database_helper,
 )
 from square_authentication.messages import messages
 from square_authentication.pydantic_models.core import (
@@ -49,15 +46,9 @@ router = APIRouter(
     tags=["core"],
 )
 
-global_object_square_database_helper = SquareDatabaseHelper(
-    param_str_square_database_ip=config_str_square_database_ip,
-    param_int_square_database_port=config_int_square_database_port,
-    param_str_square_database_protocol=config_str_square_database_protocol,
-)
-
 
 @router.post("/register_username/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def register_username_v0(
     body: RegisterUsernameV0,
 ):
@@ -246,7 +237,7 @@ async def register_username_v0(
 
 
 @router.get("/get_user_details/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def get_user_details_v0(
     access_token: Annotated[str, Header()],
 ):
@@ -374,7 +365,7 @@ async def get_user_details_v0(
 
 
 @router.patch("/update_user_app_ids/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def update_user_app_ids_v0(
     access_token: Annotated[str, Header()],
     app_ids_to_add: List[int],
@@ -535,7 +526,7 @@ async def update_user_app_ids_v0(
 
 
 @router.post("/login_username/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def login_username_v0(body: LoginUsernameV0):
     username = body.username
     password = body.password
@@ -578,7 +569,9 @@ async def login_username_v0(body: LoginUsernameV0):
                 filters=FiltersV0(
                     root={
                         UserCredential.user_id.name: FilterConditionsV0(
-                            eq=local_list_response_user_profile[0][UserProfile.user_id.name]
+                            eq=local_list_response_user_profile[0][
+                                UserProfile.user_id.name
+                            ]
                         )
                     }
                 ),
@@ -742,7 +735,7 @@ async def login_username_v0(body: LoginUsernameV0):
 
 
 @router.get("/generate_access_token/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def generate_access_token_v0(
     refresh_token: Annotated[str, Header()],
 ):
@@ -833,7 +826,7 @@ async def generate_access_token_v0(
 
 
 @router.delete("/logout/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def logout_v0(
     refresh_token: Annotated[str, Header()],
 ):
@@ -925,7 +918,7 @@ async def logout_v0(
 
 
 @router.delete("/logout/apps/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def logout_apps_v0(
     access_token: Annotated[str, Header()],
     body: LogoutAppsV0,
@@ -1018,7 +1011,7 @@ async def logout_apps_v0(
 
 
 @router.delete("/logout/all/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def logout_all_v0(
     access_token: Annotated[str, Header()],
 ):
@@ -1082,7 +1075,7 @@ async def logout_all_v0(
 
 
 @router.patch("/update_username/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def update_username_v0(
     new_username: str,
     access_token: Annotated[str, Header()],
@@ -1197,7 +1190,7 @@ async def update_username_v0(
 
 
 @router.delete("/delete_user/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def delete_user_v0(
     body: DeleteUserV0,
     access_token: Annotated[str, Header()],
@@ -1303,7 +1296,7 @@ async def delete_user_v0(
 
 
 @router.patch("/update_password/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def update_password_v0(
     body: UpdatePasswordV0,
     access_token: Annotated[str, Header()],
@@ -1416,7 +1409,7 @@ async def update_password_v0(
 
 
 @router.get("/validate_and_get_payload_from_token/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def validate_and_get_payload_from_token_v0(
     token: Annotated[str, Header()],
     token_type: TokenType = Query(...),

square_authentication-5.2.0/square_authentication/routes/profile.py

@@ -0,0 +1,134 @@
+import os
+from typing import Annotated
+
+from fastapi import APIRouter, HTTPException, status, Header, UploadFile
+from fastapi.responses import JSONResponse
+from square_commons import get_api_output_in_standard_format
+from square_database_helper import FiltersV0
+from square_database_helper.pydantic_models import FilterConditionsV0
+from square_database_structure.square import global_string_database_name
+from square_database_structure.square.authentication import global_string_schema_name
+from square_database_structure.square.authentication.tables import UserProfile
+
+from square_authentication.configuration import (
+    global_object_square_logger,
+    config_str_secret_key_for_access_token,
+    global_object_square_file_store_helper,
+    global_object_square_database_helper,
+)
+from square_authentication.messages import messages
+from square_authentication.utils.token import get_jwt_payload
+
+router = APIRouter(
+    tags=["profile"],
+)
+
+
+@router.patch("/update_profile_photo/v0")
+@global_object_square_logger.auto_logger()
+async def update_profile_photo_v0(
+    access_token: Annotated[str, Header()],
+    profile_photo: UploadFile,
+):
+
+    try:
+        """
+        validation
+        """
+        # validate access token
+        try:
+            local_dict_access_token_payload = get_jwt_payload(
+                access_token, config_str_secret_key_for_access_token
+            )
+        except Exception as error:
+            output_content = get_api_output_in_standard_format(
+                message=messages["INCORRECT_ACCESS_TOKEN"], log=str(error)
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
+        user_id = local_dict_access_token_payload["user_id"]
+
+        # validate file format
+        if not profile_photo.filename.endswith((".jpg", ".jpeg", ".png")):
+            output_content = get_api_output_in_standard_format(
+                message=messages["INVALID_FILE_FORMAT"]
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
+
+        # validate file size
+        file_size_limit_in_mib = 5
+        if profile_photo.size > (file_size_limit_in_mib * 1024 * 1024):
+            output_content = get_api_output_in_standard_format(
+                message=messages["FILE_SIZE_EXCEEDS_LIMIT"]
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
+        """
+        main process
+        """
+        # uploading to square file store
+        destination_path = f"temp/{user_id}/profile_photo/{profile_photo.filename}"
+        os.makedirs(os.path.dirname(destination_path), exist_ok=True)
+        with open(destination_path, "wb") as out_file:
+            content = await profile_photo.read()
+            out_file.write(content)
+
+        file_upload_response = (
+            global_object_square_file_store_helper.upload_file_using_file_path_v0(
+                file_path=destination_path,
+                system_relative_path="global/users/profile_photos",
+            )
+        )
+        os.remove(destination_path)
+
+        # adding file storage token to user profile
+        profile_update_response = global_object_square_database_helper.edit_rows_v0(
+            data={
+                UserProfile.user_profile_photo_storage_token.name: file_upload_response[
+                    "data"
+                ]["main"]
+            },
+            filters=FiltersV0(
+                {UserProfile.user_id.name: FilterConditionsV0(eq=user_id)}
+            ),
+            database_name=global_string_database_name,
+            schema_name=global_string_schema_name,
+            table_name=UserProfile.__tablename__,
+            apply_filters=True,
+        )
+
+        """
+        return value
+        """
+        output_content = get_api_output_in_standard_format(
+            data=profile_update_response["data"],
+            message=messages["GENERIC_UPDATE_SUCCESSFUL"],
+        )
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=output_content,
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        """
+        rollback logic
+        """
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"],
+            log=str(e),
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/routes/utility.py

@@ -12,7 +12,7 @@ router = APIRouter(
 
 
 @router.get("/get_text_hash/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def get_text_hash_v0(plain_text: str):
 
     try:

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/utils/encryption.py

@@ -7,7 +7,7 @@ from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from square_authentication.configuration import global_object_square_logger
 
 
-@global_object_square_logger.auto_logger
+@global_object_square_logger.auto_logger()
 def encrypt(key, plaintext):
     # Ensure the key length is 16, 24, or 32 bytes for AES
     key = key.ljust(32)[:32].encode('utf-8')
@@ -31,7 +31,7 @@ def encrypt(key, plaintext):
 
     return encoded_ciphertext
 
-@global_object_square_logger.auto_logger
+@global_object_square_logger.auto_logger()
 def decrypt(key, encoded_ciphertext):
     # Ensure the key length is 16, 24, or 32 bytes for AES
     key = key.ljust(32)[:32].encode('utf-8')

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication/utils/token.py

@@ -4,7 +4,7 @@ from jwt.exceptions import ExpiredSignatureError, DecodeError, InvalidTokenError
 from square_authentication.configuration import global_object_square_logger
 
 
-@global_object_square_logger.auto_logger
+@global_object_square_logger.auto_logger()
 def get_jwt_payload(token, secret_key):
     try:
         # Decode the token and verify the signature

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication.egg-info/PKG-INFO

@@ -1,18 +1,39 @@
-Metadata-Version: 2.1
-Name: square-authentication
-Version: 5.1.4
+Metadata-Version: 2.4
+Name: square_authentication
+Version: 5.2.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
+Requires-Dist: uvicorn>=0.24.0.post1
+Requires-Dist: fastapi>=0.104.1
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: bcrypt>=4.1.2
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: cryptography>=42.0.7
+Requires-Dist: square_commons>=1.0.0
+Requires-Dist: square_logger>=2.0.0
+Requires-Dist: square_database_helper>=2.0.0
+Requires-Dist: square_database_structure>=2.3.1
+Requires-Dist: square_file_store_helper>=2.1.0
+Requires-Dist: pytest>=8.0.0
+Requires-Dist: httpx>=0.27.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
 
 # square_authentication
 
@@ -32,6 +53,22 @@ pip install square_authentication
 
 ## changelog
 
+### v5.2.0
+
+- add temp folder to .gitignore.
+- add square_file_store_helper as a dependency.
+- config
+    - add config section for file store helper.
+- initialise file store helper and database helper in config.py
+- add profile router
+- profile
+    - add update_profile_photo/v0
+- update messages.
+
+### v5.1.5
+
+- bump square_logger to >=2.0.0.
+
 ### v5.1.4
 
 - re bug fix v5.1.3
@@ -139,5 +176,3 @@ pip install square_authentication
 - initial implementation.
 
 ## Feedback is appreciated. Thank you!
-
-

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication.egg-info/SOURCES.txt

@@ -14,7 +14,9 @@ square_authentication/pydantic_models/__init__.py
 square_authentication/pydantic_models/core.py
 square_authentication/routes/__init__.py
 square_authentication/routes/core.py
+square_authentication/routes/profile.py
 square_authentication/routes/utility.py
 square_authentication/utils/__init__.py
 square_authentication/utils/encryption.py
-square_authentication/utils/token.py
+square_authentication/utils/token.py
+tests/test_1.py

{square_authentication-5.1.4 → square_authentication-5.2.0}/square_authentication.egg-info/requires.txt

@@ -1,13 +1,15 @@
 uvicorn>=0.24.0.post1
 fastapi>=0.104.1
+python-multipart>=0.0.6
 pydantic>=2.5.3
 bcrypt>=4.1.2
 pyjwt>=2.8.0
 requests>=2.32.3
 cryptography>=42.0.7
 square_commons>=1.0.0
-square_logger>=1.0.0
+square_logger>=2.0.0
 square_database_helper>=2.0.0
 square_database_structure>=2.3.1
+square_file_store_helper>=2.1.0
 pytest>=8.0.0
 httpx>=0.27.2

square_authentication-5.2.0/tests/test_1.py

@@ -0,0 +1,17 @@
+from fastapi.testclient import TestClient
+from square_commons import get_api_output_in_standard_format
+
+from square_authentication.configuration import config_str_module_name
+from square_authentication.main import (
+    app,
+)
+
+client = TestClient(app)
+
+
+def test_read_main():
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.json() == get_api_output_in_standard_format(
+        log=config_str_module_name
+    )