Sam Rolfe
9cbfa7db9b
The project side of the frozen Hub contract
(central_ai_llm_master/docs/ask-contract.md), on this service's own port:
GET /capabilities the routing topics the Hub reads, project "compass_nhs"
POST /ask one short, read-only answer about a child's school work
POST /notify accept the contract's notification shape, deliver via Apprise
All three require the shared bearer token SCHOOL_HUB_TOKEN; with no token they
answer 503. GET /health now also carries "ok": true and "hub_api".
/ask answers deterministically (no model on the path) from the stored Compass
items, reusing dashboard.Classify so the answer and the dashboard never
disagree. It is one short sentence, for example "Harry has 8 school events
today from 8:55am to 6:00pm and 6 overdue tasks", with the buckets in `data`.
It reads only, enforced by a Reader interface with no write method and by
TestHubAskReadsOnly.
Fail loudly (FR-12): a missing or failed scan is never an empty day. /ask says
due work is unknown, and an answer older than 36 hours carries a stale warning.
Permission follows the contract: a parent may ask about any child; anyone else
only about themselves.
/notify follows the house interpretation already used by internet_use_control:
the contract shape is accepted and delivered to the named person, recorded in
notifications with scope "hub". An unknown person is refused, not misdelivered.
Live proof on .13 (deploy/verify-phase8.sh):
/health 200, ok true
/capabilities 200, project compass_nhs; unsigned 401
/ask 200, the sentence above, duration 1ms
/notify 400 on a bad level (auth proven, nothing sent), then 200 with
a real delivery to Sam on email and WhatsApp
The live Hub registration (HUB_PROJECTS + HUB_PROJECT_COMPASS_NHS_TOKEN +
hub restart) is a change to a running family service and is pending approval.
Co-Authored-By: Paperclip <noreply@paperclip.ing>
114 lines
4.0 KiB
Makefile
114 lines
4.0 KiB
Makefile
IMAGE ?= compass-teams-nhs/school:0.6.0-phase8
|
|
BUILD_VERSION ?= 0.6.0-phase8
|
|
|
|
# Parse options (see scripts/parse-compass.sh).
|
|
CHILD ?= Harry
|
|
RUN ?= latest
|
|
CLASSIFY ?= auto
|
|
|
|
# Scan target: 'all' scans every child; set SCAN_CHILD=Harry to narrow it.
|
|
SCAN_CHILD ?= all
|
|
|
|
# Notify options (see scripts/morning-brief.sh and school notify run).
|
|
NOTIFY_ARGS ?=
|
|
|
|
# Bounded docker helper for the Go toolchain. The container runs as the current
|
|
# user, so the repository and the module cache stay owned by you.
|
|
GO_IMAGE ?= golang:1.25-alpine
|
|
GO_RUN = timeout 600 docker run --rm --network host --user "$$(id -u):$$(id -g)" \
|
|
-e HOME=/src/.gocache -e GOMODCACHE=/src/.gocache/mod -e GOCACHE=/src/.gocache/build \
|
|
-v "$$PWD":/src -w /src $(GO_IMAGE)
|
|
|
|
.PHONY: help test vet build up down restart logs ps deps fmt hash-password gen-secret verify-phase1 verify-phase8 parse scan calendar notify morning-brief
|
|
|
|
help:
|
|
@echo "make test run go test ./... in golang:1.25-alpine"
|
|
@echo "make vet run go vet ./... in golang:1.25-alpine"
|
|
@echo "make build build the container image ($(IMAGE))"
|
|
@echo "make up docker compose up -d --build"
|
|
@echo "make down docker compose down"
|
|
@echo "make logs follow container logs"
|
|
@echo "make ps docker compose ps"
|
|
@echo "make deps go mod tidy + download (writes go.mod/go.sum)"
|
|
@echo "make hash-password generate a bcrypt hash (PASSWORD=...)"
|
|
@echo "make gen-secret print a fresh session secret"
|
|
@echo "make parse parse stored Compass pages into SQLite (Phase 3)"
|
|
@echo "make scan fetch + parse one or both children (Phase 4; SCAN_CHILD=Harry|Finn|all)"
|
|
@echo "make calendar push important events to the HA calendar (Phase 6; CALENDAR_ARGS=...)"
|
|
@echo "make notify build and send the morning briefs via Apprise (Phase 7; NOTIFY_ARGS=...)"
|
|
@echo "make preview print the briefs without sending (Phase 7)"
|
|
@echo "make morning-brief scan both children, then send the briefs (the n8n job)"
|
|
@echo "make verify-phase1 prove /health, the login and the Caddy route"
|
|
@echo "make verify-phase8 prove the Hub API: /capabilities, /ask, /notify (--send delivers)"
|
|
|
|
test:
|
|
$(GO_RUN) go test ./...
|
|
|
|
vet:
|
|
$(GO_RUN) go vet ./...
|
|
|
|
deps:
|
|
$(GO_RUN) sh -c 'go mod tidy'
|
|
|
|
fmt:
|
|
$(GO_RUN) sh -c 'go fmt ./...'
|
|
|
|
build:
|
|
docker build --build-arg VERSION=$(BUILD_VERSION) -t $(IMAGE) .
|
|
|
|
up:
|
|
docker compose up -d --build
|
|
|
|
down:
|
|
docker compose down
|
|
|
|
restart:
|
|
docker compose restart school
|
|
|
|
logs:
|
|
docker compose logs -f school
|
|
|
|
ps:
|
|
docker compose ps
|
|
|
|
hash-password:
|
|
@test -n "$(PASSWORD)" || (echo "usage: make hash-password PASSWORD=secret"; exit 2)
|
|
docker run --rm --entrypoint /app/school $(IMAGE) hash-password '$(PASSWORD)'
|
|
|
|
gen-secret:
|
|
docker run --rm --entrypoint /app/school $(IMAGE) gen-secret
|
|
|
|
# Phase 3: parse the stored raw pages for one child into the items table.
|
|
parse:
|
|
CHILD=$(CHILD) RUN=$(RUN) CLASSIFY=$(CLASSIFY) IMAGE=$(IMAGE) scripts/parse-compass.sh
|
|
|
|
# Phase 4: fetch + parse one child or both, with a per-child session.
|
|
scan:
|
|
CLASSIFY=$(CLASSIFY) IMAGE=$(IMAGE) scripts/scan-compass.sh $(if $(filter-out all,$(SCAN_CHILD)),--child $(SCAN_CHILD))
|
|
|
|
# Phase 6: Home Assistant calendar. CALENDAR_ARGS defaults to 'status'.
|
|
calendar:
|
|
IMAGE=$(IMAGE) scripts/calendar-push.sh $(if $(CALENDAR_ARGS),$(CALENDAR_ARGS),status)
|
|
|
|
# Phase 7: send the morning briefs through Apprise (FR-9, FR-14).
|
|
notify:
|
|
IMAGE=$(IMAGE) scripts/morning-brief.sh --no-scan $(NOTIFY_ARGS)
|
|
|
|
# Phase 7: print the briefs and send nothing.
|
|
preview:
|
|
IMAGE=$(IMAGE) scripts/morning-brief.sh --no-scan --dry-run
|
|
|
|
# Phase 7: the job the 6:00am n8n schedule calls — scan, then send.
|
|
morning-brief:
|
|
IMAGE=$(IMAGE) scripts/morning-brief.sh
|
|
|
|
# Phase 1 definition of done: /health 200, login page + session login, and the
|
|
# Caddy route on .35.
|
|
verify-phase1:
|
|
deploy/verify-phase1.sh
|
|
|
|
# Phase 8 definition of done: the Hub API answers and authenticates. Pass
|
|
# ARGS=--send to deliver one real /notify message to Sam.
|
|
verify-phase8:
|
|
deploy/verify-phase8.sh $(ARGS)
|