new zip code class version 2

Author: Mohamed Ben Makhlouf

pyzipcodeapi/api.py

@@ -3,10 +3,11 @@
 from io import StringIO
 from json import loads
 from xml.etree.ElementTree import Element, fromstring
+from urllib.parse import urlencode
 
 import requests
 
-from pyzipcodeapi.dataclass import Distance, Error, MultiDistance, Radius
+from pyzipcodeapi.dataclass import Distance, Error, MultiDistance, Radius, MultiRadius
 from pyzipcodeapi.enums import FormatEnum, UnitEnum, CountryEnum
 from pyzipcodeapi.options import OPTIONS
 
@@ -111,10 +112,15 @@ def _api_call(
         path: str,
         data_class: type | None = None,
         country: CountryEnum = CountryEnum.US,
+        method: str = "GET",
+        body: str | None = None,
     ) -> DictReader | bytes | type | Element | Error:
         base_url = f"rest/v2/CA" if country == CountryEnum.CA else f"rest"
+        headers = {}
+        if method != "GET":
+            headers = {"Content-type": "application/x-www-form-urlencoded"}
         self.con.request(
-            method="GET", url=f"/{base_url}/{self.api_key}/{option}.{f}/{path}"
+            method, f"/{base_url}/{self.api_key}/{option}.{f}/{path}", body, headers
         )
         response = self.con.getresponse()
         success = response.status == 200
@@ -172,3 +178,25 @@ def radius(
         if minimal:
             path = f"{path}?minimal"
         return self._api_call("radius", f, path, dc, country=country)
+
+    def multi_radius(
+        self,
+        distance: int,
+        zip_codes: list[str] | None = None,
+        addresses: list[str] | None = None,
+        units: UnitEnum = UnitEnum.KM,
+        f: FormatEnum | None = FormatEnum.JSON,
+    ) -> MultiRadius | DictReader | Element:
+        """multi-radius.<format>/<distance>/<units>"""
+        assert len(zip_codes) <= 100
+        if zip_codes is None and addresses is None:
+            raise ValueError
+        path = f"{distance}/{units}"
+        dc = MultiRadius
+        params = dict()
+        if zip_codes:
+            params["zip_codes"] = "\n".join(zip_codes)
+        if addresses:
+            params["addrs"] = "\n".join(addresses)
+        body = urlencode(params)
+        return self._api_call("multi-radius", f, path, dc, method="POST", body=body)

pyzipcodeapi/dataclass.py

@@ -34,3 +34,18 @@ def info(self) -> list[RadiusInfo | str]:
         if self.zip_codes and type(self.zip_codes[0] == dict):
             return [RadiusInfo(**zp) for zp in self.zip_codes]
         return self.zip_codes
+
+
+@dataclass
+class MultiRadiusInfo:
+    base_zip_code: str
+    zip_codes: list[str]
+
+
+@dataclass
+class MultiRadius:
+    responses: list[dict]
+
+    @property
+    def info(self) -> list[MultiRadiusInfo]:
+        return [MultiRadiusInfo(**r) for r in self.responses]

pyzipcodeapi/example.py

@@ -16,14 +16,26 @@
     us = CountryEnum.US
     ca = CountryEnum.CA
     # https://www.zipcodeapi.com/rest/<api_key>/distance.<format>/<zip_code1>/<zip_code2>/<units>
-    print(zca.distance(zip_code1="94106", zip_code2="94132", units=u2, f=f2, country=us))
+    print(
+        zca.distance(zip_code1="94106", zip_code2="94132", units=u2, f=f2, country=us)
+    )
     print("------------------")
     # https://www.zipcodeapi.com/rest/<api_key>/multi-distance.<format>/<zip_code>/<other_zip_codes>/<units>
     print(zca.multi_distance(zip_code="94106", zip_codes=["94132"], units=u2, f=f2))
     print("------------------")
     # https://www.zipcodeapi.com/rest/<api_key>/radius.<format>/<zip_code>/<distance>/<units>
     print(zca.radius(zip_code="94120", distance=5, units=u2, minimal=False))
     print("------------------")
+    # https://www.zipcodeapi.com/rest/<api_key>/multi-radius.<format>/<zip_code>/<distance>/<units>
+    print(
+        zca.multi_radius(
+            distance=5,
+            zip_codes=["22911", "22902"],
+            addresses=["1827 Glissade Ln, Charlottesville VA 22911"],
+            units=u2,
+        )
+    )
+    print("------------------")
     # https://www.zipcodeapi.com/rest/<api_key>/match-close.<format>/<zip_codes>/<distance>/<units>
     print(obj.get("match-close", f).filter(zip_codes="941asd32", distance="5", units=u))
     print("------------------")