feat: allow tokens for paging (#23)

Author: gadomski

Cargo.lock

@@ -34,6 +34,7 @@ class Client:
         sortby: str | list[str] | None = None,
         filter: str | dict[str, Any] | None = None,
         query: dict[str, Any] | None = None,
+        **kwargs: str,
     ) -> dict[str, Any]:
         """
         Searches the database with STAC API item search.
@@ -59,6 +60,7 @@ class Client:
             query: Additional filtering based on properties.
                 It is recommended to use filter instead, if possible.
             limit: The page size returned from the server.
+            kwargs: Any additional arguments to pass down into the search, e.g a pagination token
         """
 
     async def print_config(self) -> None:

pgstacrs.pyi

@@ -293,7 +293,7 @@ impl Client {
         })
     }
 
-    #[pyo3(signature = (*, collections=None, ids=None, intersects=None, bbox=None, datetime=None, include=None, exclude=None, sortby=None, filter=None, query=None, limit=None))]
+    #[pyo3(signature = (*, collections=None, ids=None, intersects=None, bbox=None, datetime=None, include=None, exclude=None, sortby=None, filter=None, query=None, limit=None, **kwargs))]
     fn search<'a>(
         &self,
         py: Python<'a>,
@@ -308,6 +308,7 @@ impl Client {
         filter: Option<StringOrDict>,
         query: Option<Bound<'a, PyDict>>,
         limit: Option<u64>,
+        kwargs: Option<Bound<'a, PyDict>>,
     ) -> PyResult<Bound<'a, PyAny>> {
         let search = stac_api::python::search(
             intersects,
@@ -321,6 +322,7 @@ impl Client {
             sortby,
             filter,
             query,
+            kwargs,
         )?;
         self.run(py, |pool| async move {
             let connection = pool.get().await?;

src/lib.rs

@@ -1,4 +1,5 @@
 import copy
+import urllib.parse
 from typing import Any
 
 import pytest
@@ -219,3 +220,30 @@ async def test_collections(
 
     feature_collection = await client.search(collections=["simple-collection"])
     assert len(feature_collection["features"]) == 1
+
+
+async def test_pagination(
+    client: Client, collection: dict[str, Any], item: dict[str, Any]
+) -> None:
+    version = await client.get_version()
+
+    await client.create_collection(collection)
+    item["id"] = "first-item"
+    await client.create_item(item)
+    second_item = copy.deepcopy(item)
+    second_item["id"] = "second-item"
+    await client.create_item(second_item)
+
+    feature_collection = await client.search(limit=1, sortby="id")
+
+    if version.startswith("0.9"):
+        next_link = next(
+            (link for link in feature_collection["links"] if link["rel"] == "next")
+        )
+        url = urllib.parse.urlparse(next_link["href"])
+        token = url.query.split("=")[1]
+    elif version.startswith("0.8"):
+        token = "next:" + feature_collection["next"]
+
+    feature_collection = await client.search(limit=1, sortby="id", token=token)
+    assert feature_collection["features"][0]["id"] == "second-item"