fancy-google-ads 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.
- fancy_google_ads-0.1.0/.gitignore +24 -0
- fancy_google_ads-0.1.0/CHANGELOG.md +17 -0
- fancy_google_ads-0.1.0/LICENSE +21 -0
- fancy_google_ads-0.1.0/PKG-INFO +123 -0
- fancy_google_ads-0.1.0/README.md +101 -0
- fancy_google_ads-0.1.0/pyproject.toml +87 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/__init__.py +37 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/_fake.py +170 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/_runtime.py +371 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/actions/__init__.py +14 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/actions/customer_list_accessible.py +66 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/faker.py +51 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/py.typed +0 -0
- fancy_google_ads-0.1.0/src/fancy_google_ads/service.py +82 -0
- fancy_google_ads-0.1.0/tests/test_faker.py +42 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
node_modules/
|
|
2
|
+
dist/
|
|
3
|
+
vendor/
|
|
4
|
+
.venv/
|
|
5
|
+
__pycache__/
|
|
6
|
+
*.egg-info/
|
|
7
|
+
.pytest_cache/
|
|
8
|
+
.ruff_cache/
|
|
9
|
+
.mypy_cache/
|
|
10
|
+
|
|
11
|
+
# Lockfiles are NOT source of a generated repo.
|
|
12
|
+
#
|
|
13
|
+
# The generator cannot emit one -- a lockfile is the result of a network
|
|
14
|
+
# resolve -- and "a provider repo must be generated and re-generatable" is the
|
|
15
|
+
# constraint the whole estate rests on. At a few hundred repos, a committed
|
|
16
|
+
# lockfile each is a few hundred files nothing can regenerate and a few hundred
|
|
17
|
+
# Dependabot surfaces.
|
|
18
|
+
#
|
|
19
|
+
# The trade is real and worth stating: CI resolves fresh on every run, so an
|
|
20
|
+
# upstream release inside the declared range can break a build with no change
|
|
21
|
+
# here. That is early warning rather than a surprise at publish time, and the
|
|
22
|
+
# ranges are deliberately narrow (>=X <2.0, never a caret on a 0.x).
|
|
23
|
+
composer.lock
|
|
24
|
+
package-lock.json
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@particle-academy/google-ads-ui`,
|
|
4
|
+
`@particle-academy/google-ads-js`, `particle-academy/google-ads-php` and
|
|
5
|
+
`fancy-google-ads`.
|
|
6
|
+
|
|
7
|
+
## [0.1.0] - 2026-08-24
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- List Google Ads customers directly accessible to an OAuth identity.
|
|
12
|
+
- Send the required developer token alongside OAuth bearer authorization.
|
|
13
|
+
- Support an optional manager customer header for manager-account access.
|
|
14
|
+
- Model Google Ads' isolated test-account hierarchy.
|
|
15
|
+
- Provide a deterministic fixture matching the v25 discovery response.
|
|
16
|
+
|
|
17
|
+
[0.1.0]: https://github.com/Fancy-Friends/google-ads/releases/tag/v0.1.0
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Particle Academy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: fancy-google-ads
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Google Ads for Python — the service descriptor, its faker, its webhook verification, and one function per operation. Plain HTTP; no vendor SDK.
|
|
5
|
+
Project-URL: Homepage, https://github.com/Fancy-Friends/google-ads
|
|
6
|
+
Project-URL: Issues, https://github.com/Fancy-Friends/google-ads/issues
|
|
7
|
+
Project-URL: Source, https://github.com/Fancy-Friends/google-ads
|
|
8
|
+
Author: Particle Academy
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: api,connector,fancy-flow,google_ads,marketing,particle-academy
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
# Google Ads
|
|
24
|
+
|
|
25
|
+
Google Ads for [fancy-flow][flow] — as **four imported, versioned packages**, one
|
|
26
|
+
per runtime. Not vendored source: a copy cannot be upgraded, and third-party APIs
|
|
27
|
+
change.
|
|
28
|
+
|
|
29
|
+
[flow]: https://github.com/Particle-Academy/fancy-flow
|
|
30
|
+
|
|
31
|
+
| Runtime | Package | Install |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| Authoring surface (every host) | `@particle-academy/google-ads-ui` | `npm install @particle-academy/google-ads-ui` |
|
|
34
|
+
| Node | `@particle-academy/google-ads-js` | `npm install @particle-academy/google-ads-js` |
|
|
35
|
+
| PHP 8.4+ | `particle-academy/google-ads-php` | `composer require particle-academy/google-ads-php` |
|
|
36
|
+
| Python 3.11+ | `fancy-google-ads` | `pip install fancy-google-ads` |
|
|
37
|
+
|
|
38
|
+
The `ui` package is the editor surface and is React on every host — a PHP or
|
|
39
|
+
Python project installs it *and* its own runtime package, and never the `js` one.
|
|
40
|
+
|
|
41
|
+
## What it costs you
|
|
42
|
+
|
|
43
|
+
One dependency: `@particle-academy/fancy-connector-core` (or
|
|
44
|
+
`particle-academy/fancy-connector-core` on Composer), which the `js` and `php`
|
|
45
|
+
packages pull in themselves. The Python package has **zero** runtime
|
|
46
|
+
dependencies.
|
|
47
|
+
|
|
48
|
+
**No Google Ads SDK.** Plain HTTP, deliberately: a vendor SDK is third-party code
|
|
49
|
+
subject to the kit's full approval bar, and one per provider is hundreds of
|
|
50
|
+
dependencies nobody is tracking.
|
|
51
|
+
|
|
52
|
+
## Setting it up
|
|
53
|
+
|
|
54
|
+
Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
|
|
55
|
+
|
|
56
|
+
### Credentials
|
|
57
|
+
|
|
58
|
+
A Google Ads connection holds 6 values.
|
|
59
|
+
|
|
60
|
+
**Two kinds of value, and mixing them up matters.** A `provider` credential is ONE value for the whole installation — an OAuth app's client secret serves every connected account. An `account` credential is one per connected account. A host that stores the second where it stores the first lets one account's credentials reach another's.
|
|
61
|
+
|
|
62
|
+
| Field | Scope | Secret | Where it comes from |
|
|
63
|
+
|---|---|---|---|
|
|
64
|
+
| **OAuth client ID** | per installation | not secret | The Google Cloud OAuth client shared by the installation. |
|
|
65
|
+
| **OAuth client secret** | per installation | **secret** | The matching Google Cloud OAuth client secret. |
|
|
66
|
+
| **Developer token** | per installation | **secret** | The 22-character Google Ads API developer token from the manager account's API Center. Google says to treat it like a password; one token identifies the installed application. |
|
|
67
|
+
| **Access token** | per connected account | **secret** | The connected Google user's one-hour OAuth access token. |
|
|
68
|
+
| **Refresh token** | per connected account | **secret** | The reusable offline token used to replace expired access tokens. |
|
|
69
|
+
| **Manager customer ID** *(optional)* | per connected account | not secret | Optional. The manager account's 10-digit customer ID without hyphens. Required when the OAuth user reaches a client through that manager; omit it for direct access. |
|
|
70
|
+
|
|
71
|
+
Every request carries `developer-token` and `login-customer-id` *(when set)* alongside the primary authorization, filled from the credentials above.
|
|
72
|
+
|
|
73
|
+
### Authorising
|
|
74
|
+
|
|
75
|
+
Google Ads uses OAuth2 (authorization_code). The package DECLARES the exchange; the HOST performs it — a consent screen needs a browser, a redirect URI and somewhere to persist the result, and all three belong to the host.
|
|
76
|
+
|
|
77
|
+
- **Authorize URL** — https://accounts.google.com/o/oauth2/v2/auth
|
|
78
|
+
- **Token URL** — https://oauth2.googleapis.com/token
|
|
79
|
+
- **Scopes** — `https://www.googleapis.com/auth/adwords`
|
|
80
|
+
- **Access token lifetime** — 3600 seconds (1 hours). A host that never refreshes works all afternoon and is broken by morning.
|
|
81
|
+
|
|
82
|
+
The refresh tokens do **not** rotate: the same one is reusable, so a refresh may safely be retried and may run concurrently. Stated rather than assumed, because the opposite — a provider that spends the token and revokes the grant on a replay — looks identical until it happens.
|
|
83
|
+
|
|
84
|
+
### The estate
|
|
85
|
+
|
|
86
|
+
Google Ads has a test estate on the same host, reached with credentials from a SEPARATE test account you register. Selecting sandbox mode uses those credentials.
|
|
87
|
+
|
|
88
|
+
> Use a dedicated Google Ads test manager and test client account. Test and production hierarchies cannot interact; test ads never serve or incur cost, but some features such as billing, conversion uploads and serving reports cannot be exercised there.
|
|
89
|
+
|
|
90
|
+
## What it can do
|
|
91
|
+
|
|
92
|
+
### Actions
|
|
93
|
+
|
|
94
|
+
#### `customer_list_accessible` — Accessible Google Ads customers
|
|
95
|
+
|
|
96
|
+
List Google Ads customer resource names directly accessible to the authenticated user. Manager-linked client accounts are not included; query the account hierarchy after choosing a directly accessible manager.
|
|
97
|
+
|
|
98
|
+
`GET /v25/customers:listAccessibleCustomers` · reads only — safe to replay
|
|
99
|
+
|
|
100
|
+
Takes no input.
|
|
101
|
+
|
|
102
|
+
## Run it before you have credentials
|
|
103
|
+
|
|
104
|
+
Every operation ships a **faker**, whether or not Google Ads has a sandbox. Set a
|
|
105
|
+
node's mode to `fake` and it returns the shape Google Ads actually publishes — the
|
|
106
|
+
same field names, deterministically — so you can wire the downstream nodes before
|
|
107
|
+
touching an account, a key, or a network.
|
|
108
|
+
|
|
109
|
+
## This repository is generated
|
|
110
|
+
|
|
111
|
+
`provider/` is the source. Everything under `packages/` is emitted from it and
|
|
112
|
+
**must not be hand-edited** — CI regenerates and diffs on every push, and the
|
|
113
|
+
next protocol sync destroys anything it finds. See [`AGENTS.md`](AGENTS.md).
|
|
114
|
+
|
|
115
|
+
## Two namespaces, which do not match on purpose
|
|
116
|
+
|
|
117
|
+
The repo is `github.com/Fancy-Friends/google-ads`; the packages publish under
|
|
118
|
+
`particle-academy`. Nothing derives one from the other — the names come from
|
|
119
|
+
weaver's `friends.json` and nowhere else.
|
|
120
|
+
|
|
121
|
+
## Licence
|
|
122
|
+
|
|
123
|
+
MIT.
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Google Ads
|
|
2
|
+
|
|
3
|
+
Google Ads for [fancy-flow][flow] — as **four imported, versioned packages**, one
|
|
4
|
+
per runtime. Not vendored source: a copy cannot be upgraded, and third-party APIs
|
|
5
|
+
change.
|
|
6
|
+
|
|
7
|
+
[flow]: https://github.com/Particle-Academy/fancy-flow
|
|
8
|
+
|
|
9
|
+
| Runtime | Package | Install |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| Authoring surface (every host) | `@particle-academy/google-ads-ui` | `npm install @particle-academy/google-ads-ui` |
|
|
12
|
+
| Node | `@particle-academy/google-ads-js` | `npm install @particle-academy/google-ads-js` |
|
|
13
|
+
| PHP 8.4+ | `particle-academy/google-ads-php` | `composer require particle-academy/google-ads-php` |
|
|
14
|
+
| Python 3.11+ | `fancy-google-ads` | `pip install fancy-google-ads` |
|
|
15
|
+
|
|
16
|
+
The `ui` package is the editor surface and is React on every host — a PHP or
|
|
17
|
+
Python project installs it *and* its own runtime package, and never the `js` one.
|
|
18
|
+
|
|
19
|
+
## What it costs you
|
|
20
|
+
|
|
21
|
+
One dependency: `@particle-academy/fancy-connector-core` (or
|
|
22
|
+
`particle-academy/fancy-connector-core` on Composer), which the `js` and `php`
|
|
23
|
+
packages pull in themselves. The Python package has **zero** runtime
|
|
24
|
+
dependencies.
|
|
25
|
+
|
|
26
|
+
**No Google Ads SDK.** Plain HTTP, deliberately: a vendor SDK is third-party code
|
|
27
|
+
subject to the kit's full approval bar, and one per provider is hundreds of
|
|
28
|
+
dependencies nobody is tracking.
|
|
29
|
+
|
|
30
|
+
## Setting it up
|
|
31
|
+
|
|
32
|
+
Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
|
|
33
|
+
|
|
34
|
+
### Credentials
|
|
35
|
+
|
|
36
|
+
A Google Ads connection holds 6 values.
|
|
37
|
+
|
|
38
|
+
**Two kinds of value, and mixing them up matters.** A `provider` credential is ONE value for the whole installation — an OAuth app's client secret serves every connected account. An `account` credential is one per connected account. A host that stores the second where it stores the first lets one account's credentials reach another's.
|
|
39
|
+
|
|
40
|
+
| Field | Scope | Secret | Where it comes from |
|
|
41
|
+
|---|---|---|---|
|
|
42
|
+
| **OAuth client ID** | per installation | not secret | The Google Cloud OAuth client shared by the installation. |
|
|
43
|
+
| **OAuth client secret** | per installation | **secret** | The matching Google Cloud OAuth client secret. |
|
|
44
|
+
| **Developer token** | per installation | **secret** | The 22-character Google Ads API developer token from the manager account's API Center. Google says to treat it like a password; one token identifies the installed application. |
|
|
45
|
+
| **Access token** | per connected account | **secret** | The connected Google user's one-hour OAuth access token. |
|
|
46
|
+
| **Refresh token** | per connected account | **secret** | The reusable offline token used to replace expired access tokens. |
|
|
47
|
+
| **Manager customer ID** *(optional)* | per connected account | not secret | Optional. The manager account's 10-digit customer ID without hyphens. Required when the OAuth user reaches a client through that manager; omit it for direct access. |
|
|
48
|
+
|
|
49
|
+
Every request carries `developer-token` and `login-customer-id` *(when set)* alongside the primary authorization, filled from the credentials above.
|
|
50
|
+
|
|
51
|
+
### Authorising
|
|
52
|
+
|
|
53
|
+
Google Ads uses OAuth2 (authorization_code). The package DECLARES the exchange; the HOST performs it — a consent screen needs a browser, a redirect URI and somewhere to persist the result, and all three belong to the host.
|
|
54
|
+
|
|
55
|
+
- **Authorize URL** — https://accounts.google.com/o/oauth2/v2/auth
|
|
56
|
+
- **Token URL** — https://oauth2.googleapis.com/token
|
|
57
|
+
- **Scopes** — `https://www.googleapis.com/auth/adwords`
|
|
58
|
+
- **Access token lifetime** — 3600 seconds (1 hours). A host that never refreshes works all afternoon and is broken by morning.
|
|
59
|
+
|
|
60
|
+
The refresh tokens do **not** rotate: the same one is reusable, so a refresh may safely be retried and may run concurrently. Stated rather than assumed, because the opposite — a provider that spends the token and revokes the grant on a replay — looks identical until it happens.
|
|
61
|
+
|
|
62
|
+
### The estate
|
|
63
|
+
|
|
64
|
+
Google Ads has a test estate on the same host, reached with credentials from a SEPARATE test account you register. Selecting sandbox mode uses those credentials.
|
|
65
|
+
|
|
66
|
+
> Use a dedicated Google Ads test manager and test client account. Test and production hierarchies cannot interact; test ads never serve or incur cost, but some features such as billing, conversion uploads and serving reports cannot be exercised there.
|
|
67
|
+
|
|
68
|
+
## What it can do
|
|
69
|
+
|
|
70
|
+
### Actions
|
|
71
|
+
|
|
72
|
+
#### `customer_list_accessible` — Accessible Google Ads customers
|
|
73
|
+
|
|
74
|
+
List Google Ads customer resource names directly accessible to the authenticated user. Manager-linked client accounts are not included; query the account hierarchy after choosing a directly accessible manager.
|
|
75
|
+
|
|
76
|
+
`GET /v25/customers:listAccessibleCustomers` · reads only — safe to replay
|
|
77
|
+
|
|
78
|
+
Takes no input.
|
|
79
|
+
|
|
80
|
+
## Run it before you have credentials
|
|
81
|
+
|
|
82
|
+
Every operation ships a **faker**, whether or not Google Ads has a sandbox. Set a
|
|
83
|
+
node's mode to `fake` and it returns the shape Google Ads actually publishes — the
|
|
84
|
+
same field names, deterministically — so you can wire the downstream nodes before
|
|
85
|
+
touching an account, a key, or a network.
|
|
86
|
+
|
|
87
|
+
## This repository is generated
|
|
88
|
+
|
|
89
|
+
`provider/` is the source. Everything under `packages/` is emitted from it and
|
|
90
|
+
**must not be hand-edited** — CI regenerates and diffs on every push, and the
|
|
91
|
+
next protocol sync destroys anything it finds. See [`AGENTS.md`](AGENTS.md).
|
|
92
|
+
|
|
93
|
+
## Two namespaces, which do not match on purpose
|
|
94
|
+
|
|
95
|
+
The repo is `github.com/Fancy-Friends/google-ads`; the packages publish under
|
|
96
|
+
`particle-academy`. Nothing derives one from the other — the names come from
|
|
97
|
+
weaver's `friends.json` and nowhere else.
|
|
98
|
+
|
|
99
|
+
## Licence
|
|
100
|
+
|
|
101
|
+
MIT.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.27"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "fancy-google-ads"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Google Ads for Python — the service descriptor, its faker, its webhook verification, and one function per operation. Plain HTTP; no vendor SDK."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
# 3.11 matches fancy-flow-py's floor: 3.10 reaches end of life on 2026-10-31,
|
|
11
|
+
# and a floor that dies before the package's second release is not a floor.
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
license = "MIT"
|
|
14
|
+
license-files = ["LICENSE"]
|
|
15
|
+
authors = [{ name = "Particle Academy" }]
|
|
16
|
+
keywords = ["google_ads", "marketing", "connector", "api", "fancy-flow", "particle-academy"]
|
|
17
|
+
classifiers = [
|
|
18
|
+
"Development Status :: 3 - Alpha",
|
|
19
|
+
"Intended Audience :: Developers",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Software Development :: Libraries",
|
|
25
|
+
"Typing :: Typed",
|
|
26
|
+
]
|
|
27
|
+
|
|
28
|
+
# ZERO runtime dependencies, and that is a design constraint rather than an
|
|
29
|
+
# accident. There is no Python twin of fancy-connector-core to depend on, and a
|
|
30
|
+
# vendor SDK is third-party code subject to the kit's full approval bar — one
|
|
31
|
+
# SDK per provider is hundreds of dependencies nobody is tracking. The HTTP is
|
|
32
|
+
# stdlib `urllib`; the HMAC is stdlib `hmac`.
|
|
33
|
+
dependencies = []
|
|
34
|
+
|
|
35
|
+
[project.urls]
|
|
36
|
+
Homepage = "https://github.com/Fancy-Friends/google-ads"
|
|
37
|
+
Issues = "https://github.com/Fancy-Friends/google-ads/issues"
|
|
38
|
+
Source = "https://github.com/Fancy-Friends/google-ads"
|
|
39
|
+
|
|
40
|
+
[dependency-groups]
|
|
41
|
+
# Not optional. A package with no way to run its tests reports green by doing
|
|
42
|
+
# nothing, which is the one defect that hides itself.
|
|
43
|
+
test = ["pytest>=8.0"]
|
|
44
|
+
lint = ["ruff>=0.16"]
|
|
45
|
+
typecheck = ["mypy>=1.11"]
|
|
46
|
+
dev = [{ include-group = "test" }, { include-group = "lint" }, { include-group = "typecheck" }]
|
|
47
|
+
|
|
48
|
+
[tool.hatch.build.targets.wheel]
|
|
49
|
+
packages = ["src/fancy_google_ads"]
|
|
50
|
+
|
|
51
|
+
[tool.hatch.build.targets.sdist]
|
|
52
|
+
include = ["/src", "/tests", "/README.md", "/CHANGELOG.md", "/LICENSE"]
|
|
53
|
+
|
|
54
|
+
[tool.pytest.ini_options]
|
|
55
|
+
testpaths = ["tests"]
|
|
56
|
+
# importlib mode pairs with src-layout: the working tree is never on sys.path,
|
|
57
|
+
# so the tests exercise the INSTALLED package. Under the default mode a missing
|
|
58
|
+
# py.typed or an unshipped file passes locally and breaks for every user.
|
|
59
|
+
addopts = "--import-mode=importlib -ra"
|
|
60
|
+
|
|
61
|
+
[tool.ruff]
|
|
62
|
+
line-length = 100
|
|
63
|
+
src = ["src", "tests"]
|
|
64
|
+
target-version = "py311"
|
|
65
|
+
|
|
66
|
+
[tool.ruff.lint]
|
|
67
|
+
# `S` — flake8-bandit — is ON, and it is the one addition worth arguing for: this
|
|
68
|
+
# package handles a credential, builds an HMAC, and opens a URL. Security lint
|
|
69
|
+
# belongs on exactly this code.
|
|
70
|
+
#
|
|
71
|
+
# It also makes the two `# noqa: S310` in _runtime.py MEANINGFUL. Without `S`
|
|
72
|
+
# selected, ruff reports them as unused directives (RUF100) and the obvious fix
|
|
73
|
+
# is to delete them — which quietly removes a security annotation because a
|
|
74
|
+
# linter was not looking for it.
|
|
75
|
+
select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "N", "C4", "PT", "S"]
|
|
76
|
+
|
|
77
|
+
[tool.ruff.lint.per-file-ignores]
|
|
78
|
+
# pytest's whole idiom is bare `assert`. S101 would fail every test file.
|
|
79
|
+
"tests/*" = ["S101"]
|
|
80
|
+
|
|
81
|
+
[tool.mypy]
|
|
82
|
+
python_version = "3.11"
|
|
83
|
+
packages = ["fancy_google_ads"]
|
|
84
|
+
mypy_path = "src"
|
|
85
|
+
strict = true
|
|
86
|
+
disallow_any_expr = false
|
|
87
|
+
disallow_any_explicit = false
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/manifest.json by weaver's generator.
|
|
4
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
5
|
+
# being rejected, because it works until it silently does not. Fix
|
|
6
|
+
# provider/manifest.json (or weaver's template/) and regenerate:
|
|
7
|
+
#
|
|
8
|
+
# npm run provider -- google_ads
|
|
9
|
+
|
|
10
|
+
"""Google Ads for Python.
|
|
11
|
+
|
|
12
|
+
The service descriptor, its faker, its delivery contract, and one function
|
|
13
|
+
per operation — plain HTTP on the stdlib, no vendor SDK and no runtime
|
|
14
|
+
dependency.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
from ._fake import FakeValues
|
|
20
|
+
from .actions.customer_list_accessible import customer_list_accessible
|
|
21
|
+
from .faker import respond
|
|
22
|
+
from .service import BASE_URLS, CONNECTOR_API_VERSION, REQUIRES, SANDBOX, SERVICE, TITLE, descriptor
|
|
23
|
+
|
|
24
|
+
__version__ = "0.1.0"
|
|
25
|
+
|
|
26
|
+
__all__ = [
|
|
27
|
+
"BASE_URLS",
|
|
28
|
+
"CONNECTOR_API_VERSION",
|
|
29
|
+
"REQUIRES",
|
|
30
|
+
"SANDBOX",
|
|
31
|
+
"SERVICE",
|
|
32
|
+
"TITLE",
|
|
33
|
+
"FakeValues",
|
|
34
|
+
"customer_list_accessible",
|
|
35
|
+
"descriptor",
|
|
36
|
+
"respond",
|
|
37
|
+
]
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/manifest.json (via weaver's
|
|
4
|
+
# template/embed/py/_fake.py) by weaver's generator.
|
|
5
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
6
|
+
# being rejected, because it works until it silently does not. Fix
|
|
7
|
+
# provider/manifest.json (via weaver's template/embed/py/_fake.py) (or
|
|
8
|
+
# weaver's template/) and regenerate:
|
|
9
|
+
#
|
|
10
|
+
# npm run provider -- google_ads
|
|
11
|
+
|
|
12
|
+
"""Deterministic faker values — bit-for-bit with TypeScript and PHP.
|
|
13
|
+
|
|
14
|
+
PROVENANCE — read before editing.
|
|
15
|
+
|
|
16
|
+
This is the SINGLE SOURCE for the Python faker helpers. It exists because
|
|
17
|
+
``fancy-connector-core`` has a TypeScript implementation and a PHP twin and
|
|
18
|
+
**no Python twin at all**, so a generated ``fancy-<provider>`` package has no
|
|
19
|
+
shared runtime to import. Every generated package carries a copy emitted from
|
|
20
|
+
this file, and ``new-provider.mjs --check`` fails CI when a copy differs.
|
|
21
|
+
|
|
22
|
+
The permanent fix is a Python ``fancy-connector-core``. When it exists, this
|
|
23
|
+
file becomes a re-export and every provider picks it up on the next protocol
|
|
24
|
+
sync.
|
|
25
|
+
|
|
26
|
+
## Bit-for-bit identical is the whole point
|
|
27
|
+
|
|
28
|
+
Not "similar": the same FNV-1a seed and the same xorshift32 sequence, so a
|
|
29
|
+
golden fixture asserts the exact faked payload and ALL THREE runtimes have to
|
|
30
|
+
produce it. That turns the faker into a parity test rather than a convenience —
|
|
31
|
+
which matters, because cross-runtime drift does not fail loudly. It completes,
|
|
32
|
+
down one path, with no error.
|
|
33
|
+
|
|
34
|
+
Python integers are unbounded, so every 32-bit operation is masked back into
|
|
35
|
+
range. Dropping one of those masks does not break anything visibly; it just
|
|
36
|
+
makes the runtimes diverge after a few hundred calls, which is the worst
|
|
37
|
+
possible way for this to fail.
|
|
38
|
+
|
|
39
|
+
## Deterministic, and obviously fake
|
|
40
|
+
|
|
41
|
+
Same inputs, same output — always. A faker returning a fresh uuid every call
|
|
42
|
+
cannot be asserted on, so its fixtures degrade to "it did not throw", which is
|
|
43
|
+
the assertion that catches nothing. And the values are obviously synthetic ON
|
|
44
|
+
PURPOSE — ``fake_``-prefixed ids, ``example.test`` hosts, round numbers. Nobody
|
|
45
|
+
should ever look at a faked result and wonder whether it moved real money.
|
|
46
|
+
"""
|
|
47
|
+
|
|
48
|
+
from __future__ import annotations
|
|
49
|
+
|
|
50
|
+
import json
|
|
51
|
+
from datetime import UTC, datetime, timedelta
|
|
52
|
+
from typing import Any
|
|
53
|
+
|
|
54
|
+
MASK = 0xFFFFFFFF
|
|
55
|
+
|
|
56
|
+
# `FakeValues.int` is part of the cross-runtime faker API — `fake.int(min, max)`
|
|
57
|
+
# in TypeScript, PHP and here — so the method keeps that name. Inside the class
|
|
58
|
+
# body it then shadows the builtin, and every LATER annotation reading `int`
|
|
59
|
+
# resolves to the method instead of the type. This alias is what the annotations
|
|
60
|
+
# after it use.
|
|
61
|
+
_Int = int
|
|
62
|
+
|
|
63
|
+
#: The instant every faker counts from. A constant rather than the clock,
|
|
64
|
+
#: because a fixture asserting on ``created`` must not start failing tomorrow.
|
|
65
|
+
FAKE_EPOCH = "2026-01-01T00:00:00.000Z"
|
|
66
|
+
|
|
67
|
+
_FNV_OFFSET = 0x811C9DC5
|
|
68
|
+
_FNV_PRIME = 0x01000193
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
def _stable_json(value: Any) -> str:
|
|
72
|
+
"""Render a value the way ``JSON.stringify`` would, with sorted object keys.
|
|
73
|
+
|
|
74
|
+
Key order must not change a seed. ``json.dumps`` preserves insertion order,
|
|
75
|
+
so ``{a, b}`` and ``{b, a}`` would hash differently and "same inputs, same
|
|
76
|
+
output" would hold only for dicts that happened to be built in the same
|
|
77
|
+
order — the kind of almost-true that survives review and fails in a fixture
|
|
78
|
+
months later.
|
|
79
|
+
"""
|
|
80
|
+
if isinstance(value, dict):
|
|
81
|
+
parts = [
|
|
82
|
+
f"{json.dumps(str(key))}:{_stable_json(item)}"
|
|
83
|
+
for key, item in sorted(value.items(), key=lambda pair: str(pair[0]))
|
|
84
|
+
if item is not ...
|
|
85
|
+
]
|
|
86
|
+
return "{" + ",".join(parts) + "}"
|
|
87
|
+
|
|
88
|
+
if isinstance(value, (list, tuple)):
|
|
89
|
+
return "[" + ",".join(_stable_json(item) for item in value) + "]"
|
|
90
|
+
|
|
91
|
+
# `separators` matters: JavaScript emits no spaces, and a space here would
|
|
92
|
+
# change every seed.
|
|
93
|
+
return json.dumps(value, separators=(",", ":"), ensure_ascii=False)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
def seed_from(*parts: Any) -> int:
|
|
97
|
+
"""FNV-1a over the stable rendering of the parts. Twin of ``seedFrom``."""
|
|
98
|
+
text = "|".join(part if isinstance(part, str) else _stable_json(part) for part in parts)
|
|
99
|
+
|
|
100
|
+
hash_ = _FNV_OFFSET
|
|
101
|
+
# JavaScript hashes UTF-16 code units, so a character outside the BMP
|
|
102
|
+
# contributes two of them. Encoding to UTF-16-LE and reading pairs is what
|
|
103
|
+
# keeps a provider name with an emoji in it seeding identically.
|
|
104
|
+
for unit in _utf16_units(text):
|
|
105
|
+
hash_ ^= unit
|
|
106
|
+
hash_ = (hash_ * _FNV_PRIME) & MASK
|
|
107
|
+
|
|
108
|
+
return hash_
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
def _utf16_units(text: str) -> list[int]:
|
|
112
|
+
raw = text.encode("utf-16-le")
|
|
113
|
+
|
|
114
|
+
return [raw[i] | (raw[i + 1] << 8) for i in range(0, len(raw), 2)]
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
def seed_for_call(service: str, operation: str, config: dict[str, Any] | None) -> int:
|
|
118
|
+
"""The seed for one faked call: service, operation, and the caller's config."""
|
|
119
|
+
return seed_from(service, operation, config or {})
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
class FakeValues:
|
|
123
|
+
"""Deterministic value helpers handed to a faker.
|
|
124
|
+
|
|
125
|
+
Small on purpose. A faker's job is to return the SHAPE the provider returns
|
|
126
|
+
— the field names a downstream node will reference — not to simulate the
|
|
127
|
+
provider's business logic.
|
|
128
|
+
"""
|
|
129
|
+
|
|
130
|
+
def __init__(self, seed: int) -> None:
|
|
131
|
+
masked = seed & MASK
|
|
132
|
+
self._state = masked if masked != 0 else 0x9E3779B9
|
|
133
|
+
|
|
134
|
+
def _next(self) -> int:
|
|
135
|
+
"""xorshift32, matching the JS generator step for step."""
|
|
136
|
+
state = self._state
|
|
137
|
+
state ^= (state << 13) & MASK
|
|
138
|
+
state &= MASK
|
|
139
|
+
state ^= state >> 17
|
|
140
|
+
state ^= (state << 5) & MASK
|
|
141
|
+
state &= MASK
|
|
142
|
+
self._state = state
|
|
143
|
+
|
|
144
|
+
return state
|
|
145
|
+
|
|
146
|
+
def hex(self, length: _Int) -> str:
|
|
147
|
+
"""A stable lowercase hex string of ``length`` characters."""
|
|
148
|
+
out = ""
|
|
149
|
+
while len(out) < length:
|
|
150
|
+
out += format(self._next(), "08x")
|
|
151
|
+
|
|
152
|
+
return out[:length]
|
|
153
|
+
|
|
154
|
+
def id(self, prefix: str) -> str:
|
|
155
|
+
"""A stable id with the provider's usual prefix: ``id("ch")`` -> ``ch_fake_1a2b3c``."""
|
|
156
|
+
return f"{prefix}_fake_{self.hex(12)}"
|
|
157
|
+
|
|
158
|
+
def int(self, minimum: int, maximum: int) -> int:
|
|
159
|
+
"""A stable integer in ``[minimum, maximum]``."""
|
|
160
|
+
return minimum + (self._next() % max(1, maximum - minimum + 1))
|
|
161
|
+
|
|
162
|
+
def pick(self, options: list[Any]) -> Any:
|
|
163
|
+
"""Pick a stable element of a list."""
|
|
164
|
+
return options[self._next() % len(options)]
|
|
165
|
+
|
|
166
|
+
def timestamp(self, offset_seconds: _Int = 0) -> str:
|
|
167
|
+
"""A fixed ISO-8601 instant, offset by whole seconds. Never ``now()``."""
|
|
168
|
+
base = datetime(2026, 1, 1, tzinfo=UTC) + timedelta(seconds=offset_seconds)
|
|
169
|
+
|
|
170
|
+
return base.strftime("%Y-%m-%dT%H:%M:%S") + ".000Z"
|
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/manifest.json (via weaver's
|
|
4
|
+
# template/embed/py/_runtime.py) by weaver's generator.
|
|
5
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
6
|
+
# being rejected, because it works until it silently does not. Fix
|
|
7
|
+
# provider/manifest.json (via weaver's template/embed/py/_runtime.py) (or
|
|
8
|
+
# weaver's template/) and regenerate:
|
|
9
|
+
#
|
|
10
|
+
# npm run provider -- google_ads
|
|
11
|
+
|
|
12
|
+
"""The minimum connector runtime, in the standard library only.
|
|
13
|
+
|
|
14
|
+
PROVENANCE — read before editing.
|
|
15
|
+
|
|
16
|
+
This is the SINGLE SOURCE for the Python connector runtime, and it is
|
|
17
|
+
deliberately much smaller than ``@particle-academy/fancy-connector-core``. It
|
|
18
|
+
exists because that package has a TypeScript implementation and a PHP twin and
|
|
19
|
+
**no Python twin at all**. Every generated ``fancy-<provider>`` package carries
|
|
20
|
+
a copy emitted from this file, and ``new-provider.mjs --check`` fails CI when a
|
|
21
|
+
copy differs.
|
|
22
|
+
|
|
23
|
+
The permanent fix is a Python ``fancy-connector-core``. When it exists, this
|
|
24
|
+
file becomes a re-export and every provider picks it up on the next protocol
|
|
25
|
+
sync.
|
|
26
|
+
|
|
27
|
+
## What it does, and what it deliberately does not
|
|
28
|
+
|
|
29
|
+
It owns the WIRE: the estate, the auth placement, one call path, the faker
|
|
30
|
+
branch, an idempotency header, and HMAC delivery verification.
|
|
31
|
+
|
|
32
|
+
It owns NO GATE. Approval, liveness, consent, second review and every journal
|
|
33
|
+
belong to the host, because each is enforced in ONE place and every connector
|
|
34
|
+
inherits it from the dispatch path rather than implementing it.
|
|
35
|
+
|
|
36
|
+
Three properties that are asserted rather than promised:
|
|
37
|
+
|
|
38
|
+
- **Nothing here reads the environment.** Credentials are arguments. A package
|
|
39
|
+
that reached for ``os.environ`` would bypass the host's discipline entirely.
|
|
40
|
+
- **Nothing here retries an ambiguous failure.** A request that may or may not
|
|
41
|
+
have arrived is repeated only when the caller has said repeating it is
|
|
42
|
+
harmless.
|
|
43
|
+
- **Nothing here phones home.** No telemetry, no central service, and no URL
|
|
44
|
+
this module contacts that the connector did not name.
|
|
45
|
+
|
|
46
|
+
## Zero dependencies is a constraint, not an accident
|
|
47
|
+
|
|
48
|
+
``urllib`` for HTTP, ``hmac``/``hashlib`` for signatures. A vendor SDK is
|
|
49
|
+
third-party code subject to the kit's full approval bar, and one SDK per
|
|
50
|
+
provider is hundreds of dependencies nobody is tracking.
|
|
51
|
+
"""
|
|
52
|
+
|
|
53
|
+
from __future__ import annotations
|
|
54
|
+
|
|
55
|
+
import hashlib
|
|
56
|
+
import hmac
|
|
57
|
+
import json
|
|
58
|
+
import time
|
|
59
|
+
import urllib.error
|
|
60
|
+
import urllib.parse
|
|
61
|
+
import urllib.request
|
|
62
|
+
from collections.abc import Callable
|
|
63
|
+
from dataclasses import dataclass, field
|
|
64
|
+
from typing import Any, Literal
|
|
65
|
+
|
|
66
|
+
Mode = Literal["fake", "sandbox", "live", "auto"]
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
class ConnectorError(Exception):
|
|
70
|
+
"""Something went wrong talking to the provider."""
|
|
71
|
+
|
|
72
|
+
def __init__(self, message: str, *, status: int | None = None, retryable: bool = False) -> None:
|
|
73
|
+
super().__init__(message)
|
|
74
|
+
self.status = status
|
|
75
|
+
#: Whether repeating this exact request is known to be harmless. Defaults
|
|
76
|
+
#: to False: an ambiguous failure is only retryable when the caller said
|
|
77
|
+
#: so, not when a retry would be convenient.
|
|
78
|
+
self.retryable = retryable
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
class ConnectorConfigError(ConnectorError):
|
|
82
|
+
"""The call was refused before anything was sent. Nothing was attempted."""
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
class ConnectorAuthError(ConnectorError):
|
|
86
|
+
"""The provider rejected the credential."""
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
class ConnectorModeError(ConnectorError):
|
|
90
|
+
"""The requested estate does not exist for this provider."""
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
@dataclass
|
|
94
|
+
class PreparedRequest:
|
|
95
|
+
"""An outgoing request, after the service descriptor has authorised it."""
|
|
96
|
+
|
|
97
|
+
method: str
|
|
98
|
+
url: str
|
|
99
|
+
headers: dict[str, str] = field(default_factory=dict)
|
|
100
|
+
query: dict[str, str] = field(default_factory=dict)
|
|
101
|
+
body: bytes | None = None
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
@dataclass
|
|
105
|
+
class ServiceDescriptor:
|
|
106
|
+
"""A provider, as one value shared by every one of its operations."""
|
|
107
|
+
|
|
108
|
+
service: str
|
|
109
|
+
title: str
|
|
110
|
+
sandbox: str
|
|
111
|
+
base_urls: dict[str, str]
|
|
112
|
+
requires: list[str]
|
|
113
|
+
authorize: Callable[[dict[str, str | None], PreparedRequest, str], None]
|
|
114
|
+
faker: Callable[[str, dict[str, Any]], Any]
|
|
115
|
+
idempotency_header: str | None = None
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
@dataclass
|
|
119
|
+
class CallResult:
|
|
120
|
+
"""What one call produced, and which estate produced it."""
|
|
121
|
+
|
|
122
|
+
mode: str
|
|
123
|
+
connection: str | None
|
|
124
|
+
data: Any
|
|
125
|
+
status: int | None = None
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
@dataclass
|
|
129
|
+
class Verification:
|
|
130
|
+
"""Whether an inbound delivery can be trusted, and why not when it cannot."""
|
|
131
|
+
|
|
132
|
+
ok: bool
|
|
133
|
+
reason: str | None = None
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
#: The estate kinds a ``sandbox`` mode can actually point at. Mirrors the
|
|
137
|
+
#: TypeScript ``sandboxIsSelectable``.
|
|
138
|
+
SELECTABLE_SANDBOX = ("credential", "base-url", "separate-account")
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
def resolve_mode(descriptor: ServiceDescriptor, requested: Mode) -> str:
|
|
142
|
+
"""Turn ``auto`` into a real estate, and refuse one the provider does not have.
|
|
143
|
+
|
|
144
|
+
A provider with no sandbox resolving ``sandbox`` to ``live`` would be the
|
|
145
|
+
worst possible reading: it moves real money while the caller believes it did
|
|
146
|
+
not.
|
|
147
|
+
"""
|
|
148
|
+
if requested == "auto":
|
|
149
|
+
return "fake"
|
|
150
|
+
|
|
151
|
+
if requested == "sandbox" and descriptor.sandbox not in SELECTABLE_SANDBOX:
|
|
152
|
+
raise ConnectorModeError(
|
|
153
|
+
f'{descriptor.service}: sandbox was requested but this provider\'s estate is '
|
|
154
|
+
f'"{descriptor.sandbox}", which cannot be selected. Use "fake" to design against '
|
|
155
|
+
f'a shaped response, or "live" deliberately.'
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
return requested
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
def call(
|
|
162
|
+
descriptor: ServiceDescriptor,
|
|
163
|
+
*,
|
|
164
|
+
operation: str,
|
|
165
|
+
method: str,
|
|
166
|
+
path: str,
|
|
167
|
+
form: dict[str, Any] | None = None,
|
|
168
|
+
json_body: Any | None = None,
|
|
169
|
+
query: dict[str, Any] | None = None,
|
|
170
|
+
config: dict[str, Any] | None = None,
|
|
171
|
+
credentials: dict[str, str | None] | None = None,
|
|
172
|
+
mode: Mode = "auto",
|
|
173
|
+
connection_id: str | None = None,
|
|
174
|
+
idempotency_key: str | None = None,
|
|
175
|
+
idempotent: bool = False,
|
|
176
|
+
attempts: int = 3,
|
|
177
|
+
timeout: float = 30.0,
|
|
178
|
+
transport: Callable[[PreparedRequest], tuple[int, str]] | None = None,
|
|
179
|
+
) -> CallResult:
|
|
180
|
+
"""Make one call, or fake one.
|
|
181
|
+
|
|
182
|
+
``fake`` mode never touches the network, so a connector is runnable before an
|
|
183
|
+
account, a key or a provider that is up.
|
|
184
|
+
"""
|
|
185
|
+
resolved = resolve_mode(descriptor, mode)
|
|
186
|
+
config = config or {}
|
|
187
|
+
|
|
188
|
+
if resolved == "fake":
|
|
189
|
+
from ._fake import FakeValues, seed_for_call
|
|
190
|
+
|
|
191
|
+
fake = FakeValues(seed_for_call(descriptor.service, operation, config))
|
|
192
|
+
|
|
193
|
+
return CallResult(
|
|
194
|
+
mode="fake",
|
|
195
|
+
connection=connection_id,
|
|
196
|
+
data=descriptor.faker(operation, {"config": config, "fake": fake}),
|
|
197
|
+
)
|
|
198
|
+
|
|
199
|
+
base = descriptor.base_urls.get(resolved)
|
|
200
|
+
if not base:
|
|
201
|
+
raise ConnectorModeError(f"{descriptor.service}: no base URL for mode \"{resolved}\".")
|
|
202
|
+
|
|
203
|
+
credentials = credentials or {}
|
|
204
|
+
missing = [key for key in descriptor.requires if not credentials.get(key)]
|
|
205
|
+
if missing:
|
|
206
|
+
raise ConnectorConfigError(
|
|
207
|
+
f"{descriptor.service}: the connection is missing {', '.join(missing)}."
|
|
208
|
+
)
|
|
209
|
+
|
|
210
|
+
request = PreparedRequest(method=method, url=base.rstrip("/") + path)
|
|
211
|
+
request.query = {k: str(v) for k, v in (query or {}).items() if v is not None}
|
|
212
|
+
|
|
213
|
+
if form is not None:
|
|
214
|
+
request.body = urllib.parse.urlencode(
|
|
215
|
+
{k: v for k, v in form.items() if v is not None}, doseq=False
|
|
216
|
+
).encode()
|
|
217
|
+
request.headers["Content-Type"] = "application/x-www-form-urlencoded"
|
|
218
|
+
elif json_body is not None:
|
|
219
|
+
request.body = json.dumps(json_body, separators=(",", ":")).encode()
|
|
220
|
+
request.headers["Content-Type"] = "application/json"
|
|
221
|
+
|
|
222
|
+
if idempotency_key and descriptor.idempotency_header:
|
|
223
|
+
request.headers[descriptor.idempotency_header] = idempotency_key
|
|
224
|
+
|
|
225
|
+
descriptor.authorize(credentials, request, resolved)
|
|
226
|
+
|
|
227
|
+
send = transport or _urllib_transport
|
|
228
|
+
last: ConnectorError | None = None
|
|
229
|
+
|
|
230
|
+
for attempt in range(1, max(1, attempts) + 1):
|
|
231
|
+
try:
|
|
232
|
+
status, text = send(_with_query(request, timeout))
|
|
233
|
+
except OSError as error: # DNS, connection reset, timeout
|
|
234
|
+
# Nobody can tell whether this arrived. Repeating is safe only when
|
|
235
|
+
# the caller has said so or the request carries an idempotency key.
|
|
236
|
+
last = ConnectorError(
|
|
237
|
+
f"{descriptor.service}: {operation} did not complete ({error}).",
|
|
238
|
+
retryable=idempotent or bool(idempotency_key),
|
|
239
|
+
)
|
|
240
|
+
else:
|
|
241
|
+
if 200 <= status < 300:
|
|
242
|
+
return CallResult(
|
|
243
|
+
mode=resolved,
|
|
244
|
+
connection=connection_id,
|
|
245
|
+
data=json.loads(text) if text else None,
|
|
246
|
+
status=status,
|
|
247
|
+
)
|
|
248
|
+
|
|
249
|
+
last = _classify(descriptor.service, operation, status, text)
|
|
250
|
+
|
|
251
|
+
if not last.retryable or attempt == attempts:
|
|
252
|
+
raise last
|
|
253
|
+
|
|
254
|
+
time.sleep(min(2 ** (attempt - 1), 8))
|
|
255
|
+
|
|
256
|
+
raise last if last else ConnectorError(f"{descriptor.service}: {operation} failed.")
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
def _with_query(request: PreparedRequest, timeout: float) -> PreparedRequest:
|
|
260
|
+
if not request.query:
|
|
261
|
+
return request
|
|
262
|
+
|
|
263
|
+
separator = "&" if "?" in request.url else "?"
|
|
264
|
+
joined = PreparedRequest(
|
|
265
|
+
method=request.method,
|
|
266
|
+
url=f"{request.url}{separator}{urllib.parse.urlencode(request.query)}",
|
|
267
|
+
headers=dict(request.headers),
|
|
268
|
+
body=request.body,
|
|
269
|
+
)
|
|
270
|
+
joined.headers.setdefault("_timeout", str(timeout))
|
|
271
|
+
|
|
272
|
+
return joined
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
def _urllib_transport(request: PreparedRequest) -> tuple[int, str]:
|
|
276
|
+
timeout = float(request.headers.pop("_timeout", "30"))
|
|
277
|
+
raw = urllib.request.Request( # noqa: S310 — the URL comes from the descriptor
|
|
278
|
+
request.url,
|
|
279
|
+
data=request.body,
|
|
280
|
+
headers=request.headers,
|
|
281
|
+
method=request.method,
|
|
282
|
+
)
|
|
283
|
+
|
|
284
|
+
try:
|
|
285
|
+
with urllib.request.urlopen(raw, timeout=timeout) as response: # noqa: S310
|
|
286
|
+
return response.status, response.read().decode("utf-8", "replace")
|
|
287
|
+
except urllib.error.HTTPError as error:
|
|
288
|
+
return error.code, error.read().decode("utf-8", "replace")
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
def _classify(service: str, operation: str, status: int, body: str) -> ConnectorError:
|
|
292
|
+
"""Separate "it was refused" from "nobody can tell"."""
|
|
293
|
+
message = f"{service}: {operation} failed with {status}. {body[:400]}"
|
|
294
|
+
|
|
295
|
+
if status in (401, 403):
|
|
296
|
+
return ConnectorAuthError(message, status=status)
|
|
297
|
+
if status == 429 or status >= 500:
|
|
298
|
+
# A 5xx or a rate limit is the provider saying "try again", which is a
|
|
299
|
+
# different fact from a 4xx saying "this request is wrong".
|
|
300
|
+
return ConnectorError(message, status=status, retryable=True)
|
|
301
|
+
|
|
302
|
+
return ConnectorError(message, status=status)
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
_ALGORITHMS = {"sha256": hashlib.sha256, "sha1": hashlib.sha1, "sha512": hashlib.sha512}
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
def verify_hmac(
|
|
309
|
+
*,
|
|
310
|
+
raw: str,
|
|
311
|
+
signature: str | None,
|
|
312
|
+
secret: str | None,
|
|
313
|
+
payload: Callable[[str, str | None], str],
|
|
314
|
+
algorithm: str,
|
|
315
|
+
encoding: str = "hex",
|
|
316
|
+
tolerance: int | None = None,
|
|
317
|
+
timestamp: str | None = None,
|
|
318
|
+
now: int | None = None,
|
|
319
|
+
) -> Verification:
|
|
320
|
+
"""Verify one inbound delivery.
|
|
321
|
+
|
|
322
|
+
Refuses rather than accepts on every missing input. That asymmetry is the
|
|
323
|
+
whole safety property: an unverifiable endpoint is a stranger's button for
|
|
324
|
+
starting workflows in your account, and defaulting to "allow" would make
|
|
325
|
+
every misconfiguration into an open door that looks shut.
|
|
326
|
+
|
|
327
|
+
``raw`` must be the body EXACTLY as received. Re-serialised JSON changes key
|
|
328
|
+
order and whitespace and produces a mismatch that looks precisely like a
|
|
329
|
+
wrong secret.
|
|
330
|
+
"""
|
|
331
|
+
if not secret:
|
|
332
|
+
return Verification(False, "no signing secret is configured for this connection")
|
|
333
|
+
if not signature:
|
|
334
|
+
return Verification(False, "the delivery carried no signature")
|
|
335
|
+
|
|
336
|
+
digest = _ALGORITHMS.get(algorithm)
|
|
337
|
+
if digest is None:
|
|
338
|
+
return Verification(False, f'unsupported signature algorithm "{algorithm}"')
|
|
339
|
+
|
|
340
|
+
if tolerance is not None:
|
|
341
|
+
if not timestamp:
|
|
342
|
+
return Verification(
|
|
343
|
+
False, "the delivery carried no timestamp, and this scheme signs one"
|
|
344
|
+
)
|
|
345
|
+
try:
|
|
346
|
+
sent = int(float(timestamp))
|
|
347
|
+
except (TypeError, ValueError):
|
|
348
|
+
return Verification(False, f'the delivery timestamp "{timestamp}" is not a number')
|
|
349
|
+
|
|
350
|
+
current = int(time.time()) if now is None else now
|
|
351
|
+
if abs(current - sent) > tolerance:
|
|
352
|
+
return Verification(
|
|
353
|
+
False,
|
|
354
|
+
f"the delivery is outside the {tolerance}s replay window "
|
|
355
|
+
f"({abs(current - sent)}s old)",
|
|
356
|
+
)
|
|
357
|
+
|
|
358
|
+
computed = hmac.new(secret.encode(), payload(raw, timestamp).encode(), digest)
|
|
359
|
+
expected = computed.hexdigest() if encoding == "hex" else _b64(computed.digest())
|
|
360
|
+
|
|
361
|
+
# Constant time, so a signature cannot be discovered one character at a time.
|
|
362
|
+
if not hmac.compare_digest(expected, signature):
|
|
363
|
+
return Verification(False, "the signature does not match")
|
|
364
|
+
|
|
365
|
+
return Verification(True)
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
def _b64(raw: bytes) -> str:
|
|
369
|
+
import base64
|
|
370
|
+
|
|
371
|
+
return base64.b64encode(raw).decode()
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/actions/ by weaver's generator.
|
|
4
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
5
|
+
# being rejected, because it works until it silently does not. Fix
|
|
6
|
+
# provider/actions/ (or weaver's template/) and regenerate:
|
|
7
|
+
#
|
|
8
|
+
# npm run provider -- google_ads
|
|
9
|
+
|
|
10
|
+
from .customer_list_accessible import customer_list_accessible
|
|
11
|
+
|
|
12
|
+
__all__ = [
|
|
13
|
+
"customer_list_accessible",
|
|
14
|
+
]
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/actions/customer-list-accessible.json by weaver's
|
|
4
|
+
# generator.
|
|
5
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
6
|
+
# being rejected, because it works until it silently does not. Fix
|
|
7
|
+
# provider/actions/customer-list-accessible.json (or weaver's template/) and
|
|
8
|
+
# regenerate:
|
|
9
|
+
#
|
|
10
|
+
# npm run provider -- google_ads
|
|
11
|
+
|
|
12
|
+
"""List Google Ads customer resource names directly accessible to the
|
|
13
|
+
authenticated user. Manager-linked client accounts are not included; query
|
|
14
|
+
the account hierarchy after choosing a directly accessible manager.
|
|
15
|
+
|
|
16
|
+
GET /v25/customers:listAccessibleCustomers —
|
|
17
|
+
https://developers.google.com/google-ads/api/rest/reference/rest/v25/customers/listAccessibleCustomers
|
|
18
|
+
|
|
19
|
+
This describes the request. `call` resolves the connection, picks the
|
|
20
|
+
estate, and either calls Google Ads or calls the faker.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
from __future__ import annotations
|
|
24
|
+
|
|
25
|
+
from typing import Any
|
|
26
|
+
|
|
27
|
+
from .._runtime import CallResult, Mode, call
|
|
28
|
+
from ..service import descriptor
|
|
29
|
+
|
|
30
|
+
OPERATION = "customer_list_accessible"
|
|
31
|
+
METHOD = "GET"
|
|
32
|
+
PATH = "/v25/customers:listAccessibleCustomers"
|
|
33
|
+
SIDE_EFFECTS = "none"
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def body(config: dict[str, Any]) -> dict[str, Any]:
|
|
37
|
+
"""Build the form body for one call, failing loudly and specifically."""
|
|
38
|
+
out: dict[str, Any] = {}
|
|
39
|
+
|
|
40
|
+
return out
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def customer_list_accessible(
|
|
44
|
+
config: dict[str, Any],
|
|
45
|
+
*,
|
|
46
|
+
credentials: dict[str, str | None] | None = None,
|
|
47
|
+
mode: Mode = "auto",
|
|
48
|
+
connection_id: str | None = None,
|
|
49
|
+
attempts: int = 3,
|
|
50
|
+
) -> CallResult:
|
|
51
|
+
"""List Google Ads customer resource names directly accessible to the authenticated user.
|
|
52
|
+
Manager-linked client accounts are not included; query the account hierarchy after choosing a
|
|
53
|
+
directly accessible manager.
|
|
54
|
+
"""
|
|
55
|
+
return call(
|
|
56
|
+
descriptor(),
|
|
57
|
+
operation=OPERATION,
|
|
58
|
+
method=METHOD,
|
|
59
|
+
path=PATH,
|
|
60
|
+
form=body(config),
|
|
61
|
+
config=config,
|
|
62
|
+
credentials=credentials,
|
|
63
|
+
mode=mode,
|
|
64
|
+
connection_id=connection_id,
|
|
65
|
+
attempts=attempts,
|
|
66
|
+
)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/fixtures/ by weaver's generator.
|
|
4
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
5
|
+
# being rejected, because it works until it silently does not. Fix
|
|
6
|
+
# provider/fixtures/ (or weaver's template/) and regenerate:
|
|
7
|
+
#
|
|
8
|
+
# npm run provider -- google_ads
|
|
9
|
+
|
|
10
|
+
"""The Google Ads faker.
|
|
11
|
+
|
|
12
|
+
Bit-for-bit identical to the TypeScript and PHP fakers: the same FNV-1a seed
|
|
13
|
+
and the same xorshift32 sequence, so a golden fixture asserts the exact
|
|
14
|
+
faked payload and ALL THREE runtimes have to produce it. That turns the
|
|
15
|
+
faker into a parity test rather than a convenience — which matters, because
|
|
16
|
+
cross-runtime drift does not fail loudly. It completes, down one path, with
|
|
17
|
+
no error.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
from __future__ import annotations
|
|
21
|
+
|
|
22
|
+
from typing import Any
|
|
23
|
+
|
|
24
|
+
from ._fake import FakeValues
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def _customer_list_accessible(config: dict[str, Any], fake: FakeValues) -> Any:
|
|
28
|
+
return {
|
|
29
|
+
"resourceNames": [
|
|
30
|
+
"customers/1234567890",
|
|
31
|
+
"customers/9876543210",
|
|
32
|
+
],
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def respond(operation: str, request: dict[str, Any]) -> Any:
|
|
37
|
+
"""Dispatch to the fixture for one operation."""
|
|
38
|
+
config: dict[str, Any] = request.get("config") or {}
|
|
39
|
+
fake: FakeValues = request["fake"]
|
|
40
|
+
|
|
41
|
+
if operation == "customer_list_accessible":
|
|
42
|
+
return _customer_list_accessible(config, fake)
|
|
43
|
+
|
|
44
|
+
# A faker asked for an operation it has no shape for must SAY so. Making
|
|
45
|
+
# something up would produce a green run whose output silently has none of
|
|
46
|
+
# the fields the author is about to reference.
|
|
47
|
+
raise ValueError(
|
|
48
|
+
f'google_ads: no fake response is defined for "{operation}". '
|
|
49
|
+
"Add a fixture under provider/fixtures/ and regenerate — a connector without a faker "
|
|
50
|
+
"cannot be developed against, tested, or demonstrated."
|
|
51
|
+
)
|
|
File without changes
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/manifest.json by weaver's generator.
|
|
4
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
5
|
+
# being rejected, because it works until it silently does not. Fix
|
|
6
|
+
# provider/manifest.json (or weaver's template/) and regenerate:
|
|
7
|
+
#
|
|
8
|
+
# npm run provider -- google_ads
|
|
9
|
+
|
|
10
|
+
"""Google Ads, as one service descriptor shared by every Google Ads operation.
|
|
11
|
+
|
|
12
|
+
The Python twin of the js and php packages' service modules.
|
|
13
|
+
|
|
14
|
+
## The sandbox trap, written down where it is used
|
|
15
|
+
|
|
16
|
+
Use a dedicated Google Ads test manager and test client account. Test and
|
|
17
|
+
production hierarchies cannot interact; test ads never serve or incur cost,
|
|
18
|
+
but some features such as billing, conversion uploads and serving reports
|
|
19
|
+
cannot be exercised there.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
from __future__ import annotations
|
|
23
|
+
|
|
24
|
+
from ._runtime import PreparedRequest, ServiceDescriptor
|
|
25
|
+
from .faker import respond
|
|
26
|
+
|
|
27
|
+
# The connector API version this package was GENERATED against. A literal,
|
|
28
|
+
# never imported: an imported constant lets an upgrade rewrite the very claim
|
|
29
|
+
# it exists to detect, after which the copy agrees with itself forever.
|
|
30
|
+
CONNECTOR_API_VERSION = 1
|
|
31
|
+
|
|
32
|
+
SERVICE = "google_ads"
|
|
33
|
+
TITLE = "Google Ads"
|
|
34
|
+
SANDBOX = "separate-account"
|
|
35
|
+
BASE_URLS = {
|
|
36
|
+
"live": "https://googleads.googleapis.com",
|
|
37
|
+
"sandbox": "https://googleads.googleapis.com",
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
"""Credential keys a remote call cannot proceed without."""
|
|
41
|
+
REQUIRES = [
|
|
42
|
+
"accessToken",
|
|
43
|
+
"refreshToken",
|
|
44
|
+
"clientId",
|
|
45
|
+
"clientSecret",
|
|
46
|
+
"developerToken",
|
|
47
|
+
"loginCustomerId",
|
|
48
|
+
]
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
def authorize(
|
|
52
|
+
credentials: dict[str, str | None],
|
|
53
|
+
request: PreparedRequest,
|
|
54
|
+
mode: str,
|
|
55
|
+
) -> None:
|
|
56
|
+
"""Apply Google Ads's auth scheme to an outgoing request.
|
|
57
|
+
|
|
58
|
+
Google Ads requires the OAuth bearer AND the developer-token header on
|
|
59
|
+
ordinary calls. developerToken identifies the installed API application;
|
|
60
|
+
loginCustomerId selects the manager account only when access to a client is
|
|
61
|
+
through that manager. An absent optional manager id omits the header rather
|
|
62
|
+
than sending it empty.
|
|
63
|
+
"""
|
|
64
|
+
request.headers["Authorization"] = f"Bearer {credentials.get('accessToken') or ''}"
|
|
65
|
+
|
|
66
|
+
request.headers["developer-token"] = str(credentials.get("developerToken") or "")
|
|
67
|
+
if credentials.get("loginCustomerId"):
|
|
68
|
+
request.headers["login-customer-id"] = str(credentials["loginCustomerId"])
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
def descriptor() -> ServiceDescriptor:
|
|
72
|
+
"""The Google Ads service, for the Python runtime."""
|
|
73
|
+
return ServiceDescriptor(
|
|
74
|
+
service=SERVICE,
|
|
75
|
+
title=TITLE,
|
|
76
|
+
sandbox=SANDBOX,
|
|
77
|
+
base_urls=BASE_URLS,
|
|
78
|
+
requires=REQUIRES,
|
|
79
|
+
authorize=authorize,
|
|
80
|
+
faker=respond,
|
|
81
|
+
idempotency_header=None,
|
|
82
|
+
)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# GENERATED FILE — do not edit.
|
|
2
|
+
#
|
|
3
|
+
# Emitted from provider/fixtures/ by weaver's generator.
|
|
4
|
+
# A hand-edit here is destroyed by the next protocol sync, which is worse than
|
|
5
|
+
# being rejected, because it works until it silently does not. Fix
|
|
6
|
+
# provider/fixtures/ (or weaver's template/) and regenerate:
|
|
7
|
+
#
|
|
8
|
+
# npm run provider -- google_ads
|
|
9
|
+
|
|
10
|
+
"""The golden fixtures — the SAME values the TypeScript and PHP packages
|
|
11
|
+
assert.
|
|
12
|
+
|
|
13
|
+
Bit-for-bit identical is the claim, and this is what checks it for Python.
|
|
14
|
+
Cross-runtime drift does not fail loudly on its own: it completes, down one
|
|
15
|
+
path, with no error.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
import pytest
|
|
19
|
+
|
|
20
|
+
from fancy_google_ads._fake import FakeValues, seed_for_call
|
|
21
|
+
from fancy_google_ads.faker import respond
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def test_customer_list_accessible_fakes_the_published_shape() -> None:
|
|
25
|
+
config = {}
|
|
26
|
+
fake = FakeValues(seed_for_call("google_ads", "customer_list_accessible", config))
|
|
27
|
+
|
|
28
|
+
faked = respond("customer_list_accessible", {"config": config, "fake": fake})
|
|
29
|
+
|
|
30
|
+
assert faked == {
|
|
31
|
+
"resourceNames": [
|
|
32
|
+
"customers/1234567890",
|
|
33
|
+
"customers/9876543210",
|
|
34
|
+
],
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def test_an_operation_with_no_fixture_raises_rather_than_inventing_a_shape() -> None:
|
|
39
|
+
fake = FakeValues(seed_for_call("google_ads", "no_such_operation", {}))
|
|
40
|
+
|
|
41
|
+
with pytest.raises(ValueError, match="no fake response"):
|
|
42
|
+
respond("no_such_operation", {"config": {}, "fake": fake})
|