dex-connector-cloudflare 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dex_connector_cloudflare-0.1.0/.gitignore +6 -0
- dex_connector_cloudflare-0.1.0/PKG-INFO +55 -0
- dex_connector_cloudflare-0.1.0/README.md +44 -0
- dex_connector_cloudflare-0.1.0/examples/cloudflare_lookup/__init__.py +3 -0
- dex_connector_cloudflare-0.1.0/examples/cloudflare_lookup/flow.py +76 -0
- dex_connector_cloudflare-0.1.0/examples/cloudflare_lookup/worker.py +51 -0
- dex_connector_cloudflare-0.1.0/pyproject.toml +37 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/__init__.py +52 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/__init__.py +2 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/config.py +25 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/connection.py +131 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/definitions.py +57 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/mock.py +113 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/models.py +90 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/_generated/steps.py +134 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/client.py +385 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/cloudflaremock/__init__.py +59 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/connection.py +49 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/dex-connector.json +82 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/models.py +33 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/py.typed +0 -0
- dex_connector_cloudflare-0.1.0/src/dex_connectors/cloudflare/steps.py +38 -0
- dex_connector_cloudflare-0.1.0/tests/test_conformance.py +34 -0
- dex_connector_cloudflare-0.1.0/tests/test_manifest_contract.py +15 -0
- dex_connector_cloudflare-0.1.0/tests/test_operations.py +228 -0
- dex_connector_cloudflare-0.1.0/uv.lock +932 -0
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: dex-connector-cloudflare
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Cloudflare connector for Dex Flows
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Requires-Python: >=3.11
|
|
7
|
+
Requires-Dist: dex-connectors-sdk==0.1.0
|
|
8
|
+
Requires-Dist: dex-python-sdk>=1.28.0
|
|
9
|
+
Requires-Dist: httpx>=0.27
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
|
|
12
|
+
# Cloudflare connector for Python
|
|
13
|
+
|
|
14
|
+
Install with `pip install dex-connector-cloudflare==0.1.0`. The package requires
|
|
15
|
+
`dex-connectors-sdk==0.1.0` and `dex-python-sdk>=1.28.0`, and implements the
|
|
16
|
+
manifest operations `listZones` (Query) and `purgeCacheByURLs` (Mutation) with
|
|
17
|
+
the same branches, defaults, and failure classification as the Go module.
|
|
18
|
+
|
|
19
|
+
## Operations
|
|
20
|
+
|
|
21
|
+
| Operation | Factory | Happy branch | Optional branches |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
| `listZones` | `new_list_zones_step` | `listed` | `providerRejected`, `invalidResponse`, `defect` |
|
|
24
|
+
| `purgeCacheByURLs` | `new_purge_cache_by_urls_step` | `purged` | `notFound`, `providerRejected`, `invalidResponse`, `defect` |
|
|
25
|
+
|
|
26
|
+
`listZones` reads the first page of `/zones` and requires `success: true` with
|
|
27
|
+
a `result` list. `purgeCacheByURLs` posts 1 through 30 absolute HTTP or HTTPS
|
|
28
|
+
URLs without user information to `/zones/<zoneId>/purge_cache`; repeating the
|
|
29
|
+
same purge has the same effect, so retries are safe. Acceptance does not
|
|
30
|
+
guarantee a cache miss.
|
|
31
|
+
|
|
32
|
+
Both operations retry on 408, 409, 429, 5xx, and transport failures. A
|
|
33
|
+
`success: false` envelope selects `providerRejected`; HTTP 404 selects
|
|
34
|
+
`notFound` for purges; other statuses select `providerRejected` with
|
|
35
|
+
authentication (401), authorization (403), not-found (404), or validation
|
|
36
|
+
(400, 422) kinds.
|
|
37
|
+
|
|
38
|
+
## Authorization
|
|
39
|
+
|
|
40
|
+
Create a Dex Web connection named `cloudflare` as described in the
|
|
41
|
+
[connector README](../README.md#authorization). The API token travels only in
|
|
42
|
+
the `Authorization: Bearer` header and is resolved for every attempt.
|
|
43
|
+
|
|
44
|
+
## Example
|
|
45
|
+
|
|
46
|
+
[`examples/cloudflare_lookup`](examples/cloudflare_lookup/flow.py) lists the
|
|
47
|
+
first zone page. Run the Worker with
|
|
48
|
+
`uv run python -m examples.cloudflare_lookup.worker` after `dexcli dev` has
|
|
49
|
+
loaded a project containing the `cloudflare` connection.
|
|
50
|
+
|
|
51
|
+
## Tests
|
|
52
|
+
|
|
53
|
+
`cloudflaremock.Mock` scripts both operations and defaults to the manifest
|
|
54
|
+
answers. Run `uv run pytest tests` for provider parity and manifest contract
|
|
55
|
+
checks.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Cloudflare connector for Python
|
|
2
|
+
|
|
3
|
+
Install with `pip install dex-connector-cloudflare==0.1.0`. The package requires
|
|
4
|
+
`dex-connectors-sdk==0.1.0` and `dex-python-sdk>=1.28.0`, and implements the
|
|
5
|
+
manifest operations `listZones` (Query) and `purgeCacheByURLs` (Mutation) with
|
|
6
|
+
the same branches, defaults, and failure classification as the Go module.
|
|
7
|
+
|
|
8
|
+
## Operations
|
|
9
|
+
|
|
10
|
+
| Operation | Factory | Happy branch | Optional branches |
|
|
11
|
+
| --- | --- | --- | --- |
|
|
12
|
+
| `listZones` | `new_list_zones_step` | `listed` | `providerRejected`, `invalidResponse`, `defect` |
|
|
13
|
+
| `purgeCacheByURLs` | `new_purge_cache_by_urls_step` | `purged` | `notFound`, `providerRejected`, `invalidResponse`, `defect` |
|
|
14
|
+
|
|
15
|
+
`listZones` reads the first page of `/zones` and requires `success: true` with
|
|
16
|
+
a `result` list. `purgeCacheByURLs` posts 1 through 30 absolute HTTP or HTTPS
|
|
17
|
+
URLs without user information to `/zones/<zoneId>/purge_cache`; repeating the
|
|
18
|
+
same purge has the same effect, so retries are safe. Acceptance does not
|
|
19
|
+
guarantee a cache miss.
|
|
20
|
+
|
|
21
|
+
Both operations retry on 408, 409, 429, 5xx, and transport failures. A
|
|
22
|
+
`success: false` envelope selects `providerRejected`; HTTP 404 selects
|
|
23
|
+
`notFound` for purges; other statuses select `providerRejected` with
|
|
24
|
+
authentication (401), authorization (403), not-found (404), or validation
|
|
25
|
+
(400, 422) kinds.
|
|
26
|
+
|
|
27
|
+
## Authorization
|
|
28
|
+
|
|
29
|
+
Create a Dex Web connection named `cloudflare` as described in the
|
|
30
|
+
[connector README](../README.md#authorization). The API token travels only in
|
|
31
|
+
the `Authorization: Bearer` header and is resolved for every attempt.
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
[`examples/cloudflare_lookup`](examples/cloudflare_lookup/flow.py) lists the
|
|
36
|
+
first zone page. Run the Worker with
|
|
37
|
+
`uv run python -m examples.cloudflare_lookup.worker` after `dexcli dev` has
|
|
38
|
+
loaded a project containing the `cloudflare` connection.
|
|
39
|
+
|
|
40
|
+
## Tests
|
|
41
|
+
|
|
42
|
+
`cloudflaremock.Mock` scripts both operations and defaults to the manifest
|
|
43
|
+
answers. Run `uv run pytest tests` for provider parity and manifest contract
|
|
44
|
+
checks.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
"""Runnable Cloudflare lookup Flow using the listZones Query."""
|
|
4
|
+
|
|
5
|
+
import dex
|
|
6
|
+
from dex_connectors.sdk import QueryResult
|
|
7
|
+
|
|
8
|
+
from dex_connectors.cloudflare import Connection, ListZonesInput, ZonesPage, new_list_zones_step
|
|
9
|
+
|
|
10
|
+
FLOW_TYPE = "CloudflareLookup"
|
|
11
|
+
CONNECTION_NAME = "cloudflare"
|
|
12
|
+
_OPERATION_STEP_TYPE = "ListZonesCloudflare"
|
|
13
|
+
_REQUEST = dex.Attribute("cloudflare-lookup-request", ListZonesInput)
|
|
14
|
+
_OUTPUT = dex.Attribute("cloudflare-lookup-output", ZonesPage)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
def map_to_operation_input(request: ListZonesInput) -> ListZonesInput:
|
|
18
|
+
"""List zones; the request carries no parameters."""
|
|
19
|
+
return request
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# dex:group group-id:cloudflare group-label:"Cloudflare"
|
|
23
|
+
# dex:explanation text:"Start the Cloudflare lookup with its typed request."
|
|
24
|
+
class _StartLookup(dex.Step[ListZonesInput]):
|
|
25
|
+
def get_step_type(self) -> str:
|
|
26
|
+
return "StartCloudflareLookup"
|
|
27
|
+
|
|
28
|
+
def execute(self, context: dex.Context, input: ListZonesInput) -> dex.StepDecision:
|
|
29
|
+
_REQUEST.set(context, input)
|
|
30
|
+
return dex.go_to(dex.StepRef(_OPERATION_STEP_TYPE), input)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# dex:group group-id:cloudflare group-label:"Cloudflare"
|
|
34
|
+
# dex:explanation text:"Complete with the Cloudflare result."
|
|
35
|
+
class _CompleteLookup(dex.Step[QueryResult[ZonesPage]]):
|
|
36
|
+
def get_step_type(self) -> str:
|
|
37
|
+
return "CompleteCloudflareLookup"
|
|
38
|
+
|
|
39
|
+
def execute(self, context: dex.Context, input: QueryResult[ZonesPage]) -> dex.StepDecision:
|
|
40
|
+
_OUTPUT.set(context, input.value)
|
|
41
|
+
return dex.graceful_complete(input.value)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
class CloudflareLookupFlow(dex.Flow[ListZonesInput]):
|
|
45
|
+
"""List Cloudflare zones through the static cloudflare connection."""
|
|
46
|
+
|
|
47
|
+
def __init__(self, connection: Connection) -> None:
|
|
48
|
+
if connection.reference.name != CONNECTION_NAME:
|
|
49
|
+
raise ValueError("Cloudflare lookup requires the static cloudflare connection")
|
|
50
|
+
self._start = _StartLookup()
|
|
51
|
+
self._complete = _CompleteLookup()
|
|
52
|
+
self._list = new_list_zones_step(
|
|
53
|
+
step_type=_OPERATION_STEP_TYPE,
|
|
54
|
+
step_input_type=ListZonesInput,
|
|
55
|
+
annotations={
|
|
56
|
+
"groupId": "cloudflare",
|
|
57
|
+
"groupLabel": "Cloudflare",
|
|
58
|
+
"explanation": "List the first page of Cloudflare zones.",
|
|
59
|
+
},
|
|
60
|
+
connection=connection,
|
|
61
|
+
connection_name=CONNECTION_NAME,
|
|
62
|
+
map_to_operation_input=map_to_operation_input,
|
|
63
|
+
listed=self._complete,
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
def get_flow_type(self) -> str:
|
|
67
|
+
"""Return the stable Flow identity used in Dex Web."""
|
|
68
|
+
return FLOW_TYPE
|
|
69
|
+
|
|
70
|
+
def get_steps(self) -> dex.StepList[ListZonesInput]:
|
|
71
|
+
"""Register the start, provider list, and completion Steps."""
|
|
72
|
+
return dex.StepList.start_step(self._start).other_steps(self._list, self._complete)
|
|
73
|
+
|
|
74
|
+
def get_persistence_schema(self) -> dex.PersistenceSchema:
|
|
75
|
+
"""Persist the request and zone page."""
|
|
76
|
+
return dex.PersistenceSchema.of(_REQUEST, _OUTPUT)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
"""Worker entrypoint for the Cloudflare lookup Flow."""
|
|
4
|
+
|
|
5
|
+
import asyncio
|
|
6
|
+
import os
|
|
7
|
+
import tempfile
|
|
8
|
+
from pathlib import Path
|
|
9
|
+
|
|
10
|
+
import dex
|
|
11
|
+
from dex_connectors.sdk.projectconfig import load_from_environment
|
|
12
|
+
|
|
13
|
+
from dex_connectors.cloudflare import new_project_connection
|
|
14
|
+
|
|
15
|
+
from .flow import CONNECTION_NAME, CloudflareLookupFlow
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
async def run_worker() -> None:
|
|
19
|
+
"""Load the named Dex Web connection and list zones."""
|
|
20
|
+
project = await load_from_environment()
|
|
21
|
+
connection = None
|
|
22
|
+
cache = None
|
|
23
|
+
try:
|
|
24
|
+
connection = new_project_connection(project, CONNECTION_NAME)
|
|
25
|
+
registry = dex.Registry([CloudflareLookupFlow(connection)], allow_async_handlers=True)
|
|
26
|
+
cache_directory = os.environ.get(
|
|
27
|
+
"DEX_BLOB_CACHE_DIR", str(Path(tempfile.gettempdir()) / "dex-cloudflare-lookup-blobs")
|
|
28
|
+
)
|
|
29
|
+
cache = dex.open_blob_cache(dex.BlobCacheConfig(cache_directory, 1 << 30))
|
|
30
|
+
worker = dex.AsyncWorker(
|
|
31
|
+
registry,
|
|
32
|
+
cache,
|
|
33
|
+
dex.WorkerOptions(server_address=os.environ.get("DEX_FLOW_SERVICE_ADDRESS", "localhost:8801")),
|
|
34
|
+
)
|
|
35
|
+
async with worker:
|
|
36
|
+
await worker.start()
|
|
37
|
+
finally:
|
|
38
|
+
if connection is not None:
|
|
39
|
+
await connection.aclose()
|
|
40
|
+
if cache is not None:
|
|
41
|
+
cache.close()
|
|
42
|
+
await project.close()
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def main() -> None:
|
|
46
|
+
"""Run until the Worker stops or the process receives an interrupt."""
|
|
47
|
+
asyncio.run(run_worker())
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
if __name__ == "__main__":
|
|
51
|
+
main()
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.27"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "dex-connector-cloudflare"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Cloudflare connector for Dex Flows"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
dependencies = ["dex-connectors-sdk==0.1.0", "dex-python-sdk>=1.28.0", "httpx>=0.27"]
|
|
13
|
+
|
|
14
|
+
[dependency-groups]
|
|
15
|
+
dev = ["pytest>=8", "pytest-asyncio>=0.24", "mypy>=1.13", "ruff>=0.7", "pyyaml>=6", "types-PyYAML>=6"]
|
|
16
|
+
|
|
17
|
+
[tool.hatch.build.targets.wheel]
|
|
18
|
+
packages = ["src/dex_connectors"]
|
|
19
|
+
|
|
20
|
+
[tool.pytest.ini_options]
|
|
21
|
+
testpaths = ["tests"]
|
|
22
|
+
pythonpath = [".", "src"]
|
|
23
|
+
asyncio_mode = "auto"
|
|
24
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
25
|
+
|
|
26
|
+
[tool.mypy]
|
|
27
|
+
python_version = "3.11"
|
|
28
|
+
strict = true
|
|
29
|
+
mypy_path = "src"
|
|
30
|
+
explicit_package_bases = true
|
|
31
|
+
|
|
32
|
+
[tool.ruff]
|
|
33
|
+
target-version = "py311"
|
|
34
|
+
line-length = 110
|
|
35
|
+
|
|
36
|
+
[tool.ruff.lint]
|
|
37
|
+
select = ["E", "F", "I", "UP", "B"]
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
"""Cloudflare zone listing and URL cache purge operations for Dex connector Steps."""
|
|
4
|
+
|
|
5
|
+
from .client import (
|
|
6
|
+
CONNECTOR_ID,
|
|
7
|
+
DEFECT,
|
|
8
|
+
INVALID_RESPONSE,
|
|
9
|
+
LIST_ZONES_DEFINITION,
|
|
10
|
+
LISTED,
|
|
11
|
+
NOT_FOUND,
|
|
12
|
+
PROVIDER_REJECTED,
|
|
13
|
+
PURGE_CACHE_BY_URLS_DEFINITION,
|
|
14
|
+
PURGED,
|
|
15
|
+
Client,
|
|
16
|
+
Config,
|
|
17
|
+
Credentials,
|
|
18
|
+
ListZonesOperation,
|
|
19
|
+
PurgeCacheByURLsOperation,
|
|
20
|
+
)
|
|
21
|
+
from .connection import Connection, new_connection, new_connection_with_operations, new_project_connection
|
|
22
|
+
from .models import CachePurge, ListZonesInput, PurgeCacheByURLsInput, PurgeRequest, Zone, ZonesPage
|
|
23
|
+
from .steps import new_list_zones_step, new_purge_cache_by_urls_step
|
|
24
|
+
|
|
25
|
+
__all__ = [
|
|
26
|
+
"CachePurge",
|
|
27
|
+
"Client",
|
|
28
|
+
"Config",
|
|
29
|
+
"Connection",
|
|
30
|
+
"Credentials",
|
|
31
|
+
"ListZonesInput",
|
|
32
|
+
"ListZonesOperation",
|
|
33
|
+
"PurgeCacheByURLsInput",
|
|
34
|
+
"PurgeCacheByURLsOperation",
|
|
35
|
+
"PurgeRequest",
|
|
36
|
+
"Zone",
|
|
37
|
+
"ZonesPage",
|
|
38
|
+
"new_connection",
|
|
39
|
+
"new_connection_with_operations",
|
|
40
|
+
"new_list_zones_step",
|
|
41
|
+
"new_project_connection",
|
|
42
|
+
"new_purge_cache_by_urls_step",
|
|
43
|
+
"CONNECTOR_ID",
|
|
44
|
+
"DEFECT",
|
|
45
|
+
"INVALID_RESPONSE",
|
|
46
|
+
"LIST_ZONES_DEFINITION",
|
|
47
|
+
"LISTED",
|
|
48
|
+
"NOT_FOUND",
|
|
49
|
+
"PROVIDER_REJECTED",
|
|
50
|
+
"PURGE_CACHE_BY_URLS_DEFINITION",
|
|
51
|
+
"PURGED",
|
|
52
|
+
]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
# ruff: noqa
|
|
4
|
+
|
|
5
|
+
from dataclasses import dataclass
|
|
6
|
+
|
|
7
|
+
from dex_connectors.sdk import SecretString
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
@dataclass(frozen=True, slots=True)
|
|
11
|
+
class Config:
|
|
12
|
+
|
|
13
|
+
base_url: str = "https://api.cloudflare.com/client/v4"
|
|
14
|
+
timeout_seconds: float = 15
|
|
15
|
+
max_response_bytes: int = 2097152
|
|
16
|
+
|
|
17
|
+
setattr(Config, '__module__', 'dex_connectors.cloudflare.client')
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
@dataclass(frozen=True, slots=True)
|
|
21
|
+
class Credentials:
|
|
22
|
+
|
|
23
|
+
api_token: SecretString
|
|
24
|
+
|
|
25
|
+
setattr(Credentials, '__module__', 'dex_connectors.cloudflare.client')
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
# ruff: noqa
|
|
4
|
+
|
|
5
|
+
from typing import Any
|
|
6
|
+
|
|
7
|
+
import httpx
|
|
8
|
+
from dex_connectors.sdk import ConnectionRef, Mutation, Query, Call, SecretString
|
|
9
|
+
from dex_connectors.sdk.projectconfig import ConnectionKey, LoadedProject
|
|
10
|
+
|
|
11
|
+
from ..client import Client, Config, Credentials
|
|
12
|
+
from .definitions import CONNECTOR_ID, LIST_ZONES_DEFINITION, PURGE_CACHE_BY_URLS_DEFINITION
|
|
13
|
+
from ..models import CachePurge, ListZonesInput, PurgeCacheByURLsInput, ZonesPage
|
|
14
|
+
|
|
15
|
+
class Connection:
|
|
16
|
+
|
|
17
|
+
__slots__ = ('_purge_cache_by_urls', '_list_zones', '_client', 'reference')
|
|
18
|
+
|
|
19
|
+
def __init__(self,
|
|
20
|
+
reference: ConnectionRef,
|
|
21
|
+
purge_cache_by_urls: Mutation[PurgeCacheByURLsInput, CachePurge],
|
|
22
|
+
list_zones: Query[ListZonesInput, ZonesPage],
|
|
23
|
+
client: Client | None = None,
|
|
24
|
+
) -> None:
|
|
25
|
+
reference.validate()
|
|
26
|
+
if reference.provider != CONNECTOR_ID or purge_cache_by_urls is None or list_zones is None:
|
|
27
|
+
raise ValueError("Cloudflare connection provider and operations are required")
|
|
28
|
+
if purge_cache_by_urls.definition().operation != PURGE_CACHE_BY_URLS_DEFINITION.operation:
|
|
29
|
+
raise ValueError("Cloudflare connection operation identity differs")
|
|
30
|
+
if list_zones.definition().operation != LIST_ZONES_DEFINITION.operation:
|
|
31
|
+
raise ValueError("Cloudflare connection operation identity differs")
|
|
32
|
+
self.reference = reference
|
|
33
|
+
self._purge_cache_by_urls = purge_cache_by_urls
|
|
34
|
+
self._list_zones = list_zones
|
|
35
|
+
self._client = client
|
|
36
|
+
|
|
37
|
+
def purge_cache_by_urls(self) -> Mutation[PurgeCacheByURLsInput, CachePurge]:
|
|
38
|
+
return self._purge_cache_by_urls
|
|
39
|
+
|
|
40
|
+
def list_zones(self) -> Query[ListZonesInput, ZonesPage]:
|
|
41
|
+
return self._list_zones
|
|
42
|
+
|
|
43
|
+
async def aclose(self) -> None:
|
|
44
|
+
if self._client is not None:
|
|
45
|
+
await self._client.aclose()
|
|
46
|
+
|
|
47
|
+
def __repr__(self) -> str:
|
|
48
|
+
return "cloudflare.Connection([REDACTED])"
|
|
49
|
+
|
|
50
|
+
def __reduce__(self) -> tuple[object, ...]:
|
|
51
|
+
raise TypeError("Cloudflare connections cannot be serialized")
|
|
52
|
+
|
|
53
|
+
setattr(Connection, '__module__', 'dex_connectors.cloudflare.connection')
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def new_connection(client: Client, reference: ConnectionRef) -> Connection:
|
|
57
|
+
if client is None:
|
|
58
|
+
raise ValueError("Cloudflare client is required")
|
|
59
|
+
return Connection(reference, client.purge_cache_by_urls(), client.list_zones(), client)
|
|
60
|
+
|
|
61
|
+
setattr(new_connection, '__module__', 'dex_connectors.cloudflare.connection')
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
def new_connection_with_operations(
|
|
65
|
+
purge_cache_by_urls: Mutation[PurgeCacheByURLsInput, CachePurge],
|
|
66
|
+
list_zones: Query[ListZonesInput, ZonesPage],
|
|
67
|
+
reference: ConnectionRef,
|
|
68
|
+
) -> Connection:
|
|
69
|
+
return Connection(reference, purge_cache_by_urls, list_zones)
|
|
70
|
+
|
|
71
|
+
setattr(new_connection_with_operations, '__module__', 'dex_connectors.cloudflare.connection')
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
class _ProjectCredentialSource:
|
|
75
|
+
|
|
76
|
+
def __init__(self, project: LoadedProject, key: ConnectionKey) -> None:
|
|
77
|
+
self.project = project
|
|
78
|
+
self.key = key
|
|
79
|
+
|
|
80
|
+
async def resolve(self, call: Call) -> Credentials:
|
|
81
|
+
material = await self.project.resolve_credential(self.key, str(call.id))
|
|
82
|
+
api_token = material.get("api_token")
|
|
83
|
+
if not isinstance(api_token, str) or not api_token:
|
|
84
|
+
raise ValueError("Cloudflare credential api_token is required")
|
|
85
|
+
return Credentials(SecretString(api_token))
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
def new_project_connection(
|
|
89
|
+
project: LoadedProject, connection_name: str, http_client: httpx.AsyncClient | None = None
|
|
90
|
+
) -> Connection:
|
|
91
|
+
if project is None:
|
|
92
|
+
raise ValueError("Cloudflare connection requires loaded project configuration")
|
|
93
|
+
reference = ConnectionRef(CONNECTOR_ID, connection_name)
|
|
94
|
+
reference.validate()
|
|
95
|
+
key = ConnectionKey(CONNECTOR_ID, connection_name)
|
|
96
|
+
matching = [
|
|
97
|
+
entry
|
|
98
|
+
for entry in project.configuration.connections
|
|
99
|
+
if entry.connector_id == CONNECTOR_ID and entry.connection_name == connection_name
|
|
100
|
+
]
|
|
101
|
+
if len(matching) != 1:
|
|
102
|
+
raise ValueError("Cloudflare project connection is missing or duplicated")
|
|
103
|
+
if matching[0].provider != CONNECTOR_ID:
|
|
104
|
+
raise ValueError("Cloudflare project connection provider differs")
|
|
105
|
+
config = _decode_config(matching[0].configuration)
|
|
106
|
+
client = Client(config, _ProjectCredentialSource(project, key), http_client)
|
|
107
|
+
return new_connection(client, reference)
|
|
108
|
+
|
|
109
|
+
setattr(new_project_connection, '__module__', 'dex_connectors.cloudflare.connection')
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
def _decode_config(value: dict[str, Any]) -> Config:
|
|
113
|
+
if set(value) - {"baseUrl", "timeout", "maxResponseBytes"}:
|
|
114
|
+
raise ValueError("Cloudflare configuration has unknown fields")
|
|
115
|
+
config_arguments: dict[str, Any] = {}
|
|
116
|
+
if "baseUrl" in value:
|
|
117
|
+
base_url = value["baseUrl"]
|
|
118
|
+
if not (isinstance(base_url, str)):
|
|
119
|
+
raise ValueError("Cloudflare configuration baseUrl has an invalid type")
|
|
120
|
+
config_arguments['base_url'] = base_url
|
|
121
|
+
if "timeout" in value:
|
|
122
|
+
timeout = value["timeout"]
|
|
123
|
+
if not (type(timeout) is int):
|
|
124
|
+
raise ValueError("Cloudflare configuration timeout has an invalid type")
|
|
125
|
+
config_arguments['timeout_seconds'] = timeout / 1_000_000_000
|
|
126
|
+
if "maxResponseBytes" in value:
|
|
127
|
+
max_response_bytes = value["maxResponseBytes"]
|
|
128
|
+
if not (type(max_response_bytes) is int):
|
|
129
|
+
raise ValueError("Cloudflare configuration maxResponseBytes has an invalid type")
|
|
130
|
+
config_arguments['max_response_bytes'] = max_response_bytes
|
|
131
|
+
return Config(**config_arguments)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
# ruff: noqa
|
|
4
|
+
|
|
5
|
+
from datetime import timedelta
|
|
6
|
+
|
|
7
|
+
from dex_connectors.sdk import (
|
|
8
|
+
BranchDefinition,
|
|
9
|
+
MutationDefinition,
|
|
10
|
+
OperationRef,
|
|
11
|
+
QueryDefinition,
|
|
12
|
+
RetryPolicy,
|
|
13
|
+
StepDefaults,
|
|
14
|
+
default_connector_step_execute_retry_policy,
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
CONNECTOR_ID = "cloudflare"
|
|
18
|
+
PROVIDER = "cloudflare"
|
|
19
|
+
PURGE_CACHE_BY_URLS_OPERATION_ID = "purgeCacheByURLs"
|
|
20
|
+
LIST_ZONES_OPERATION_ID = "listZones"
|
|
21
|
+
DEFECT = "defect"
|
|
22
|
+
INVALID_RESPONSE = "invalidResponse"
|
|
23
|
+
LISTED = "listed"
|
|
24
|
+
NOT_FOUND = "notFound"
|
|
25
|
+
PROVIDER_REJECTED = "providerRejected"
|
|
26
|
+
PURGED = "purged"
|
|
27
|
+
|
|
28
|
+
PURGE_CACHE_BY_URLS_DEFINITION = MutationDefinition(
|
|
29
|
+
OperationRef(CONNECTOR_ID, PURGE_CACHE_BY_URLS_OPERATION_ID),
|
|
30
|
+
(
|
|
31
|
+
BranchDefinition(PURGED, "Purge specific URLs from a Cloudflare zone; repeating the same purge has the same cache-removal effect.", False),
|
|
32
|
+
BranchDefinition(NOT_FOUND, "The requested resource does not exist or is inaccessible.", True),
|
|
33
|
+
BranchDefinition(PROVIDER_REJECTED, "The provider rejected the request.", True),
|
|
34
|
+
BranchDefinition(INVALID_RESPONSE, "The provider returned malformed or oversized JSON.", True),
|
|
35
|
+
BranchDefinition(DEFECT, "Local input or connection credentials are invalid.", True),
|
|
36
|
+
),
|
|
37
|
+
StepDefaults(
|
|
38
|
+
timedelta(seconds=30),
|
|
39
|
+
2,
|
|
40
|
+
execute_retry=default_connector_step_execute_retry_policy(),
|
|
41
|
+
),
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
LIST_ZONES_DEFINITION = QueryDefinition(
|
|
45
|
+
OperationRef(CONNECTOR_ID, LIST_ZONES_OPERATION_ID),
|
|
46
|
+
(
|
|
47
|
+
BranchDefinition(LISTED, "List the first page of Cloudflare zones.", False),
|
|
48
|
+
BranchDefinition(PROVIDER_REJECTED, "The provider rejected the request.", True),
|
|
49
|
+
BranchDefinition(INVALID_RESPONSE, "The provider returned malformed or oversized JSON.", True),
|
|
50
|
+
BranchDefinition(DEFECT, "Local input or connection credentials are invalid.", True),
|
|
51
|
+
),
|
|
52
|
+
StepDefaults(
|
|
53
|
+
timedelta(seconds=30),
|
|
54
|
+
2,
|
|
55
|
+
execute_retry=default_connector_step_execute_retry_policy(),
|
|
56
|
+
),
|
|
57
|
+
)
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# Copyright (c) 2026 Super Durable
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
# ruff: noqa
|
|
4
|
+
|
|
5
|
+
from datetime import datetime
|
|
6
|
+
|
|
7
|
+
from dex_connectors.sdk import ConnectionRef, Failure, FailureKind
|
|
8
|
+
from dex_connectors.sdk.connectormock import Case, Mutation, Query
|
|
9
|
+
|
|
10
|
+
from ..connection import Connection, new_connection_with_operations
|
|
11
|
+
from ..models import CachePurge, ListZonesInput, PurgeCacheByURLsInput, PurgeRequest, Zone, ZonesPage
|
|
12
|
+
from .definitions import CONNECTOR_ID, DEFECT, INVALID_RESPONSE, LISTED, LIST_ZONES_DEFINITION, NOT_FOUND, PROVIDER_REJECTED, PURGED, PURGE_CACHE_BY_URLS_DEFINITION
|
|
13
|
+
|
|
14
|
+
def purge_cache_by_urls_purged(value: CachePurge, failure: Failure | None = None) -> Case[CachePurge]:
|
|
15
|
+
return Case.branch_result(PURGED, value, failure)
|
|
16
|
+
|
|
17
|
+
setattr(purge_cache_by_urls_purged, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
18
|
+
|
|
19
|
+
def purge_cache_by_urls_not_found(value: CachePurge, failure: Failure | None = None) -> Case[CachePurge]:
|
|
20
|
+
return Case.branch_result(NOT_FOUND, value, failure)
|
|
21
|
+
|
|
22
|
+
setattr(purge_cache_by_urls_not_found, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
23
|
+
|
|
24
|
+
def purge_cache_by_urls_provider_rejected(value: CachePurge, failure: Failure | None = None) -> Case[CachePurge]:
|
|
25
|
+
return Case.branch_result(PROVIDER_REJECTED, value, failure)
|
|
26
|
+
|
|
27
|
+
setattr(purge_cache_by_urls_provider_rejected, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
28
|
+
|
|
29
|
+
def purge_cache_by_urls_invalid_response(value: CachePurge, failure: Failure | None = None) -> Case[CachePurge]:
|
|
30
|
+
return Case.branch_result(INVALID_RESPONSE, value, failure)
|
|
31
|
+
|
|
32
|
+
setattr(purge_cache_by_urls_invalid_response, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
33
|
+
|
|
34
|
+
def purge_cache_by_urls_defect(value: CachePurge, failure: Failure | None = None) -> Case[CachePurge]:
|
|
35
|
+
return Case.branch_result(DEFECT, value, failure)
|
|
36
|
+
|
|
37
|
+
setattr(purge_cache_by_urls_defect, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
38
|
+
|
|
39
|
+
def purge_cache_by_urls_retry(failure: Failure, after_seconds: float = 0) -> Case[CachePurge]:
|
|
40
|
+
return Case.retry(failure, after_seconds)
|
|
41
|
+
|
|
42
|
+
setattr(purge_cache_by_urls_retry, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
43
|
+
|
|
44
|
+
def purge_cache_by_urls_purged_default() -> Case[CachePurge]:
|
|
45
|
+
return Case.branch_result(PURGED, CachePurge(success=True, result=PurgeRequest(id='purge-meridian')))
|
|
46
|
+
|
|
47
|
+
setattr(purge_cache_by_urls_purged_default, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
48
|
+
|
|
49
|
+
def list_zones_listed(value: ZonesPage, failure: Failure | None = None) -> Case[ZonesPage]:
|
|
50
|
+
return Case.branch_result(LISTED, value, failure)
|
|
51
|
+
|
|
52
|
+
setattr(list_zones_listed, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
53
|
+
|
|
54
|
+
def list_zones_provider_rejected(value: ZonesPage, failure: Failure | None = None) -> Case[ZonesPage]:
|
|
55
|
+
return Case.branch_result(PROVIDER_REJECTED, value, failure)
|
|
56
|
+
|
|
57
|
+
setattr(list_zones_provider_rejected, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
58
|
+
|
|
59
|
+
def list_zones_invalid_response(value: ZonesPage, failure: Failure | None = None) -> Case[ZonesPage]:
|
|
60
|
+
return Case.branch_result(INVALID_RESPONSE, value, failure)
|
|
61
|
+
|
|
62
|
+
setattr(list_zones_invalid_response, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
63
|
+
|
|
64
|
+
def list_zones_defect(value: ZonesPage, failure: Failure | None = None) -> Case[ZonesPage]:
|
|
65
|
+
return Case.branch_result(DEFECT, value, failure)
|
|
66
|
+
|
|
67
|
+
setattr(list_zones_defect, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
68
|
+
|
|
69
|
+
def list_zones_retry(failure: Failure, after_seconds: float = 0) -> Case[ZonesPage]:
|
|
70
|
+
return Case.retry(failure, after_seconds)
|
|
71
|
+
|
|
72
|
+
setattr(list_zones_retry, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
73
|
+
|
|
74
|
+
def list_zones_listed_default() -> Case[ZonesPage]:
|
|
75
|
+
return Case.branch_result(LISTED, ZonesPage(success=True, result=(Zone(id='zone-meridian', name='meridian.example', status='active'),)))
|
|
76
|
+
|
|
77
|
+
setattr(list_zones_listed_default, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
class Mock:
|
|
81
|
+
|
|
82
|
+
def __init__(self, connection_name: str = "cloudflare") -> None:
|
|
83
|
+
self.purge_cache_by_urls_script: Mutation[PurgeCacheByURLsInput, CachePurge] = Mutation(PURGE_CACHE_BY_URLS_DEFINITION)
|
|
84
|
+
self.purge_cache_by_urls_script.default(purge_cache_by_urls_purged_default())
|
|
85
|
+
self.list_zones_script: Query[ListZonesInput, ZonesPage] = Query(LIST_ZONES_DEFINITION)
|
|
86
|
+
self.list_zones_script.default(list_zones_listed_default())
|
|
87
|
+
self._connection = new_connection_with_operations(
|
|
88
|
+
purge_cache_by_urls=self.purge_cache_by_urls_script,
|
|
89
|
+
list_zones=self.list_zones_script,
|
|
90
|
+
reference=ConnectionRef(CONNECTOR_ID, connection_name),
|
|
91
|
+
)
|
|
92
|
+
|
|
93
|
+
def connection(self) -> Connection:
|
|
94
|
+
return self._connection
|
|
95
|
+
|
|
96
|
+
setattr(Mock, '__module__', "dex_connectors.cloudflare.cloudflaremock")
|
|
97
|
+
|
|
98
|
+
__all__ = [
|
|
99
|
+
"Mock",
|
|
100
|
+
"purge_cache_by_urls_purged",
|
|
101
|
+
"purge_cache_by_urls_not_found",
|
|
102
|
+
"purge_cache_by_urls_provider_rejected",
|
|
103
|
+
"purge_cache_by_urls_invalid_response",
|
|
104
|
+
"purge_cache_by_urls_defect",
|
|
105
|
+
"purge_cache_by_urls_retry",
|
|
106
|
+
"purge_cache_by_urls_purged_default",
|
|
107
|
+
"list_zones_listed",
|
|
108
|
+
"list_zones_provider_rejected",
|
|
109
|
+
"list_zones_invalid_response",
|
|
110
|
+
"list_zones_defect",
|
|
111
|
+
"list_zones_retry",
|
|
112
|
+
"list_zones_listed_default",
|
|
113
|
+
]
|