feat: add holds list command

Author: tomsquest

src/mediathequeroubaix/cli_utils.py

@@ -0,0 +1,24 @@
+import typer
+from returns.unsafe import unsafe_perform_io
+from rich import print
+
+from mediathequeroubaix.config import Config, get_config, User
+
+
+def _load_config_or_raise() -> Config:
+    try:
+        result = get_config()
+        io = result.unwrap()
+        config = unsafe_perform_io(io)
+    except Exception as e:
+        print("❌ Unable to read configuration!", e)
+        raise typer.Exit(1) from e
+    else:
+        return config
+
+
+def _get_users_or_raise(config: Config) -> list[User]:
+    if not config.users:
+        print("❌ No user defined in configuration")
+        raise typer.Exit(1)
+    return config.users

src/mediathequeroubaix/get_holds/__init__.py

@@ -0,0 +1,7 @@
+from returns.result import Result
+
+from mediathequeroubaix.shared.extract_input_value import extract_input_value
+
+
+def extract_token(s: str) -> Result[str, Exception]:
+    return extract_input_value("my_holds", s)

src/mediathequeroubaix/get_holds/extract_token.py

@@ -0,0 +1,50 @@
+from returns.result import Success
+
+from mediathequeroubaix.get_holds.extract_token import extract_token
+
+
+def test_ok() -> None:
+    html = """
+        <div class="panel-body">
+            <input type="hidden" id="my_holds" value="abc" />
+        </div>
+    """
+
+    assert extract_token(html) == Success("abc")
+
+
+def test_empty_html() -> None:
+    html = ""
+
+    assert str(extract_token(html)) == "<Failure: Token not found>"
+
+
+def test_empty_token() -> None:
+    html = """
+        <div class="panel-body">
+            <input type="hidden" id="my_holds" value="" />
+        </div>
+    """
+
+    assert str(extract_token(html)) == "<Failure: Token not found>"
+
+
+def test_two_tokens() -> None:
+    html = """
+        <div class="panel-body">
+            <input type="hidden" id="my_holds" value="first" />
+            <input type="hidden" id="my_holds" value="another" />
+        </div>
+    """
+
+    assert extract_token(html) == Success("first")
+
+
+def test_contain_equal() -> None:
+    html = """
+        <div class="panel-body">
+            <input type="hidden" id="my_holds" value="b64str=" />
+        </div>
+    """
+
+    assert extract_token(html) == Success("b64str=")

src/mediathequeroubaix/get_holds/extract_token_test.py

@@ -0,0 +1,22 @@
+from returns.io import IOResultE
+from returns.pipeline import flow
+from returns.pointfree import bind_result
+from returns.result import safe
+
+from mediathequeroubaix.auth.authenticated_session import AuthenticatedSession
+from mediathequeroubaix.get_holds.extract_token import extract_token
+from mediathequeroubaix.get_holds.hold import Holds
+from mediathequeroubaix.get_holds.parse_holds import parse_holds
+from mediathequeroubaix.shared.base64decode import base64decode
+from mediathequeroubaix.shared.get_personal_space import get_personal_space
+
+
+def get_holds(session: AuthenticatedSession) -> IOResultE[Holds]:
+    return flow(
+        session,
+        get_personal_space,
+        bind_result(extract_token),
+        bind_result(base64decode),
+        bind_result(parse_holds),
+        bind_result(safe(lambda holds: Holds(username=session.username, items=holds))),
+    )

src/mediathequeroubaix/get_holds/get_holds.py

@@ -0,0 +1,40 @@
+import base64
+
+import requests
+from requests_mock import mock
+from returns.pipeline import is_successful
+from returns.unsafe import unsafe_perform_io
+
+from mediathequeroubaix.auth.authenticated_session import AuthenticatedSession, Username
+from mediathequeroubaix.get_holds.get_holds import get_holds
+
+
+def test_ok(requests_mock: mock) -> None:
+    holds = base64.b64encode(
+        '[{"hold_id":507643,"title":"Apprendre, si par bonheur","itemnumber":null,"barcode":"","found":null,"cancellationdate":null,"rank":2,"biblionumber":329375,"itemcallnumber":"","reservedate":"2025-07-14","branchcode":"MED","branchname":"M\u00e9diath\u00e8que"}]'.encode()
+    ).decode("utf-8")
+    requests_mock.get(
+        "http://www.mediathequederoubaix.fr/espace_personnel",
+        text=f"""
+        Welcome
+        <input type="hidden" id="my_holds" value="{holds}" />
+    """,
+    )
+
+    result = get_holds(AuthenticatedSession(requests.Session(), Username("John Doe")))
+
+    assert is_successful(result)
+    actual = unsafe_perform_io(result.unwrap())
+    assert actual.username == "John Doe"
+    assert len(actual.items) == 1
+    assert actual.items[0].title == "Apprendre, si par bonheur"
+
+
+def test_no_token(requests_mock: mock) -> None:
+    requests_mock.get(
+        "http://www.mediathequederoubaix.fr/espace_personnel", text="some html"
+    )
+
+    result = get_holds(AuthenticatedSession(requests.Session(), Username("John doe")))
+
+    assert is_successful(result) is False

src/mediathequeroubaix/get_holds/get_holds_test.py

@@ -0,0 +1,33 @@
+from datetime import date, datetime
+
+from pydantic import field_validator
+from pydantic.main import BaseModel
+
+from mediathequeroubaix.auth.authenticated_session import Username
+
+
+class Hold(BaseModel):
+    # 1234
+    hold_id: int
+    # Vampi
+    title: str
+    # 1234567
+    itemnumber: int | None = None
+    # C2500011705
+    barcode: str
+    # 0
+    rank: int
+    # E BD/FON
+    itemcallnumber: str | None = None
+    # 2025-07-14
+    reservedate: date | None = None
+
+    @field_validator("reservedate", mode="before")
+    @classmethod
+    def parse_reservedate(cls, value: str) -> date:
+        return datetime.strptime(value, "%Y-%m-%d").date()
+
+
+class Holds(BaseModel):
+    username: Username
+    items: list[Hold]

src/mediathequeroubaix/get_holds/hold.py

@@ -0,0 +1,15 @@
+import datetime
+
+from mediathequeroubaix.get_holds.hold import Hold
+
+
+def test_convert_due_date_to_date() -> None:
+    hold = Hold(
+        hold_id=1234,
+        title="Test Book",
+        barcode="c123",
+        rank=1,
+        reservedate="2023-04-05",
+    )
+
+    assert hold.reservedate == datetime.date.fromisoformat("2023-04-05")

src/mediathequeroubaix/get_holds/hold_test.py

@@ -0,0 +1,14 @@
+from returns.result import safe
+from typing import List
+from pydantic import BaseModel, Json
+
+from mediathequeroubaix.get_holds.hold import Hold
+
+
+class JsonStringWrapper(BaseModel):
+    json_obj: Json[List[Hold]]
+
+
+@safe
+def parse_holds(s: str) -> list[Hold]:
+    return JsonStringWrapper(json_obj=s).json_obj

src/mediathequeroubaix/get_holds/parse_holds.py

@@ -0,0 +1,49 @@
+from returns.pipeline import is_successful
+from returns.result import Success
+
+from mediathequeroubaix.get_holds.hold import Hold
+from mediathequeroubaix.get_holds.parse_holds import parse_holds
+
+
+def test_empty() -> None:
+    assert is_successful(parse_holds("")) is False
+
+
+def test_object() -> None:
+    assert is_successful(parse_holds("{}")) is False
+
+
+def test_empty_array() -> None:
+    assert parse_holds("[]") == Success([])
+
+
+def test_some_holds() -> None:
+    assert parse_holds(
+        '[{"hold_id":507643,"title":"Apprendre, si par bonheur","itemnumber":null,"barcode":"","found":null,'
+        '"cancellationdate":null,"rank":2,"biblionumber":329375,"itemcallnumber":"","reservedate":"2025-07-14",'
+        '"branchcode":"MED","branchname":"M\u00e9diath\u00e8que"},{"hold_id":507642,"cancellationdate":null,'
+        '"rank":0,"biblionumber":302152,"found":"W","itemnumber":368084,"barcode":"C1400002454",'
+        '"title":"L\'espace d\'un an","reservedate":"2025-07-14","itemcallnumber":"SF\/CHA",'
+        '"branchname":"M\u00e9diath\u00e8que","branchcode":"MED"}]'
+    ) == Success(
+        [
+            Hold(
+                hold_id=507643,
+                title="Apprendre, si par bonheur",
+                itemnumber=None,
+                barcode="",
+                rank=2,
+                itemcallnumber="",
+                reservedate="2025-07-14",
+            ),
+            Hold(
+                hold_id=507642,
+                title="L'espace d'un an",
+                itemnumber=368084,
+                barcode="C1400002454",
+                rank=0,
+                itemcallnumber="SF/CHA",
+                reservedate="2025-07-14",
+            ),
+        ]
+    )