confirm.py file refactored, breaking changes

Author: knownbug06

verify_email/confirm.py

@@ -1,36 +1,88 @@
-from django.utils import timezone
+import logging
+from dataclasses import dataclass
+
 from .token_manager import TokenManager
+from django.utils import timezone
+
+logger = logging.getLogger(__name__)
 
 
-class _UserActivationProcess:
+@dataclass
+class UserActivationProcess:
     """
-    This class is pretty self.explanatory...
+    This class handles the process of activating a user account
+    by verifying a token associated with the user's email.
+
+    Attributes
+    ----------
+    token_manager : TokenManager
+        An instance of TokenManager used to manage token operations.
+
+    Methods
+    -------
+    activate_user(encoded_email: str, encoded_token: str) -> None:
+        Activates the user account after verifying the provided token.
+
     Exceptions Raised
     ------------------
-        - MaxRetriesExceeded    (by) verify_user()
-        - BadSignature          (by) verify_user()
-        - SignatureExpired      (by) verify_user()
-        - ValueError            (by) verify_user()
-        - TypeError             (by) verify_user()
-        - InvalidToken          (by) verify_user()
+    - MaxRetriesExceeded: Raised when the maximum number of retries for verification is exceeded.
+    - BadSignature: Raised when the token signature is invalid.
+    - SignatureExpired: Raised when the token has expired.
+    - ValueError: Raised for invalid values during verification.
+    - TypeError: Raised for incorrect types during verification.
+    - InvalidToken: Raised when the provided token is invalid.
     """
 
-    def __init__(self):
-        self.token_manager = TokenManager()
+    token_manager: TokenManager = TokenManager()
+
+    @classmethod
+    def activate_user(cls, encoded_email: str, encoded_token: str) -> None:
+        """
+        Steps to activate a user account:
+        1. Verify the token.
+        2. Set the user as active.
+        3. Update the last login time.
 
-    @staticmethod
-    def __activate_user(user):
-        user.is_active = True
-        user.last_login = timezone.now()
-        user.save()
+        Parameters
+        ----------
+        encoded_email : str
+            The encoded email address of the user.
+        encoded_token : str
+            The encoded token for user verification.
 
-    def verify_token(self, useremail, usertoken):
-        user = self.token_manager.decrypt_link(useremail, usertoken)
-        if user:
-            self.__activate_user(user)
-            return True
-        return False
+        Raises
+        ------
+        MaxRetriesExceeded
+            If the maximum number of retries for token verification is exceeded.
+        BadSignature
+            If the token signature is invalid.
+        SignatureExpired
+            If the token has expired.
+        ValueError
+            If an invalid value is encountered during verification.
+        TypeError
+            If an incorrect type is provided.
+        InvalidToken
+            If the provided token is invalid.
 
+        Notes
+        -----
+        This method instantiates the class to access its methods. This
+        approach may be revised in the future as part of the class design
+        considerations.
+        """
+        self = cls()  # Consider if instantiation is necessary here
+        try:
+            # Verify token and retrieve user object
+            user = self.token_manager.decrypt_token_and_get_user(
+                encoded_email, encoded_token
+            )
 
-def verify_user(useremail, usertoken):
-    return _UserActivationProcess().verify_token(useremail, usertoken)
+            # Activate the user account
+            user.is_active = True
+            user.last_login = timezone.now()
+            user.save()
+        except Exception as err:
+            logger.exception(err)
+            # Perform any necessary cleanup if required
+            raise