Refactor configuration and utility structure (#33)

Vianpyro · web-flow · commit b0c3de21e766 · 2025-04-03T11:01:10.000-04:00
* Refactor configuration and utility structure

* Disable validation for the entire codebase in super-linter configuration

* Refactor utility imports to improve module organization

* Refactor import statement for database cursor to improve module clarity
diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml
@@ -29,7 +29,7 @@ jobs:
         uses: super-linter/super-linter@v7
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          VALIDATE_ALL_CODEBASE: true
+          VALIDATE_ALL_CODEBASE: false
           VALIDATE_JSON_PRETTIER: false
           VALIDATE_PYTHON_ISORT: false
           VALIDATE_PYTHON_PYLINT: false
diff --git a/app.py b/app.py
@@ -4,9 +4,9 @@
 from flask import Flask, jsonify, request
 from flask_cors import CORS
 
-from config import Config, limiter
+from config.settings import Config, limiter
 from routes import register_routes
-from utility import extract_error_message
+from utility.database import extract_error_message
 
 app = Flask(__name__)
 app.config.from_object(Config)
diff --git a/config/__init__.py b/config/__init__.py
diff --git a/config/database.py b/config/database.py
diff --git a/config/settings.py b/config/settings.py
diff --git a/routes/authentication.py b/routes/authentication.py
@@ -2,23 +2,17 @@
 from flask import Blueprint, jsonify, request
 from pymysql import MySQLError
 
-from config import limiter
+from config.settings import limiter
 from jwt_helper import (
     TokenError,
     extract_token_from_header,
     generate_access_token,
     generate_refresh_token,
     verify_token,
 )
-from utility import (
-    database_cursor,
-    encrypt_email,
-    hash_email,
-    hash_password,
-    validate_email,
-    validate_password,
-    verify_password,
-)
+from utility.database import database_cursor
+from utility.encryption import encrypt_email, hash_email, hash_password, verify_password
+from utility.validation import validate_email, validate_password
 
 authentication_blueprint = Blueprint("authentication", __name__)
 
diff --git a/routes/comment.py b/routes/comment.py
@@ -1,6 +1,6 @@
 from flask import Blueprint, jsonify
 
-from utility import database_cursor
+from utility.database import database_cursor
 
 comment_blueprint = Blueprint("comment", __name__)
 
diff --git a/routes/ingredient.py b/routes/ingredient.py
@@ -1,6 +1,6 @@
 from flask import Blueprint, jsonify
 
-from utility import database_cursor
+from utility.database import database_cursor
 
 ingredient_blueprint = Blueprint("ingredient", __name__)
 
diff --git a/routes/language.py b/routes/language.py
@@ -1,6 +1,6 @@
 from flask import Blueprint, jsonify
 
-from utility import database_cursor
+from utility.database import database_cursor
 
 language_blueprint = Blueprint("language", __name__)
 
diff --git a/routes/person.py b/routes/person.py
@@ -1,16 +1,16 @@
 from argon2 import exceptions
 from flask import Blueprint, jsonify, request
 
-from utility import (
-    database_cursor,
+from utility.database import database_cursor
+from utility.encryption import (
     decrypt_email,
     encrypt_email,
     hash_email,
     hash_password,
     mask_email,
-    validate_password,
     verify_password,
 )
+from utility.validation import validate_password
 
 person_blueprint = Blueprint("person", __name__)
 
diff --git a/routes/picture.py b/routes/picture.py
@@ -2,9 +2,9 @@
 
 from flask import Blueprint, jsonify, request, send_from_directory
 
-from config import Config
+from config.settings import Config
 from jwt_helper import token_required
-from utility import database_cursor
+from utility.database import database_cursor
 
 picture_blueprint = Blueprint("picture", __name__)
 
diff --git a/routes/recipe.py b/routes/recipe.py
@@ -1,7 +1,7 @@
 from flask import Blueprint, jsonify, request
 
-from config import DEFAULT_PAGE_SIZE
-from utility import database_cursor
+from config.settings import DEFAULT_PAGE_SIZE
+from utility.database import database_cursor
 
 recipe_blueprint = Blueprint("recipe", __name__)
 
diff --git a/routes/recipe_engagement.py b/routes/recipe_engagement.py
@@ -1,6 +1,6 @@
 from flask import Blueprint, jsonify, request
 
-from utility import database_cursor
+from utility.database import database_cursor
 
 recipe_engagement_blueprint = Blueprint("recipe_engagement", __name__)
 
diff --git a/tests/test_utility/encryption/test_email/__init__.py b/tests/test_utility/encryption/test_email/__init__.py
diff --git a/tests/test_utility/encryption/test_email/conftest.py b/tests/test_utility/encryption/test_email/conftest.py
diff --git a/tests/test_utility/encryption/test_email/test_decrypt_email.py b/tests/test_utility/encryption/test_email/test_decrypt_email.py
@@ -1,4 +1,4 @@
-from utility import decrypt_email, encrypt_email
+from utility.encryption import decrypt_email, encrypt_email
 
 
 def test_decrypt_email_type(sample_email):
diff --git a/tests/test_utility/encryption/test_email/test_encrypt_email.py b/tests/test_utility/encryption/test_email/test_encrypt_email.py
@@ -1,4 +1,4 @@
-from utility import encrypt_email
+from utility.encryption import encrypt_email
 
 
 def test_encrypt_email(sample_email):
diff --git a/tests/test_utility/encryption/test_email/test_hash_email.py b/tests/test_utility/encryption/test_email/test_hash_email.py
@@ -1,4 +1,4 @@
-from utility import hash_email
+from utility.encryption import hash_email
 
 
 def test_hash_email_type(sample_email):
diff --git a/tests/test_utility/encryption/test_email/test_mask_email.py b/tests/test_utility/encryption/test_email/test_mask_email.py
@@ -1,6 +1,6 @@
 import pytest
 
-from utility import mask_email
+from utility.encryption import mask_email
 
 
 @pytest.mark.parametrize(
diff --git a/tests/test_utility/encryption/test_password/__init__.py b/tests/test_utility/encryption/test_password/__init__.py
diff --git a/tests/test_utility/encryption/test_password/conftest.py b/tests/test_utility/encryption/test_password/conftest.py
diff --git a/tests/test_utility/encryption/test_password/test_hash_password.py b/tests/test_utility/encryption/test_password/test_hash_password.py
@@ -1,6 +1,6 @@
 from argon2 import PasswordHasher
 
-from utility import hash_password
+from utility.encryption import hash_password
 
 ph = PasswordHasher()
 
diff --git a/tests/test_utility/encryption/test_password/test_verify_password.py b/tests/test_utility/encryption/test_password/test_verify_password.py
@@ -2,7 +2,7 @@
 from argon2 import PasswordHasher
 from argon2.exceptions import VerificationError, VerifyMismatchError
 
-from utility import hash_password, verify_password
+from utility.encryption import hash_password, verify_password
 
 ph = PasswordHasher()
 
diff --git a/tests/test_utility/validation/test_validate_email.py b/tests/test_utility/validation/test_validate_email.py
@@ -1,4 +1,4 @@
-from utility import validate_email
+from utility.validation import validate_email
 
 
 def test_valid_emails():
diff --git a/tests/test_utility/validation/test_validate_password.py b/tests/test_utility/validation/test_validate_password.py
@@ -1,6 +1,6 @@
 from argon2 import PasswordHasher
 
-from utility import validate_password
+from utility.validation import validate_password
 
 ph = PasswordHasher()
 
diff --git a/utility/__init__.py b/utility/__init__.py
diff --git a/utility/database.py b/utility/database.py
@@ -0,0 +1,29 @@
+from contextlib import contextmanager
+
+from config.database import get_db_connection
+
+__all__ = ["database_cursor", "extract_error_message"]
+
+
+@contextmanager
+def database_cursor():
+    db = get_db_connection()
+    cursor = db.cursor()
+    try:
+        yield cursor
+        db.commit()
+    except Exception as e:
+        db.rollback()
+        raise e
+    finally:
+        cursor.close()
+        db.close()
+
+
+def extract_error_message(message):
+    """Extracts a user-friendly error message from a database error message."""
+    try:
+        cleaner_message = message.split(", ")[1].strip("()'")
+        return cleaner_message if "SQL" not in cleaner_message else "Database error"
+    except IndexError:
+        return "An unknown error occurred"
diff --git a/utility/encryption.py b/utility/encryption.py
@@ -2,37 +2,27 @@
 import hashlib
 import os
 import re
-from contextlib import contextmanager
-from re import match
 
 from argon2 import PasswordHasher
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from dotenv import load_dotenv
 
-from db import get_db_connection
+__all__ = [
+    "decrypt_email",
+    "encrypt_email",
+    "hash_email",
+    "hash_password",
+    "mask_email",
+    "verify_password",
+]
 
 load_dotenv()
 ph = PasswordHasher()
 AES_KEY = bytes.fromhex(os.getenv("AES_SECRET_KEY", os.urandom(32).hex()))
 PEPPER = os.getenv("PEPPER", "SuperSecretPepper").encode("utf-8")
 
 
-@contextmanager
-def database_cursor():
-    db = get_db_connection()
-    cursor = db.cursor()
-    try:
-        yield cursor
-        db.commit()
-    except Exception as e:
-        db.rollback()
-        raise e
-    finally:
-        cursor.close()
-        db.close()
-
-
 def decrypt_email(encrypted_email: str) -> str:
     """Decrypts an AES-256 encrypted email."""
     encrypted_data = base64.b64decode(encrypted_email)
@@ -59,15 +49,6 @@ def encrypt_email(email: str) -> str:
     return base64.b64encode(iv + ciphertext).decode()
 
 
-def extract_error_message(message):
-    """Extracts a user-friendly error message from a database error message."""
-    try:
-        cleaner_message = message.split(", ")[1].strip("()'")
-        return cleaner_message if "SQL" not in cleaner_message else "Database error"
-    except IndexError:
-        return "An unknown error occurred"
-
-
 def hash_email(email: str) -> str:
     """Generate a SHA-256 hash of the email (used for fast lookup)."""
     return hashlib.sha256(email.encode()).hexdigest()
@@ -97,25 +78,6 @@ def mask_part(part: str) -> str:
     return masked_local + "@" + masked_domain
 
 
-def validate_email(email: str) -> bool:
-    """Validates an email address using a regex pattern."""
-    pattern = r"^[a-zA-Z0-9._+-]+@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$"
-    return bool(re.match(pattern, email))
-
-
-def validate_password(password) -> bool:
-    """
-    Validates a password based on the following criteria:
-    - At least 12 characters long.
-    - Contains at least one uppercase letter (A-Z).
-    - Contains at least one lowercase letter (a-z).
-    - Contains at least one digit (0-9).
-    - Contains at least one special character (any non-alphanumeric character).
-    """
-    pattern = r"^(?=.*[A-Z])(?=.*[a-z])(?=.*\d)(?=.*[^A-Za-z0-9]).{12,}$"
-    return bool(match(pattern, password))
-
-
 def verify_password(password, stored_password):
     peppered_password = password.encode("utf-8") + PEPPER
     return ph.verify(stored_password, peppered_password)
diff --git a/utility/validation.py b/utility/validation.py
@@ -0,0 +1,22 @@
+from re import match
+
+__all__ = ["validate_email", "validate_password"]
+
+
+def validate_email(email: str) -> bool:
+    """Validates an email address using a regex pattern."""
+    pattern = r"^[a-zA-Z0-9._+-]+@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$"
+    return bool(match(pattern, email))
+
+
+def validate_password(password) -> bool:
+    """
+    Validates a password based on the following criteria:
+    - At least 12 characters long.
+    - Contains at least one uppercase letter (A-Z).
+    - Contains at least one lowercase letter (a-z).
+    - Contains at least one digit (0-9).
+    - Contains at least one special character (any non-alphanumeric character).
+    """
+    pattern = r"^(?=.*[A-Z])(?=.*[a-z])(?=.*\d)(?=.*[^A-Za-z0-9]).{12,}$"
+    return bool(match(pattern, password))
