jentic-openapi-transformer-redocly 1.0.0a5__py3-none-any.whl

jentic/apitools/openapi/transformer/bundler/backends/redocly/__init__.py

@@ -0,0 +1,147 @@
+import json
+import shlex
+import tempfile
+from collections.abc import Sequence
+from pathlib import Path
+from typing import Literal
+from urllib.parse import urlparse
+from urllib.request import url2pathname
+
+from jentic.apitools.openapi.common.path_security import validate_path
+from jentic.apitools.openapi.common.subproc import run_subprocess
+from jentic.apitools.openapi.common.uri import is_path
+from jentic.apitools.openapi.transformer.bundler.backends.base import BaseBundlerBackend
+
+
+__all__ = ["RedoclyBundlerBackend"]
+
+
+class RedoclyBundlerBackend(BaseBundlerBackend):
+    def __init__(
+        self,
+        redocly_path: str = "npx --yes @redocly/cli@^2.4.0",
+        timeout: float = 600.0,
+        allowed_base_dir: str | Path | None = None,
+    ):
+        """
+        Initialize the RedoclyBundler.
+
+        Args:
+            redocly_path: Path to the redocly CLI executable (default: "npx --yes @redocly/cli@^2.4.0").
+                Uses shell-safe parsing to handle quoted arguments properly.
+            timeout: Maximum time in seconds to wait for Redocly CLI execution (default: 600.0)
+            allowed_base_dir: Optional base directory for path security validation.
+                When set, all document paths will be validated to ensure they
+                are within this directory. This provides defense against path traversal attacks
+                and is recommended for web services or when processing untrusted input.
+                If None (default), only file extension validation is performed (no base directory
+                containment check). Extension validation ensures only .yaml, .yml, and .json files
+                are processed.
+        """
+        self.redocly_path = redocly_path
+        self.timeout = timeout
+        self.allowed_base_dir = allowed_base_dir
+
+    @staticmethod
+    def accepts() -> Sequence[Literal["uri", "dict"]]:
+        """Return the document formats this bundler can accept.
+
+        Returns:
+            Sequence of supported document format identifiers:
+            - "uri": File path or URI pointing to OpenAPI Document
+            - "dict": Python dictionary containing OpenAPI Document data
+        """
+        return ["uri", "dict"]
+
+    def bundle(self, document: str | dict, *, base_url: str | None = None) -> str:
+        """
+        Bundle an OpenAPI document using Redocly CLI.
+
+        Args:
+            document: Path to the OpenAPI document file to bundle, or dict containing the document
+            base_url: Base URL for resolving relative references (currently unused)
+
+        Returns:
+            Bundled OpenAPI document as a JSON string
+
+        Raises:
+            TypeError: If a document type is not supported
+            SubprocessExecutionError: If Redocly execution times out or fails to start
+            RuntimeError: If Redocly execution fails
+            PathTraversalError: Document path attempts to escape allowed_base_dir (only when allowed_base_dir is set)
+            InvalidExtensionError: Document path has disallowed file extension (always checked for filesystem paths)
+        """
+        if isinstance(document, str):
+            return self._bundle_uri(document, base_url)
+        elif isinstance(document, dict):
+            return self._bundle_dict(document, base_url)
+        else:
+            raise TypeError(f"Unsupported document type: {type(document)!r}")
+
+    def _bundle_uri(self, document: str, base_url: str | None = None) -> str:
+        parsed_doc_url = urlparse(document)
+        doc_path = (
+            url2pathname(parsed_doc_url.path) if parsed_doc_url.scheme == "file" else document
+        )
+
+        # Validate document path if it's a filesystem path (skip non-path URIs like HTTP(S))
+        validated_doc_path = (
+            validate_path(
+                doc_path,
+                allowed_base=self.allowed_base_dir,
+                allowed_extensions=(".yaml", ".yml", ".json"),
+            )
+            if is_path(doc_path)
+            else doc_path
+        )
+
+        # Create a temporary output file path
+        temp_output_path = tempfile.mktemp(suffix=".json")
+        try:
+            # Build redocly command
+            cmd = [
+                *shlex.split(self.redocly_path),
+                "bundle",
+                validated_doc_path,
+                "-o",
+                temp_output_path,
+                "--ext",
+                "json",
+                "--lint-config",
+                "off",
+                "--force",
+                # TODO(francesco@jentic.com): raises errors in redocly for unknown reason
+                # "--remove-unused-components",
+            ]
+            result = run_subprocess(cmd, timeout=self.timeout)
+
+            # Check if bundling was successful based on return code
+            if result.returncode != 0:
+                err = (result.stderr or "").strip()
+                msg = err or f"Redocly exited with code {result.returncode}"
+                raise RuntimeError(msg)
+
+            # Verify an output file was created
+            output_path = Path(temp_output_path)
+            if not output_path.exists():
+                # Return code was OK but no output file - unexpected failure
+                err = (result.stderr or "").strip()
+                msg = err or "Redocly exited successfully but produced no output file"
+                raise RuntimeError(msg)
+
+            return output_path.read_text(encoding="utf-8")
+        finally:
+            # Clean up the temporary file if it was created
+            output_path = Path(temp_output_path)
+            if output_path.exists():
+                output_path.unlink()
+
+    def _bundle_dict(self, document: dict, base_url: str | None = None) -> str:
+        """Bundle a dict document by creating a temporary file and using _bundle_uri."""
+        with tempfile.NamedTemporaryFile(
+            mode="w", suffix=".json", delete=True, encoding="utf-8"
+        ) as temp_file:
+            json.dump(document, temp_file)
+            temp_file.flush()  # Ensure content is written to disk
+
+            return self._bundle_uri(Path(temp_file.name).as_uri(), base_url)

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/METADATA

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: jentic-openapi-transformer-redocly
+Version: 1.0.0a5
+Summary: Jentic OpenAPI Redocly Transformer Backend
+Author: Jentic
+Author-email: Jentic <hello@jentic.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: jentic-openapi-common~=1.0.0a5
+Requires-Dist: jentic-openapi-transformer~=1.0.0a5
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
+Description-Content-Type: text/markdown
+
+# 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 backend pattern for bundling OpenAPI documents by resolving external references.
+
+## Features
+
+- **Multiple Input Formats**: Support for file paths, URIs, and Python dictionaries
+- **External Reference Resolution**: Automatically resolves `$ref` references across multiple files
+- **Robust Error Handling**: Comprehensive error reporting with detailed messages
+- **Timeout Configuration**: Configurable timeout for long-running bundling operations
+- **Type Safety**: Full type hints and comprehensive documentation
+
+
+## Installation
+
+```bash
+pip install jentic-openapi-transformer-redocly
+```
+
+**Prerequisites:**
+- Node.js and npm (for Redocly CLI)
+- Python 3.11+
+
+The Redocly CLI will be automatically downloaded via npx on first use, or you can install it globally:
+
+```bash
+npm install -g @redocly/cli
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
+
+# Create a bundler instance
+bundler = RedoclyBundlerBackend()
+
+# Bundle an OpenAPI document from a file path
+result = bundler.bundle("/path/to/your/openapi.yaml")
+print(result)  # Bundled OpenAPI document as JSON string
+```
+
+### Using with Dictionary Input
+
+```python
+# Bundle an OpenAPI document from a Python dictionary
+openapi_dict = {
+    "openapi": "3.0.3",
+    "info": {"title": "My API", "version": "1.0.0"},
+    "paths": {
+        "/users": {
+            "get": {
+                "responses": {"200": {"description": "Success"}}
+            }
+        }
+    }
+}
+
+result = bundler.bundle(openapi_dict)
+parsed_result = json.loads(result)
+```
+
+### Custom Configuration
+
+```python
+# Custom Redocly CLI path and timeout
+bundler = RedoclyBundlerBackend(
+    redocly_path="redocly",  # Use global redocly installation
+    timeout=60.0  # 60 second timeout
+)
+
+result = bundler.bundle("https://petstore3.swagger.io/api/v3/openapi.json")
+```
+
+## Advanced Usage
+
+## Error Handling
+
+The bundler provides detailed error reporting for various failure scenarios:
+
+```python
+from jentic.apitools.openapi.transformer.bundler.backends.redocly import RedoclyBundlerBackend
+from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
+
+bundler = RedoclyBundlerBackend()
+
+try:
+    result = bundler.bundle("/path/to/openapi.yaml")
+except TypeError as e:
+    print(f"Unsupported document type: {e}")
+except SubprocessExecutionError as e:
+    print(f"Redocly CLI execution failed: {e}")
+except RuntimeError as e:
+    print(f"Bundling failed: {e}")
+```
+
+### Supported Input Formats
+
+The bundler accepts the following input formats (returned by `accepts()` method):
+
+- **`"uri"`**: File paths or URIs pointing to OpenAPI documents
+- **`"dict"`**: Python dictionaries containing OpenAPI document data
+
+## Testing
+
+### Integration Tests
+
+The integration tests require Redocly CLI to be available. They will be automatically skipped if Redocly is not installed.
+
+**Run the integration test:**
+
+```bash
+uv run --package jentic-openapi-transformer-redocly pytest packages/jentic-openapi-transformer-redocly -v
+```
+
+## API Reference
+
+### RedoclyBundler
+
+```python
+class RedoclyBundlerBackend(BaseBundlerBackend):
+    def __init__(
+        self,
+        redocly_path: str = "npx --yes @redocly/cli@^2.4.0",
+        timeout: float = 600.0,
+        allowed_base_dir: str | Path | None = None,
+    ) -> None
+```
+
+**Parameters:**
+- `redocly_path`: Path to Redocly CLI executable
+- `timeout`: Maximum execution time in seconds
+- `allowed_base_dir`: Optional base directory for path security validation. When set, all document paths are validated to be within this directory, providing defense against path traversal attacks. When `None` (default), only file extension validation is performed (no base directory containment check). Recommended for web services or untrusted input (optional)
+
+**Methods:**
+
+- `accepts() -> list[str]`: Returns supported document format identifiers
+- `bundle(document: str | dict, base_url: str | None = None) -> str`: Bundles an OpenAPI document
+
+**Exceptions:**
+- `TypeError`: Document type is not supported
+- `RuntimeError`: Redocly execution fails or produces invalid output
+- `SubprocessExecutionError`: Redocly times out or fails to start
+- `PathTraversalError`: Document path attempts to escape allowed_base_dir (only when `allowed_base_dir` is set)
+- `InvalidExtensionError`: Document path has disallowed file extension (always checked for filesystem paths)

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/RECORD

@@ -0,0 +1,8 @@
+jentic/apitools/openapi/transformer/bundler/backends/redocly/__init__.py,sha256=OKArtOyRI0qKq0ViBmnFL8VPeWjUUAHk7iMAkBRTpuU,6117
+jentic/apitools/openapi/transformer/bundler/backends/redocly/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/licenses/NOTICE,sha256=pAOGW-rGw9KNc2cuuLWZkfx0GSTV4TicbgBKZSLPMIs,168
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/entry_points.txt,sha256=X61t3p9y4Sco-tJPkoNj3Px_6uii-xbYSzWI45N5Akg,149
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/METADATA,sha256=n4fVzvNt1NrYjdATmU6aNOw5BCueDZz21wA0Gc6Lxac,5173
+jentic_openapi_transformer_redocly-1.0.0a5.dist-info/RECORD,,

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.24
+Root-Is-Purelib: true
+Tag: py3-none-any

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[jentic.apitools.openapi.transformer.bundler.backends]
+redocly = jentic.apitools.openapi.transformer.bundler.backends.redocly:RedoclyBundlerBackend
+

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jentic_openapi_transformer_redocly-1.0.0a5.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+Jentic OpenAPI Tools
+Copyright (c) 2025 Jentic
+Jentic OpenAPI Tools is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.