scroll_events now returns ScrollEventResult

Author: aviau

src/flareio/api_client.py

@@ -11,9 +11,9 @@
 
 import typing as t
 
-from flareio._models import _ScrollEventsResult
 from flareio._ratelimit import _Limiter
 from flareio.exceptions import TokenError
+from flareio.models import ScrollEventsResult
 from flareio.version import __version__ as _flareio_version
 
 
@@ -285,7 +285,7 @@ def scroll(
             if json and from_in_json:
                 json["from"] = next_page
 
-    def _scroll_events_items(
+    def scroll_events(
         self,
         *,
         method: t.Literal[
@@ -298,7 +298,7 @@ def _scroll_events_items(
         json: t.Optional[t.Dict[str, t.Any]] = None,
         _pages_limiter: t.Optional[_Limiter] = None,
         _events_limiter: t.Optional[_Limiter] = None,
-    ) -> t.Iterator[_ScrollEventsResult]:
+    ) -> t.Iterator[ScrollEventsResult]:
         pages_limiter: _Limiter = _pages_limiter or _Limiter(
             tick_interval=timedelta(seconds=1),
         )
@@ -330,40 +330,10 @@ def _scroll_events_items(
                 event_resp.raise_for_status()
                 event: dict = event_resp.json()
 
-                yield _ScrollEventsResult(
-                    item=event_item,
-                    data=event,
+                yield ScrollEventsResult(
+                    metadata=event_item,
+                    event=event,
                     next=page_next,
                 )
 
             pages_limiter.tick()
-
-    def scroll_events(
-        self,
-        *,
-        method: t.Literal[
-            "GET",
-            "POST",
-        ],
-        pages_url: str,
-        events_url: str,
-        params: t.Optional[t.Dict[str, t.Any]] = None,
-        json: t.Optional[t.Dict[str, t.Any]] = None,
-        _pages_limiter: t.Optional[_Limiter] = None,
-        _events_limiter: t.Optional[_Limiter] = None,
-    ) -> t.Iterator[
-        t.Tuple[
-            dict,
-            t.Optional[str],
-        ],
-    ]:
-        for result in self._scroll_events_items(
-            method=method,
-            pages_url=pages_url,
-            events_url=events_url,
-            params=params,
-            json=json,
-            _pages_limiter=_pages_limiter,
-            _events_limiter=_events_limiter,
-        ):
-            yield result.data, result.next

src/flareio/_models.py src/flareio/models.pysrc/flareio/_models.py renamed to src/flareio/models.py

@@ -2,7 +2,7 @@
 
 
 @dataclasses.dataclass(frozen=True)
-class _ScrollEventsResult:
-    item: dict
-    data: dict
+class ScrollEventsResult:
+    metadata: dict
+    event: dict
     next: str | None

tests/test_api_client_scroll_events.py

@@ -45,10 +45,11 @@ def test_scroll_events() -> None:
             status_code=200,
         )
 
-        event, cursor = next(events_iterator)
+        result = next(events_iterator)
         assert len(mocker.request_history) == 2
-        assert event == {"event": "hello"}
-        assert cursor == "second_page"
+        assert result.metadata == {"metadata": {"uid": "first_event_uid"}}
+        assert result.event == {"event": "hello"}
+        assert result.next == "second_page"
 
     # Last page
     with requests_mock.Mocker() as mocker:
@@ -63,48 +64,3 @@ def test_scroll_events() -> None:
         with pytest.raises(StopIteration):
             next(events_iterator)
         assert len(mocker.request_history) == 1
-
-
-def test_scroll_events_items() -> None:
-    """
-    scroll_events_metadata is used by the flareio-cli
-    """
-    api_client = get_test_client()
-    no_limit: _Limiter = _Limiter._unlimited()
-
-    events_iterator = api_client._scroll_events_items(
-        method="GET",
-        pages_url="https://api.flare.io/pages",
-        events_url="https://api.flare.io/events",
-        params={
-            "from": None,
-        },
-        _pages_limiter=no_limit,
-        _events_limiter=no_limit,
-    )
-
-    # First page
-    with requests_mock.Mocker() as mocker:
-        mocker.register_uri(
-            "GET",
-            "https://api.flare.io/pages",
-            json={
-                "items": [
-                    {"metadata": {"uid": "first_event_uid"}},
-                ],
-                "next": "second_page",
-            },
-            status_code=200,
-        )
-        mocker.register_uri(
-            "GET",
-            "https://api.flare.io/events",
-            json={"event": "hello"},
-            status_code=200,
-        )
-
-        result = next(events_iterator)
-        assert len(mocker.request_history) == 2
-        assert result.item == {"metadata": {"uid": "first_event_uid"}}
-        assert result.data == {"event": "hello"}
-        assert result.next == "second_page"