feat(openapi-transformer): prepare for production use (#33)

Polish the package and prepare for production ready state.

Author: char0n

packages/jentic-openapi-parser/src/jentic/apitools/openapi/parser/core/uri.py

@@ -1,4 +1,3 @@
-# uri_resolution.py
 from __future__ import annotations
 
 import logging

packages/jentic-openapi-transformer-redocly/README.md

@@ -1,6 +1,6 @@
 # jentic-openapi-transformer-redocly
 
-A Python library that provides OpenAPI document bundling functionality using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and implements the transformer strategy pattern for bundling OpenAPI documents by resolving external references.
+A Python library that provides OpenAPI document bundling functionality using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and implements the transformer backend pattern for bundling OpenAPI documents by resolving external references.
 
 ## Features
 
@@ -32,10 +32,10 @@ npm install -g @redocly/cli
 ### Basic Usage
 
 ```python
-from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
 
 # Create a bundler instance
-bundler = RedoclyBundler()
+bundler = RedoclyBundlerBackend()
 
 # Bundle an OpenAPI document from a file path
 result = bundler.bundle("/path/to/your/openapi.yaml")
@@ -66,7 +66,7 @@ parsed_result = json.loads(result)
 
 ```python
 # Custom Redocly CLI path and timeout
-bundler = RedoclyBundler(
+bundler = RedoclyBundlerBackend(
     redocly_path="redocly",  # Use global redocly installation
     timeout=60.0  # 60 second timeout
 )
@@ -81,10 +81,10 @@ result = bundler.bundle("https://petstore3.swagger.io/api/v3/openapi.json")
 The bundler provides detailed error reporting for various failure scenarios:
 
 ```python
-from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
 from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
 
-bundler = RedoclyBundler()
+bundler = RedoclyBundlerBackend()
 
 try:
     result = bundler.bundle("/path/to/openapi.yaml")
@@ -120,7 +120,7 @@ uv run --package jentic-openapi-transformer-redocly pytest packages/jentic-opena
 ### RedoclyBundler
 
 ```python
-class RedoclyBundler(BaseBundlerStrategy):
+class RedoclyBundlerBackend(BaseBundlerBackend):
     def __init__(
         self,
         redocly_path: str = "npx @redocly/cli@^2.1.5",

packages/jentic-openapi-transformer-redocly/pyproject.toml

@@ -26,7 +26,7 @@ package = true
 
 [tool.uv.build-backend]
 namespace = true
-module-name = "jentic.apitools.openapi.transformer.redocly"
+module-name = "jentic.apitools.openapi.transformer.bundler.backends"
 module-root = "src/"
 
 [tool.uv.sources]
@@ -37,7 +37,7 @@ jentic-openapi-transformer = { workspace = true }
 requires = ["uv_build>=0.8.15,<0.9.0"]
 build-backend = "uv_build"
 
-[project.entry-points."jentic.apitools.openapi.transformer.strategies"]
-redocly = "jentic.apitools.openapi.transformer.redocly:RedoclyBundler"
+[project.entry-points."jentic.apitools.openapi.transformer.bundler.backends"]
+redocly = "jentic.apitools.openapi.transformer.bundler.backends.redocly:RedoclyBundlerBackend"
 
 

…/openapi/transformer/redocly/__init__.py …mer/bundler/backends/redocly/__init__.pypackages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/redocly/__init__.py renamed to packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/bundler/backends/redocly/__init__.py packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/redocly/__init__.py renamed to packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/bundler/backends/redocly/__init__.py

@@ -4,14 +4,14 @@
 from urllib.parse import urlparse
 from urllib.request import url2pathname
 
-from jentic.apitools.openapi.transformer.strategies.base import BaseBundlerStrategy
+from jentic.apitools.openapi.transformer.bundler.backends.base import BaseBundlerBackend
 from jentic.apitools.openapi.common.subproc import run_subprocess
 
 
-__all__ = ["RedoclyBundler"]
+__all__ = ["RedoclyBundlerBackend"]
 
 
-class RedoclyBundler(BaseBundlerStrategy):
+class RedoclyBundlerBackend(BaseBundlerBackend):
     def __init__(self, redocly_path: str = "npx @redocly/cli@^2.1.5", timeout: float = 30.0):
         """
         Initialize the RedoclyBundler.
@@ -33,7 +33,7 @@ def accepts(self) -> list[str]:
         """
         return ["uri", "dict"]
 
-    def bundle(self, document: str | dict, base_url: str | None = None) -> str:
+    def bundle(self, document: str | dict, *, base_url: str | None = None) -> str:
         """
         Bundle an OpenAPI document using Redocly CLI.
 

…ols/openapi/transformer/redocly/py.typed …former/bundler/backends/redocly/py.typedpackages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/redocly/py.typed renamed to packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/bundler/backends/redocly/py.typed packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/redocly/py.typed renamed to packages/jentic-openapi-transformer-redocly/src/jentic/apitools/openapi/transformer/bundler/backends/redocly/py.typed

@@ -5,7 +5,7 @@
 
 import pytest
 
-from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
 
 
 @pytest.fixture
@@ -27,21 +27,21 @@ def snapshots_dir(fixtures_dir: Path) -> Path:
 
 
 @pytest.fixture
-def redocly_bundler() -> RedoclyBundler:
+def redocly_bundler() -> RedoclyBundlerBackend:
     """Return a default RedoclyBundler instance."""
-    return RedoclyBundler()
+    return RedoclyBundlerBackend()
 
 
 @pytest.fixture
-def redocly_bundler_with_custom_timeout() -> RedoclyBundler:
+def redocly_bundler_with_custom_timeout() -> RedoclyBundlerBackend:
     """Return a RedoclyBundler instance with custom timeout."""
-    return RedoclyBundler(timeout=60.0)
+    return RedoclyBundlerBackend(timeout=60.0)
 
 
 @pytest.fixture
-def redocly_bundler_with_custom_path() -> RedoclyBundler:
+def redocly_bundler_with_custom_path() -> RedoclyBundlerBackend:
     """Return a RedoclyBundler instance with custom redocly path."""
-    return RedoclyBundler(redocly_path="/custom/path/to/redocly")
+    return RedoclyBundlerBackend(redocly_path="/custom/path/to/redocly")
 
 
 @pytest.fixture

packages/jentic-openapi-transformer-redocly/tests/conftest.py

@@ -1,8 +1,8 @@
-"""Tests for RedoclyBundler functionality."""
+"""Tests for RedoclyBundlerBackend functionality."""
 
 import pytest
 
-from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
 from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
 
 
@@ -12,7 +12,7 @@ class TestRedoclyBundlerIntegration:
     @pytest.mark.requires_redocly_cli
     def test_bundle_valid_openapi_document(
         self,
-        redocly_bundler: RedoclyBundler,
+        redocly_bundler: RedoclyBundlerBackend,
         valid_openapi_uri: str,
         expected_bundled_content: str,
     ):
@@ -23,7 +23,7 @@ def test_bundle_valid_openapi_document(
     @pytest.mark.requires_redocly_cli
     def test_bundle_malformed_openapi_document(
         self,
-        redocly_bundler: RedoclyBundler,
+        redocly_bundler: RedoclyBundlerBackend,
         malformed_openapi_uri: str,
     ):
         """Test bundling of a malformed OpenAPI document raises RuntimeError."""
@@ -33,7 +33,7 @@ def test_bundle_malformed_openapi_document(
     @pytest.mark.requires_redocly_cli
     def test_bundle_with_custom_timeout(
         self,
-        redocly_bundler_with_custom_timeout: RedoclyBundler,
+        redocly_bundler_with_custom_timeout: RedoclyBundlerBackend,
         valid_openapi_uri: str,
         expected_bundled_content: str,
     ):
@@ -44,7 +44,7 @@ def test_bundle_with_custom_timeout(
     @pytest.mark.requires_redocly_cli
     def test_bundle_dict_document(
         self,
-        redocly_bundler: RedoclyBundler,
+        redocly_bundler: RedoclyBundlerBackend,
         expected_bundled_content: str,
     ):
         """Test bundling of a dict OpenAPI document."""
@@ -68,26 +68,28 @@ class TestRedoclyBundlerUnit:
     """Unit tests that don't require external dependencies."""
 
     def test_init_with_defaults(self):
-        """Test RedoclyBundler initialization with default values."""
-        bundler = RedoclyBundler()
+        """Test RedoclyBundlerBackend initialization with default values."""
+        bundler = RedoclyBundlerBackend()
         assert bundler.redocly_path == "npx @redocly/cli@^2.1.5"
         assert bundler.timeout == 30.0
 
-    def test_init_with_custom_path(self, redocly_bundler_with_custom_path: RedoclyBundler):
-        """Test RedoclyBundler initialization with custom redocly path."""
+    def test_init_with_custom_path(self, redocly_bundler_with_custom_path: RedoclyBundlerBackend):
+        """Test RedoclyBundlerBackend initialization with custom redocly path."""
         assert redocly_bundler_with_custom_path.redocly_path == "/custom/path/to/redocly"
 
-    def test_init_with_custom_timeout(self, redocly_bundler_with_custom_timeout: RedoclyBundler):
-        """Test RedoclyBundler initialization with custom timeout."""
+    def test_init_with_custom_timeout(
+        self, redocly_bundler_with_custom_timeout: RedoclyBundlerBackend
+    ):
+        """Test RedoclyBundlerBackend initialization with custom timeout."""
         assert redocly_bundler_with_custom_timeout.timeout == 60.0
 
-    def test_accepts_returns_correct_formats(self, redocly_bundler: RedoclyBundler):
+    def test_accepts_returns_correct_formats(self, redocly_bundler: RedoclyBundlerBackend):
         """Test that accepts() returns the correct supported formats."""
         formats = redocly_bundler.accepts()
         assert formats == ["uri", "dict"]
         assert isinstance(formats, list)
 
-    def test_bundle_with_unsupported_document_type(self, redocly_bundler: RedoclyBundler):
+    def test_bundle_with_unsupported_document_type(self, redocly_bundler: RedoclyBundlerBackend):
         """Test that bundle() raises TypeError for unsupported document types."""
         with pytest.raises(TypeError, match="Unsupported document type"):
             redocly_bundler.bundle(42)  # type: ignore
@@ -104,28 +106,28 @@ class TestRedoclyBundlerErrorHandling:
 
     def test_bundle_with_nonexistent_cli(self):
         """Test behavior when redocly CLI is not available."""
-        bundler = RedoclyBundler(redocly_path="nonexistent_redocly")
+        bundler = RedoclyBundlerBackend(redocly_path="nonexistent_redocly")
 
         with pytest.raises(SubprocessExecutionError):
             bundler.bundle("/some/test/file.yaml")
 
-    def test_bundle_with_invalid_file_path(self, redocly_bundler: RedoclyBundler):
+    def test_bundle_with_invalid_file_path(self, redocly_bundler: RedoclyBundlerBackend):
         """Test bundling with invalid file path."""
         with pytest.raises(RuntimeError, match="does not exist"):
             redocly_bundler.bundle("/nonexistent/path/to/file.yaml")
 
     def test_bundle_with_timeout_configuration(self):
         """Test that timeout is properly configured."""
-        bundler = RedoclyBundler(timeout=1.0)  # Very short timeout
+        bundler = RedoclyBundlerBackend(timeout=1.0)  # Very short timeout
         assert bundler.timeout == 1.0
 
-    def test_bundle_empty_string_input(self, redocly_bundler: RedoclyBundler):
+    def test_bundle_empty_string_input(self, redocly_bundler: RedoclyBundlerBackend):
         """Test bundling with empty string input."""
         with pytest.raises(RuntimeError, match="Path cannot be empty"):
             redocly_bundler.bundle("")
 
     @pytest.mark.requires_redocly_cli
-    def test_bundle_invalid_dict_input(self, redocly_bundler: RedoclyBundler):
+    def test_bundle_invalid_dict_input(self, redocly_bundler: RedoclyBundlerBackend):
         """Test bundling with invalid dict input."""
         invalid_dict = {"invalid": "not an openapi document"}