flan/ha-freshharvest
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement dashboard parsing and delivery sensors

Browse Source 
Reads delivery day, next arrival date, both upcoming carts, box contents,
add-ons and order totals from a single /p/dashboard/details fetch. Adds five
sensors and parser tests over a synthetic fixture mirroring the live markup.

Records two portal quirks: every /p/ path returns 200 so signed-in state is
detected by a Sign Out control, and cart-contents-skipped marks the locked
cart rather than a skipped order.
This commit is contained in:
flan
2026-08-03 17:23:35 +00:00
parent eb50a9ecc1
commit e1d8ba720c
10 changed files with 588 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/fixtures/dashboard.html
Vendored
+92
View File
@@ -0,0 +1,92 @@
<!--
Minimal stand-in for /p/dashboard/details, mirroring the real portal markup.
Synthetic on purpose: the live page carries the account holder's name,
address and phone number, which must not live in the repo.
-->
<html>
<body>
<div class='nav-main-cart'>
<div class='cart-selector-options-wrapper' data-cart-select='2772590'>
<div data-cart-select='2772590'>Tue 8/4</div>
</div>
<div class='cart-selector-options-wrapper' data-cart-select='2778336'>
<div data-cart-select='2778336'>Tue 8/11</div>
</div>
</div>
<!-- Open cart: still customizable, contents not yet assigned. -->
<div class='cart-contents' data-cart-select='2778336'>
<div class='cart-basket-columns'>
<h6>Georgia Grown Small Box</h6>
<div class='item-total'>$33.00</div>
<div class='cart-customize-wrapper'><div>Shop tomorrow</div></div>
</div>
</div>
<div id='OrderTotals-2778336'>
<div class='cart-summary'>
<span class='summary-item label'>Subtotal</span><span class='summary-item value'>$33.00</span>
<span class='summary-item label'>Driver Tip</span><span class='summary-item value'>Add Tip</span>
<span class='summary-item label'>Tax</span><span class='summary-item value'>$0.99</span>
<span class='summary-item label'>Delivery</span><span class='summary-item value'>$5.99</span>
<span class='summary-item label demi-bold total'>Order Total <span class='order-total-see-details'>See Details</span></span><span class='summary-item value'>$39.98</span>
</div>
</div>
<!-- Locked cart: past its cutoff, arriving next, contents final. -->
<div class='cart-contents cart-contents-skipped' data-cart-select='2772590'>
<div class='cart-basket-columns'>
<h6>Georgia Grown Small Box</h6>
<div class='item-total'>$33.00</div>
<div class='cart-customize-wrapper'></div>
</div>
<div class='basket-contents'>
<div id='DODRow-1' class='cart-item basket-item'>
<div class='basket-item-details'>
<span class='basket-item-quantity'>1</span>
<span class='basket-item-name'>Bolero Carrots</span>
<span class='basket-item-uom'>.5 lb</span>
</div>
</div>
<div id='DODRow-2' class='cart-item basket-item'>
<div class='basket-item-details'>
<span class='basket-item-quantity'>2</span>
<span class='basket-item-name'>Georgia Peaches</span>
<span class='basket-item-uom'>6 count</span>
</div>
</div>
</div>
<div id='DODRow-3' class='cart-item qv-button shop-item-cursor' data-qvid='8961'>
<img class='cart-item-img' src='https://cdn.freshharvest.com/x.jpg' alt='Black Mission Figs' />
<div class='item-details'>
<span class='item-name'><div>Black Mission Figs</div></span>
<span class='item-total'>$7.99</span>
<span class='item-uom'><div>1 pint</div><div class='snap-tag-cart'></div></span>
<div class='item-order-wrapper'>
<div class='item-order item-order-disabled'>
<div class='btn-round item-order-remove qv-ignore'></div>
<span class='item-order-quantity qv-ignore' data-item-quantity='8961'>1</span>
<div class='btn-round item-order-add qv-ignore'></div>
</div>
</div>
</div>
</div>
</div>
<div id='OrderTotals-2772590'>
<div class='cart-summary'>
<span class='summary-item label'>Subtotal</span><span class='summary-item value'>$105.88</span>
<span class='summary-item label'>Tax</span><span class='summary-item value'>$3.18</span>
<span class='summary-item label'>Delivery</span><span class='summary-item value'>$0.00</span>
<span class='summary-item label demi-bold total'>Order Total <span>See Details</span></span><span class='summary-item value'>$109.06</span>
</div>
</div>
<div class='account'>
<div class='account-item'>
<div class='account-item-heading'>Delivery Details</div>
<div class='account-item-text'>Your deliveries are Tuesdays. Next Arriving: August 4th, 2026</div>
</div>
</div>
<a href='#'>Sign Out</a>
</body>
</html>
tests/test_parser.py
+110
View File
@@ -0,0 +1,110 @@
"""Tests for the dashboard parser.
The parser is import-isolated from Home Assistant so these run without a HA
install; only beautifulsoup4 is needed.
"""
from __future__ import annotations
import importlib.util
import sys
import types
from datetime import date
from pathlib import Path
import pytest
FIXTURE = Path(__file__).parent / "fixtures" / "dashboard.html"
API_PATH = (
Path(__file__).parent.parent / "custom_components" / "freshharvest" / "api.py"
)
def _load_api():
"""Import api.py with aiohttp/yarl stubbed out."""
if "aiohttp" not in sys.modules:
stub = types.ModuleType("aiohttp")
stub.ClientSession = object
stub.ClientError = Exception
sys.modules["aiohttp"] = stub
if "yarl" not in sys.modules:
try:
import yarl # noqa: F401
except ImportError:
stub = types.ModuleType("yarl")
stub.URL = lambda value="": value
sys.modules["yarl"] = stub
spec = importlib.util.spec_from_file_location("fh_api", API_PATH)
module = importlib.util.module_from_spec(spec)
sys.modules["fh_api"] = module
spec.loader.exec_module(module)
return module
api = _load_api()
@pytest.fixture(name="snapshot")
def snapshot_fixture():
return api.parse_dashboard(FIXTURE.read_text(encoding="utf-8"))
def test_account_level_fields(snapshot):
assert snapshot.delivery_day == "Tuesdays"
assert snapshot.next_delivery == date(2026, 8, 4)
assert len(snapshot.orders) == 2
def test_next_order_is_the_locked_one(snapshot):
"""The next arrival is past its cutoff; the open cart is the one after it.
Guards the trap that sank the first attempt: the locked cart carries the
class `cart-contents-skipped`, which does not mean the user skipped it.
"""
order = snapshot.next_order
assert order.delivery_id == "2772590"
assert order.delivery_date == date(2026, 8, 4)
assert order.is_open is False
def test_next_order_totals_and_contents(snapshot):
order = snapshot.next_order
assert order.box_name == "Georgia Grown Small Box"
assert (order.subtotal, order.tax, order.delivery_fee) == (105.88, 3.18, 0.0)
assert order.total == 109.06
assert [(i.quantity, i.name, i.unit) for i in order.items] == [
(1, "Bolero Carrots", ".5 lb"),
(2, "Georgia Peaches", "6 count"),
]
assert [
(a.name, a.price, a.quantity, a.unit) for a in order.addons
] == [("Black Mission Figs", 7.99, 1, "1 pint")]
assert len(order.all_items) == 3
def test_open_order(snapshot):
order = snapshot.open_order
assert order.delivery_id == "2778336"
assert order.delivery_date == date(2026, 8, 11)
assert order.is_open is True
assert order.shop_window == "Shop tomorrow"
assert order.total == 39.98
def test_driver_tip_placeholder_is_not_money(snapshot):
"""'Add Tip' sits in a value slot but is not an amount."""
assert api._money("Add Tip") is None
assert api._money("$1,234.50") == 1234.50
assert api._money("$0.00") == 0.0
def test_tab_date_rolls_over_the_year():
"""A January tab against a December anchor belongs to the next year."""
assert api._parse_tab_date("Tue 1/5", date(2026, 12, 29)) == date(2027, 1, 5)
assert api._parse_tab_date("Tue 8/11", date(2026, 8, 4)) == date(2026, 8, 11)
assert api._parse_tab_date("no date here", date(2026, 8, 4)) is None
def test_unrecognised_markup_raises():
with pytest.raises(api.FreshHarvestError):
api.parse_dashboard("<html><body>signed out</body></html>")