adding iterative function

Author: Samuel-Gill

ipinfo/handler.py

@@ -305,3 +305,24 @@ def getMap(self, ips):
         )
         response.raise_for_status()
         return response.json()["reportUrl"]
+
+    def getIterativeBatchDetails(self, ip_addresses, batch_size=None):
+        if batch_size == None:
+            batch_size = BATCH_MAX_SIZE
+
+        url = API_URL + "/batch"
+        headers = handler_utils.get_headers(self.access_token, self.headers)
+        headers["content-type"] = "application/json"
+
+        # Split the IP addresses into batches
+        batches = [
+            ip_addresses[i : i + batch_size]
+            for i in range(0, len(ip_addresses), batch_size)
+        ]
+
+        for batch in batches:
+            response = requests.post(url, json=batch, headers=headers)
+            json_response = response.json()
+
+            for ip_address, details in json_response.items():
+                yield ip_address, details

ipinfo/handler_async.py

@@ -98,10 +98,10 @@ def __init__(self, access_token=None, **kwargs):
             if "ttl" not in cache_options:
                 cache_options["ttl"] = CACHE_TTL
             self.cache = DefaultCache(**cache_options)
-        
+
         # setup custom headers
         self.headers = kwargs.get("headers", None)
-        
+
     async def init(self):
         """
         Initializes internal aiohttp connection pool.

ipinfo/handler_utils.py

@@ -51,14 +51,14 @@
 def get_headers(access_token, custom_headers):
     """Build headers for request to IPinfo API."""
     headers = {
-       "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
-        version=sys.version_info[0], sdk_version=SDK_VERSION
+        "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
+            version=sys.version_info[0], sdk_version=SDK_VERSION
         ),
         "accept": "application/json",
     }
 
     if custom_headers:
-        headers = {** headers, ** custom_headers}
+        headers = {**headers, **custom_headers}
 
     if access_token:
         headers["authorization"] = "Bearer {}".format(access_token)

tests/handler_async_test.py

@@ -162,4 +162,4 @@ async def test_bogon_details():
     token = os.environ.get("IPINFO_TOKEN", "")
     handler = AsyncHandler(token)
     details = await handler.getDetails("127.0.0.1")
-    assert details.all == {'bogon': True, 'ip': '127.0.0.1'}
+    assert details.all == {"bogon": True, "ip": "127.0.0.1"}

tests/handler_test.py

@@ -128,6 +128,19 @@ def _check_batch_details(ips, details, token):
             assert "domains" in d
 
 
+def _check_iterative_batch_details(ip, details, token):
+    """Helper for iterative batch tests."""
+    assert ip == details.get("ip")
+    assert "country" in details
+    assert "city" in details
+    if token:
+        assert "asn" in details
+        assert "company" in details
+        assert "privacy" in details
+        assert "abuse" in details
+        assert "domains" in details
+
+
 @pytest.mark.parametrize("batch_size", [None, 1, 2, 3])
 def test_get_batch_details(batch_size):
     handler, token, ips = _prepare_batch_test()
@@ -144,6 +157,16 @@ def test_get_batch_details_total_timeout(batch_size):
         )
 
 
+@pytest.mark.parametrize("batch_size", [None, 1, 2, 3])
+def test_get_iterative_batch_details(batch_size):
+    handler, token, ips = _prepare_batch_test()
+    details_iterator = handler.getIterativeBatchDetails(
+        ips, batch_size=batch_size
+    )
+    for ip, details in details_iterator:
+        _check_iterative_batch_details(ip, details, token)
+
+
 #############
 # MAP TESTS
 #############
@@ -165,4 +188,4 @@ def test_bogon_details():
     handler = Handler(token)
     details = handler.getDetails("127.0.0.1")
     assert isinstance(details, Details)
-    assert details.all == {'bogon': True, 'ip': '127.0.0.1'}
+    assert details.all == {"bogon": True, "ip": "127.0.0.1"}