square-administration 3.2.1__py3-none-any.whl → 3.3.0__py3-none-any.whl

square_administration/configuration.py

@@ -10,8 +10,12 @@ try:
     config_file_path = os.path.join(
         os.path.dirname(os.path.abspath(__file__)), "data", "config.ini"
     )
-    ldict_configuration = ConfigReader(config_file_path).read_configuration()
-
+    config_sample_file_path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "data", "config.sample.ini"
+    )
+    ldict_configuration = ConfigReader(
+        config_file_path, config_sample_file_path
+    ).read_configuration()
     # get all vars and typecast
     # ===========================================
     # general

square_administration/pydantic_models/authentication.py

@@ -14,3 +14,21 @@ class LoginUsernameV0(BaseModel):
 
 class RemoveAppForSelfV0(BaseModel):
     password: str
+
+
+class RegisterLoginGoogleV0(BaseModel):
+    google_id: str
+
+
+class ResetPasswordAndLoginUsingBackupCodeV0(BaseModel):
+    backup_code: str
+    username: str
+    new_password: str
+    logout_other_sessions: bool = False
+
+
+class ResetPasswordAndLoginUsingResetEmailCodeV0(BaseModel):
+    reset_email_code: str
+    username: str
+    new_password: str
+    logout_other_sessions: bool = False

square_administration/routes/authentication.py

@@ -26,6 +26,9 @@ from square_administration.pydantic_models.authentication import (
     RegisterUsernameV0,
     LoginUsernameV0,
     RemoveAppForSelfV0,
+    RegisterLoginGoogleV0,
+    ResetPasswordAndLoginUsingBackupCodeV0,
+    ResetPasswordAndLoginUsingResetEmailCodeV0,
 )
 from square_administration.utils.common import is_https, global_int_app_id
 
@@ -481,3 +484,194 @@ async def generate_access_token_v0(
         return JSONResponse(
             status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
         )
+
+
+@router.post("/register_login_google/v0")
+@global_object_square_logger.auto_logger()
+async def register_login_google_v0(body: RegisterLoginGoogleV0):
+    google_id = body.google_id
+    try:
+        """
+        validation
+        """
+        # pass
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.register_login_google_v0(
+            google_id=google_id,
+            assign_app_id_if_missing=False,
+            app_id=global_int_app_id,
+        )
+        """
+        return value
+        """
+
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=response,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        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
+        )
+
+
+@router.post("/reset_password_and_login_using_backup_code/v0")
+@global_object_square_logger.auto_logger()
+async def reset_password_and_login_using_backup_code_v0(
+    body: ResetPasswordAndLoginUsingBackupCodeV0,
+):
+    backup_code = body.backup_code
+    username = body.username
+    new_password = body.new_password
+    logout_other_sessions = body.logout_other_sessions
+    try:
+        """
+        validation
+        """
+        # pass
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.reset_password_and_login_using_backup_code_v0(
+            backup_code=backup_code,
+            username=username,
+            new_password=new_password,
+            app_id=global_int_app_id,
+            logout_other_sessions=logout_other_sessions,
+        )
+        """
+        return value
+        """
+
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=response,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        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
+        )
+
+
+@router.post("/reset_password_and_login_using_reset_email_code/v0")
+@global_object_square_logger.auto_logger()
+async def reset_password_and_login_using_reset_email_code_v0(
+    body: ResetPasswordAndLoginUsingResetEmailCodeV0,
+):
+    reset_email_code = body.reset_email_code
+    username = body.username
+    new_password = body.new_password
+    logout_other_sessions = body.logout_other_sessions
+    try:
+        """
+        validation
+        """
+        # pass
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.reset_password_and_login_using_reset_email_code_v0(
+            reset_email_code=reset_email_code,
+            username=username,
+            new_password=new_password,
+            app_id=global_int_app_id,
+            logout_other_sessions=logout_other_sessions,
+        )
+        """
+        return value
+        """
+
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=response,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        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_administration-3.2.1.dist-info → square_administration-3.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: square-administration
-Version: 3.2.1
+Version: 3.3.0
 Summary: common business layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_administration
 Author: thePmSquare
@@ -20,7 +20,7 @@ Requires-Dist: requests>=2.32.3
 Requires-Dist: bcrypt>=4.2.0
 Requires-Dist: pytest>=8.0.0
 Requires-Dist: httpx>=0.27.2
-Requires-Dist: square-commons>=1.0.0
+Requires-Dist: square-commons>=2.1.0
 Requires-Dist: square-logger>=2.0.0
 Requires-Dist: square-database-helper>=2.0.0
 Requires-Dist: square-database-structure>=1.0.0
@@ -44,6 +44,17 @@ pip install square_administration
 
 ## changelog
 
+### v3.3.0
+
+- authentication
+    - add new endpoint -> register_login_google_v0.
+    - add new endpoint -> reset_password_and_login_using_backup_code_v0.
+    - add new endpoint -> reset_password_and_login_using_reset_email_code_v0.
+
+### v3.2.2
+
+- remove config.ini and config.testing.ini from version control.
+
 ### v3.2.1
 
 - testing

{square_administration-3.2.1.dist-info → square_administration-3.3.0.dist-info}/RECORD

@@ -1,21 +1,21 @@
 square_administration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-square_administration/configuration.py,sha256=kP2zfEvt-knzrzFIeINI1kz7260eXz_DbNjIjakByEY,4433
+square_administration/configuration.py,sha256=GoeYwDL3EQeInUdGPEKCT9UvA1wY45o-CGVO4OMGvrk,4601
 square_administration/main.py,sha256=vvKBMn4JkDp8B2L_zwBMIfYaSA41rXxhL3ZFsSv8ly8,1660
 square_administration/messages.py,sha256=VYjJGW0Kvtjrx1Mw7ekksLVMoxcexLol2OckvqhZ3n0,1063
-square_administration/data/config.ini,sha256=kkSbjJP7qR8ah44Oyv2IyCgYfmheYYh4zSU7wD7v3ec,1145
-square_administration/data/config.testing.ini,sha256=vdW01yJdCqdI6uK-jXHfWa9B9IJVuecYdx0n3y7dS2k,1193
+square_administration/data/config.sample.ini,sha256=kkSbjJP7qR8ah44Oyv2IyCgYfmheYYh4zSU7wD7v3ec,1145
+square_administration/data/config.testing.sample.ini,sha256=vdW01yJdCqdI6uK-jXHfWa9B9IJVuecYdx0n3y7dS2k,1193
 square_administration/pydantic_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-square_administration/pydantic_models/authentication.py,sha256=QEfM5ezG45hc_qATXpFIPNPl4bjf8ICW_bY5tY4cqO4,259
+square_administration/pydantic_models/authentication.py,sha256=elgVJC-uELO78uSTmwRK_z42iWzEuSSpdqWIW_hiAnU,649
 square_administration/pydantic_models/core.py,sha256=HUMrBmfKrXeL-126gE5j2povdVmktn8XLg2tHEdeXTk,344
 square_administration/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-square_administration/routes/authentication.py,sha256=-1B82WgFr78_p2Udq0WbOwD3jcgjK8jXHI7KvhtfuJA,16029
+square_administration/routes/authentication.py,sha256=gI1Y3yr3_NDbcjfq0ABARrn3rkeVuSB58NOcVWZ83rI,21960
 square_administration/routes/core.py,sha256=H5pfPuPDzSn8-HN40gyI7eDVxFW7821urYq0ceI_TDo,5271
 square_administration/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 square_administration/utils/common.py,sha256=bnyBF10EDMLIYXnfV3ZZOApNKScHRmw-Jcj2zIFE8kE,1157
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/conftest.py,sha256=Lu7qQkrnSeV1WKlN0zVyNLLXRf3Sv8ghPlIWAByv1NQ,1921
+tests/conftest.py,sha256=pqL3wk-mb_DPjtTHXWtIcYqVDXqhtM77xFPl3ljbLiw,2010
 tests/test_1.py,sha256=hikxL01-2dcax594y8ceanjRmLJXvuhLpcY-FMPIdY8,378
-square_administration-3.2.1.dist-info/METADATA,sha256=NzJek8yM3W4b1tqj7kRkXvXxc7-HhWnvmcZN6PQQLQM,3011
-square_administration-3.2.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-square_administration-3.2.1.dist-info/top_level.txt,sha256=tyroqpdXXQAiA7Y_V1wCqPPt6nnS_orcY9txLeHjm1s,28
-square_administration-3.2.1.dist-info/RECORD,,
+square_administration-3.3.0.dist-info/METADATA,sha256=5sFbRXJ2WJ0uQjJ-cJwIwY1sENyU-Xhvqpeg3JkGigQ,3322
+square_administration-3.3.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+square_administration-3.3.0.dist-info/top_level.txt,sha256=tyroqpdXXQAiA7Y_V1wCqPPt6nnS_orcY9txLeHjm1s,28
+square_administration-3.3.0.dist-info/RECORD,,

tests/conftest.py

@@ -11,6 +11,8 @@ def get_patched_configuration():
         *rest, last = args
         if last == "config.ini":
             last = "config.testing.ini"
+        elif last == "config.sample.ini":
+            last = "config.testing.sample.ini"
 
         return original_join(*rest, last)