djcheckup 0.2.0__tar.gz → 0.2.2__tar.gz

{djcheckup-0.2.0 → djcheckup-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: djcheckup
-Version: 0.2.0
+Version: 0.2.2
 Summary: DJ Checkup is a security scanner for Django sites.
 Author: Stuart Maxwell
 Author-email: Stuart Maxwell <stuart@amanzi.nz>

{djcheckup-0.2.0 → djcheckup-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "djcheckup"
-version = "0.2.0"
+version = "0.2.2"
 description = "DJ Checkup is a security scanner for Django sites."
 readme = "README.md"
 authors = [{ name = "Stuart Maxwell", email = "stuart@amanzi.nz" }]
@@ -26,5 +26,15 @@ target-version = "py313"
 [tool.ruff.lint]
 select = ["ALL"]
 
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/**" = ["S101", "ANN201", "ANN001", "ARG001"]
+
 [tool.ruff.lint.pydocstyle]
 convention = "google" # Accepts: "google", "numpy", or "pep257".
+
+[dependency-groups]
+dev = ["pytest>=8.4.2"]
+
+[tool.pytest.ini_options]
+pythonpath = "."
+python_files = "test_*.py"

{djcheckup-0.2.0 → djcheckup-0.2.2}/src/djcheckup/checks.py

@@ -4,7 +4,7 @@ from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from enum import Enum
 from http.cookiejar import CookieJar
-from typing import Literal
+from typing import Literal, Self
 
 import httpx
 
@@ -286,23 +286,76 @@ class SchemeCheck(_BaseCheck):
         return response.url.scheme == self.end_scheme
 
 
+def create_context(url: httpx.URL, client: httpx.Client, response: httpx.Response) -> SiteCheckContext:
+    """Create a SiteCheckContext context object.
+
+    Args:
+        url: The URL to check.
+        client: The HTTPX client to use for requests.
+        response: The HTTPX response object from the initial request.
+
+    Returns:
+        A SiteCheckContext object containing the provided parameters.
+    """
+    return SiteCheckContext(
+        url=url,
+        client=client,
+        headers=response.headers,
+        cookies=response.cookies.jar,
+        content=response.text,
+        response_url=response.url,
+    )
+
+
 class SiteChecker:
     """Run all the checks for a given site."""
 
-    def __init__(self, url: str) -> None:
-        """Initialize the SiteChecker with a URL."""
+    def __init__(
+        self,
+        url: str,
+        *,
+        client: httpx.Client | None = None,
+        user_agent: str = "DJCheckupBot/1.0 (+https://pypi.org/project/djcheckup/)",
+        timeout: float = 10.0,
+        follow_redirects: bool = True,
+    ) -> None:
+        """Initialize the SiteChecker with a URL and optional HTTPX client.
+
+        Args:
+            url: The URL to check.
+            client: An optional HTTPX client to use for requests.
+            user_agent: The User-Agent string to use for requests.
+            timeout: The timeout for requests in seconds.
+            follow_redirects: Whether to follow redirects.
+        """
         self.url: httpx.URL = httpx.URL(url)
-        self.user_agent: str = "DJCheckupBot/1.0 (+https://djcheckup.com/bot-info)"
-        self.timeout: float = 10.0
-        self.client: httpx.Client = httpx.Client(
-            headers={"User-Agent": self.user_agent},
-            timeout=self.timeout,
-            follow_redirects=True,
-        )
+        self._client_provided = client is not None
+
+        if client is not None:
+            self.client = client
+        else:
+            self.client = httpx.Client(
+                headers={"User-Agent": user_agent},
+                timeout=timeout,
+                follow_redirects=follow_redirects,
+            )
 
     def close(self) -> None:
-        """Close the HTTP client and release resources."""
-        self.client.close()
+        """Close the HTTP client and release resources.
+
+        Only close the client if it was created by this instance.
+        """
+        if not self._client_provided:
+            self.client.close()
+
+    # Context manager support for automatic cleanup
+    def __enter__(self) -> Self:
+        """Context manager entry."""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:  # noqa: ANN001
+        """Context manager exit."""
+        self.close()
 
     def run_first_check(self) -> CheckResponse:
         """Run the first check.
@@ -327,14 +380,7 @@ class SiteChecker:
                 message=error_message,
             )
 
-        self.context = SiteCheckContext(
-            url=self.url,
-            client=self.client,
-            headers=response.headers,
-            cookies=response.cookies.jar,
-            content=response.text,
-            response_url=response.url,
-        )
+        self.context = create_context(self.url, self.client, response)
 
         return CheckResponse(
             name=check_name,
@@ -360,6 +406,4 @@ class SiteChecker:
             site_check_results.check_results.append(result)
             previous_results[check.check_id] = result
 
-        # Close the HTTP client
-        self.client.close()
         return site_check_results

{djcheckup-0.2.0 → djcheckup-0.2.2}/src/djcheckup/run.py

@@ -15,8 +15,8 @@ def run_checks(url: str, output_format: Literal["json"]) -> str: ...
 
 def run_checks(url: str, output_format: Literal["object", "json"] = "object") -> str | SiteCheckResult:
     """Run the DJ Checkup tool against a specific URL and returns a JSON string."""
-    checker = SiteChecker(url)
-    results = checker.run_checks(all_checks)
+    with SiteChecker(url) as checker:
+        results = checker.run_checks(all_checks)
 
     if output_format not in {"object", "json"}:
         msg = f"Invalid output_format: {output_format!r}. Must be 'object' or 'json'."