square-authentication 5.1.5__py3-none-any.whl → 6.0.0__py3-none-any.whl

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/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/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,6 +28,7 @@ app.add_middleware(
 
 app.include_router(core.router)
 app.include_router(utility.router)
+app.include_router(profile.router)
 
 
 @app.get("/")

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/routes/core.py

@@ -1,3 +1,4 @@
+import copy
 from datetime import datetime, timedelta, timezone
 from typing import Annotated, List
 
@@ -8,7 +9,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 +27,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,12 +47,6 @@ 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.auto_logger()
@@ -311,16 +303,14 @@ async def get_user_details_v0(
                 ),
             )["data"]["main"]
         )
+        user_profile = copy.deepcopy(local_list_response_user_profile[0])
+        del user_profile[UserProfile.user_id.name]
         """
         return value
         """
         return_this = {
             "user_id": user_id,
-            "credentials": {
-                "username": local_list_response_user_profile[0][
-                    UserProfile.user_profile_username.name
-                ],
-            },
+            "profile": user_profile,
             "apps": [
                 y[App.app_name.name]
                 for y in local_list_app

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.5.dist-info → square_authentication-6.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: square_authentication
-Version: 5.1.5
+Version: 6.0.0
 Summary: authentication layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_authentication
 Author: thePmSquare
@@ -13,6 +13,7 @@ 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
@@ -22,6 +23,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
@@ -51,6 +53,22 @@ pip install square_authentication
 
 ## changelog
 
+### v6.0.0
+
+- add profile details in get_user_details_v0 instead of credentials keyword.
+
+### 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.

{square_authentication-5.1.5.dist-info → square_authentication-6.0.0.dist-info}/RECORD

@@ -1,17 +1,18 @@
 square_authentication/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-square_authentication/configuration.py,sha256=i0uNtNSQd-n1rBxFM6jsIz1Wy3d090RcdTViSqHKc7Y,2973
-square_authentication/main.py,sha256=zP8Affuljk1m7fsRSa1WG8KP0xdcVgOvA-62bWlLe4s,1660
-square_authentication/messages.py,sha256=BA9KC0vW9UD1ZXT4VneVqVNLlgdbMdsAwAgxhJISLf4,1175
-square_authentication/data/config.ini,sha256=_740RvKpL5W2bUDGwZ7ePwuP-mAasr5cXXB81yq_Jv8,906
+square_authentication/configuration.py,sha256=AvwARscNVNFdiblu01zxhqwQ2OuKPasaTU_YqZ7pzyc,4211
+square_authentication/main.py,sha256=zADc2vmV8yDylmbihj4FzLDEs5b-9nItFoB5c4AoKGk,1704
+square_authentication/messages.py,sha256=vhcl4bw8Ar1npiErjGh3kkNPmW1rmDRtf6rKn5JF8W8,1364
+square_authentication/data/config.ini,sha256=xkKVlwqspOE8z55ty15ERbZcNVkMOuxF_rLHluNYzVs,1033
 square_authentication/pydantic_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 square_authentication/pydantic_models/core.py,sha256=qeNETcJv7mnRKGhATOW2bg0NlHuyzvot1dZ1b1qqhwU,610
 square_authentication/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-square_authentication/routes/core.py,sha256=nfATWJ3NWQkCe9gmMhJIh1lsdxmiCQ1OL3HoqIhFd88,57195
+square_authentication/routes/core.py,sha256=Ui2kJI3DHK1tsb4_cCle8iurZlU__O_nptk2-YLZ2vg,56778
+square_authentication/routes/profile.py,sha256=YkApDwsSL4KDKdT5uHDqdpSmTEhPgRkJ6bTQkf5sj9Q,4879
 square_authentication/routes/utility.py,sha256=KDr8KdkT0jAGPjfP-b5XXYG7p49WU7J1FiK6oSIckQI,1779
 square_authentication/utils/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 square_authentication/utils/encryption.py,sha256=WakaiEAgWpTJltxBzqOtv81_DCDKfzJqt60fWSPoNvo,2027
 square_authentication/utils/token.py,sha256=t-RPBY4cYyT1ro3lkLBTOy2BeRGBfluBVBivL5DLmDg,680
-square_authentication-5.1.5.dist-info/METADATA,sha256=0GDaWp1LZIJ1WGH1_r-uf0GhBgfuERwosV8hzZ8wl0s,4258
-square_authentication-5.1.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-square_authentication-5.1.5.dist-info/top_level.txt,sha256=wDssVJIl9KIEJPj5rR3rv4uRI7yCndMBrvHd_6BGXQA,22
-square_authentication-5.1.5.dist-info/RECORD,,
+square_authentication-6.0.0.dist-info/METADATA,sha256=diCuuGBkXdBe3l2ArU7R1M6dB-BwAox2bdzdDb-MC8o,4733
+square_authentication-6.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+square_authentication-6.0.0.dist-info/top_level.txt,sha256=wDssVJIl9KIEJPj5rR3rv4uRI7yCndMBrvHd_6BGXQA,22
+square_authentication-6.0.0.dist-info/RECORD,,