Adds handling for sort and propertySelector (beta) parameters

Cleans up some handling code for snake_case variant parameters
Adds tests for the above

Author: aaront

mygeotab/parameters.py

@@ -9,7 +9,7 @@
 
 import re
 from copy import copy
-from typing import Any
+from typing import Any, Optional
 
 
 def camelcaseify_parameters(parameters: dict[str, Any]) -> dict[str, Any]:
@@ -37,8 +37,8 @@ def camelcaseify_parameters(parameters: dict[str, Any]) -> dict[str, Any]:
 def convert_get_parameters(parameters: dict[str, Any]) -> dict[str, Any]:
     """Converts parameters passed into a get() call to a format suitable for the MyGeotab API.
     It detects if a 'search' dictionary is passed and flattens it into the top-level parameters.
-    It also detects 'resultsLimit' or 'results_limit' and removes it from the parameters
-    so it doesn't become part of the search.
+    It also detects 'resultsLimit'/'results_limit' or 'sort' parameters and removes them from the parameters
+    so they doesn't become part of the search.
 
     :param parameters: The parameters object.
     :type parameters: dict
@@ -48,18 +48,33 @@ def convert_get_parameters(parameters: dict[str, Any]) -> dict[str, Any]:
     if not parameters:
         return dict()
 
-    results_limit = parameters.get("resultsLimit")
-    if results_limit is not None:
-        del parameters["resultsLimit"]
-    else:
-        results_limit = parameters.get("results_limit")
-        if results_limit is not None:
-            del parameters["results_limit"]
+    parameters = copy(parameters)
+
+    results_limit_param = _try_extract_get_parameter(parameters, "resultsLimit", "results_limit")
+    property_selector_param = _try_extract_get_parameter(parameters, "propertySelector", "property_selector")
+    sort_param = _try_extract_get_parameter(parameters, "sort")
 
     if "search" in parameters:
         parameters.update(parameters["search"])
         del parameters["search"]
+
     result = {"search": parameters}
-    if results_limit is not None:
-        result["resultsLimit"] = results_limit
+    if results_limit_param is not None:
+        result["resultsLimit"] = results_limit_param
+    if property_selector_param is not None:
+        result["propertySelector"] = property_selector_param
+    if sort_param is not None:
+        result["sort"] = sort_param
     return result
+
+
+def _try_extract_get_parameter(parameters: dict[str, Any], name: str, pythonic_name: Optional[str] = None) -> Any | None:
+    """Helper to get a parameter from a dictionary, returning None if it doesn't exist."""
+    parameter = parameters.get(name)
+    if parameter is not None:
+        del parameters[name]
+    elif pythonic_name is not None:
+        parameter = parameters.get(pythonic_name)
+        if parameter is not None:
+            del parameters[pythonic_name]
+    return parameter

tests/test_parameters.py

@@ -78,3 +78,52 @@ def test_convert_get_parameters_removes_results_limit_from_search():
     assert "resultsLimit" in result
     assert result["resultsLimit"] == 7
     assert "results_limit" not in result["search"]
+
+
+def test_convert_get_parameters_with_sort():
+    params = {
+        "search": {"foo": "bar"},
+        "sort": {"sortBy": "name", "sortDirection": "asc", "offset": "Delivery Truck 12", "lastId": "b1234"},
+    }
+    result = convert_get_parameters(params)
+    assert "sort" in result
+    assert isinstance(result["sort"], dict)
+    assert result["sort"]["sortBy"] == "name"
+    assert result["sort"]["sortDirection"] == "asc"
+    assert result["sort"]["offset"] == "Delivery Truck 12"
+    assert result["sort"]["lastId"] == "b1234"
+
+
+def test_convert_get_parameters_with_property_selector():
+    params = {"search": {"foo": "bar"}, "propertySelector": {"fields": ["id", "name"], "isIncluded": True}}
+    result = convert_get_parameters(params)
+    assert "propertySelector" in result
+    assert isinstance(result["propertySelector"], dict)
+    assert "fields" in result["propertySelector"]
+    assert "isIncluded" in result["propertySelector"]
+
+
+def test_convert_get_parameters_with_property_selector_snake_case():
+    params = {"search": {"foo": "bar"}, "property_selector": {"fields": ["id", "name"], "isIncluded": True}}
+    result = convert_get_parameters(params)
+    assert "propertySelector" in result
+    assert isinstance(result["propertySelector"], dict)
+    assert "fields" in result["propertySelector"]
+    assert "isIncluded" in result["propertySelector"]
+
+
+def test_convert_get_parameters_with_sort_and_property_selector():
+    params = {
+        "search": {"foo": "bar"},
+        "sort": {"sortBy": "name", "sortDirection": "asc", "offset": "Delivery Truck 12", "lastId": "b1234"},
+        "property_selector": {"fields": ["id", "status"], "isIncluded": True},
+    }
+    result = convert_get_parameters(params)
+    assert "sort" in result
+    assert result["sort"]["sortBy"] == "name"
+    assert result["sort"]["sortDirection"] == "asc"
+    assert result["sort"]["offset"] == "Delivery Truck 12"
+    assert result["sort"]["lastId"] == "b1234"
+    assert "propertySelector" in result
+    assert "fields" in result["propertySelector"]
+    assert "isIncluded" in result["propertySelector"]