Merge pull request #23 from bartbroere/feature/allow-builtin-ipaddress

Allow supplying IP address from the builtin ipaddress module

Author: coderholic

ipinfo/handler.py

@@ -2,6 +2,7 @@
 Main API client handler for fetching data from the IPinfo service.
 """
 
+from ipaddress import IPv4Address, IPv6Address
 import json
 import os
 import sys
@@ -57,6 +58,11 @@ def getBatchDetails(self, ip_addresses):
         # the IPs not in the cache.
         lookup_addresses = []
         for ip_address in ip_addresses:
+            # If the supplied IP address uses the objects defined in the built-in module ipaddress
+            # extract the appropriate string notation before formatting the URL
+            if isinstance(ip_address, IPv4Address) or isinstance(ip_address, IPv6Address):
+                ip_address = ip_address.exploded
+
             if ip_address in self.cache:
                 result[ip_address] = self.cache[ip_address]
             else:
@@ -90,6 +96,12 @@ def getBatchDetails(self, ip_addresses):
 
     def _requestDetails(self, ip_address=None):
         """Get IP address data by sending request to IPinfo API."""
+
+        # If the supplied IP address uses the objects defined in the built-in module ipaddress
+        # extract the appropriate string notation before formatting the URL
+        if isinstance(ip_address, IPv4Address) or isinstance(ip_address, IPv6Address):
+            ip_address = ip_address.exploded
+
         if ip_address not in self.cache:
             url = self.API_URL
             if ip_address:

tests/handler_test.py

@@ -1,3 +1,4 @@
+from ipaddress import IPv4Address
 import json
 
 from ipinfo.cache.default import DefaultCache
@@ -39,6 +40,22 @@ def test_get_details():
     assert details.latitude == "12.34"
 
 
+def test_builtin_ip_types():
+    handler = Handler()
+    fake_details = {"country": "US", "ip": "127.0.0.1", "loc": "12.34,56.78"}
+
+    handler._requestDetails = lambda x: fake_details
+
+    details = handler.getDetails(IPv4Address(fake_details["ip"]))
+    assert isinstance(details, Details)
+    assert details.country == fake_details["country"]
+    assert details.country_name == "United States"
+    assert details.ip == fake_details["ip"]
+    assert details.loc == fake_details["loc"]
+    assert details.longitude == "56.78"
+    assert details.latitude == "12.34"
+
+
 def test_json_serialization():
     handler = Handler()
     fake_details = {