Template
## Summary - Port Monica campaign UTM + piha.li minting into always-on `core` (`shortener.py`, `campaign_utm.py`) so `email_sms` and `directmail` stay optional and never import each other. - `utm_source` is a slug of `SITE_NAME` (override with `UTM_SOURCE`). Email gets an HTML `data-campaign-utm` link; SMS gets a plain URL; postcard QR only — no body inject. - Live composer mints through login+CSRF `POST /portal/campaigns/short-link/` (registered only when an outreach app is installed). Empty `SHORTENER_*` falls back to the long UTM URL. Reference: [monica_site PR #10](ai_ml_operations/monica_site#10) Closes #3 ## Test plan - [x] `cd site && uv run python manage.py test` (125 tests) - [ ] Email composer: type a name, confirm HTML link + `utm_campaign` updates, save draft - [ ] SMS composer: plain `piha.li` (or long UTM if shortener unset) in the body - [ ] Postcard composer: QR copies the tracked URL; campaign body has no `utm_source` - [ ] Campaign report pages show the same panel - [ ] With `FEATURE_EMAIL_SMS` and `FEATURE_DIRECT_MAIL` off, no extra nav and no `/portal/campaigns/short-link/` route Reviewed-on: #4
88 lines
2.5 KiB
Python
88 lines
2.5 KiB
Python
"""Server-to-server client for url_shortening_service (piha.li).
|
|
|
|
Call the API host (`SHORTENER_BASE_URL`), never the public short domain.
|
|
Auth: Authorization: Bearer <SHORTENER_API_TOKEN> (name:secret).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
|
|
import requests
|
|
from django.conf import settings
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def is_configured() -> bool:
|
|
base = (getattr(settings, "SHORTENER_BASE_URL", None) or "").strip()
|
|
token = (getattr(settings, "SHORTENER_API_TOKEN", None) or "").strip()
|
|
return bool(base and token)
|
|
|
|
|
|
def mint_short_url(
|
|
target_url: str,
|
|
*,
|
|
title: str = "",
|
|
external_ref: str = "",
|
|
) -> str | None:
|
|
"""POST /api/links/. Return short_url, or None if unconfigured / failed.
|
|
|
|
Does not raise. Compose must still work when the shortener is down or unset.
|
|
"""
|
|
if not is_configured():
|
|
return None
|
|
target = (target_url or "").strip()
|
|
if not target.lower().startswith("https://"):
|
|
logger.info("shortener skip: target is not https")
|
|
return None
|
|
|
|
base = str(settings.SHORTENER_BASE_URL).rstrip("/")
|
|
token = str(settings.SHORTENER_API_TOKEN).strip()
|
|
timeout = int(getattr(settings, "SHORTENER_TIMEOUT_SECONDS", 10) or 10)
|
|
try:
|
|
response = requests.post(
|
|
f"{base}/api/links/",
|
|
headers={
|
|
"Authorization": f"Bearer {token}",
|
|
"Content-Type": "application/json",
|
|
},
|
|
json={
|
|
"target_url": target,
|
|
"title": (title or "")[:200],
|
|
"external_ref": (external_ref or "")[:64],
|
|
},
|
|
timeout=timeout,
|
|
)
|
|
except requests.RequestException:
|
|
logger.exception("shortener request failed")
|
|
return None
|
|
|
|
if response.status_code not in (200, 201):
|
|
logger.warning(
|
|
"shortener mint failed status=%s",
|
|
response.status_code,
|
|
)
|
|
return None
|
|
try:
|
|
data = response.json()
|
|
except ValueError:
|
|
logger.warning("shortener mint returned non-json")
|
|
return None
|
|
if not isinstance(data, dict):
|
|
return None
|
|
short = (data.get("short_url") or "").strip()
|
|
return short or None
|
|
|
|
|
|
def resolve_display_url(
|
|
target_url: str,
|
|
*,
|
|
title: str = "",
|
|
external_ref: str = "",
|
|
) -> str:
|
|
"""Short URL when mint succeeds, otherwise the original target."""
|
|
return mint_short_url(
|
|
target_url, title=title, external_ref=external_ref
|
|
) or target_url
|