Graham McIntire
99e7560601
Instead of shelling out to https://gridmap.org/locate/:callsign for callsign → lat/lon lookups, ports the resolver pipeline from gridmap-web into this project so the whole flow runs in-process. New modules: - Microwaveprop.Qrz — cache facade over the QRZ.com XML callsign API. Looks up from qrz_callsigns first, falls back to a live fetch, and upserts the result with a configurable cache_ttl_hours (default 168h / 7 days). - Microwaveprop.Qrz.Client — HTTP/XML client against https://xmldata.qrz.com/xml/current/. Holds the session key in an Agent, transparently re-logs-in on :session_expired, and parses responses via xmerl. - Microwaveprop.Qrz.Callsign — Ecto schema for the qrz_callsigns cache table, binary_id primary key per project convention. - Microwaveprop.Qrz.Record — slim struct with only the 11 fields we actually consume (identity, name, grid, address, lat/lon). The full XML payload stays in the raw :data jsonb column for anyone who wants the other ~40 QRZ fields. - Microwaveprop.Geocoder — Req-based client against the Google Maps Geocoding API. Only called as a fallback when QRZ has no explicit <lat>/<lon> for the callsign. - Microwaveprop.CallsignLocation — orchestrator. Reads the callsign_locations cache, on miss calls Qrz then either uses QRZ's coords directly or geocodes the formatted address, snaps to an 8-char Maidenhead grid via Microwaveprop.Radio.Maidenhead, and upserts the result. Microwaveprop.Radio.CallsignClient.locate/1 is rewritten to delegate to CallsignLocation.lookup/1 and shape the response back to the existing {:ok, %{callsign, gridsquare, lat, lon}} contract so the callers in PathLive and RoverLive don't change. Wiring: - priv/repo/migrations/20260413000000_create_qrz_callsigns_and_callsign_locations.exs creates qrz_callsigns and callsign_locations with unique indexes on :callsign. - Microwaveprop.Qrz.Client added to the application supervision tree so the session Agent is started. - :xmerl added to extra_applications so the release bundles it. - config/test.exs wires Req.Test plugs for Microwaveprop.Qrz.Client and Microwaveprop.Geocoder, forces cache_ttl_hours: 0 so the cache never short-circuits test-level stubs, and supplies dummy QRZ credentials. - config/runtime.exs pulls QRZ_USERNAME / QRZ_PASSWORD / QRZ_AGENT and GOOGLE_API_KEY from the environment so prod and dev can configure both upstream keys out of band. Tests (ported verbatim from gridmap-web): - test/microwaveprop/qrz/callsign_test.exs — schema/changeset - test/microwaveprop/qrz_test.exs — cache hit, cache miss, TTL behavior, upsert on stale, error passthrough, case-insensitive input - test/microwaveprop/geocoder_test.exs — success, zero results, request denied, transport error - test/microwaveprop/callsign_location_test.exs — end-to-end flow including the QRZ-lat/lon shortcut and the missing-address error path All 1294 tests still pass. Credo strict clean.
72 lines
2 KiB
Elixir
72 lines
2 KiB
Elixir
defmodule Microwaveprop.Qrz do
|
|
@moduledoc """
|
|
Callsign-lookup facade around the QRZ.com XML API.
|
|
|
|
Results are cached in the `qrz_callsigns` table keyed by uppercased
|
|
callsign with a configurable TTL (`cache_ttl_hours`, default 168 / 7
|
|
days). Entries that are still fresh return from the DB without
|
|
touching the upstream.
|
|
"""
|
|
import Ecto.Query
|
|
|
|
alias Microwaveprop.Qrz.Callsign
|
|
alias Microwaveprop.Qrz.Client
|
|
alias Microwaveprop.Qrz.Record
|
|
alias Microwaveprop.Repo
|
|
|
|
@spec lookup_callsign(String.t()) :: {:ok, Record.t()} | {:error, String.t()}
|
|
def lookup_callsign(callsign) do
|
|
callsign = String.upcase(callsign)
|
|
|
|
case get_fresh_cache(callsign) do
|
|
%Callsign{data: data} ->
|
|
{:ok, Record.from_map(data)}
|
|
|
|
nil ->
|
|
fetch_and_upsert(callsign)
|
|
end
|
|
end
|
|
|
|
@spec get_callsign(String.t()) :: Callsign.t() | nil
|
|
def get_callsign(callsign) do
|
|
callsign = String.upcase(callsign)
|
|
Repo.get_by(Callsign, callsign: callsign)
|
|
end
|
|
|
|
defp get_fresh_cache(callsign) do
|
|
ttl_hours = config()[:cache_ttl_hours] || 168
|
|
cutoff = DateTime.add(DateTime.utc_now(), -ttl_hours, :hour)
|
|
|
|
Callsign
|
|
|> where([c], c.callsign == ^callsign and c.updated_at > ^cutoff)
|
|
|> Repo.one()
|
|
end
|
|
|
|
defp fetch_and_upsert(callsign) do
|
|
case Client.lookup(callsign) do
|
|
{:ok, data} ->
|
|
now = DateTime.utc_now(:second)
|
|
|
|
result =
|
|
%Callsign{}
|
|
|> Callsign.changeset(%{callsign: callsign, data: data})
|
|
|> Repo.insert(
|
|
on_conflict: [set: [data: data, updated_at: now]],
|
|
conflict_target: :callsign,
|
|
returning: true
|
|
)
|
|
|
|
case result do
|
|
{:ok, %Callsign{data: data}} -> {:ok, Record.from_map(data)}
|
|
{:error, changeset} -> {:error, "Failed to save: #{inspect(changeset.errors)}"}
|
|
end
|
|
|
|
{:error, _} = error ->
|
|
error
|
|
end
|
|
end
|
|
|
|
defp config do
|
|
Application.get_env(:microwaveprop, __MODULE__, [])
|
|
end
|
|
end
|