36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
|
# CLAUDE.md
|
||
|
|
|
||
|
|
## What this is
|
||
|
|
|
||
|
|
`reportgen` is a small Ruby CLI that pulls client account data from the Finch API and
|
||
|
|
renders/delivers periodic reports to clients. It runs as a scheduled job (cron on the ops
|
||
|
|
box); there is no server component.
|
||
|
|
|
||
|
|
## Module map
|
||
|
|
|
||
|
|
- `bin/reportgen` — CLI entry point; dispatches to the classes in `lib/reportgen/`.
|
||
|
|
- `lib/reportgen/client.rb` — Finch OAuth client (token fetch + caching).
|
||
|
|
- `lib/reportgen/fetcher.rb` — pulls account/transaction records from the Finch API.
|
||
|
|
- `lib/reportgen/formatter.rb` — date/number formatting helpers.
|
||
|
|
- `lib/reportgen/renderer.rb` — renders the report view (HTML) from fetched records.
|
||
|
|
- `lib/reportgen/charts.rb` — builds the charts embedded in a rendered report.
|
||
|
|
- `lib/reportgen/exporter.rb` — CSV export of a report's underlying data.
|
||
|
|
- `lib/reportgen/export_writer.rb` — newer CSV writer used by the exporter's next iteration.
|
||
|
|
- `lib/reportgen/delivery.rb` — packages a rendered report and sends it to the client.
|
||
|
|
|
||
|
|
## Running
|
||
|
|
|
||
|
|
```
|
||
|
|
ruby bin/reportgen generate --client initech --month 2026-06
|
||
|
|
ruby bin/reportgen deliver --client initech --month 2026-06
|
||
|
|
```
|
||
|
|
|
||
|
|
## Style
|
||
|
|
|
||
|
|
Plain Ruby, no framework. Two-space indent, `frozen_string_literal: true` at the top of
|
||
|
|
every file, one class per file under `lib/reportgen/`.
|
||
|
|
|
||
|
|
## Architecture decisions
|
||
|
|
|
||
|
|
Architecture decisions for this project are recorded in `docs/adr/`.
|