square-authentication 6.2.2__py3-none-any.whl → 8.0.0__py3-none-any.whl

square_authentication/configuration.py

@@ -94,6 +94,43 @@ try:
         ldict_configuration["SQUARE_FILE_STORE_HELPER"]["SQUARE_FILE_STORE_PORT"]
     )
     # ===========================================
+
+    # ===========================================
+    # EMAIL
+
+    MAIL_GUN_API_KEY = ldict_configuration["EMAIL"]["MAIL_GUN_API_KEY"]
+    # ===========================================
+    # ===========================================
+    # GOOGLE
+
+    GOOGLE_AUTH_PLATFORM_CLIENT_ID = ldict_configuration["GOOGLE"][
+        "GOOGLE_AUTH_PLATFORM_CLIENT_ID"
+    ]
+    # ===========================================
+    # ===========================================
+    # GOOGLE
+
+    NUMBER_OF_RECOVERY_CODES = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_RECOVERY_CODES"]
+    )
+    EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = int(
+        ldict_configuration["LOGIC"][
+            "EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS"
+        ]
+    )
+    NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE"]
+    )
+    EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = int(
+        ldict_configuration["LOGIC"][
+            "EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS"
+        ]
+    )
+    NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE"]
+    )
+    # ===========================================
+
     # Initialize logger
     global_object_square_logger = SquareLogger(
         pstr_log_file_name=config_str_log_file_name,

square_authentication/data/config.sample.ini

@@ -51,4 +51,17 @@ SQUARE_DATABASE_PORT = 10010
 
 SQUARE_FILE_STORE_PROTOCOL = http
 SQUARE_FILE_STORE_IP = localhost
-SQUARE_FILE_STORE_PORT = 10100
+SQUARE_FILE_STORE_PORT = 10100
+
+[EMAIL]
+MAIL_GUN_API_KEY = dummy_mailgun_api_key
+
+[GOOGLE]
+GOOGLE_AUTH_PLATFORM_CLIENT_ID = dummy_google_client_id
+
+[LOGIC]
+NUMBER_OF_RECOVERY_CODES = 10
+EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = 6
+EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = 6

square_authentication/data/config.testing.sample.ini

@@ -51,4 +51,17 @@ SQUARE_DATABASE_PORT = 20010
 
 SQUARE_FILE_STORE_PROTOCOL = http
 SQUARE_FILE_STORE_IP = raspi.thepmsquare.com
-SQUARE_FILE_STORE_PORT = 20010
+SQUARE_FILE_STORE_PORT = 20010
+
+[EMAIL]
+MAIL_GUN_API_KEY = dummy_mailgun_api_key
+
+[GOOGLE]
+GOOGLE_AUTH_PLATFORM_CLIENT_ID = dummy_google_client_id
+
+[LOGIC]
+NUMBER_OF_RECOVERY_CODES = 10
+EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = 6
+EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = 6

square_authentication/messages.py

@@ -13,8 +13,20 @@ messages = {
     "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_ACTION_SUCCESSFUL": "the action was completed 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.",
+    "INCORRECT_AUTH_PROVIDER": "you have not linked this authentication provider to your account. please link it first.",
+    "INVALID_EMAIL_FORMAT": "the email address is invalid. please provide a valid email address.",
+    "INVALID_PHONE_NUMBER_FORMAT": "the phone number is invalid. please provide a valid phone number.",
+    "GENERIC_MISSING_REQUIRED_FIELD": "a required field is missing. please check your input and try again.",
+    "RECOVERY_METHOD_NOT_ENABLED": "the recovery method you are trying to use is not enabled for your account.",
+    "INCORRECT_BACKUP_CODE": "the backup code you provided is incorrect or has already been used. please try again with a valid code.",
+    "EMAIL_ALREADY_VERIFIED": "your email address has already been verified.",
+    "INCORRECT_VERIFICATION_CODE": "the verification code you entered is incorrect or has expired. please request a new code.",
+    "EMAIL_NOT_VERIFIED": "your email address has not been verified. please verify your email to continue.",
+    "ACCOUNT_WITH_EMAIL_ALREADY_EXISTS": "an account with this email address already exists.",
+    "MALFORMED_USER": " the user data is malformed or incomplete.",
 }

square_authentication/pydantic_models/core.py

@@ -10,6 +10,12 @@ class RegisterUsernameV0(BaseModel):
     app_id: Optional[int] = None
 
 
+class RegisterLoginGoogleV0(BaseModel):
+    google_id: str
+    app_id: Optional[int] = None
+    assign_app_id_if_missing: bool = False
+
+
 class LoginUsernameV0(BaseModel):
     username: str
     password: str
@@ -24,6 +30,8 @@ class DeleteUserV0(BaseModel):
 class UpdatePasswordV0(BaseModel):
     old_password: str
     new_password: str
+    logout_other_sessions: bool = False
+    preserve_session_refresh_token: Optional[str] = None
 
 
 class TokenType(Enum):
@@ -33,3 +41,23 @@ class TokenType(Enum):
 
 class LogoutAppsV0(BaseModel):
     app_ids: List[int]
+
+
+class ResetPasswordAndLoginUsingBackupCodeV0(BaseModel):
+    backup_code: str
+    username: str
+    new_password: str
+    app_id: int
+    logout_other_sessions: bool = False
+
+
+class SendResetPasswordEmailV0(BaseModel):
+    username: str
+
+
+class ResetPasswordAndLoginUsingResetEmailCodeV0(BaseModel):
+    reset_email_code: str
+    username: str
+    new_password: str
+    app_id: int
+    logout_other_sessions: bool = False

square_authentication/pydantic_models/profile.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class ValidateEmailVerificationCodeV0(BaseModel):
+    verification_code: str