woltapi 0.4.0__tar.gz → 0.4.1__tar.gz

{woltapi-0.4.0/src/woltapi.egg-info → woltapi-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woltapi
-Version: 0.4.0
+Version: 0.4.1
 Summary: A small synchronous client for observed Wolt ordering flows.
 License-Expression: AGPL-3.0-only
 Project-URL: Repository, https://github.com/skorokithakis/woltapi

woltapi-0.4.1/examples/verify_saved_basket_rebuild.py

@@ -0,0 +1,108 @@
+#!/usr/bin/env python3
+"""Verify saved baskets can be rebuilt from their current assortments.
+
+Read-only: this script only reads saved baskets and assortments. Its output is
+restricted to venue slugs, item counts, and integer cent totals.
+"""
+
+import argparse
+import math
+import re
+from collections.abc import Mapping
+from pathlib import Path
+
+from browse import TokenFileError, check_token_file, refresh_credentials
+
+from woltapi import Basket, WoltApiError, WoltClient
+
+
+class VerificationInputError(ValueError):
+    """A local saved-basket shape problem safe to report to the owner."""
+
+
+def venue_slug(saved_basket):
+    """Return the saved basket's public venue slug without exposing other fields."""
+    if not isinstance(saved_basket, Mapping):
+        raise VerificationInputError("Saved basket is not an object.")
+    venue = saved_basket.get("venue")
+    if not isinstance(venue, Mapping):
+        raise VerificationInputError("Saved basket venue is not an object.")
+    slug = venue.get("slug")
+    if not isinstance(slug, str) or re.fullmatch(r"[a-z0-9][a-z0-9-]*", slug) is None:
+        raise VerificationInputError("Saved basket venue has no usable slug.")
+    return slug
+
+
+def failure_line(slug, error):
+    """Format only local static error messages, never response-derived data."""
+    if isinstance(error, VerificationInputError):
+        message = str(error)
+    else:
+        message = "Details omitted."
+    return f"FAIL venue={slug}: {type(error).__name__}: {message}"
+
+
+def verify_baskets(client, args):
+    """Read, rebuild, and report each saved basket; return whether all passed."""
+    try:
+        page = client.get_baskets_page(args.latitude, args.longitude)
+        baskets = page.get("baskets") if isinstance(page, Mapping) else None
+        if not isinstance(baskets, list):
+            raise VerificationInputError("Saved baskets page has no baskets list.")
+    except (VerificationInputError, WoltApiError, TypeError, ValueError) as exc:
+        print(failure_line("unknown", exc))
+        return False
+
+    if not baskets:
+        # Keep the zero-basket note in the same privacy-safe output format.
+        print("PASS venue=no-saved-baskets items=0 total=0")
+        return True
+
+    passed = True
+    for saved_basket in baskets:
+        slug = "unknown"
+        try:
+            slug = venue_slug(saved_basket)
+            assortment = client.get_assortment(slug)
+            basket = Basket.from_saved_basket(assortment, saved_basket, args.language)
+            selections = basket.item_selections()
+            item_count = sum(selection.count for selection in selections)
+            total = sum(selection.basket_price for selection in selections)
+            print(f"PASS venue={slug} items={item_count} total={total}")
+        except (VerificationInputError, WoltApiError, TypeError, ValueError) as exc:
+            print(failure_line(slug, exc))
+            passed = False
+    return passed
+
+
+def main():
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("--latitude", type=float, required=True)
+    parser.add_argument("--longitude", type=float, required=True)
+    parser.add_argument("--token-file", type=Path, required=True)
+    parser.add_argument("--language", default="en")
+    args = parser.parse_args()
+    if not (
+        math.isfinite(args.latitude)
+        and -90 <= args.latitude <= 90
+        and math.isfinite(args.longitude)
+        and -180 <= args.longitude <= 180
+    ):
+        parser.error("Provide finite latitude [-90, 90] and longitude [-180, 180].")
+    check_token_file(parser, args.token_file)
+    try:
+        client = WoltClient(refresh_credentials(args.language, args.token_file))
+        return 0 if verify_baskets(client, args) else 1
+    except TokenFileError:
+        print("FAIL venue=unknown: TokenFileError: Could not save the refresh token.")
+        return 1
+    except (EOFError, KeyboardInterrupt) as exc:
+        print(f"FAIL venue=unknown: {type(exc).__name__}: Cancelled.")
+        return 1
+    except (OSError, UnicodeError, ValueError, WoltApiError) as exc:
+        print(failure_line("unknown", exc))
+        return 1
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

{woltapi-0.4.0 → woltapi-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "woltapi"
-version = "0.4.0"
+version = "0.4.1"
 description = "A small synchronous client for observed Wolt ordering flows."
 readme = "README.md"
 requires-python = ">=3.10"

{woltapi-0.4.0 → woltapi-0.4.1}/src/woltapi/basket.py

@@ -265,6 +265,10 @@ def _index_by_id(value: Any) -> dict[str, Mapping[str, Any]]:
 
 
 def _translated_name(value: Any, language: str) -> str:
+    # Catalog/read endpoints return strings; only restaurant-api purchase payloads
+    # (/v2/purchases, /v1/post-checkout-config) use list-of-{lang, value} names.
+    if _is_nonempty_text(value):
+        return value
     if not _is_array(value):
         raise SelectionError("The selected item is missing translated names.")
     for translation in value:
@@ -274,7 +278,12 @@ def _translated_name(value: Any, language: str) -> str:
         name = translation.get("value")
         if translation_language == language and _is_nonempty_text(name):
             return name
-    raise SelectionError("The selected item has no name for the basket language.")
+    for translation in value:
+        if isinstance(translation, Mapping) and _is_nonempty_text(
+            name := translation.get("value")
+        ):
+            return name
+    raise SelectionError("The selected item has no usable name.")
 
 
 def _required_fields(

{woltapi-0.4.0 → woltapi-0.4.1}/src/woltapi/purchase.py

@@ -937,6 +937,7 @@ def _purchase_option_summary(option: Mapping[str, Any]) -> PurchaseOptionSummary
 
 
 def _purchase_name_summaries(names: Any, label: str) -> tuple[PurchaseNameSummary, ...]:
+    # This list shape is correct for /v2/purchases; do not accept strings (verified by capture).
     if not _is_array(names) or not names:
         raise PurchasePreparationError(f"{label} are incomplete.")
     summaries: list[PurchaseNameSummary] = []

{woltapi-0.4.0 → woltapi-0.4.1/src/woltapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woltapi
-Version: 0.4.0
+Version: 0.4.1
 Summary: A small synchronous client for observed Wolt ordering flows.
 License-Expression: AGPL-3.0-only
 Project-URL: Repository, https://github.com/skorokithakis/woltapi

{woltapi-0.4.0 → woltapi-0.4.1}/src/woltapi.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ pyproject.toml
 examples/browse.py
 examples/check_session.py
 examples/order.py
+examples/verify_saved_basket_rebuild.py
 src/woltapi/__init__.py
 src/woltapi/auth.py
 src/woltapi/basket.py
@@ -30,4 +31,5 @@ tests/test_check_session.py
 tests/test_client.py
 tests/test_order_example.py
 tests/test_purchase.py
-tests/test_selection.py
+tests/test_selection.py
+tests/test_verify_saved_basket_rebuild_example.py

{woltapi-0.4.0 → woltapi-0.4.1}/tests/test_basket.py

@@ -81,11 +81,25 @@ def assortment() -> dict[str, Any]:
                 "vat_percentage_decimal": "14.0",
                 "options": [],
             },
+            {
+                "id": "item-waffle",
+                "name": "Βέλγικη Βάφλα",
+                "price": 525,
+                "checksum": "checksum-waffle",
+                "allowed_delivery_methods": ["homedelivery"],
+                "restrictions": [],
+                "alcohol_permille": 0,
+                "product_hierarchy_tags": ["food", "dessert"],
+                "vat_percentage": 14,
+                "vat_percentage_decimal": "14.0",
+                "options": [],
+            },
         ],
         "categories": [
             {"id": "pizza", "item_ids": ["item-1"]},
             {"id": "salad", "item_ids": ["item-2"]},
             {"id": "other", "item_ids": ["item-removed"]},
+            {"id": "dessert", "item_ids": ["item-waffle"]},
         ],
         "options": [
             {
@@ -234,7 +248,6 @@ def test_basket_mutation_rejects_duplicates_and_contents_are_detached() -> None:
         lambda data: data["categories"][0]["item_ids"].clear(),
         lambda data: data["items"][0].update(price=1.5),
         lambda data: data["options"][0]["values"][0].update(price=True),
-        lambda data: data["items"][0].update(name=[{"lang": "fi", "value": "Pizza"}]),
     ],
 )
 def test_basket_rejects_missing_catalog_fields_invalid_prices_and_names(change) -> None:
@@ -246,6 +259,25 @@ def test_basket_rejects_missing_catalog_fields_invalid_prices_and_names(change)
         basket.add_item("item-1", options=[topping("pizza-toppings", "cheese")])
 
 
+def test_basket_falls_back_to_first_list_name_without_language_match() -> None:
+    data = assortment()
+    data["items"][0]["name"] = [{"lang": "fi", "value": "Pizza"}]
+
+    basket = Basket(data, "en")
+    basket.add_item("item-1")
+
+    assert basket.item_selections()[0].basket_name == "Pizza"
+
+
+def test_basket_rejects_unusable_name_shape() -> None:
+    data = assortment()
+    data["items"][0]["name"] = {"value": "Pizza"}
+
+    basket = Basket(data, "en")
+    with pytest.raises(SelectionError):
+        basket.add_item("item-1")
+
+
 def test_basket_copies_assortment_and_option_input() -> None:
     data = assortment()
     selected = [topping("pizza-toppings", "cheese")]
@@ -275,6 +307,19 @@ def test_basket_from_saved_basket_rebuilds_catalog_prices_and_options() -> None:
     assert basket.item_selections()[0].substitution_allowed is True
 
 
+def test_basket_uses_plain_string_catalog_names_when_adding_and_rebuilding() -> None:
+    basket = Basket(assortment(), "en")
+    basket.add_item("item-waffle")
+
+    assert basket.item_selections()[0].basket_name == "Βέλγικη Βάφλα"
+
+    saved = saved_basket()
+    saved["items"][0].update(id="item-waffle", options=[])
+    rebuilt = Basket.from_saved_basket(assortment(), saved, "en")
+
+    assert rebuilt.item_selections()[0].basket_name == "Βέλγικη Βάφλα"
+
+
 def test_basket_from_saved_basket_skips_unchosen_option_configurations() -> None:
     saved = saved_basket()
     saved["items"][0]["options"].append({"id": "pizza-toppings", "values": []})

woltapi-0.4.1/tests/test_verify_saved_basket_rebuild_example.py

@@ -0,0 +1,103 @@
+import argparse
+import runpy
+from pathlib import Path
+from urllib.parse import urlsplit
+
+import pytest
+
+from tests.test_basket import assortment, saved_basket
+from tests.test_client import FakeResponse, make_client
+from woltapi import SelectionError
+
+
+def load_example(monkeypatch):
+    examples = Path(__file__).resolve().parents[1] / "examples"
+    monkeypatch.syspath_prepend(str(examples))
+    return runpy.run_path(str(examples / "verify_saved_basket_rebuild.py"))
+
+
+def test_verify_baskets_rebuilds_with_read_only_requests(monkeypatch, capsys):
+    example = load_example(monkeypatch)
+    client, opener = make_client(
+        FakeResponse({"baskets": [saved_basket()]}), FakeResponse(assortment())
+    )
+    args = argparse.Namespace(latitude=60.17, longitude=24.94, language="en")
+
+    assert example["verify_baskets"](client, args) is True
+
+    assert capsys.readouterr().out == "PASS venue=pizza-place items=2 total=1630\n"
+    assert [
+        (request.get_method(), urlsplit(request.full_url).path)
+        for request in opener.requests
+    ] == [
+        ("GET", "/order-xp/web/v1/pages/baskets"),
+        (
+            "GET",
+            "/consumer-api/consumer-assortment/v1/venues/slug/pizza-place/assortment",
+        ),
+    ]
+
+
+def test_verify_baskets_reports_zero_baskets_without_extra_requests(
+    monkeypatch, capsys
+):
+    example = load_example(monkeypatch)
+    client, opener = make_client(FakeResponse({"baskets": []}))
+    args = argparse.Namespace(latitude=60.17, longitude=24.94, language="en")
+
+    assert example["verify_baskets"](client, args) is True
+
+    assert capsys.readouterr().out == "PASS venue=no-saved-baskets items=0 total=0\n"
+    assert len(opener.requests) == 1
+
+
+def test_verify_baskets_omits_private_malformed_page_data(monkeypatch, capsys):
+    example = load_example(monkeypatch)
+    client, _ = make_client(FakeResponse({"baskets": "PRIVATE BASKET DATA"}))
+    args = argparse.Namespace(latitude=60.17, longitude=24.94, language="en")
+
+    assert example["verify_baskets"](client, args) is False
+
+    output = capsys.readouterr().out
+    assert output == (
+        "FAIL venue=unknown: VerificationInputError: "
+        "Saved baskets page has no baskets list.\n"
+    )
+    assert "PRIVATE" not in output
+
+
+def test_verify_baskets_omits_private_library_error_message(monkeypatch, capsys):
+    example = load_example(monkeypatch)
+    args = argparse.Namespace(latitude=60.17, longitude=24.94, language="en")
+
+    class FailingClient:
+        def get_baskets_page(self, latitude, longitude):
+            return {"baskets": [saved_basket()]}
+
+        def get_assortment(self, slug):
+            raise SelectionError("PRIVATE LIBRARY ERROR")
+
+    assert example["verify_baskets"](FailingClient(), args) is False
+
+    output = capsys.readouterr().out
+    assert output == "FAIL venue=pizza-place: SelectionError: Details omitted.\n"
+    assert "PRIVATE" not in output
+
+
+@pytest.mark.parametrize(
+    "slug", ["pizza place", "pizza\x00place", "Pizza-place", "pizza_place"]
+)
+def test_verify_baskets_rejects_invalid_venue_slug(monkeypatch, capsys, slug):
+    example = load_example(monkeypatch)
+    basket = saved_basket()
+    basket["venue"]["slug"] = slug
+    client, opener = make_client(FakeResponse({"baskets": [basket]}))
+    args = argparse.Namespace(latitude=60.17, longitude=24.94, language="en")
+
+    assert example["verify_baskets"](client, args) is False
+
+    assert capsys.readouterr().out == (
+        "FAIL venue=unknown: VerificationInputError: "
+        "Saved basket venue has no usable slug.\n"
+    )
+    assert len(opener.requests) == 1