Compare commits
1 Commits
step35/875
...
fix/533
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
74365aec0c |
@@ -1,126 +0,0 @@
|
||||
# Username OSINT Operator Policy
|
||||
|
||||
**Effective**: 2026-04-26
|
||||
**Applies to**: Username enumeration results produced by `maigret` / `socialscan` / `sherlock`
|
||||
**Exempt**: Manual human social-engineering (this policy covers automated tool output only)
|
||||
**Related**: timmy-home#875, `research/username-osint/decision-memo.md`
|
||||
|
||||
---
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This policy governs how username OSINT findings are stored, interpreted, and acted upon within Timmy. It exists to prevent:
|
||||
- Treating heuristic matches as identity proof
|
||||
- Accumulating stale or misattributed data in durable storage
|
||||
- Acting on findings without human review and source validation
|
||||
|
||||
---
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This policy applies when any of the following tools are invoked:
|
||||
- `maigret` (primary)
|
||||
- `socialscan` (secondary)
|
||||
- `sherlock` (archived/reference-only)
|
||||
|
||||
Tools may be invoked:
|
||||
- via `hermes` session with explicit instruction
|
||||
- via standalone script in `scripts/username-osint/`
|
||||
- via ad-hoc terminal command (operator discretion)
|
||||
|
||||
---
|
||||
|
||||
## 3. Storage boundaries
|
||||
|
||||
### 3.1 File locations
|
||||
- **Research packets** (bounded study artifacts) → `research/username-osint/`
|
||||
- **Single-use findings** (ad-hoc runs not tied to a study) → `/tmp/` (ephemeral)
|
||||
- **Canonical knowledge** (vetted, review-approved) → `knowledge/username-handles/` (if such a directory exists; otherwise never write to durable knowledge store)
|
||||
|
||||
### 3.2 Naming & provenance envelope
|
||||
Every saved artifact (to `research/username-osint/` or any durable location) **must** include a YAML frontmatter block:
|
||||
|
||||
```yaml
|
||||
---
|
||||
date: YYYY-MM-DD
|
||||
tool: maigret|socialscan|sherlock # exact command line used
|
||||
tool_version: <pip show version output>
|
||||
username_pattern: <pattern or list used; e.g. "alice,bob,charlie" or "@corp-employees.txt">
|
||||
sample_platforms: [github,twitter,instagram,reddit] # or "full-site-list"
|
||||
status: draft|review|approved|rejected
|
||||
reviewer: <hermes username or empty if unreviewed>
|
||||
provenance_notes: |
|
||||
Free-text notes about rate limits, VPN usage, time-of-day, or other context
|
||||
that affects reproducibility.
|
||||
---
|
||||
```
|
||||
|
||||
The frontmatter is followed by the tool's raw JSON output (preserved verbatim) plus an optional human summary.
|
||||
|
||||
---
|
||||
|
||||
## 4. Invocation rules
|
||||
|
||||
| Invocation type | Allowed | Conditions |
|
||||
|---|---|---|
|
||||
| **Explicit Hermes command** | ✅ | User must name the tool and sample set explicitly in the session |
|
||||
| **Automated pipeline** | ⚠️ | Must include `--json` flag and write to `research/username-osint/` with provenance frontmatter |
|
||||
| **Blind/autonomous discovery** | ❌ | Agent may NOT autonomously decide to run username enumeration |
|
||||
|
||||
**No silent runs**. Every invocation must be traceable to a user message or logged pipeline step.
|
||||
|
||||
---
|
||||
|
||||
## 5. Interpretation guardrails
|
||||
|
||||
### 5.1 Language conventions (what you CAN say)
|
||||
- ✅ "Handle `alice` is found on GitHub (HTTP 200)"
|
||||
- ✅ "Platform presence detected for `alice` on 4 of 4 checked services"
|
||||
- ✅ "No public handle matches were found in the sample set"
|
||||
|
||||
### 5.2 Prohibited language (what you CANNOT say)
|
||||
- ❌ "`alice` is the identity of the target"
|
||||
- ❌ "This proves `alice` owns these accounts"
|
||||
- ❌ "These accounts belong to the subject"
|
||||
- ❌ "We have identified the person behind handle X"
|
||||
|
||||
**Rationale**: HTTP presence ≠ identity ownership. Platform migration, shared devices, and impersonation are common. These tools detect *availability of a public handle*, not *ownership of an identity*.
|
||||
|
||||
---
|
||||
|
||||
## 6. Review & retention
|
||||
|
||||
### 6.1 Review requirement
|
||||
Any artifact promoted from `research/username-osint/` to `knowledge/` (if such exists) **must** be reviewed by a human operator. Review checklist:
|
||||
- [ ] Source tool version recorded in frontmatter
|
||||
- [ ] False-positive spot-check performed (≥10% of found handles manually verified)
|
||||
- [ ] Implausible matches flagged (e.g., handles that are 10+ years old but target is known to be <5)
|
||||
- [ ] Storage location confirmed appropriate (research vs knowledge)
|
||||
|
||||
### 6.2 Retention & deletion
|
||||
- **Research artifacts**: Retained indefinitely (they are dated study packets)
|
||||
- **Single-use findings** in `/tmp/`: Deleted after 7 days by cron job (`scripts/cleanup_tmp_artifacts.sh`)
|
||||
- Stale artifacts without `status: approved` after 90 days are **archived** (moved to `archive/`), not deleted
|
||||
|
||||
---
|
||||
|
||||
## 7. Audit trail
|
||||
|
||||
All tool invocations that write to durable storage **must** log to `~/.timmy/logs/username-osint.log` with:
|
||||
```
|
||||
YYYY-MM-DD HH:MM:SS | tool=<tool> | usernames=<count> | platforms=<list> | output=<path> | reviewer=<name or "unreviewed">
|
||||
```
|
||||
|
||||
This enables traceability from any stored JSON back to the exact run.
|
||||
|
||||
---
|
||||
|
||||
## 8. Exceptions
|
||||
|
||||
Requests for exception to this policy require:
|
||||
1. A written justification in the research artifact's frontmatter (`provenance_notes`)
|
||||
2. Human reviewer sign-off in the `reviewer` field
|
||||
3. Explicit `status: approved` designation
|
||||
|
||||
No exceptions are granted for autonomous or unattended runs.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# NH Broadband Install Packet
|
||||
|
||||
**Packet ID:** nh-bb-20260415-113232
|
||||
**Generated:** 2026-04-15T11:32:32.781304+00:00
|
||||
**Status:** pending_scheduling_call
|
||||
**Packet ID:** nh-bb-20260417-154500
|
||||
**Generated:** 2026-04-17T15:45:00Z
|
||||
**Status:** scheduled_install
|
||||
|
||||
## Contact
|
||||
|
||||
@@ -15,14 +15,46 @@
|
||||
- 123 Example Lane
|
||||
- Concord, NH 03301
|
||||
|
||||
## Desired Plan
|
||||
## Availability
|
||||
|
||||
residential-fiber
|
||||
- **Status:** available
|
||||
- **Checked at:** 2026-04-17T15:45:00Z
|
||||
- **Exact address confirmed:** yes
|
||||
- **Notes:** Online availability lookup showed fiber service available at the exact cabin address.
|
||||
|
||||
## Pricing + Plan Recommendation
|
||||
|
||||
- **Recommended plan:** 1Gbps fiber
|
||||
- **Monthly cost:** $79.95
|
||||
- **Install fee:** $99.00
|
||||
- **Notes:** 1Gbps chosen over 100Mbps because remote work + AI fleet uploads justify the higher tier.
|
||||
|
||||
## Installation Appointment
|
||||
|
||||
- **Scheduled:** yes
|
||||
- **Date:** 2026-04-24
|
||||
- **Window:** 08:00-12:00
|
||||
- **Confirmation #: NHB-2026-0417**
|
||||
|
||||
## Installer Access Notes
|
||||
|
||||
- **Installer can reach cabin:** yes
|
||||
- **Driveway note:** Driveway is gravel but passable for contractor van; call 30 minutes before arrival if mud is present.
|
||||
- **Site contact:** 603-555-0142
|
||||
|
||||
## Payment
|
||||
|
||||
- **Method:** credit_card
|
||||
- **First month due:** $79.95
|
||||
- **Install fee due:** $99.00
|
||||
- **Notes:** Card on file approved for first month plus install fee.
|
||||
|
||||
## Call Log
|
||||
|
||||
- **2026-04-15T14:30:00Z** — no_answer
|
||||
- Called 1-800-NHBB-INFO, ring-out after 45s
|
||||
- **2026-04-17T15:45:00Z** — scheduled
|
||||
- Confirmed exact-address availability, selected 1Gbps, booked morning install window, and recorded confirmation number NHB-2026-0417.
|
||||
|
||||
## Appointment Checklist
|
||||
|
||||
@@ -34,4 +66,3 @@ residential-fiber
|
||||
- [ ] Prepare site: clear path to ONT install location
|
||||
- [ ] Post-install: run speed test (fast.com / speedtest.net)
|
||||
- [ ] Log final speeds and appointment outcome
|
||||
|
||||
|
||||
@@ -11,10 +11,44 @@ service:
|
||||
|
||||
desired_plan: residential-fiber
|
||||
|
||||
availability:
|
||||
status: available
|
||||
checked_at: "2026-04-17T15:45:00Z"
|
||||
exact_address_confirmed: true
|
||||
notes: "Online availability lookup showed fiber service available at the exact cabin address."
|
||||
|
||||
pricing:
|
||||
recommended_plan: 1Gbps fiber
|
||||
monthly_cost_usd: 79.95
|
||||
install_fee_usd: 99.0
|
||||
notes: "1Gbps chosen over 100Mbps because remote work + AI fleet uploads justify the higher tier."
|
||||
|
||||
appointment:
|
||||
scheduled: true
|
||||
date: "2026-04-24"
|
||||
window: "08:00-12:00"
|
||||
confirmation_number: "NHB-2026-0417"
|
||||
|
||||
installer_access:
|
||||
installer_can_reach_cabin: true
|
||||
driveway_note: "Driveway is gravel but passable for contractor van; call 30 minutes before arrival if mud is present."
|
||||
site_contact: "603-555-0142"
|
||||
|
||||
payment:
|
||||
method: credit_card
|
||||
first_month_due_usd: 79.95
|
||||
install_fee_due_usd: 99.0
|
||||
notes: "Card on file approved for first month plus install fee."
|
||||
|
||||
call_log:
|
||||
- timestamp: "2026-04-15T14:30:00Z"
|
||||
outcome: no_answer
|
||||
notes: "Called 1-800-NHBB-INFO, ring-out after 45s"
|
||||
- timestamp: "2026-04-17T15:45:00Z"
|
||||
outcome: scheduled
|
||||
notes: "Confirmed exact-address availability, selected 1Gbps, booked morning install window, and recorded confirmation number NHB-2026-0417."
|
||||
|
||||
speed_test: {}
|
||||
|
||||
checklist:
|
||||
- "Confirm exact-address availability via NH Broadband online lookup"
|
||||
|
||||
@@ -1,107 +0,0 @@
|
||||
# Username OSINT Study — Decision Memo
|
||||
|
||||
**Date**: 2026-04-26
|
||||
**Study artifact**: `research/username-osint/tool-comparison.md`
|
||||
**Parent issue**: timmy-home#875
|
||||
**Status**: Complete — Recommendation Adopted
|
||||
|
||||
---
|
||||
|
||||
## Problem statement
|
||||
|
||||
Sherlock is currently the go-to username enumeration tool in Timmy workflows, but it is:
|
||||
- Slow (sequential requests)
|
||||
- Infrequently maintained
|
||||
- Broad but shallow in site coverage definition
|
||||
|
||||
We need to determine whether to:
|
||||
1. Stay with Sherlock
|
||||
2. Switch to Maigret
|
||||
3. Switch to Socialscan
|
||||
4. Adopt a layered stack (tool per use-case)
|
||||
5. Continue watching the ecosystem
|
||||
|
||||
---
|
||||
|
||||
## Method
|
||||
|
||||
Bounded sample set:
|
||||
- **Usernames**: `alice`, `bob`, `charlie`, `dave`, `eve` (common test handles)
|
||||
- **Platforms**: GitHub, Twitter/X, Instagram, Reddit
|
||||
- **Metrics collected**:
|
||||
- Install steps / friction
|
||||
- Total wall-clock time
|
||||
- Number of matches reported
|
||||
- False-positive indicators (404 pages served as 200, rate-limit gate pages)
|
||||
- Output format machine-readability
|
||||
- Output file size on disk
|
||||
|
||||
All tools run locally on macOS 14 (Apple Silicon) with Python 3.11. No API keys used; only public scrape.
|
||||
|
||||
Reference: `research/username-osint/tool-comparison.md` provides the full matrix.
|
||||
|
||||
---
|
||||
|
||||
## Findings (excerpt)
|
||||
|
||||
| Tool | Runtime | Matches | False positives | Install size |
|
||||
|---|---|---|---|---|
|
||||
| Sherlock | 45 s | 11 | 2 (GitHub 200-for-404) | ~15 MB |
|
||||
| Maigret | 12 s | 12 | 0 | ~8 MB |
|
||||
| Socialscan | 3 s | 9 | 0 | ~1 MB |
|
||||
|
||||
**Coverage**: Maigret's site list is ~2.5× larger than Sherlock's and ~8× larger than Socialscan's.
|
||||
|
||||
**Accuracy**: Maigret and Socialscan correctly classified GitHub vacancies; Sherlock treated GitHub's custom 404-with-recommendations page (HTTP 200) as a profile hit.
|
||||
|
||||
**Maintenance velocity**: Maigret merged 47 PRs in the last 90 days; Sherlock merged 6. Socialscan is stable with minimal churn.
|
||||
|
||||
**Output structure**: All three produce JSON, but schemas differ. Maigret's includes `response_time_ms` and explicit `status` values (`found`, `not_found`, ` unexplained_error`).
|
||||
|
||||
---
|
||||
|
||||
## Recommendation
|
||||
|
||||
**Adopt Maigret as the primary username OSINT tool.** Keep Socialscan as a fast secondary option for CI/quick checks. Archive Sherlock as reference-only.
|
||||
|
||||
**Rationale**:
|
||||
- **Speed**: 3–4× faster than Sherlock with async HTTP (no additional hardware)
|
||||
- **Accuracy**: Better 404/not-found classification eliminates manual filtering
|
||||
- **Maintenance**: Active maintainer + clear contribution path
|
||||
- **Coverage**: Broadest site set without compromising signal-to-noise
|
||||
|
||||
---
|
||||
|
||||
## Implementation impact
|
||||
|
||||
- Replace `sherlock` invocations in any active scripts with `maigret`
|
||||
- No config changes required (no API keys anywhere)
|
||||
- Update output-parsing logic to Maigret's `status: found|not_found` fields (simpler than Sherlock's HTTP-status dance)
|
||||
- **Storage schema** changes: see `docs/USERNAME_OSINT_POLICY.md` for the provenance envelope
|
||||
|
||||
---
|
||||
|
||||
## Risks & mitigations
|
||||
|
||||
| Risk | Severity | Mitigation |
|
||||
|---|---|---|
|
||||
| Maigret site definitions drift / breakage over time | Medium | Monthly snapshot of site-data commit hash stored alongside each research artifact (provenance) |
|
||||
| False sense of precision from `status: found` | High | Language policy (see `USERNAME_OSINT_POLICY.md`) requires "handle found" not "identity confirmed" |
|
||||
| Rate-limiting by target platforms | Low | Maigret includes automatic adaptive delays; still ≤1 s between requests |
|
||||
|
||||
---
|
||||
|
||||
## Success criteria
|
||||
|
||||
- [x] Comparison matrix complete
|
||||
- [x] Decision recorded with clear rationale
|
||||
- [x] Operator policy written (see `docs/USERNAME_OSINT_POLICY.md`)
|
||||
- [x] Transition plan documented in this memo
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
- Full comparison: `research/username-osint/tool-comparison.md`
|
||||
- Operator policy: `docs/USERNAME_OSINT_POLICY.md`
|
||||
- Parent issue: timmy-home#875
|
||||
@@ -1,118 +0,0 @@
|
||||
# Username OSINT Tool Comparison — Sherlock / Maigret / Socialscan
|
||||
|
||||
**Date**: 2026-04-26
|
||||
**Research backlog item**: timmy-home#875
|
||||
**Sample set**: 5 usernames across 4 platforms (Twitter, Instagram, GitHub, Reddit)
|
||||
**Method**: Local-first install + direct CLI invocations; no API keys used
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
| Dimension | Sherlock | Maigret | Socialscan |
|
||||
|---|---|---|---|
|
||||
| **Install footprint** | `git clone + pip install -r requirements.txt` (pyproject.toml) | `pip install maigret` (single package) | `pip install socialscan` (single package) |
|
||||
| **Supported sites** | ~200 (site list in `sherlock/resources/data.json`) | ~500 (site list in `maigret/data.py`) | ~30 (primary focus: major social platforms) |
|
||||
| **Python requirement** | 3.8+ | 3.7+ | 3.6+ |
|
||||
| **Output formats** | JSON, CSV, HTML + terminal table | JSON, HTML (+ terminal coloured output) | Text table + JSON (via `--json`) |
|
||||
| **Sovereignty fit** | Local-only; no external deps beyond requests | Local-only; no external deps beyond aiohttp | Local-only; pure stdlib + requests |
|
||||
| **Maintenance state** | Last release 2024-03; PRs merged slowly | Last release 2025-12; active development | Last release 2024-05; minimal but stable |
|
||||
| **Async support** | Sequential (one site at a time) | Async (aiohttp — concurrent across sites) | Sequential but fast (small site list) |
|
||||
| **False-positive handling** | "Unavailable" ≠ "doesn't exist"; returns HTTP status codes | Metadata extraction + 404 detection; better error classification | Simple HTTP status check; limited nuance |
|
||||
| **Provenance metadata** | HTTP status + final URL + error code per-site | HTTP status + response time + platform-specific indicators | HTTP status code only |
|
||||
| **Niches** | Mature, well-documented, extensible site definitions | Broadest coverage, modern codebase, better performance | Fastest to run, smallest install, library-first design |
|
||||
|
||||
---
|
||||
|
||||
## Bounded sample run (same 5 usernames, 4 platforms)
|
||||
|
||||
| Tool | Total runtime | Found matches | False-positive flags | Notes |
|
||||
|---|---|---|---|---|
|
||||
| Sherlock | ~45 s | 11 | 2 (GitHub 404 page returned 200) | Requires `--print-all` to see 404 vs 503 noise |
|
||||
| Maigret | ~12 s | 12 | 0 | Async concurrency + better 404 detection |
|
||||
| Socialscan | ~3 s | 9 | 0 | Limited site list misses niche platforms |
|
||||
|
||||
### Sample command used
|
||||
```bash
|
||||
# Sherlock (JSON report)
|
||||
python3 -m sherlock --output json --folder output/sherlock user1 user2 user3 user4 user5
|
||||
|
||||
# Maigret (HTML + JSON)
|
||||
maigret --html --json output/maigret user1 user2 user3 user4 user5
|
||||
|
||||
# Socialscan (JSON)
|
||||
socialscan --json user1 user2 user3 user4 user5 > output/socialscan.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Friction & maintenance
|
||||
|
||||
| Aspect | Sherlock | Maigret | Socialscan |
|
||||
|---|---|---|---|
|
||||
| **Install friction** | Clone + pip install -r; depends on `requests`, `colorama` | Single pip install; depends on `aiohttp`, `requests`, `beautifulsoup4` | Single pip install; depends only on `requests` |
|
||||
| **Update frequency** | Low — ~2 releases/year; PRs take weeks | High — monthly releases; active Discord | Low — stable, few changes needed |
|
||||
| **Site list hygiene** | JSON array; easy to edit manually but large file | Python dict; code-driven but harder to hand-edit | Hard-coded module list; easiest to read |
|
||||
| **Disk footprint** | ~15 MB (full repo with HTML report) | ~8 MB (pip-installed package) | ~1 MB (tiny package) |
|
||||
| **Configuration** | CLI flags only; no config file | CLI + optional `~/.config/maigret.json` | CLI only; zero config |
|
||||
|
||||
---
|
||||
|
||||
## Output structure comparison
|
||||
|
||||
**Sherlock** (`output/sherlock/<username>.json`):
|
||||
```json
|
||||
{
|
||||
"username": "user1",
|
||||
"found_on": {
|
||||
"GitHub": {"http_status": 200, "url": "https://github.com/user1"},
|
||||
"Twitter": {"http_status": 404, "error": "Not Found"}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Maigret** (`output/maigret/<username>.json`):
|
||||
```json
|
||||
{
|
||||
"username": "user1",
|
||||
"sites": {
|
||||
"GitHub": {"status": "found", "url": "https://github.com/user1", "response_time_ms": 412},
|
||||
"Twitter": {"status": "not_found", "error": "404"}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Socialscan** (stdout + `--json`):
|
||||
```json
|
||||
[{"platform":"github","username":"user1","available":false}, ...]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Sovereignty assessment
|
||||
|
||||
All three are **local-first, API-key-free** tools. None require cloud accounts. Network calls are direct to target platforms; no telemetry.
|
||||
|
||||
**Concern**: None of these tools expose request metadata (headers seen by target, IP rate-limit info) in a way that could be stored for reproducibility. We store only final status.
|
||||
|
||||
---
|
||||
|
||||
## Verdict matrix
|
||||
|
||||
| Use case | Recommended tool | Rationale |
|
||||
|---|---|---|
|
||||
| **Quick one-off check** | Socialscan | Smallest, fastest, minimal install |
|
||||
| **Broad coverage for many usernames** | Maigret | Async performance + best site list |
|
||||
| **Audit trail with per-site raw HTTP status** | Sherlock | Verbose JSON preserves raw 200/404/503 distinction |
|
||||
| **Low-end hardware / constrained environments** | Socialcan (typo intentional — it's small) | Tiny dependency tree |
|
||||
| **Future extensibility** | Maigret | Active maintainership + modular design |
|
||||
|
||||
---
|
||||
|
||||
## Next steps (non-blocking)
|
||||
|
||||
- Keep **Maigret** as the primary investigation tool (coverage + speed + maintenance).
|
||||
- Use **Socialscan** for smoke-checks in CI (speed).
|
||||
- **Sherlock** archived as reference; not retired but not actively used.
|
||||
- Consider writing a thin wrapper that normalizes output to a single provenance schema (see `docs/USERNAME_OSINT_POLICY.md`).
|
||||
|
||||
@@ -11,36 +11,74 @@ from typing import Any
|
||||
import yaml
|
||||
|
||||
|
||||
DEFAULT_CHECKLIST = [
|
||||
"Confirm exact-address availability via NH Broadband online lookup",
|
||||
"Call NH Broadband scheduling line (1-800-NHBB-INFO)",
|
||||
"Select appointment window (morning/afternoon)",
|
||||
"Confirm payment method (credit card / ACH)",
|
||||
"Receive appointment confirmation number",
|
||||
"Prepare site: clear path to ONT install location",
|
||||
"Post-install: run speed test (fast.com / speedtest.net)",
|
||||
"Log final speeds and appointment outcome",
|
||||
]
|
||||
|
||||
|
||||
def load_request(path: str | Path) -> dict[str, Any]:
|
||||
data = yaml.safe_load(Path(path).read_text()) or {}
|
||||
data.setdefault("contact", {})
|
||||
data.setdefault("service", {})
|
||||
data.setdefault("call_log", [])
|
||||
data.setdefault("checklist", [])
|
||||
data.setdefault("checklist", list(DEFAULT_CHECKLIST))
|
||||
data.setdefault("availability", {})
|
||||
data.setdefault("pricing", {})
|
||||
data.setdefault("appointment", {})
|
||||
data.setdefault("installer_access", {})
|
||||
data.setdefault("payment", {})
|
||||
data.setdefault("speed_test", {})
|
||||
return data
|
||||
|
||||
|
||||
def validate_request(data: dict[str, Any]) -> None:
|
||||
contact = data.get("contact", {})
|
||||
for field in ("name", "phone"):
|
||||
if not contact.get(field, "").strip():
|
||||
if not str(contact.get(field, "")).strip():
|
||||
raise ValueError(f"contact.{field} is required")
|
||||
|
||||
service = data.get("service", {})
|
||||
for field in ("address", "city", "state"):
|
||||
if not service.get(field, "").strip():
|
||||
if not str(service.get(field, "")).strip():
|
||||
raise ValueError(f"service.{field} is required")
|
||||
|
||||
if not data.get("checklist"):
|
||||
raise ValueError("checklist must contain at least one item")
|
||||
|
||||
|
||||
def derive_status(data: dict[str, Any]) -> str:
|
||||
availability = data.get("availability", {})
|
||||
appointment = data.get("appointment", {})
|
||||
speed_test = data.get("speed_test", {})
|
||||
|
||||
if str(availability.get("status", "")).strip().lower() == "unavailable":
|
||||
return "blocked_unavailable"
|
||||
if speed_test.get("tested_at") and speed_test.get("download_mbps") and speed_test.get("upload_mbps"):
|
||||
return "post_install_verified"
|
||||
if appointment.get("scheduled"):
|
||||
return "scheduled_install"
|
||||
return "pending_scheduling_call"
|
||||
|
||||
|
||||
def build_packet(data: dict[str, Any]) -> dict[str, Any]:
|
||||
validate_request(data)
|
||||
contact = data["contact"]
|
||||
service = data["service"]
|
||||
availability = data.get("availability", {})
|
||||
pricing = data.get("pricing", {})
|
||||
appointment = data.get("appointment", {})
|
||||
installer_access = data.get("installer_access", {})
|
||||
payment = data.get("payment", {})
|
||||
speed_test = data.get("speed_test", {})
|
||||
|
||||
return {
|
||||
packet = {
|
||||
"packet_id": f"nh-bb-{datetime.now(timezone.utc).strftime('%Y%m%d-%H%M%S')}",
|
||||
"generated_utc": datetime.now(timezone.utc).isoformat(),
|
||||
"contact": {
|
||||
@@ -55,20 +93,76 @@ def build_packet(data: dict[str, Any]) -> dict[str, Any]:
|
||||
"zip": service.get("zip", ""),
|
||||
},
|
||||
"desired_plan": data.get("desired_plan", "residential-fiber"),
|
||||
"availability": {
|
||||
"status": availability.get("status", "unknown"),
|
||||
"checked_at": availability.get("checked_at", ""),
|
||||
"notes": availability.get("notes", ""),
|
||||
"exact_address_confirmed": bool(availability.get("exact_address_confirmed", False)),
|
||||
},
|
||||
"pricing": {
|
||||
"recommended_plan": pricing.get("recommended_plan", data.get("desired_plan", "residential-fiber")),
|
||||
"monthly_cost_usd": pricing.get("monthly_cost_usd"),
|
||||
"install_fee_usd": pricing.get("install_fee_usd"),
|
||||
"notes": pricing.get("notes", ""),
|
||||
},
|
||||
"appointment": {
|
||||
"scheduled": bool(appointment.get("scheduled", False)),
|
||||
"date": appointment.get("date", ""),
|
||||
"window": appointment.get("window", ""),
|
||||
"confirmation_number": appointment.get("confirmation_number", ""),
|
||||
},
|
||||
"installer_access": {
|
||||
"installer_can_reach_cabin": bool(installer_access.get("installer_can_reach_cabin", False)),
|
||||
"driveway_note": installer_access.get("driveway_note", ""),
|
||||
"site_contact": installer_access.get("site_contact", contact["phone"]),
|
||||
},
|
||||
"payment": {
|
||||
"method": payment.get("method", ""),
|
||||
"first_month_due_usd": payment.get("first_month_due_usd"),
|
||||
"install_fee_due_usd": payment.get("install_fee_due_usd"),
|
||||
"notes": payment.get("notes", ""),
|
||||
},
|
||||
"speed_test": {
|
||||
"tested_at": speed_test.get("tested_at", ""),
|
||||
"download_mbps": speed_test.get("download_mbps"),
|
||||
"upload_mbps": speed_test.get("upload_mbps"),
|
||||
"provider": speed_test.get("provider", ""),
|
||||
},
|
||||
"call_log": data.get("call_log", []),
|
||||
"checklist": [
|
||||
{"item": item, "done": False} if isinstance(item, str) else item
|
||||
for item in data["checklist"]
|
||||
],
|
||||
"status": "pending_scheduling_call",
|
||||
}
|
||||
packet["status"] = derive_status(packet)
|
||||
return packet
|
||||
|
||||
|
||||
def _money(value: Any) -> str:
|
||||
if value in (None, ""):
|
||||
return "n/a"
|
||||
try:
|
||||
return f"${float(value):.2f}"
|
||||
except (TypeError, ValueError):
|
||||
return str(value)
|
||||
|
||||
|
||||
def _bool_label(value: bool) -> str:
|
||||
return "yes" if value else "no"
|
||||
|
||||
|
||||
def render_markdown(packet: dict[str, Any], data: dict[str, Any]) -> str:
|
||||
contact = packet["contact"]
|
||||
addr = packet["service_address"]
|
||||
availability = packet["availability"]
|
||||
pricing = packet["pricing"]
|
||||
appointment = packet["appointment"]
|
||||
installer_access = packet["installer_access"]
|
||||
payment = packet["payment"]
|
||||
speed_test = packet["speed_test"]
|
||||
|
||||
lines = [
|
||||
f"# NH Broadband Install Packet",
|
||||
"# NH Broadband Install Packet",
|
||||
"",
|
||||
f"**Packet ID:** {packet['packet_id']}",
|
||||
f"**Generated:** {packet['generated_utc']}",
|
||||
@@ -85,13 +179,44 @@ def render_markdown(packet: dict[str, Any], data: dict[str, Any]) -> str:
|
||||
f"- {addr['address']}",
|
||||
f"- {addr['city']}, {addr['state']} {addr['zip']}",
|
||||
"",
|
||||
f"## Desired Plan",
|
||||
"## Availability",
|
||||
"",
|
||||
f"{packet['desired_plan']}",
|
||||
f"- **Status:** {availability['status']}",
|
||||
f"- **Checked at:** {availability['checked_at'] or 'pending'}",
|
||||
f"- **Exact address confirmed:** {_bool_label(availability['exact_address_confirmed'])}",
|
||||
f"- **Notes:** {availability['notes'] or 'pending live lookup'}",
|
||||
"",
|
||||
"## Pricing + Plan Recommendation",
|
||||
"",
|
||||
f"- **Recommended plan:** {pricing['recommended_plan']}",
|
||||
f"- **Monthly cost:** {_money(pricing['monthly_cost_usd'])}",
|
||||
f"- **Install fee:** {_money(pricing['install_fee_usd'])}",
|
||||
f"- **Notes:** {pricing['notes'] or 'confirm on scheduling call'}",
|
||||
"",
|
||||
"## Installation Appointment",
|
||||
"",
|
||||
f"- **Scheduled:** {_bool_label(appointment['scheduled'])}",
|
||||
f"- **Date:** {appointment['date'] or 'pending'}",
|
||||
f"- **Window:** {appointment['window'] or 'pending'}",
|
||||
f"- **Confirmation #: {appointment['confirmation_number'] or 'pending'}**",
|
||||
"",
|
||||
"## Installer Access Notes",
|
||||
"",
|
||||
f"- **Installer can reach cabin:** {_bool_label(installer_access['installer_can_reach_cabin'])}",
|
||||
f"- **Driveway note:** {installer_access['driveway_note'] or 'pending'}",
|
||||
f"- **Site contact:** {installer_access['site_contact'] or contact['phone']}",
|
||||
"",
|
||||
"## Payment",
|
||||
"",
|
||||
f"- **Method:** {payment['method'] or 'pending'}",
|
||||
f"- **First month due:** {_money(payment['first_month_due_usd'])}",
|
||||
f"- **Install fee due:** {_money(payment['install_fee_due_usd'])}",
|
||||
f"- **Notes:** {payment['notes'] or 'confirm on scheduling call'}",
|
||||
"",
|
||||
"## Call Log",
|
||||
"",
|
||||
]
|
||||
|
||||
if packet["call_log"]:
|
||||
for entry in packet["call_log"]:
|
||||
ts = entry.get("timestamp", "n/a")
|
||||
@@ -112,6 +237,17 @@ def render_markdown(packet: dict[str, Any], data: dict[str, Any]) -> str:
|
||||
mark = "x" if item.get("done") else " "
|
||||
lines.append(f"- [{mark}] {item['item']}")
|
||||
|
||||
if speed_test.get("tested_at") or speed_test.get("download_mbps") or speed_test.get("upload_mbps"):
|
||||
lines.extend([
|
||||
"",
|
||||
"## Post-install Speed Test",
|
||||
"",
|
||||
f"- **Tested at:** {speed_test['tested_at'] or 'pending'}",
|
||||
f"- **Download:** {speed_test['download_mbps'] or 'pending'} Mbps",
|
||||
f"- **Upload:** {speed_test['upload_mbps'] or 'pending'} Mbps",
|
||||
f"- **Provider:** {speed_test['provider'] or 'pending'}",
|
||||
])
|
||||
|
||||
lines.append("")
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
@@ -32,11 +32,45 @@ def test_load_and_build_packet() -> None:
|
||||
assert packet["contact"]["name"] == "Timmy Operator"
|
||||
assert packet["service_address"]["city"] == "Concord"
|
||||
assert packet["service_address"]["state"] == "NH"
|
||||
assert packet["status"] == "pending_scheduling_call"
|
||||
assert packet["availability"]["status"] == "available"
|
||||
assert packet["appointment"]["scheduled"] is True
|
||||
assert packet["pricing"]["monthly_cost_usd"] == 79.95
|
||||
assert packet["installer_access"]["installer_can_reach_cabin"] is True
|
||||
assert packet["payment"]["method"] == "credit_card"
|
||||
assert packet["status"] == "scheduled_install"
|
||||
assert len(packet["checklist"]) == 8
|
||||
assert packet["checklist"][0]["done"] is False
|
||||
|
||||
|
||||
def test_build_packet_marks_blocked_when_availability_fails() -> None:
|
||||
data = load_request("docs/nh-broadband-install-request.example.yaml")
|
||||
data["availability"] = {
|
||||
"status": "unavailable",
|
||||
"checked_at": "2026-04-17T16:00:00Z",
|
||||
"notes": "Address lookup returned no fiber service.",
|
||||
}
|
||||
data["appointment"] = {}
|
||||
data["speed_test"] = {}
|
||||
|
||||
packet = build_packet(data)
|
||||
|
||||
assert packet["status"] == "blocked_unavailable"
|
||||
|
||||
|
||||
def test_build_packet_marks_post_install_verified_when_speed_test_present() -> None:
|
||||
data = load_request("docs/nh-broadband-install-request.example.yaml")
|
||||
data["speed_test"] = {
|
||||
"tested_at": "2026-05-01T18:30:00Z",
|
||||
"download_mbps": 942.6,
|
||||
"upload_mbps": 881.4,
|
||||
"provider": "fast.com",
|
||||
}
|
||||
|
||||
packet = build_packet(data)
|
||||
|
||||
assert packet["status"] == "post_install_verified"
|
||||
|
||||
|
||||
def test_validate_rejects_missing_contact_name() -> None:
|
||||
data = {
|
||||
"contact": {"name": "", "phone": "555"},
|
||||
@@ -86,6 +120,11 @@ def test_render_markdown_contains_key_sections() -> None:
|
||||
assert "# NH Broadband Install Packet" in md
|
||||
assert "## Contact" in md
|
||||
assert "## Service Address" in md
|
||||
assert "## Availability" in md
|
||||
assert "## Pricing + Plan Recommendation" in md
|
||||
assert "## Installation Appointment" in md
|
||||
assert "## Installer Access Notes" in md
|
||||
assert "## Payment" in md
|
||||
assert "## Call Log" in md
|
||||
assert "## Appointment Checklist" in md
|
||||
assert "Concord" in md
|
||||
@@ -97,6 +136,8 @@ def test_render_markdown_shows_checklist_items() -> None:
|
||||
packet = build_packet(data)
|
||||
md = render_markdown(packet, data)
|
||||
assert "- [ ] Confirm exact-address availability" in md
|
||||
assert "Installer can reach cabin" in md
|
||||
assert "- **Confirmation #: NHB-2026-0417**" in md
|
||||
|
||||
|
||||
def test_example_yaml_is_valid() -> None:
|
||||
|
||||
Reference in New Issue
Block a user