pubsub-fxmacrodata 0.1.0__py3-none-any.whl

fxmacrodata_pubsub/__init__.py

@@ -0,0 +1,157 @@
+"""Publish public FXMacroData responses to a customer-owned Google Cloud Pub/Sub topic."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import hashlib
+import json
+import math
+import re
+from typing import Any
+
+from fxmacrodata_platform_core import read
+
+__version__ = "0.1.0"
+
+COLUMNS = (
+    "operation", "source_url", "record_id", "currency", "indicator", "date",
+    "announcement_datetime", "value", "value_text", "record_json", "response_json",
+    "content_hash",
+)
+ATTRIBUTES = ("operation", "record_id", "content_hash", "source_url")
+MAX_MESSAGE_BYTES = 16 * 1024 * 1024
+_TOPIC = re.compile(
+    r"projects/[a-z][a-z0-9-]{4,28}[a-z0-9]/topics/(?!goog)[A-Za-z][A-Za-z0-9._~%+-]{2,254}\Z"
+)
+
+
+class PublishError(RuntimeError):
+    """A destination publish failed; inspect the destination before retrying."""
+
+
+@dataclass(frozen=True)
+class PublishResult:
+    destination: str
+    messages: int
+    batches: int
+
+
+def _topic(topic: str) -> str:
+    if not isinstance(topic, str) or not _TOPIC.fullmatch(topic):
+        raise ValueError("destination must be a full topic path: projects/<project>/topics/<topic>")
+    return topic
+
+
+def _bounds(batch_size: int, max_message_bytes: int) -> None:
+    if isinstance(batch_size, bool) or not isinstance(batch_size, int) or not 1 <= batch_size <= 10000:
+        raise ValueError("batch_size must be an integer between 1 and 10000")
+    if isinstance(max_message_bytes, bool) or not isinstance(max_message_bytes, int) or not 1 <= max_message_bytes <= MAX_MESSAGE_BYTES:
+        raise ValueError(f"max_message_bytes must be an integer between 1 and {MAX_MESSAGE_BYTES}")
+
+
+def _rows(batch: Any) -> list[dict[str, Any]]:
+    rows = []
+    for source in batch.rows():
+        row = {name: source.get(name) for name in COLUMNS[:-1]}
+        if not isinstance(row["operation"], str) or not isinstance(row["record_id"], str):
+            raise ValueError("every row requires string operation and record_id")
+        for name, value in row.items():
+            if name == "value":
+                if value is not None and (
+                    isinstance(value, bool) or not isinstance(value, (int, float)) or
+                    not math.isfinite(value)
+                ):
+                    raise ValueError("value must be a finite number or null")
+            elif value is not None and not isinstance(value, str):
+                raise ValueError(f"{name} must be a string or null")
+        encoded = json.dumps(row, sort_keys=True, separators=(",", ":"), ensure_ascii=False)
+        row["content_hash"] = hashlib.sha256(encoded.encode("utf-8")).hexdigest()
+        rows.append(row)
+    return rows
+
+
+def message_key(row: dict[str, Any]) -> str:
+    """Return the idempotency key consumers can use to drop redelivered messages."""
+    return f"{row['operation']}:{row['record_id']}:{row['content_hash']}"
+
+
+def encode_message(row: dict[str, Any]) -> bytes:
+    """Return the canonical UTF-8 JSON body for one envelope row."""
+    return json.dumps(row, sort_keys=True, separators=(",", ":"), ensure_ascii=False,
+                      allow_nan=False).encode("utf-8")
+
+
+def _attributes(row: dict[str, Any]) -> dict[str, str]:
+    return {name: row[name] for name in ATTRIBUTES if row.get(name) is not None}
+
+
+def _blocks(rows: list[dict[str, Any]], batch_size: int,
+            max_message_bytes: int) -> list[list[tuple[str, bytes, dict[str, str]]]]:
+    _bounds(batch_size, max_message_bytes)
+    output: list[list[tuple[str, bytes, dict[str, str]]]] = []
+    block: list[tuple[str, bytes, dict[str, str]]] = []
+    for row in rows:
+        body = encode_message(row)
+        if len(body) > max_message_bytes:
+            raise ValueError("one envelope exceeds max_message_bytes; narrow the source date range")
+        if len(block) >= batch_size:
+            output.append(block)
+            block = []
+        block.append((message_key(row), body, _attributes(row)))
+    if block:
+        output.append(block)
+    return output
+
+
+def publish(batch: Any, client: Any, destination: str, *, batch_size: int = 1000,
+            max_message_bytes: int = MAX_MESSAGE_BYTES, ordered: bool = True) -> PublishResult:
+    """Publish one message per envelope row through PublisherClient.publish.
+
+    Each message carries the canonical JSON body, the attributes `operation`,
+    `record_id`, `content_hash` and `source_url`, and (when `ordered` is true)
+    an ordering key of `operation:record_id:content_hash`. Futures are awaited
+    per block, so a block is complete before the next block starts. Delivery
+    is at-least-once; a failed block raises PublishError and is not retried.
+    """
+    topic = _topic(destination)
+    if not isinstance(ordered, bool):
+        raise ValueError("ordered must be a boolean")
+    blocks = _blocks(_rows(batch), batch_size, max_message_bytes)
+    count, messages = 0, 0
+    for block in blocks:
+        try:
+            futures = [
+                client.publish(topic, body, ordering_key=key if ordered else "", **attributes)
+                for key, body, attributes in block
+            ]
+            for future in futures:
+                future.result()
+        except Exception:
+            raise PublishError(
+                f"Pub/Sub publish block {count + 1} failed; earlier blocks may be delivered. "
+                "Inspect the destination and deduplicate by ordering key on retry."
+            ) from None
+        count += 1
+        messages += len(block)
+    return PublishResult(topic, messages, count)
+
+
+def publish_operation(operation: str, args: dict[str, Any] | None, client: Any, destination: str,
+                      *, api_key_env: str | None = None, complete_history: bool = True,
+                      max_pages: int = 10000, client_factory: Any = None,
+                      batch_size: int = 1000, max_message_bytes: int = MAX_MESSAGE_BYTES,
+                      ordered: bool = True) -> PublishResult:
+    """Read one public operation and publish its complete response envelope."""
+    _topic(destination)
+    _bounds(batch_size, max_message_bytes)
+    if not isinstance(ordered, bool):
+        raise ValueError("ordered must be a boolean")
+    batch = read(operation, args, api_key_env=api_key_env,
+                 complete_history=complete_history, max_pages=max_pages,
+                 client_factory=client_factory)
+    return publish(batch, client, destination, batch_size=batch_size,
+                   max_message_bytes=max_message_bytes, ordered=ordered)
+
+
+__all__ = ["ATTRIBUTES", "COLUMNS", "MAX_MESSAGE_BYTES", "PublishError", "PublishResult",
+           "encode_message", "message_key", "publish", "publish_operation"]

pubsub_fxmacrodata-0.1.0.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: pubsub-fxmacrodata
+Version: 0.1.0
+Summary: Publish public FXMacroData responses to Google Cloud Pub/Sub
+License-Expression: MIT
+Project-URL: Documentation, https://fxmacrodata.com/documentation/reference?utm_source=pypi&utm_medium=referral&utm_campaign=pubsub-fxmacrodata&utm_content=package
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fxmacrodata-platform-core==0.1.0
+Requires-Dist: google-cloud-pubsub<3,>=2.41.0
+Provides-Extra: test
+Requires-Dist: pytest<9,>=8; extra == "test"
+Dynamic: license-file
+
+# FXMacroData for Google Cloud Pub/Sub
+
+Publish FXMacroData public responses to a Pub/Sub topic with the official
+`google-cloud-pubsub` Python client. Fan macro announcements out to your own
+subscribers while retaining the source payload and revision metadata.
+
+[FXMacroData documentation](https://fxmacrodata.com/documentation/reference?utm_source=github&utm_medium=referral&utm_campaign=pubsub-fxmacrodata&utm_content=readme)
+
+## Install and connect
+
+Requires Python 3.10 or later. Install this package and its adjacent public
+client dependencies from the distribution supplied to you:
+
+```sh
+python -m pip install /path/to/fxmacrodata-public-client /path/to/fxmacrodata-platform-core /path/to/pubsub-fxmacrodata
+```
+
+Authenticate the Pub/Sub client with Application Default Credentials or the
+service account your administrator provides. Then publish to a customer-owned
+topic:
+
+```python
+from google.cloud import pubsub_v1
+from fxmacrodata_platform_core import read
+from fxmacrodata_pubsub import publish
+
+client = pubsub_v1.PublisherClient(
+    publisher_options=pubsub_v1.types.PublisherOptions(enable_message_ordering=True),
+)
+batch = read("indicator_history", {"currency": "usd", "indicator": "policy_rate"})
+result = publish(batch, client, "projects/my-project/topics/fxmacrodata")
+print(result.messages, "messages in", result.batches, "blocks")
+```
+
+The topic must already exist. The destination is the full topic path,
+`projects/<project>/topics/<topic>`; anything else, including URLs and
+subscription paths, is rejected before any publish.
+
+Every operation exposed by `fxmacrodata_platform_core.operations()` is
+available, including REST and MCP operations. `publish_operation` reads one
+operation and publishes it in a single call:
+
+```python
+from fxmacrodata_pubsub import publish_operation
+
+publish_operation("release_calendar", {"currency": "usd"}, client,
+                  "projects/my-project/topics/fxmacrodata", api_key_env="FXMD_API_KEY")
+```
+
+## Message format
+
+Each envelope row becomes one message. The body is canonical UTF-8 JSON with
+the keys `operation`, `source_url`, `record_id`, `currency`, `indicator`,
+`date`, `announcement_datetime`, `value`, `value_text`, `record_json`,
+`response_json` and the publisher's `content_hash` (SHA-256 of the ten source
+columns). Only `value` is numeric. Dates and announcement times remain source
+strings. No publication time is inferred, and no missing value is filled.
+`record_json` retains the original record; `response_json` retains the
+complete response, including pagination and metadata. An empty response
+produces one message with `record_json` equal to `"null"`, so absence of data
+and the server's metadata remain inspectable. It is not an observation.
+
+Message attributes carry `operation`, `record_id`, `content_hash` and
+`source_url` for subscription filters. The ordering key is
+`operation:record_id:content_hash`; the same source record with the same
+content always produces the same key, and changed data or metadata produces a
+different one. Pass `ordered=False` to publish without an ordering key when
+the client was created without `enable_message_ordering`.
+
+## Delivery guarantee
+
+Delivery is at-least-once. Messages are published in blocks of `batch_size`
+rows (1 to 10,000, 1,000 by default) and every block's futures are awaited
+before the next block starts. A failed block raises `PublishError` without the
+service's own diagnostic text and is not retried; earlier blocks may already
+be delivered. Subscribers should deduplicate on the ordering key, or on the
+`operation`, `record_id` and `content_hash` attributes. After an ordering-key
+failure the official client pauses that key; call `resume_publish` on the
+client before publishing the key again.
+
+`max_message_bytes` (16 MiB by default) rejects an individual envelope larger
+than the budget before anything is published; narrow the source date range to
+reduce the response size. The source response is materialized before
+publishing; choose a source date range suitable for memory.
+
+`publish_operation` accepts `api_key_env`, `complete_history`, `max_pages`
+and `client_factory` for the public source reader. Supply source credentials
+through your runtime secret store, exposing only the environment variable
+name; omit `api_key_env` for anonymous USD access. Destination authentication
+belongs to the official client you pass in. The adapter neither saves nor
+prints credentials and never places one in a message or attribute.
+
+The package licence covers this adapter code. FXMacroData data access and
+onward redistribution remain subject to your subscription and applicable
+licence. Publishing data to a topic does not grant permission to publish or
+resell it.
+
+## Development
+
+Tests run offline against an in-memory fake client:
+
+```sh
+python -m pytest tests -q
+```
+
+Official SDK reference:
+[Pub/Sub publisher client](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client?utm_source=pypi&utm_medium=referral&utm_campaign=pubsub-fxmacrodata&utm_content=upstream-reference).

pubsub_fxmacrodata-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+fxmacrodata_pubsub/__init__.py,sha256=BnloTKJILgm3co3yv4S85nyCtKhtMk_AY8FvlXYW2Wg,6667
+fxmacrodata_pubsub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pubsub_fxmacrodata-0.1.0.dist-info/licenses/LICENSE,sha256=rklK7Fl8aL1eWGubsrozZ7rCNTsN-MATw4M6LQIMv10,1092
+pubsub_fxmacrodata-0.1.0.dist-info/METADATA,sha256=sUl1BtL73qWCL9vfCbq4Ylg0kT8MGxnRHtLtOtuQtQo,5790
+pubsub_fxmacrodata-0.1.0.dist-info/WHEEL,sha256=16fc_9Rp854SLcdhaDEjr0u65p0e3FhZxihNgcnCE98,91
+pubsub_fxmacrodata-0.1.0.dist-info/top_level.txt,sha256=ambHvvmqVWonuWM8p3J0nLRNaPqrX1MQYOryUwggZj0,19
+pubsub_fxmacrodata-0.1.0.dist-info/RECORD,,

pubsub_fxmacrodata-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pubsub_fxmacrodata-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Tidball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pubsub_fxmacrodata-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fxmacrodata_pubsub