9 Commits
Author SHA1 Message Date
rick 1309cff411 Merge agent/add-oktoberfest-keg-art: Löwenbräu Oktoberfestbier spelling, v0.4.5 2026-11-07 12:37:15 +01:00
rickandCursor 5e1f790420 openspec(add-oktoberfest-keg-art): ship without on-device check 4.1 (maintainer decision)
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:36:07 +01:00
rickandCursor 7f7ac13fda openspec(add-oktoberfest-keg-art): apply progress (rename, card artwork, 0.4.5)
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:35:35 +01:00
rickandCursor 1598e7b031 Spell keg 29745 as Löwenbräu Oktoberfestbier; version 0.4.5
The catalog had the umlauts stripped, unlike its own 454 entry (Löwenbräu) and the companion card. Product ID and position are unchanged. Issue #8; ships with card 0.4.5, which adds keg artwork for both Oktoberfestbier kegs.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:34:20 +01:00
rickandCursor 88dc717833 openspec(add-oktoberfest-keg-art): propose artifacts
Issue #8: keg artwork for Löwenbräu (29745) and Spaten (33918) Oktoberfestbier on the card, and the integration's 29745 name spelled with umlauts. Joint 0.4.5 release.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:32:48 +01:00
rickandCursor d0bbda6b51 PROJECT_HYGIENE: note pre-existing main-spec format failures
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:26:48 +01:00
rickandCursor 89783da7af openspec: archive add-keg-48180, sync specs
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:26:10 +01:00
rickandCursor 8f2bced6ee openspec: archive fix-cognito-signin, sync specs
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:26:10 +01:00
rickandCursor 82062da60c openspec: archive add-keg-47792, sync specs
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-11-07 12:26:10 +01:00
27 changed files with 185 additions and 15 deletions
+2 -1
View File
@@ -197,7 +197,8 @@ When the user corrects your approach, append a one-line rule here before ending
- **`test_harness.py` is stale: it reads `user_id` from `.credentials.json`, which now holds `email` / `access_token` / `id_token` / `refresh_token`.** It exits before doing anything useful. Fix the key names (and refresh the token per the README's reCAPTCHA step) before relying on it.
- **All five files in `openspec/specs/` fail `openspec validate --specs`** for a missing `## Purpose` section. Pre-existing and repo-wide as of 2026-09-06, so a failing spec validation is not necessarily caused by your change — check whether the error is only the Purpose one before chasing it.
- **TODO — verification debt from `fix-cognito-signin` (v0.4.4 shipped without on-device checks, maintainer decision 2026-11-07).** The Cognito direct sign-in was verified only by the automated suite (stdlib API tests and pytest config-flow tests) and the README token was checked in Firefox and Chromium; no sign-in reached the live service from Home Assistant. When there is time for a reinstall: (1) add the integration from scratch with a README token and confirm sensors populate; (2) a wrong password must return to the email/password form with `invalid_credentials` and Cognito's reason, and a token older than 2 minutes must stay on the token step with `token_rejected`; (3) trigger a reauth and confirm it succeeds (with a keg fitted, this also clears the Keg Freshness TODO above). Details in the archived change's `tasks.md`, section "Deferred".
- **TODO — verification debt from `add-keg-48180` (card 0.4.4 shipped without an on-device check, maintainer decision 2026-11-07).** Do it together with the `fix-cognito-signin` checks above: on a dashboard with card 0.4.4, confirm the card editor's beer picker lists Camden Stout with its artwork; with a 48180 keg fitted, confirm the Keg sensor reads "Camden Stout" and the card brands it.
- **TODO — verification debt from `add-keg-48180` and `add-oktoberfest-keg-art` (card 0.4.4 and 0.4.5 shipped without on-device checks, maintainer decisions 2026-11-07).** Do it together with the `fix-cognito-signin` checks above, on integration and card 0.4.5 or later: confirm the card editor's beer picker shows artwork for Camden Stout, Löwenbräu Oktoberfestbier and Spaten Oktoberfestbier, and that the two Oktoberfest images are sharp in the `hero` layout. With a 48180 keg fitted, confirm the Keg sensor reads "Camden Stout" and the card brands it. With a 29745 keg fitted, the sensor must read "Löwenbräu Oktoberfestbier" (with umlauts).
- **TODO — main specs fail `openspec validate --specs --strict` (all 5, pre-existing; seen 2026-11-07).** None of `openspec/specs/*/spec.md` has the `## Purpose` / `## Requirements` headers the current CLI requires; requirements start directly at `### Requirement:`. Archiving still works, but sync tooling and validation expect the headers. Fix in one housekeeping commit: add a short `## Purpose` and a `## Requirements` heading to each spec, then re-run strict validation.
- **TODO — own OpenSpec change: persist Cognito-refreshed tokens back to the config entry.** `PerfectDraftApiClient.refresh_access_token()` updates `_access_token`/`_id_token` in memory only, so every HA restart reloads the stale access token and burns a wasted 401-plus-refresh round trip before the first successful poll. Harmless today because the refresh token is what actually gates reauth and Cognito's `REFRESH_TOKEN_AUTH` never issues a new one, so nothing is lost — just wasteful. Deferred out of `fix-reauth-flow` to keep that diff surgical.
- **TODO — housekeeping, after `fix-cognito-signin` / `add-keg-48180` ship: take the GitHub token out of the `github` remote URLs** in both this repo and `Hassio-PerfectDraftPro-Component`. Not a leak (never committed; `.git/` is untracked), but `git remote -v` prints it. Order matters: first change `credential.helper` to an **absolute** path (`store --file=/home/rick/Lab/Dev/<repo>/.git/credentials`) — the current relative `.git/credentials` resolves against the worktree root, where `.git` is a file, so pushes from `.worktree/<topic>` only reach `github` (whose URL carries the token); pushing to `origin` from a worktree fails with "unable to open .git/credentials: Not a directory". Until fixed, push agent branches from the main checkout: `git push origin agent/<topic>` (no branch switch needed). Then strip the URL, run `git ls-remote github` from a worktree to prove auth, and update the `AGENTS.md` helper command to the absolute form.
- **Config-flow tests run in `.venv-test` (main checkout) on the system Python 3.14** with `pytest-homeassistant-custom-component==0.13.375` (core 2026.10.4). Run them from a worktree as `../../.venv-test/bin/pytest tests/`. Do not pin a harness that needs Python 3.12: there is no 3.12 and no C compiler on the dev host, so old numpy cannot build.
@@ -21,7 +21,7 @@
"2565": "Hoegaarden Rose",
"3550": "Leffe Winter",
"9156": "Leffe Royal Cascade",
"29745": "Lowenbrau Oktoberfestbier",
"29745": "Löwenbräu Oktoberfestbier",
"29775": "Goose Island Midway",
"29896": "Kwak",
"29974": "Spaten",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"domain": "perfectdraft",
"name": "PerfectDraft",
"version": "0.4.4",
"version": "0.4.5",
"documentation": "https://github.com/Falkvinge/hassio-integration-perfectdraft-pro",
"issue_tracker": "https://github.com/Falkvinge/hassio-integration-perfectdraft-pro/issues",
"codeowners": ["@Falkvinge"],
@@ -0,0 +1,3 @@
schema: spec-driven
created: 2026-11-07
skip_specs: true
@@ -0,0 +1,42 @@
## Context
See proposal.md for why. The card resolves a fitted keg by product ID through `getBeerByKegId` and keeps its own curated name when the ID matches. So the integration's name for `29745` only reaches the **Keg** sensor state, never the card label. `npm run check:catalog` compares IDs only, not names, but `scripts/keg-catalog.reference.json` is meant to be a faithful snapshot of the integration catalog (`_upstreamCommit` is currently `8b2c4418`).
Existing keg art is WebP, capped at 800 px (`spaten.webp` is 800×800, about 25 KB), as set by the card's `card-layouts-and-imagery` design. The two sources, checked 2026-11-07:
| Beer | Source image | Size |
|---|---|---|
| Löwenbräu Oktoberfestbier | `media/catalog/product/k/e/kegs--lowenbrau--oktoberfest2023.png` | 1200×1200 PNG |
| Spaten Oktoberfestbier | `media/catalog/product/s/p/spaten_oktoberfest_6l_keg_1_1.png` | 700×700 PNG |
Both are under `https://www.perfectdraft.com/`, from the DE product pages linked in issue #8. The page thumbnails carry Magento resize parameters (`?optimize=medium&…&width=265`). Drop those to get the originals above.
## Goals / Non-Goals
**Goals:**
- Both Oktoberfest kegs render their keg photo on the card, sharp in `hero` and `vessel`.
- The integration and the card spell Löwenbräu the same way.
**Non-Goals:**
- Changing any card entry field other than `imagePath`.
- A new image pipeline or script. This is two one-off conversions.
## Decisions
**Slugs as file names.** The files are `lowenbrau-oktoberfest.webp` and `spaten-oktoberfest.webp`, so `kegImage(slug)` resolves them with no special case, as for every other entry.
**Encode to match the existing art: WebP, longest edge at most 800 px, no upscaling.** Löwenbräu goes from 1200 to 800 px. Spaten stays at its native 700 px, because upscaling adds bytes without adding detail, and CSS scales it anyway. The conversion uses Pillow (WebP support confirmed on the dev host); `cwebp` is not installed. Pick a quality setting that keeps each file in the range of the existing art (about 25–40 KB), then check it by eye at hero size. Keep the source PNGs out of the repo.
**Rename to the brand's spelling, "Löwenbräu Oktoberfestbier".** This matches the integration's own `454` entry, the card entry, the storefront page and the issue. The catalog's observation rule applies to which ID maps to which beer, and that is unchanged: the reporter's machine reports `29745` for this keg. The alternative was leaving the name alone, since the card ignores it. It was rejected because the sensor state is user-visible and inconsistent with `454`.
**Order: integration commit first, then card.** The card's reference snapshot records the integration commit (`_upstreamCommit`) and must contain the new name. Because it cites the commit, the integration commit has to exist on `agent/add-oktoberfest-keg-art` first. Re-check the hash after any rebase or merge that rewrites it.
**Versions: both packages go to 0.4.5.** Both change, so this is a joint release under the numbering rule in `PROJECT_HYGIENE.md`. The integration bumps `manifest.json`. The card bumps `package.json`, `CARD_VERSION` and `EDITOR_VERSION`, and regenerates `package-lock.json` with `npm install --package-lock-only`.
## Risks / Trade-offs
- [The Löwenbräu source file is named `oktoberfest2023`, so it may show an older keg design than the one shipping now] → The DE storefront itself shows it, so it is what owners will recognise. Swapping it later is a one-file change.
- [Users with automations matching the string "Lowenbrau Oktoberfestbier"] → Unlikely, since the card matches on ID. Call out the rename in the release notes.
- [HACS users update only one package] → Card only: artwork appears, and the sensor keeps the old spelling. Integration only: the spelling is fixed, and the card still shows the silhouette. Neither breaks anything. The release notes say to update both.
@@ -0,0 +1,39 @@
## Why
[Issue #8](https://github.com/Falkvinge/hassio-integration-perfectdraft-pro/issues/8): reimargithub reports that the card shows no keg picture for Löwenbräu Oktoberfestbier (`29745`), and asks about Spaten Oktoberfestbier, which he has since fitted. He gave its product ID, `33918`, in a follow-up comment.
Both beers are already known to both packages. The integration's `keg_catalog.json` names both IDs, and the card has `lowenbrau-oktoberfest` and `spaten-oktoberfest` entries bound to them by `kegId`. What is missing is the artwork. Neither card entry has an `imagePath`, so the card falls back to the generated silhouette. One small inconsistency comes along with this: the integration names `29745` "Lowenbrau Oktoberfestbier", without the umlauts that its own `454` entry ("Löwenbräu") and the card both use.
## What Changes
- Companion card:
- Add `src/assets/kegs/lowenbrau-oktoberfest.webp` and `src/assets/kegs/spaten-oktoberfest.webp`, sourced once from the PerfectDraft DE storefront pages linked in the issue.
- Set `imagePath: kegImage(...)` on the two existing entries. Name, ABV, style, colours and `kegId` stay unchanged; the storefront ABVs (6.1% and 5.9%) already match.
- Re-sync `scripts/keg-catalog.reference.json` to the integration commit with the rename.
- Bump the card to 0.4.5 and rebuild `dist/`.
- Integration:
- Rename `29745` to "Löwenbräu Oktoberfestbier" in `keg_catalog.json`. The key, its position and the count (117) stay the same.
- Bump to 0.4.5, so the joint release puts both packages on the same version.
- Close issue #8 with a thank-you and the release link.
Not in scope:
- Other card entries without artwork, such as `leffe-winter`.
- Other ASCII-only names in the integration catalog. None are known, and checking every name against the app is a separate job.
## Capabilities
### New Capabilities
None.
### Modified Capabilities
None. The integration's `entities` spec already requires catalog names to be the beer's name, and the floor of 117 IDs is unchanged. The card's own `beer-imagery` spec already requires bundled keg photos for currently-sold beers. This change brings both packages into line with requirements they already have, so it sets `skip_specs: true`.
## Impact
- The **Keg** sensor for `29745` reads "Löwenbräu Oktoberfestbier" instead of "Lowenbrau Oktoberfestbier". The entity ID doesn't change. History shows the new state from the update onwards, and automations comparing against the old string need updating. Such automations are unlikely, since the card matches on product ID.
- On the card, both Oktoberfest kegs show their keg photo in every layout, including the beer picker in the editor.
- Integration: `custom_components/perfectdraft/keg_catalog.json`, `custom_components/perfectdraft/manifest.json`.
- Card repo (`Hassio-PerfectDraftPro-Component`): `src/assets/kegs/` (two new files), `src/beer-catalog.ts`, `scripts/keg-catalog.reference.json`, `package.json`, `package-lock.json`, `CARD_VERSION`, `EDITOR_VERSION`, `dist/`.
@@ -0,0 +1,37 @@
## 1. Worktrees
- [x] 1.1 `scripts/agent-worktree.sh create add-oktoberfest-keg-art` in the integration repo, and an equivalent `.worktree/add-oktoberfest-keg-art` on branch `agent/add-oktoberfest-keg-art` in `Hassio-PerfectDraftPro-Component`; verify `.agent-lock` exists in both and `git worktree list` shows both branches
## 2. Integration rename
- [x] 2.1 Change `"29745"` in `custom_components/perfectdraft/keg_catalog.json` to `"Löwenbräu Oktoberfestbier"`, in place; verify `git diff` is a single-line change and the file is still UTF-8 (written as literal characters, like `454`, not `\u` escapes)
- [x] 2.2 Assert `catalog["29745"] == "Löwenbräu Oktoberfestbier"` in `tests/test_keg_catalog.py`, leaving `MINIMUM_ENTRIES` at 117; verify `python3 -m unittest tests.test_keg_catalog` passes
- [x] 2.3 Bump `manifest.json` to 0.4.5 and commit; record the commit hash here for 3.3
- Commit `1598e7b` on `agent/add-oktoberfest-keg-art`
## 3. Card artwork
Work in `Hassio-PerfectDraftPro-Component`.
- [x] 3.1 Download the two source PNGs listed in design.md (no resize query string) to a scratch directory outside the repo; verify 1200×1200 and 700×700
- Downloaded to `/tmp/oktoberfest-art/`: 1200×1200 and 700×700 RGBA PNGs
- [x] 3.2 Encode them with Pillow to `src/assets/kegs/lowenbrau-oktoberfest.webp` (800 px) and `src/assets/kegs/spaten-oktoberfest.webp` (700 px, not upscaled); verify the dimensions, a file size in the range of the existing art (about 25–40 KB), and a visual check of both files
- Pillow, WebP quality 80, method 6, alpha kept: Löwenbräu 800×800 (32 KB), Spaten 700×700 (25 KB); existing art is 700 or 800 px, 16–46 KB. Checked composited on a dark background: labels sharp, no fringing
- [x] 3.3 Add `imagePath: kegImage("lowenbrau-oktoberfest")` and `imagePath: kegImage("spaten-oktoberfest")` to the two existing entries, changing no other field; re-sync `scripts/keg-catalog.reference.json` from the commit in 2.3 and set `_upstreamCommit` to it; verify the snapshot diff is only the `29745` name and the commit hash
- Snapshot `_upstreamCommit` is `1598e7b0`; diff is that hash and the `29745` name only
- [x] 3.4 Bump `package.json`, `CARD_VERSION` and `EDITOR_VERSION` to 0.4.5; regenerate `package-lock.json` with `npm install --package-lock-only`
- Lockfile diff is the two version fields only
- [x] 3.5 `npm run lint`, `npm run check:catalog` (117/117, snapshot at the 2.3 commit) and `npm run build`; verify both `.webp` files are in `dist/kegs/`, then commit source and `dist/`
- Lint clean; `check:catalog` 117/117 @ `1598e7b0`; build copies both files to `dist/kegs/`; bundle has both `imagePath`s and no `0.4.4`. Card commit `a79173a`
## Deferred: shipping without on-device checks
Maintainer decision, 2026-11-07: ship integration and card 0.4.5 without this check, as with 0.4.4 (no Home Assistant on the dev host). Coverage at release: catalog unit tests (117 keys, the new 29745 name), `npm run lint`, `npm run check:catalog` (117/117), a clean `npm run build` with both images in `dist/kegs/`, and a visual check of both encoded images. The open TODO is in `PROJECT_HYGIENE.md`.
- 4.1 Install integration 0.4.5 and card 0.4.5 on Home Assistant; confirm the card editor's beer picker shows artwork for both Oktoberfest entries and that each renders sharply in the `hero` layout; with a 29745 or 33918 keg unavailable, also confirm `getBeerByKegId("29745")` and `getBeerByKegId("33918")` return entries with an `imagePath` in a browser console on the dashboard
## Workflow follow-up
- Joint release: integration v0.4.5 and card v0.4.5, published together. The release notes thank reimargithub, mention the 29745 rename for anyone matching the old string, and tell users to update both.
- After the release, close issue #8 with a thank-you and the release links.
- Archive per `AGENTS.md` in both repos (merge, push, archive, remove worktrees and branches). The change has no spec deltas to sync.
@@ -1,7 +1,8 @@
## 1. Name and worktrees
- [ ] 1.1 Ask MThomas564 on PR #10 whether the keg or the PerfectDraft app calls 48180 "Camden Stout" or "Camden Nitro Stout"; record the answer (or "no reply by release, shipping Camden Stout") in this file
- Asked 2026-11-07: https://github.com/Falkvinge/hassio-integration-perfectdraft-pro/pull/10#issuecomment-6706008826 — awaiting reply; implementation proceeds with "Camden Stout"
- [x] 1.1 Ask MThomas564 on PR #10 whether the keg or the PerfectDraft app calls 48180 "Camden Stout" or "Camden Nitro Stout"; record the answer (or "no reply by release, shipping Camden Stout") in this file
- Asked 2026-11-07: https://github.com/Falkvinge/hassio-integration-perfectdraft-pro/pull/10#issuecomment-6706008826
- Answer 2026-11-07 11:13 UTC: the PerfectDraft app shows "Camden Stout" (the store lists "Camden Nitro Stout"); the catalog follows the app, so "Camden Stout" stands
- [x] 1.2 `scripts/agent-worktree.sh create add-keg-48180` in the integration repo, and an equivalent `.worktree/add-keg-48180` on branch `agent/add-keg-48180` in `Hassio-PerfectDraftPro-Component`; confirm `.agent-lock` in both
## 2. Integration catalog
+34 -4
View File
@@ -8,16 +8,46 @@ The integration SHALL provide an async API client class (`PerfectDraftApiClient`
- **THEN** it SHALL store the session and set the base URL to `https://api.perfectdraft.com`
### Requirement: Sign-in with reCAPTCHA token
The client SHALL authenticate by POSTing to `/authentication/sign-in` with email, password, recaptchaToken, and recaptchaAction fields. The `x-api-key` SHALL be sent as a header. The `recaptchaAction` SHALL be `Magento/login`.
The client SHALL authenticate by calling AWS Cognito `InitiateAuth` at `https://cognito-idp.eu-west-1.amazonaws.com/` with `AuthFlow: USER_PASSWORD_AUTH`, the Cognito client ID, and the email and password as `USERNAME` and `PASSWORD`. `ClientMetadata` SHALL carry `recaptchaToken`, `recaptchaAction: Magento/login`, and `domain: https://www.perfectdraft.com`, all three of which PerfectDraft's PreAuthentication check requires. The client SHALL NOT sign in through `api.perfectdraft.com/authentication/sign-in`, which does not forward `domain`.
#### Scenario: Successful sign-in
- **WHEN** the client calls `authenticate(email, password, recaptcha_token)`
- **THEN** it SHALL POST to `/authentication/sign-in` with the correct payload and `x-api-key` header
- **THEN** it SHALL store the returned `AccessToken`, `IdToken`, and `RefreshToken`
- **THEN** it SHALL POST an `InitiateAuth` request to Cognito with `Content-Type: application/x-amz-json-1.1` and `X-Amz-Target: AWSCognitoIdentityProviderService.InitiateAuth`
- **THEN** the request SHALL carry the `ClientMetadata` fields listed above
- **THEN** it SHALL parse the response with `content_type=None` to accept `application/x-amz-json-1.1`
- **THEN** it SHALL store the `AccessToken`, `IdToken`, and `RefreshToken` from `AuthenticationResult`
#### Scenario: Challenge instead of tokens
- **WHEN** Cognito answers 200 without a complete `AuthenticationResult`, for example with a `ChallengeName`
- **THEN** the client SHALL raise `AuthenticationError`, carrying the challenge name as its error type when present
- **THEN** no stored token SHALL change
#### Scenario: Sign-in failure
- **WHEN** the API returns 400, 401, or 403
- **WHEN** Cognito returns 400, 401, or 403
- **THEN** the client SHALL raise `AuthenticationError` with the status and response body
- **THEN** the error SHALL expose the Cognito error type (`__type`, without any namespace prefix) and the human-readable message, when the body supplies them
#### Scenario: Rejection is classified
- **WHEN** a sign-in is rejected with error type `NotAuthorizedException` or `UserNotFoundException`
- **THEN** the error SHALL classify as a credentials failure
- **WHEN** a sign-in is rejected with error type `UserLambdaValidationException`
- **THEN** the error SHALL classify as a verification token failure
- **WHEN** a sign-in is rejected with any other error type, or none
- **THEN** the error SHALL classify as an other failure
#### Scenario: Unreadable rejection body
- **WHEN** a rejection body is not JSON, such as an HTML error page
- **THEN** the client SHALL still raise `AuthenticationError`, with no error type and a reason truncated to at most 200 characters
#### Scenario: Other sign-in failures
- **WHEN** Cognito returns any other non-200 status
- **THEN** the client SHALL raise `PerfectDraftApiError`
- **WHEN** the request fails due to `aiohttp.ClientError`
- **THEN** the client SHALL raise `PerfectDraftConnectionError`
#### Scenario: Secrets are not logged
- **WHEN** sign-in succeeds or fails
- **THEN** the password, the verification token, and the issued tokens SHALL NOT be logged
### Requirement: Token refresh via Cognito
The client SHALL refresh expired access tokens by calling AWS Cognito directly at `https://cognito-idp.eu-west-1.amazonaws.com/`, bypassing the API gateway and reCAPTCHA. The Cognito client ID is `57ddq2ppqg2jcpup06r2g1deur`.
+21 -5
View File
@@ -9,7 +9,7 @@ The config flow SHALL present a form requesting the user's PerfectDraft account
- **THEN** submitting SHALL advance to the token step
### Requirement: Token step collects verification token
The config flow SHALL present a form requesting a reCAPTCHA verification token as the second step, with instructions linking to the README.
The config flow SHALL present a form requesting a reCAPTCHA verification token as the second step, with instructions linking to the README. When authentication fails, the flow SHALL tell the user which input was rejected and show the server's reason.
#### Scenario: Token step display
- **WHEN** the user reaches the token step
@@ -24,8 +24,24 @@ The config flow SHALL present a form requesting a reCAPTCHA verification token a
- **THEN** it SHALL create a config entry storing email, access token, ID token, refresh token, and machine ID
#### Scenario: Invalid or expired token
- **WHEN** authentication fails
- **THEN** the flow SHALL show an error and allow the user to retry with a fresh token
- **WHEN** authentication fails as a verification token failure
- **THEN** the flow SHALL show the token form again with the `token_rejected` error, including the server's reason
- **THEN** the user SHALL be able to retry with a fresh token
#### Scenario: Wrong email or password
- **WHEN** authentication fails as a credentials failure
- **THEN** the flow SHALL show the credentials form again with the `invalid_credentials` error, including the server's reason
- **THEN** that form SHALL be the email and password form during setup, and the `reauth_confirm` form during reauth
- **THEN** after the user resubmits credentials, the flow SHALL ask for a fresh token
#### Scenario: Other authentication failure
- **WHEN** authentication fails for any other reason
- **THEN** the flow SHALL show the token form again with the `invalid_auth` error, including the server's reason
- **THEN** the user SHALL be able to retry with a fresh token
#### Scenario: Failure without a server reason
- **WHEN** authentication fails and the server supplied no reason
- **THEN** the error message SHALL still render, with a fixed fallback in place of the reason and no unfilled placeholder
#### Scenario: API unreachable
- **WHEN** the API is unreachable
@@ -78,8 +94,8 @@ The integration SHALL support Home Assistant's reauth mechanism when the refresh
- **THEN** the flow SHALL treat it as the same account and complete successfully
#### Scenario: Reauth authentication fails
- **WHEN** the verification token is expired or the credentials are wrong during reauth
- **THEN** the flow SHALL show the `invalid_auth` error on the token form and allow retry with a fresh token
- **WHEN** the verification token or the credentials are rejected during reauth
- **THEN** the flow SHALL show the same error, on the same form, as the matching failure during setup (`token_rejected`, `invalid_credentials` on the `reauth_confirm` form, or `invalid_auth`)
- **THEN** the existing config entry's tokens SHALL be left unchanged
#### Scenario: Machine ID lookup is skipped when already known
+1 -1
View File
@@ -59,7 +59,7 @@ The integration SHALL expose the numeric product ID of the keg currently fitted
- **THEN** the sensor SHALL report no value and SHALL NOT raise
### Requirement: Keg name sensor
The integration SHALL expose the name of the tapped beer, resolved from the keg product ID through a catalog bundled with the integration at `keg_catalog.json`. The catalog SHALL cover every keg the PerfectDraft app can select, including discontinued kegs that may still be fitted in a machine, and SHALL contain at least 115 product IDs.
The integration SHALL expose the name of the tapped beer, resolved from the keg product ID through a catalog bundled with the integration at `keg_catalog.json`. The catalog SHALL cover every keg the PerfectDraft app can select, including discontinued kegs that may still be fitted in a machine, and SHALL contain at least 117 product IDs.
Catalog entries SHALL be observed directly from a machine reporting that product ID rather than inferred from shop listings, because the product IDs cannot be queried in bulk from the API. Entry names SHALL be the beer's name only, excluding shop-listing artefacts such as pack size, "Short Date" prefixes, or best-before dates.
+1
View File
@@ -107,6 +107,7 @@ class TestKegCatalogContent(unittest.TestCase):
self.assertEqual(catalog["48050"], "Anheuser-Busch Bud")
self.assertEqual(catalog["47792"], "Camden Eazy")
self.assertEqual(catalog["48180"], "Camden Stout")
self.assertEqual(catalog["29745"], "Löwenbräu Oktoberfestbier")
if __name__ == "__main__":