specforge-api 0.1.4__tar.gz → 0.1.6__tar.gz

{specforge_api-0.1.4 → specforge_api-0.1.6}/.gitignore

@@ -38,3 +38,11 @@ pnpm-debug.log*
 *.swo
 .DS_Store
 Thumbs.db
+
+# Environment & Secrets (SEC-008)
+.env
+.env.*
+*.env
+*.key
+*.pem
+secrets/

{specforge_api-0.1.4 → specforge_api-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: specforge-api
-Version: 0.1.4
+Version: 0.1.6
 Summary: The interactive API client and automated contract testing engine for Python.
 Project-URL: Homepage, https://github.com/specforge-api/specforge
 Project-URL: Documentation, https://specforge-api.github.io/specforge/
@@ -47,7 +47,7 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pyyaml>=6.0
 Provides-Extra: all
 Requires-Dist: fastapi>=0.100.0; extra == 'all'
-Requires-Dist: flask>=2.0.0; extra == 'all'
+Requires-Dist: flask>=2.3.0; extra == 'all'
 Requires-Dist: rich>=13.0.0; extra == 'all'
 Requires-Dist: typer>=0.9.0; extra == 'all'
 Provides-Extra: cli
@@ -66,7 +66,7 @@ Requires-Dist: pymdown-extensions>=10.7; extra == 'docs'
 Provides-Extra: fastapi
 Requires-Dist: fastapi>=0.100.0; extra == 'fastapi'
 Provides-Extra: flask
-Requires-Dist: flask>=2.0.0; extra == 'flask'
+Requires-Dist: flask>=2.3.0; extra == 'flask'
 Description-Content-Type: text/markdown
 
 # SpecForge ⚡

{specforge_api-0.1.4 → specforge_api-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "specforge-api"
-version = "0.1.4"
+version = "0.1.6"
 description = "The interactive API client and automated contract testing engine for Python."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -43,11 +43,11 @@ dependencies = [
 
 [project.optional-dependencies]
 fastapi = ["fastapi>=0.100.0"]
-flask = ["flask>=2.0.0"]
+flask = ["flask>=2.3.0"]
 cli = ["typer>=0.9.0", "rich>=13.0.0"]
 all = [
     "fastapi>=0.100.0",
-    "flask>=2.0.0",
+    "flask>=2.3.0",
     "typer>=0.9.0",
     "rich>=13.0.0"
 ]

{specforge_api-0.1.4 → specforge_api-0.1.6}/src/specforge/__init__.py

@@ -5,7 +5,7 @@ from specforge.parser.openapi3 import OpenAPIParser
 from specforge.testing.exporters.pytest_export import PytestExporter
 from specforge.testing.planner import TestPlanner
 
-__version__ = "0.1.4"
+__version__ = "0.1.6"
 
 # Conditionally import FastAPI adapter if available
 try:

specforge_api-0.1.6/src/specforge/adapters/fastapi.py

@@ -0,0 +1,148 @@
+"""FastAPI adapter for SpecForge interactive documentation and contract testing."""
+
+from collections.abc import Sequence
+from typing import Any, Optional
+
+try:
+    from fastapi import FastAPI, Request, Response  # type: ignore
+    from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse  # type: ignore
+except ImportError:
+    FastAPI = None  # type: ignore
+
+from specforge.config import SpecForgeConfig
+from specforge.parser.openapi3 import OpenAPIParser
+from specforge.testing.exporters.pytest_export import PytestExporter
+from specforge.testing.planner import TestPlanner
+from specforge.utils.html_injector import render_html
+
+_SECURITY_HEADERS = {
+    "X-Content-Type-Options": "nosniff",
+    "X-Frame-Options": "SAMEORIGIN",
+    "Referrer-Policy": "no-referrer",
+}
+
+
+class SpecForge:
+    """Mounts the SpecForge interactive client and boundary test suite onto a FastAPI application."""
+
+    def __init__(
+        self,
+        app: Any,
+        path: str = "/docs",
+        title: str = "SpecForge API Studio",
+        spec_url: Optional[str] = None,
+        theme: str = "dark",
+        enable_tests: bool = True,
+        disable_default_docs: bool = True,
+        enable_api_endpoints: bool = True,
+        dependencies: Optional[Sequence[Any]] = None,
+        api_dependencies: Optional[Sequence[Any]] = None,
+        **kwargs: Any,
+    ):
+        if FastAPI is None:
+            raise ImportError(
+                "FastAPI is not installed. Install it with `pip install specforge[fastapi]`."
+            )
+
+        self.app = app
+        self.path = path
+        self.spec_url = spec_url or getattr(app, "openapi_url", "/openapi.json")
+        self.dependencies = list(dependencies) if dependencies else []
+        self.api_dependencies = list(api_dependencies) if api_dependencies is not None else self.dependencies
+
+        self.config = SpecForgeConfig(
+            title=title,
+            path=path,
+            spec_url=self.spec_url,
+            theme=theme,  # type: ignore
+            enable_tests=enable_tests,
+            enable_api_endpoints=enable_api_endpoints,
+            **kwargs,
+        )
+
+        if disable_default_docs:
+            self._remove_conflicting_docs_routes()
+
+        self._register_routes()
+
+    def _remove_conflicting_docs_routes(self) -> None:
+        """Remove FastAPI's pre-registered docs routes that conflict with SpecForge."""
+        default_docs_url = getattr(self.app, "docs_url", None)
+        if default_docs_url:
+            self.app.docs_url = None
+        if getattr(self.app, "redoc_url", None) == self.path:
+            self.app.redoc_url = None
+
+        router = getattr(self.app, "router", None)
+        if router is not None and hasattr(router, "routes"):
+            router.routes = [
+                route
+                for route in router.routes
+                if not (
+                    "GET" in (getattr(route, "methods", None) or set())
+                    and (
+                        getattr(route, "path", None) == self.path
+                        or (
+                            default_docs_url is not None
+                            and getattr(route, "path", None) == default_docs_url
+                            and getattr(route, "name", None) in ("swagger_ui_html", "swagger_ui_redirect")
+                        )
+                    )
+                )
+            ]
+
+    def _register_routes(self) -> None:
+        """Register the documentation UI and test plan endpoints on the FastAPI app."""
+
+        @self.app.get(
+            self.path,
+            response_class=HTMLResponse,
+            include_in_schema=False,
+            dependencies=self.dependencies,
+        )
+        async def specforge_docs_endpoint(request: Request) -> Response:
+            html = render_html(self.config)
+            return HTMLResponse(content=html, headers=_SECURITY_HEADERS)
+
+        if self.config.enable_api_endpoints:
+            @self.app.get(
+                "/specforge/api/plan",
+                response_class=JSONResponse,
+                include_in_schema=False,
+                dependencies=self.api_dependencies,
+            )
+            async def specforge_test_plan_endpoint(request: Request) -> Response:
+                # Generate or retrieve active OpenAPI specification
+                raw_spec: dict[str, Any] = self.app.openapi()
+                parser = OpenAPIParser(raw_spec)
+                spec_model = parser.parse()
+
+                plans = []
+                for op in spec_model.operations:
+                    plan = TestPlanner.plan_operation_tests(op)
+                    plans.append(plan.to_dict())
+
+                return JSONResponse(content={"plans": plans})
+
+            @self.app.get(
+                "/specforge/api/export-pytest",
+                response_class=PlainTextResponse,
+                include_in_schema=False,
+                dependencies=self.api_dependencies,
+            )
+            async def specforge_export_pytest_endpoint(request: Request) -> Response:
+                raw_spec: dict[str, Any] = self.app.openapi()
+                parser = OpenAPIParser(raw_spec)
+                spec_model = parser.parse()
+
+                all_test_cases = []
+                for op in spec_model.operations:
+                    plan = TestPlanner.plan_operation_tests(op)
+                    all_test_cases.extend(plan.test_cases)
+
+                base_url = str(request.base_url).rstrip("/")
+                code = PytestExporter.export(all_test_cases, base_url=base_url)
+                return PlainTextResponse(
+                    content=code,
+                    headers={"Content-Disposition": 'attachment; filename="test_api_contracts.py"'},
+                )

{specforge_api-0.1.4 → specforge_api-0.1.6}/src/specforge/adapters/flask.py

@@ -3,7 +3,7 @@
 from typing import Any, Optional
 
 try:
-    from flask import (
+    from flask import (  # type: ignore
         Blueprint,
         Flask,
         Response,
@@ -17,6 +17,12 @@ from specforge.parser.openapi3 import OpenAPIParser
 from specforge.testing.planner import TestPlanner
 from specforge.utils.html_injector import render_html
 
+_SECURITY_HEADERS = {
+    "X-Content-Type-Options": "nosniff",
+    "X-Frame-Options": "SAMEORIGIN",
+    "Referrer-Policy": "no-referrer",
+}
+
 
 class SpecForge:
     """Mounts the SpecForge interactive client and boundary test suite onto a Flask application."""
@@ -29,6 +35,7 @@ class SpecForge:
         title: str = "SpecForge API Studio",
         theme: str = "dark",
         enable_tests: bool = True,
+        enable_api_endpoints: bool = True,
         spec_dict: Optional[dict[str, Any]] = None,
         **kwargs: Any,
     ):
@@ -46,6 +53,7 @@ class SpecForge:
             spec_url=spec_url,
             theme=theme,  # type: ignore
             enable_tests=enable_tests,
+            enable_api_endpoints=enable_api_endpoints,
             **kwargs,
         )
 
@@ -58,21 +66,22 @@ class SpecForge:
         @bp.route(self.path, methods=["GET"])
         def specforge_docs() -> Any:
             html = render_html(self.config, self.spec_dict)
-            return Response(html, mimetype="text/html")
+            return Response(html, mimetype="text/html", headers=_SECURITY_HEADERS)
 
-        @bp.route("/specforge/api/plan", methods=["GET"])
-        def specforge_plan() -> Any:
-            if not self.spec_dict:
-                return jsonify({"error": "SpecForge Flask adapter requires spec_dict for test planning."}), 400
+        if self.config.enable_api_endpoints:
+            @bp.route("/specforge/api/plan", methods=["GET"])
+            def specforge_plan() -> Any:
+                if not self.spec_dict:
+                    return jsonify({"error": "SpecForge Flask adapter requires spec_dict for test planning."}), 400
 
-            parser = OpenAPIParser(self.spec_dict)
-            spec_model = parser.parse()
+                parser = OpenAPIParser(self.spec_dict)
+                spec_model = parser.parse()
 
-            plans = []
-            for op in spec_model.operations:
-                plan = TestPlanner.plan_operation_tests(op)
-                plans.append(plan.to_dict())
+                plans = []
+                for op in spec_model.operations:
+                    plan = TestPlanner.plan_operation_tests(op)
+                    plans.append(plan.to_dict())
 
-            return jsonify({"plans": plans})
+                return jsonify({"plans": plans})
 
         self.app.register_blueprint(bp)