create scroll_events_metadata

Author: aviau

src/flareio/api_client.py

@@ -284,7 +284,7 @@ def scroll(
             if json and from_in_json:
                 json["from"] = next_page
 
-    def scroll_events(
+    def _scroll_events_metadata(
         self,
         *,
         method: t.Literal[
@@ -299,6 +299,7 @@ def scroll_events(
         _events_limiter: t.Optional[_Limiter] = None,
     ) -> t.Iterator[
         t.Tuple[
+            dict,
             dict,
             t.Optional[str],
         ],
@@ -321,8 +322,8 @@ def scroll_events(
             page_items: t.List[dict] = page_resp.json()["items"]
             page_next: t.Optional[str] = page_resp.json()["next"]
 
-            for page_item in page_items:
-                event_uid: str = page_item["metadata"]["uid"]
+            for event_metadata in page_items:
+                event_uid: str = event_metadata["metadata"]["uid"]
 
                 events_limiter.tick()
                 event_resp: requests.Response = self.get(
@@ -334,6 +335,36 @@ def scroll_events(
                 event_resp.raise_for_status()
                 event: dict = event_resp.json()
 
-                yield event, page_next
+                yield event_metadata, event, 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 _, event, page_next in self._scroll_events_metadata(
+            method=method,
+            pages_url=pages_url,
+            events_url=events_url,
+            params=params,
+            json=json,
+            _pages_limiter=_pages_limiter,
+            _events_limiter=_events_limiter,
+        ):
+            yield event, page_next

tests/test_api_client_scroll_events.py

@@ -45,9 +45,9 @@ def test_scroll_events() -> None:
             status_code=200,
         )
 
-        item, cursor = next(events_iterator)
+        event, cursor = next(events_iterator)
         assert len(mocker.request_history) == 2
-        assert item == {"event": "hello"}
+        assert event == {"event": "hello"}
         assert cursor == "second_page"
 
     # Last page
@@ -63,3 +63,48 @@ def test_scroll_events() -> None:
         with pytest.raises(StopIteration):
             next(events_iterator)
         assert len(mocker.request_history) == 1
+
+
+def test_scroll_events_metadata() -> 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_metadata(
+        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,
+        )
+
+        event_metadata, event, cursor = next(events_iterator)
+        assert len(mocker.request_history) == 2
+        assert event_metadata == {"metadata": {"uid": "first_event_uid"}}
+        assert event == {"event": "hello"}
+        assert cursor == "second_page"