fix(reverse): fix batch reverse geocoding coordinate format

MiniCodeMonkey · MiniCodeMonkey · commit c05f6c5b87e6 · 2025-08-08T14:19:14.000+02:00
The library was sending coordinates in incorrect format for batch reverse
geocoding operations, causing API errors. Coordinates are now properly
converted to strings before sending to the API.

- Convert tuple coordinates to comma-separated strings
- Send coordinates as plain array instead of wrapped object
- Support mixed input formats (tuples and strings)
diff --git a/src/geocodio/client.py b/src/geocodio/client.py
@@ -124,12 +124,18 @@ def reverse(
             params["limit"] = int(limit)
 
         endpoint: str
-        data: Dict[str, list] | None
+        data: Union[List[str], None]
 
         # Batch vs single coordinate
         if isinstance(coordinate, list):
             endpoint = f"{self.BASE_PATH}/reverse"
-            data = {"coordinates": coordinate}
+            coords_as_strings = []
+            for coord in coordinate:
+                if isinstance(coord, tuple):
+                    coords_as_strings.append(f"{coord[0]},{coord[1]}")
+                else:
+                    coords_as_strings.append(coord)
+            data = coords_as_strings
         else:
             endpoint = f"{self.BASE_PATH}/reverse"
             if isinstance(coordinate, tuple):
diff --git a/tests/e2e/test_batch_reverse.py b/tests/e2e/test_batch_reverse.py
@@ -0,0 +1,109 @@
+"""
+End-to-end tests for batch reverse geocoding functionality.
+"""
+
+import pytest
+from geocodio import GeocodioClient
+
+
+def test_batch_reverse_geocoding(client):
+    """Test batch reverse geocoding against real API."""
+    # Arrange
+    coordinates = [
+        (38.886665, -77.094733),  # Arlington, VA
+        (38.897676, -77.036530),  # White House
+        (37.331669, -122.030090)  # Apple Park
+    ]
+    
+    # Act
+    response = client.reverse(coordinates)
+    
+    # Assert
+    assert response is not None
+    assert len(response.results) == 3
+    
+    # Check first result (Arlington, VA)
+    arlington = response.results[0]
+    assert "Arlington" in arlington.formatted_address
+    assert "VA" in arlington.formatted_address
+    assert arlington.location.lat == pytest.approx(38.886672, abs=0.001)
+    assert arlington.location.lng == pytest.approx(-77.094735, abs=0.001)
+    
+    # Check second result (White House)
+    white_house = response.results[1]
+    assert "Pennsylvania" in white_house.formatted_address
+    assert "Washington" in white_house.formatted_address or "DC" in white_house.formatted_address
+    
+    # Check third result (Apple Park)
+    apple_park = response.results[2]
+    assert "Cupertino" in apple_park.formatted_address or "CA" in apple_park.formatted_address
+
+
+def test_batch_reverse_with_strings(client):
+    """Test batch reverse geocoding with string coordinates."""
+    # Arrange
+    coordinates = [
+        "38.886665,-77.094733",  # Arlington, VA
+        "38.897676,-77.036530"   # White House
+    ]
+    
+    # Act
+    response = client.reverse(coordinates)
+    
+    # Assert
+    assert response is not None
+    assert len(response.results) == 2
+    assert "Arlington" in response.results[0].formatted_address
+    assert "Pennsylvania" in response.results[1].formatted_address or "Washington" in response.results[1].formatted_address
+
+
+def test_batch_reverse_with_fields(client):
+    """Test batch reverse geocoding with additional fields."""
+    # Arrange
+    coordinates = [
+        (38.886665, -77.094733),  # Arlington, VA
+        (38.897676, -77.036530)   # White House
+    ]
+    
+    # Act
+    response = client.reverse(coordinates, fields=["timezone", "cd"])
+    
+    # Assert
+    assert response is not None
+    assert len(response.results) == 2
+    
+    # Check that fields are populated
+    for result in response.results:
+        assert result.fields is not None
+        if result.fields.timezone:
+            assert result.fields.timezone.name is not None
+        if result.fields.congressional_districts:
+            assert len(result.fields.congressional_districts) > 0
+
+
+def test_empty_batch_reverse(client):
+    """Test batch reverse geocoding with empty list."""
+    # Arrange
+    coordinates = []
+    
+    # Act & Assert
+    with pytest.raises(Exception):
+        client.reverse(coordinates)
+
+
+def test_mixed_batch_reverse_formats(client):
+    """Test batch reverse geocoding with mixed coordinate formats."""
+    # Note: The API expects consistent format, so this tests error handling
+    # Arrange
+    coordinates = [
+        (38.886665, -77.094733),  # Tuple format
+        "38.897676,-77.036530"     # String format
+    ]
+    
+    # Act
+    # The library should handle converting these to a consistent format
+    response = client.reverse(coordinates)
+    
+    # Assert
+    assert response is not None
+    assert len(response.results) == 2
diff --git a/tests/unit/test_reverse.py b/tests/unit/test_reverse.py
@@ -58,37 +58,51 @@ def batch_response_callback(request):
         return httpx.Response(200, json={
             "results": [
                 {
-                    "address_components": {
-                        "number": "1109",
-                        "predirectional": "N",
-                        "street": "Highland",
-                        "suffix": "St",
-                        "formatted_street": "N Highland St",
-                        "city": "Arlington",
-                        "state": "VA",
-                        "zip": "22201"
-                    },
-                    "formatted_address": "1109 N Highland St, Arlington, VA 22201",
-                    "location": {"lat": 38.886672, "lng": -77.094735},
-                    "accuracy": 1,
-                    "accuracy_type": "rooftop",
-                    "source": "Arlington"
+                    "query": "38.886672,-77.094735",
+                    "response": {
+                        "results": [
+                            {
+                                "address_components": {
+                                    "number": "1109",
+                                    "predirectional": "N",
+                                    "street": "Highland",
+                                    "suffix": "St",
+                                    "formatted_street": "N Highland St",
+                                    "city": "Arlington",
+                                    "state": "VA",
+                                    "zip": "22201"
+                                },
+                                "formatted_address": "1109 N Highland St, Arlington, VA 22201",
+                                "location": {"lat": 38.886672, "lng": -77.094735},
+                                "accuracy": 1,
+                                "accuracy_type": "rooftop",
+                                "source": "Arlington"
+                            }
+                        ]
+                    }
                 },
                 {
-                    "address_components": {
-                        "number": "1600",
-                        "street": "Pennsylvania",
-                        "suffix": "Ave",
-                        "postdirectional": "NW",
-                        "city": "Washington",
-                        "state": "DC",
-                        "zip": "20500"
-                    },
-                    "formatted_address": "1600 Pennsylvania Ave NW, Washington, DC 20500",
-                    "location": {"lat": 38.898719, "lng": -77.036547},
-                    "accuracy": 1,
-                    "accuracy_type": "rooftop",
-                    "source": "DC"
+                    "query": "38.898719,-77.036547",
+                    "response": {
+                        "results": [
+                            {
+                                "address_components": {
+                                    "number": "1600",
+                                    "street": "Pennsylvania",
+                                    "suffix": "Ave",
+                                    "postdirectional": "NW",
+                                    "city": "Washington",
+                                    "state": "DC",
+                                    "zip": "20500"
+                                },
+                                "formatted_address": "1600 Pennsylvania Ave NW, Washington, DC 20500",
+                                "location": {"lat": 38.898719, "lng": -77.036547},
+                                "accuracy": 1,
+                                "accuracy_type": "rooftop",
+                                "source": "DC"
+                            }
+                        ]
+                    }
                 }
             ]
         })
