Skip to content

Commit c9746f9

Browse files
char0nchar0n
authored
refactor(transformer-redocly): polish the package (#31)
Prepare the package to production ready state.
1 parent 8500d0c commit c9746f9

File tree

14 files changed

+1161
-134
lines changed

14 files changed

+1161
-134
lines changed

‎packages/jentic-openapi-transformer-redocly/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎packages/jentic-openapi-transformer-redocly/NOTICE‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Jentic OpenAPI Tools
2+
Copyright (c) 2025 Jentic
3+
Jentic OpenAPI Tools is licensed under Apache 2.0 license.
4+
Copy of the Apache 2.0 license can be found in `LICENSE` file.

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

Lines changed: 134 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,143 @@
11
# jentic-openapi-transformer-redocly
22

3-
## Running the tests
4-
To run these integration tests, you would need both packages installed. You can test this setup by:
3+
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.
54

6-
1. **Installing both packages in development mode:**
5+
## Features
76

7+
- **Multiple Input Formats**: Support for file paths, URIs, and Python dictionaries
8+
- **External Reference Resolution**: Automatically resolves `$ref` references across multiple files
9+
- **Robust Error Handling**: Comprehensive error reporting with detailed messages
10+
- **Timeout Configuration**: Configurable timeout for long-running bundling operations
11+
- **Type Safety**: Full type hints and comprehensive documentation
12+
13+
14+
## Installation
15+
16+
```bash
17+
pip install jentic-openapi-validator-redocly
818
```
9-
# From the project root
10-
uv run pip install -e packages/jentic-openapi-transformer
11-
uv run pip install -e packages/jentic-openapi-transformer-redocly
19+
20+
**Prerequisites:**
21+
- Node.js and npm (for Spectral CLI)
22+
- Python 3.11+
23+
24+
The Redocly CLI will be automatically downloaded via npx on first use, or you can install it globally:
25+
26+
```bash
27+
npm install -g @redocly/cli
1228
```
1329

14-
2. **Running the integration test:**
30+
## Quick Start
1531

32+
### Basic Usage
33+
34+
```python
35+
from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
36+
37+
# Create a bundler instance
38+
bundler = RedoclyBundler()
39+
40+
# Bundle an OpenAPI document from a file path
41+
result = bundler.bundle("/path/to/your/openapi.yaml")
42+
print(result) # Bundled OpenAPI document as JSON string
1643
```
17-
uv run --package jentic-openapi-transformer pytest packages/jentic-openapi-transformer/tests/test_bundle_redocly.py -v
18-
```
44+
45+
### Using with Dictionary Input
46+
47+
```python
48+
# Bundle an OpenAPI document from a Python dictionary
49+
openapi_dict = {
50+
"openapi": "3.0.3",
51+
"info": {"title": "My API", "version": "1.0.0"},
52+
"paths": {
53+
"/users": {
54+
"get": {
55+
"responses": {"200": {"description": "Success"}}
56+
}
57+
}
58+
}
59+
}
60+
61+
result = bundler.bundle(openapi_dict)
62+
parsed_result = json.loads(result)
63+
```
64+
65+
### Custom Configuration
66+
67+
```python
68+
# Custom Redocly CLI path and timeout
69+
bundler = RedoclyBundler(
70+
redocly_path="redocly", # Use global redocly installation
71+
timeout=60.0 # 60 second timeout
72+
)
73+
74+
result = bundler.bundle("https://petstore3.swagger.io/api/v3/openapi.json")
75+
```
76+
77+
## Advanced Usage
78+
79+
## Error Handling
80+
81+
The bundler provides detailed error reporting for various failure scenarios:
82+
83+
```python
84+
from jentic.apitools.openapi.transformer.redocly import RedoclyBundler
85+
from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
86+
87+
bundler = RedoclyBundler()
88+
89+
try:
90+
result = bundler.bundle("/path/to/openapi.yaml")
91+
except TypeError as e:
92+
print(f"Unsupported document type: {e}")
93+
except SubprocessExecutionError as e:
94+
print(f"Redocly CLI execution failed: {e}")
95+
except RuntimeError as e:
96+
print(f"Bundling failed: {e}")
97+
```
98+
99+
### Supported Input Formats
100+
101+
The bundler accepts the following input formats (returned by `accepts()` method):
102+
103+
- **`"uri"`**: File paths or URIs pointing to OpenAPI documents
104+
- **`"dict"`**: Python dictionaries containing OpenAPI document data
105+
106+
## Testing
107+
108+
### Integration Tests
109+
110+
The integration tests require Redocly CLI to be available. They will be automatically skipped if Spectral is not installed.
111+
112+
**Run the integration test:**
113+
114+
```bash
115+
uv run --package jentic-openapi-transformer-redocly pytest packages/jentic-openapi-transformer-redocly -v
116+
```
117+
118+
## API Reference
119+
120+
### RedoclyBundler
121+
122+
```python
123+
class RedoclyBundler(BaseBundlerStrategy):
124+
def __init__(
125+
self,
126+
redocly_path: str = "npx @redocly/cli@^2.1.5",
127+
timeout: float = 30.0,
128+
) -> None
129+
```
130+
131+
**Parameters:**
132+
- `redocly_path`: Path to Redocly CLI executable
133+
- `timeout`: Maximum execution time in seconds
134+
135+
**Methods:**
136+
137+
- `accepts() -> list[str]`: Returns supported document format identifiers
138+
- `bundle(document: str | dict, base_url: str | None = None) -> str`: Bundles an OpenAPI document
139+
140+
**Exceptions:**
141+
- `TypeError`: Document type is not supported
142+
- `RuntimeError`: Redocly execution fails or produces invalid output
143+
- `SubprocessExecutionError`: Redocly times out or fails to start

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@ version = "0.1.0"
44
description = "Jentic OpenAPI Redocly Transformer Strategy"
55
readme = "README.md"
66
authors = [{ name = "Jentic", email = "hello@jentic.com" }]
7-
license = { text = "Apache-2.0" }
7+
license = "Apache-2.0"
8+
license-files = ["LICENSE", "NOTICE"]
89
requires-python = ">=3.11"
910
dependencies = [
1011
"jentic-openapi-common",
1112
"jentic-openapi-transformer",
1213
"importlib-resources>=1.3.0;python_version<'3.9'"
1314
]
1415

16+
[project.optional-dependencies]
17+
test = [
18+
"pytest",
19+
]
20+
1521
[project.urls]
1622
Homepage = "https://github.com/jentic/jentic-openapi-tools"
1723

@@ -20,6 +26,8 @@ package = true
2026

2127
[tool.uv.build-backend]
2228
namespace = true
29+
module-name = "jentic.apitools.openapi.transformer.redocly"
30+
module-root = "src/"
2331

2432
[tool.uv.sources]
2533
jentic-openapi-common = { workspace = true }

0 commit comments

Comments
 (0)