finish match-close option

Author: Mohamed Ben Makhlouf

pyzipcodeapi/api.py

@@ -7,7 +7,7 @@
 
 import requests
 
-from pyzipcodeapi.dataclass import Distance, Error, MultiDistance, Radius, MultiRadius
+from pyzipcodeapi.dataclass import Distance, Error, MultiDistance, Radius, MultiRadius, MatchClose
 from pyzipcodeapi.enums import FormatEnum, UnitEnum, CountryEnum
 from pyzipcodeapi.options import OPTIONS
 
@@ -143,14 +143,19 @@ def _post(self, option: str, path: str, data: dict):
 
     def parse_response(
         self, data_class: type | None = None
-    ) -> DictReader | bytes | type | Element | Error:
+    ) -> DictReader | bytes | type | Element | Error | list[type]:
         response = self.con.getresponse()
         success = response.status == 200
         data = response.read()
         if self.format == FormatEnum.JSON:
             data = loads(data)
             if success:
-                return data_class(**data) if data_class else data
+                if data_class:
+                    if type(data) == dict:
+                        return data_class(**data)
+                    if type(data) == list:
+                        return [data_class(**d) for d in data]
+                return data
             return Error(**data)
         elif self.format == FormatEnum.CSV:
             return DictReader(StringIO(data.decode()), delimiter=",")
@@ -207,3 +212,10 @@ def multi_radius(
             body["addrs"] = "\n".join(addresses)
         self._post("multi-radius", f"{distance}/{units}", data=body)
         return self.parse_response(data_class=MultiRadius)
+
+    def match_close(
+        self, zip_codes: list[str], distance: int, units: UnitEnum = UnitEnum.KM
+    ) -> list[MatchClose] | DictReader | Element:
+        """match-close.<format>/<zip_codes>/<distance>/<units>"""
+        self._get("match-close", f"{','.join(zip_codes)}/{distance}/{units}")
+        return self.parse_response(data_class=MatchClose)

pyzipcodeapi/dataclass.py

@@ -49,3 +49,10 @@ class MultiRadius:
     @property
     def info(self) -> list[MultiRadiusInfo]:
         return [MultiRadiusInfo(**r) for r in self.responses]
+
+
+@dataclass
+class MatchClose:
+    zip_code1: str
+    zip_code2: str
+    distance: float

pyzipcodeapi/example.py

@@ -35,10 +35,11 @@
     )
     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("------------------")
-    # https://www.zipcodeapi.com/rest/<api_key>/info.<format>/<zip_code>/<units>
-    print(obj.get("info", f).filter(zip_code="94132", units=ou))
+    print(
+        zca.match_close(
+            zip_codes=["22911", "22902", "22904", "22905"], distance=120, units=u2
+        )
+    )
     print("------------------")
     # https://www.zipcodeapi.com/rest/<api_key>/multi-info.<format>/<zip_code>/<units>
     print(obj.get("multi-info", f).filter(zip_code="94132", units=ou))