style: fixes stricter ruff linter issues (#110)

Author: ctran88

.devcontainer/devcontainer.json

@@ -14,8 +14,15 @@
 				"tamasfe.even-better-toml",
 				"-ms-python.autopep8",
 				"-dbaeumer.vscode-eslint"
-			]
+			],
+			"settings": {
+				"linter.linters": {
+					"pylint": {
+						"enabled": false
+					}
+				}
+			}
 		}
 	},
-	"postCreateCommand": "pip install pytest python-dotenv build ruff"
+	"postCreateCommand": "pip install --upgrade pip && pip install -e .[dev]"
 }

.github/workflows/on-pull-request.yml

@@ -38,8 +38,6 @@ jobs:
         with:
           python-version: "3.8"
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest python-dotenv
+        run: pip install -e .[dev]
       - name: Test
-        run: python setup.py pytest
+        run: pytest

passageidentity/__init__.py

@@ -1,5 +1,7 @@
-from .passage import Passage
+"""Initializes the Passage identity package."""
+
 from .errors import PassageError
+from .passage import Passage
 
 __all__ = [
     "Passage",

passageidentity/errors.py

@@ -1,16 +1,19 @@
-"""
-Error class for Passage errors
-"""
+"""Defines custom error classes for handling Passage-related errors."""
+
+from __future__ import annotations
 
 
 class PassageError(Exception):
+    """Error class for handling Passage errors."""
+
     def __init__(
         self,
-        message,
-        status_code: int = None,
-        status_text: str = None,
-        body: dict = None,
-    ):
+        message: str,
+        status_code: int | None = None,
+        status_text: str | None = None,
+        body: dict | None = None,
+    ) -> None:
+        """Initialize the error with a message, status code, status text, and optional body."""
         self.message = message
         self.status_code = status_code
         self.status_text = status_text

passageidentity/helper.py

@@ -1,67 +1,58 @@
+"""Provides helper functions for interacting with the Passage Identity API."""
+
 import re
+from http import HTTPStatus
+
+from requests.sessions import Request
 
 from passageidentity import requests
 from passageidentity.errors import PassageError
 
-TOKEN_TYPE = "Bearer"
+BEARER_PATTERN = r"Bearer ([^\s,]+)"
 BASE_URL = "https://api.passage.id/v1/apps/"
 
-"""
-Helper function to extract the JWT from an Authorization header. 
-"""
 
+def extract_token(auth_header: str) -> str:
+    """Extract the JWT from an Authorization header."""
+    expression = re.escape(BEARER_PATTERN)
+    match = re.search(expression, auth_header)
 
-def extractToken(authHeader):
-    expression = re.escape(TOKEN_TYPE) + r" ([^\s,]+)"
-    match = re.search(expression, authHeader)
-    try:
+    if match:
         return match.group(1)
-    except (AttributeError, IndexError):
-        raise PassageError("No Passage authorization header.")
 
+    msg = "No Passage authorization header."
+    raise PassageError(msg)
 
-"""
-Helper funtion to get the auth token from a request.
-Checks the Authorization header first, then the psg_auth_token cookie
-"""
 
+def get_auth_token_from_request(request: Request, auth_strategy: int) -> str:
+    """Get the auth token from a request.
 
-def getAuthTokenFromRequest(request, auth_strategy):
-    if auth_strategy == 2:
-        authHeader = request.headers["Authorization"]
-        expression = re.escape(TOKEN_TYPE) + r" ([^\s,]+)"
-        match = re.search(expression, authHeader)
-        try:
+    Checks the Authorization header first, then the psg_auth_token cookie.
+    """
+    if auth_strategy == 2:  # noqa: PLR2004
+        auth_header = request.headers["Authorization"]
+        expression = re.escape(BEARER_PATTERN)
+        match = re.search(expression, auth_header)
+
+        if match:
             return match.group(1)
-        except (AttributeError, IndexError):
-            raise PassageError("No Passage authorization header.")
-    else:
-        try:
-            cookies = request.COOKIES
-            if "psg_auth_token" not in cookies.keys():
-                raise PassageError("No Passage authentication token.")
-            return cookies["psg_auth_token"]
-        except Exception:
-            try:
-                cookies = request.cookies
-                if "psg_auth_token" not in cookies.keys():
-                    raise PassageError("No Passage authentication token.")
-                return cookies["psg_auth_token"]
-            except Exception:
-                raise PassageError("No passage authentication token")
-
-
-"""
-Helper function to fetch the public key for the given app id from Passage
-"""
-
-
-def fetchApp(app_id):
+
+        msg = "No Passage authorization header."
+        raise PassageError(msg)
+
+    if "psg_auth_token" not in request.cookies:
+        msg = "No Passage authentication token."
+        raise PassageError(msg)
+
+    return request.cookies["psg_auth_token"]
+
+
+def fetch_app(app_id: str) -> dict:
+    """Fetch the public key for the given app id from Passage."""
     # unauthenticated request to get the public key
     r = requests.get(BASE_URL + app_id)
 
-    # check response code
-    if r.status_code != 200:
+    if r.status_code != HTTPStatus.OK:
         raise PassageError("Could not fetch app information for app id " + app_id)
 
     return r.json()["app"]

passageidentity/models/update_magic_link_auth_method.py

@@ -92,4 +92,4 @@ def from_dict(cls, obj: Dict) -> Self:
                 "ttl_display_unit": obj.get("ttl_display_unit"),
             }
         )
-        return _obj
+        return _obj

passageidentity/models/update_otp_auth_method.py

@@ -92,4 +92,4 @@ def from_dict(cls, obj: Dict) -> Self:
                 "ttl_display_unit": obj.get("ttl_display_unit"),
             }
         )
-        return _obj
+        return _obj

passageidentity/models/update_passkey_auth_method.py

@@ -81,4 +81,4 @@ def from_dict(cls, obj: Dict) -> Self:
         _obj = cls.model_validate(
             {"enabled": obj.get("enabled") if obj.get("enabled") is not None else True}
         )
-        return _obj
+        return _obj