square-authentication 6.0.5__tar.gz → 6.2.0__tar.gz

{square_authentication-6.0.5 → square_authentication-6.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: square_authentication
-Version: 6.0.5
+Version: 6.2.0
 Summary: authentication layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_authentication
 Author: thePmSquare
@@ -53,6 +53,16 @@ pip install square_authentication
 
 ## changelog
 
+### v6.2.0
+
+- core
+    - add update_user_recovery_methods_v0.
+
+### v6.1.0
+
+- add validation to username in register_username_v0 and update_username_v0.
+- add test cases for register_username_v0.
+
 ### v6.0.5
 
 - env

{square_authentication-6.0.5 → square_authentication-6.2.0}/README.md

@@ -16,6 +16,16 @@ pip install square_authentication
 
 ## changelog
 
+### v6.2.0
+
+- core
+    - add update_user_recovery_methods_v0.
+
+### v6.1.0
+
+- add validation to username in register_username_v0 and update_username_v0.
+- add test cases for register_username_v0.
+
 ### v6.0.5
 
 - env

{square_authentication-6.0.5 → square_authentication-6.2.0}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_authentication"
 
 setup(
     name=package_name,
-    version="6.0.5",
+    version="6.2.0",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],

{square_authentication-6.0.5 → square_authentication-6.2.0}/square_authentication/messages.py

@@ -5,6 +5,7 @@ messages = {
     "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_INVALID": "username must start and end with a lowercase letter and can include only lowercase letters, digits, underscores, or hyphens. no spaces, no dots, and no consecutive special characters.",
     "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.",

{square_authentication-6.0.5 → square_authentication-6.2.0}/square_authentication/routes/core.py

@@ -1,4 +1,5 @@
 import copy
+import re
 from datetime import datetime, timedelta, timezone
 from typing import Annotated, List
 
@@ -12,12 +13,14 @@ from square_commons import get_api_output_in_standard_format
 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
+from square_database_structure.square.authentication.enums import RecoveryMethodEnum
 from square_database_structure.square.authentication.tables import (
     User,
     UserApp,
     UserCredential,
     UserSession,
     UserProfile,
+    UserRecoveryMethod,
 )
 from square_database_structure.square.public import (
     global_string_schema_name as global_string_public_schema_name,
@@ -67,6 +70,22 @@ async def register_username_v0(
         validation
         """
         # validation for username
+        # ^(?!.*[_-]{2})           # no consecutive _ or -
+        # [a-z]                    # must start with a lowercase letter
+        # (?:[a-z0-9_-]{1,18})     # 1–18 of lowercase, digits, _ or -
+        # [a-z]$                   # must end with a lowercase letter
+        username_pattern = re.compile(r"^(?!.*[._-]{2})[a-z][a-z0-9_-]{1,18}[a-z]$")
+        if not username_pattern.match(username):
+            output_content = get_api_output_in_standard_format(
+                message=messages["USERNAME_INVALID"],
+                log=f"username '{username}' is invalid. it must start and end with a letter, "
+                f"contain only lowercase letters, numbers, underscores, or hyphens, "
+                f"and not have consecutive separators.",
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
         local_list_response_user_creds = (
             global_object_square_database_helper.get_rows_v0(
                 database_name=global_string_database_name,
@@ -1098,6 +1117,25 @@ async def update_username_v0(
             )
         user_id = local_dict_access_token_payload["user_id"]
 
+        # validation for username
+        # ^(?!.*[_-]{2})           # no consecutive _ or -
+        # [a-z]                    # must start with a lowercase letter
+        # (?:[a-z0-9_-]{1,18})     # 1–18 of lowercase, digits, _ or -
+        # [a-z]$                   # must end with a lowercase letter
+        new_username = new_username.lower()
+        username_pattern = re.compile(r"^(?!.*[._-]{2})[a-z][a-z0-9_-]{1,18}[a-z]$")
+        if not username_pattern.match(new_username):
+            output_content = get_api_output_in_standard_format(
+                message=messages["USERNAME_INVALID"],
+                log=f"username '{new_username}' is invalid. it must start and end with a letter, "
+                f"contain only lowercase letters, numbers, underscores, or hyphens, "
+                f"and not have consecutive separators.",
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
+
         # validate user_id
         local_list_user_response = global_object_square_database_helper.get_rows_v0(
             database_name=global_string_database_name,
@@ -1504,3 +1542,149 @@ async def validate_and_get_payload_from_token_v0(
         return JSONResponse(
             status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
         )
+
+
+@router.patch("/update_user_recovery_methods/v0")
+@global_object_square_logger.auto_logger()
+async def update_user_recovery_methods_v0(
+    access_token: Annotated[str, Header()],
+    recovery_methods_to_add: List[RecoveryMethodEnum],
+    recovery_methods_to_remove: List[RecoveryMethodEnum],
+):
+    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"]
+
+        recovery_methods_to_add = list(set(x.value for x in recovery_methods_to_add))
+        recovery_methods_to_remove = list(
+            set(x.value for x in recovery_methods_to_remove)
+        )
+
+        # check if recovery_methods_to_add and recovery_methods_to_remove don't have common ids.
+        local_list_common_recovery_methods = set(recovery_methods_to_add) & set(
+            recovery_methods_to_remove
+        )
+        if len(local_list_common_recovery_methods) > 0:
+            output_content = get_api_output_in_standard_format(
+                message=messages["GENERIC_400"],
+                log=f"invalid recovery_methods: {list(local_list_common_recovery_methods)}, present in both add list and remove list.",
+            )
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=output_content,
+            )
+
+        """
+        main process
+        """
+        # logic for adding new recovery_methods
+        local_list_response_user_recovery_methods = (
+            global_object_square_database_helper.get_rows_v0(
+                database_name=global_string_database_name,
+                schema_name=global_string_schema_name,
+                table_name=UserRecoveryMethod.__tablename__,
+                filters=FiltersV0(
+                    root={
+                        UserRecoveryMethod.user_id.name: FilterConditionsV0(eq=user_id)
+                    }
+                ),
+            )["data"]["main"]
+        )
+        local_list_new_recovery_methods = [
+            {
+                UserRecoveryMethod.user_id.name: user_id,
+                UserRecoveryMethod.user_recovery_method_name.name: x,
+            }
+            for x in recovery_methods_to_add
+            if x
+            not in [
+                y[UserRecoveryMethod.user_recovery_method_name.name]
+                for y in local_list_response_user_recovery_methods
+            ]
+        ]
+        if len(local_list_new_recovery_methods) > 0:
+            global_object_square_database_helper.insert_rows_v0(
+                database_name=global_string_database_name,
+                schema_name=global_string_schema_name,
+                table_name=UserRecoveryMethod.__tablename__,
+                data=local_list_new_recovery_methods,
+            )
+
+        # logic for removing recovery_methods
+        global_object_square_database_helper.delete_rows_v0(
+            database_name=global_string_database_name,
+            schema_name=global_string_schema_name,
+            table_name=UserRecoveryMethod.__tablename__,
+            filters=FiltersV0(
+                root={
+                    UserRecoveryMethod.user_id.name: FilterConditionsV0(eq=user_id),
+                    UserRecoveryMethod.user_recovery_method_name.name: FilterConditionsV0(
+                        in_=recovery_methods_to_remove
+                    ),
+                }
+            ),
+        )
+
+        """
+        return value
+        """
+        # get latest recovery_methods
+        local_list_response_user_recovery_methods = (
+            global_object_square_database_helper.get_rows_v0(
+                database_name=global_string_database_name,
+                schema_name=global_string_schema_name,
+                table_name=UserRecoveryMethod.__tablename__,
+                filters=FiltersV0(
+                    root={
+                        UserRecoveryMethod.user_id.name: FilterConditionsV0(eq=user_id)
+                    }
+                ),
+            )["data"]["main"]
+        )
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_UPDATE_SUCCESSFUL"],
+            data={
+                "main": [
+                    x[UserRecoveryMethod.user_recovery_method_name.name]
+                    for x in local_list_response_user_recovery_methods
+                ]
+            },
+        )
+        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-6.0.5 → square_authentication-6.2.0}/square_authentication.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: square_authentication
-Version: 6.0.5
+Version: 6.2.0
 Summary: authentication layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_authentication
 Author: thePmSquare
@@ -53,6 +53,16 @@ pip install square_authentication
 
 ## changelog
 
+### v6.2.0
+
+- core
+    - add update_user_recovery_methods_v0.
+
+### v6.1.0
+
+- add validation to username in register_username_v0 and update_username_v0.
+- add test cases for register_username_v0.
+
 ### v6.0.5
 
 - env

{square_authentication-6.0.5 → square_authentication-6.2.0}/square_authentication.egg-info/SOURCES.txt

@@ -20,4 +20,5 @@ square_authentication/routes/utility.py
 square_authentication/utils/__init__.py
 square_authentication/utils/encryption.py
 square_authentication/utils/token.py
-tests/test_1.py
+tests/test_1.py
+tests/test_username.py

square_authentication-6.2.0/tests/test_username.py

@@ -0,0 +1,111 @@
+from square_authentication.messages import messages
+
+
+def test_register_username_invalid(create_client_and_cleanup):
+    payload = {
+        "username": "invalid..name",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 400
+    assert "username" in response.json()["log"]
+
+
+def test_username_starts_with_number(create_client_and_cleanup):
+    payload = {
+        "username": "1username",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 400
+    assert "username" in response.json()["log"]
+
+
+def test_username_ends_with_number(create_client_and_cleanup):
+    payload = {
+        "username": "username1",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 400
+    assert "username" in response.json()["log"]
+
+
+def test_username_with_space(create_client_and_cleanup):
+    payload = {
+        "username": "user name",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 400
+    assert "username" in response.json()["log"]
+
+
+def test_username_too_short(create_client_and_cleanup):
+    payload = {
+        "username": "a",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 400
+    assert "username" in response.json()["log"]
+
+
+def test_username_simple_valid(create_client_and_cleanup):
+    payload = {
+        "username": "johnsmith",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 201
+    assert response.json()["message"] == messages["REGISTRATION_SUCCESSFUL"]
+
+
+def test_username_with_uppercase(create_client_and_cleanup):
+    payload = {
+        "username": "User_Name",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 201
+    assert response.json()["message"] == messages["REGISTRATION_SUCCESSFUL"]
+
+
+def test_username_with_digits(create_client_and_cleanup):
+    payload = {
+        "username": "john123smith",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 201
+    assert response.json()["message"] == messages["REGISTRATION_SUCCESSFUL"]
+
+
+def test_username_with_underscore_hyphen(create_client_and_cleanup):
+    payload = {
+        "username": "john_smith-doe",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 201
+    assert response.json()["message"] == messages["REGISTRATION_SUCCESSFUL"]
+
+
+def test_username_max_length(create_client_and_cleanup):
+    payload = {
+        "username": "a1234567890_b-cdefgh",
+        "password": "testpass123",
+        "app_id": 1,
+    }
+    response = create_client_and_cleanup.post("/register_username/v0", json=payload)
+    assert response.status_code == 201
+    assert response.json()["message"] == messages["REGISTRATION_SUCCESSFUL"]