[CIVIS-10059] FIX API calls should send all items in an array query parameter (#507)

* FIX array params in API calls

* MAINT update changelog

* MAINT update civis api spec

* VER bump version to 2.4.3

* MAINT update changelog

* ENH check for more general __iter__ and filter dict+str

Author: jacksonlee-civis

CHANGELOG.md

@@ -18,6 +18,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Security
 
+## 2.4.3 - 2025-01-13
+
+### Fixed
+- Fixed the way array query parameters are passed to a Civis API call,
+  so that all items in an array are included in the correctly formatted URL. (#507)
+
 ## 2.4.2 - 2025-01-02
 
 ### Changed

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "civis"
-version = "2.4.2"
+version = "2.4.3"
 description = "Civis API Python Client"
 readme = "README.rst"
 requires-python = ">= 3.10"

src/civis/base.py

@@ -119,8 +119,27 @@ def _build_path(self, path):
             return self._base_url
         return tostr_urljoin(self._base_url, path.strip("/"))
 
+    @staticmethod
+    def _handle_array_params(params):
+        """Convert array-like parameters to the format that Civis API expects.
+
+        Different APIs expect array-like parameters in different formats.
+        For Civis API, an array parameter `foo` needs to be passed in as `foo[]`.
+        Related reference: https://stackoverflow.com/a/23347265
+        """
+        if not params:
+            return
+        new_params = {}
+        for key, value in params.items():
+            if hasattr(value, "__iter__") and not isinstance(value, (dict, str)):
+                new_params[f"{key}[]"] = list(value)
+            else:
+                new_params[key] = value
+        return new_params
+
     def _make_request(self, method, path=None, params=None, data=None, **kwargs):
         url = self._build_path(path)
+        params = self._handle_array_params(params)
 
         with self._lock:
             if self._client._retrying is None:

src/civis/resources/civis_api_spec.json

@@ -47,3 +47,21 @@ def test_civis_api_error_empty_response():
 
     error = CivisAPIError(response)
     assert error.error_message == "No Response Content from Civis API"
+
+
+@pytest.mark.parametrize(
+    "source_params, expected_params",
+    [
+        ({}, None),
+        (None, None),
+        (
+            {"foo": 123, "bar": "hello", "baz": {"a": 1, "b": 2}},
+            {"foo": 123, "bar": "hello", "baz": {"a": 1, "b": 2}},
+        ),
+        ({"foo": [1, 2, 3]}, {"foo[]": [1, 2, 3]}),
+        ({"foo": (1, 2, 3)}, {"foo[]": [1, 2, 3]}),
+        ({"foo": {1, 2, 3}}, {"foo[]": [1, 2, 3]}),
+    ],
+)
+def test_array_params(source_params, expected_params):
+    assert Endpoint._handle_array_params(source_params) == expected_params