ipregistry 3.2.0__tar.gz → 4.0.0__tar.gz

{ipregistry-3.2.0 → ipregistry-4.0.0}/PKG-INFO

@@ -1,27 +1,28 @@
 Metadata-Version: 2.1
 Name: ipregistry
-Version: 3.2.0
+Version: 4.0.0
 Summary: Official Python library for Ipregistry
 Home-page: https://ipregistry.co
 License: Apache-2.0
 Keywords: ipinfo,ipregistry,ip-address,ip-data,ip-geolocation,threat-detection,user-agent-parsing
 Author: Ipregistry Team
 Author-email: support@ipregistry.co
-Requires-Python: >=3.6,<4.0
+Requires-Python: >=3.8
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
-Requires-Dist: cachetools (>=4.2.4,<5.0.0)
-Requires-Dist: requests (>=2.26.0,<3.0.0)
-Requires-Dist: six (>=1.16.0,<2.0.0)
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: cachetools (>=5.3.3,<6.0.0)
+Requires-Dist: pydantic (>=2.7.3,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: tenacity (>=8.3.0,<9.0.0)
 Project-URL: Repository, https://github.com/ipregistry/ipregistry-python
 Description-Content-Type: text/markdown
 
-[<img src="https://cdn.ipregistry.co/icons/icon-72x72.png" alt="Ipregistry" width="64"/>](https://ipregistry.co/) 
+[<img src="https://cdn.ipregistry.co/icons/favicon-96x96.png" alt="Ipregistry" width="64"/>](https://ipregistry.co/) 
 # Ipregistry Python Client Library
 
 [![License](http://img.shields.io/:license-apache-blue.svg)](LICENSE)
@@ -52,8 +53,29 @@ pip install ipregistry
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-ipInfo = client.lookup("54.85.132.205")
-print(ipInfo)
+response = client.lookup_ip("54.85.132.205")
+
+# Printing whole response
+print(response)
+
+# Retrieving a specific field
+country_code = response.data.location.country.code
+
+# Getting number of credits consumed or remaining
+credits_consumed = response.credits.consumed
+credits_remaining = response.credits.remaining
+```
+
+#### Single ASN Lookup
+
+```python
+from ipregistry import IpregistryClient
+
+client = IpregistryClient("YOUR_API_KEY")
+response = client.lookup_asn(42)
+print(response.credits.consumed)
+print(response.data.prefixes)
+print(response.data.relationships)
 ```
 
 #### Batch IP Lookup
@@ -62,9 +84,9 @@ print(ipInfo)
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-results = client.lookup(["54.85.132.205", "8.8.8.8", "2001:67c:2e8:22::c100:68b"])
-for ipInfo in results:
-    print(ipInfo)
+response = client.batch_lookup_ips(["54.85.132.205", "8.8.8.8", "2001:67c:2e8:22::c100:68b"])
+for ip_info in response.data:
+    print(ip_info)
 ```
 
 #### Origin IP Lookup
@@ -73,8 +95,18 @@ for ipInfo in results:
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-ipInfo = client.lookup()
-print(ipInfo)
+response = client.origin_lookup_ip()
+print(response.data)
+```
+
+#### User-Agent Parsing
+
+```python
+from ipregistry import IpregistryClient
+
+client = IpregistryClient("YOUR_API_KEY")
+response = client.parse_user_agent('Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36')
+print(response.data)
 ```
 
 More advanced examples are available in the [samples](https://github.com/ipregistry/ipregistry-python/tree/master/samples) 
@@ -106,6 +138,18 @@ from ipregistry import IpregistryClient, NoCache
 client = IpregistryClient("YOUR_API_KEY", cache=NoCache())
 ```
 
+### European Union Base URL
+
+With the ever-increasing concerns about data privacy and security, we recognize the importance of providing our European users with a dedicated API base URL:
+
+```python
+from ipregistry import IpregistryClient, NoCache
+
+client = IpregistryClient(IpregistryConfig("YOUR_API_KEY").with_eu_base_url())
+```
+
+Using this base URL your requests are handled by the closest cluster of nodes in the European Union.
+
 ### Errors
 
 All Ipregistry exceptions inherit `IpregistryError` class.
@@ -122,9 +166,9 @@ A manner to proceed is to identify bots using the `User-Agent` header.
 To ease this process, the library includes a utility method:
 
 ```python
-from ipregistry import UserAgent
+from ipregistry import UserAgents
 
-isBot = UserAgent.isBot('YOUR_USER_AGENT_HEADER_VALUE_HERE')
+is_bot = UserAgents.is_bot('YOUR_USER_AGENT_HEADER_VALUE_HERE')
 ```
 
 ## Other Libraries

{ipregistry-3.2.0 → ipregistry-4.0.0}/README.md

@@ -1,4 +1,4 @@
-[<img src="https://cdn.ipregistry.co/icons/icon-72x72.png" alt="Ipregistry" width="64"/>](https://ipregistry.co/) 
+[<img src="https://cdn.ipregistry.co/icons/favicon-96x96.png" alt="Ipregistry" width="64"/>](https://ipregistry.co/) 
 # Ipregistry Python Client Library
 
 [![License](http://img.shields.io/:license-apache-blue.svg)](LICENSE)
@@ -29,8 +29,29 @@ pip install ipregistry
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-ipInfo = client.lookup("54.85.132.205")
-print(ipInfo)
+response = client.lookup_ip("54.85.132.205")
+
+# Printing whole response
+print(response)
+
+# Retrieving a specific field
+country_code = response.data.location.country.code
+
+# Getting number of credits consumed or remaining
+credits_consumed = response.credits.consumed
+credits_remaining = response.credits.remaining
+```
+
+#### Single ASN Lookup
+
+```python
+from ipregistry import IpregistryClient
+
+client = IpregistryClient("YOUR_API_KEY")
+response = client.lookup_asn(42)
+print(response.credits.consumed)
+print(response.data.prefixes)
+print(response.data.relationships)
 ```
 
 #### Batch IP Lookup
@@ -39,9 +60,9 @@ print(ipInfo)
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-results = client.lookup(["54.85.132.205", "8.8.8.8", "2001:67c:2e8:22::c100:68b"])
-for ipInfo in results:
-    print(ipInfo)
+response = client.batch_lookup_ips(["54.85.132.205", "8.8.8.8", "2001:67c:2e8:22::c100:68b"])
+for ip_info in response.data:
+    print(ip_info)
 ```
 
 #### Origin IP Lookup
@@ -50,8 +71,18 @@ for ipInfo in results:
 from ipregistry import IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY")
-ipInfo = client.lookup()
-print(ipInfo)
+response = client.origin_lookup_ip()
+print(response.data)
+```
+
+#### User-Agent Parsing
+
+```python
+from ipregistry import IpregistryClient
+
+client = IpregistryClient("YOUR_API_KEY")
+response = client.parse_user_agent('Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36')
+print(response.data)
 ```
 
 More advanced examples are available in the [samples](https://github.com/ipregistry/ipregistry-python/tree/master/samples) 
@@ -83,6 +114,18 @@ from ipregistry import IpregistryClient, NoCache
 client = IpregistryClient("YOUR_API_KEY", cache=NoCache())
 ```
 
+### European Union Base URL
+
+With the ever-increasing concerns about data privacy and security, we recognize the importance of providing our European users with a dedicated API base URL:
+
+```python
+from ipregistry import IpregistryClient, NoCache
+
+client = IpregistryClient(IpregistryConfig("YOUR_API_KEY").with_eu_base_url())
+```
+
+Using this base URL your requests are handled by the closest cluster of nodes in the European Union.
+
 ### Errors
 
 All Ipregistry exceptions inherit `IpregistryError` class.
@@ -99,9 +142,9 @@ A manner to proceed is to identify bots using the `User-Agent` header.
 To ease this process, the library includes a utility method:
 
 ```python
-from ipregistry import UserAgent
+from ipregistry import UserAgents
 
-isBot = UserAgent.isBot('YOUR_USER_AGENT_HEADER_VALUE_HERE')
+is_bot = UserAgents.is_bot('YOUR_USER_AGENT_HEADER_VALUE_HERE')
 ```
 
 ## Other Libraries

{ipregistry-3.2.0 → ipregistry-4.0.0}/ipregistry/__init__.py

@@ -1,9 +1,8 @@
 name = "ipregistry"
 
-from .version import __version__
-
 from .cache import *
 from .core import *
+from .json import *
 from .model import *
 from .request import *
 from .util import *

{ipregistry-3.2.0 → ipregistry-4.0.0}/ipregistry/cache.py

@@ -14,28 +14,28 @@
     limitations under the License.
 """
 
-import abc, six
-
+from abc import ABC, abstractmethod
 from cachetools import TTLCache
 
-@six.add_metaclass(abc.ABCMeta)
-class IpregistryCache:
-    @abc.abstractmethod
+
+class IpregistryCache(ABC):
+    @abstractmethod
     def get(self, key):
         pass
 
-    @abc.abstractmethod
+    @abstractmethod
     def put(self, key, data):
         pass
 
-    @abc.abstractmethod
+    @abstractmethod
     def invalidate(self, key):
         pass
 
-    @abc.abstractmethod
-    def invalidateAll(self):
+    @abstractmethod
+    def invalidate_all(self):
         pass
 
+
 class InMemoryCache(IpregistryCache):
     def __init__(self, maxsize=2048, ttl=600):
         self._cache = TTLCache(maxsize, ttl)
@@ -52,10 +52,11 @@ class InMemoryCache(IpregistryCache):
     def invalidate(self, key):
         del self._cache[key]
 
-    def invalidateAll(self):
+    def invalidate_all(self):
         for key in self._cache:
             del self._cache[key]
 
+
 class NoCache(IpregistryCache):
     def __init__(self, maxsize=2048, ttl=86400):
         pass
@@ -69,5 +70,5 @@ class NoCache(IpregistryCache):
     def invalidate(self, key):
         pass
 
-    def invalidateAll(self):
+    def invalidate_all(self):
         pass

ipregistry-4.0.0/ipregistry/core.py

@@ -0,0 +1,183 @@
+"""
+    Copyright 2019 Ipregistry (https://ipregistry.co).
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+"""
+from .cache import IpregistryCache, NoCache
+from .json import AutonomousSystem, IpInfo
+from .model import LookupError, ApiResponse, ApiResponseCredits, ApiResponseThrottling
+from .request import DefaultRequestHandler, IpregistryRequestHandler
+
+
+class IpregistryClient:
+    def __init__(self, key_or_config, **kwargs):
+        self._config = key_or_config if isinstance(key_or_config, IpregistryConfig) else IpregistryConfig(key_or_config)
+        self._cache = kwargs["cache"] if "cache" in kwargs else NoCache()
+        self._requestHandler = kwargs["requestHandler"] if "requestHandler" in kwargs else DefaultRequestHandler(self._config)
+
+        if not isinstance(self._cache, IpregistryCache):
+            raise ValueError("Given cache instance is not of type IpregistryCache")
+        if not isinstance(self._requestHandler, IpregistryRequestHandler):
+            raise ValueError("Given request handler instance is not of type IpregistryRequestHandler")
+
+    def batch_lookup_asns(self, ips, **options):
+        return self.batch_request(ips, self._requestHandler.batch_lookup_asns, **options)
+
+    def batch_lookup_ips(self, ips, **options):
+        return self.batch_request(ips, self._requestHandler.batch_lookup_ips, **options)
+
+    def batch_parse_user_agents(self, user_agents, **options):
+        return self.batch_request(user_agents, self._requestHandler.batch_parse_user_agents, **options)
+
+    def batch_request(self, items, request_handler_func, **options):
+        sparse_cache = [None] * len(items)
+        cache_misses = []
+
+        for i in range(len(items)):
+            item = items[i]
+            cache_key = self.__build_cache_key(item, options)
+            cache_value = self._cache.get(cache_key)
+            if cache_value is None:
+                cache_misses.append(item)
+            else:
+                sparse_cache[i] = cache_value
+
+        result = [None] * len(items)
+        if len(cache_misses) > 0:
+            response = request_handler_func(cache_misses, options)
+        else:
+            response = ApiResponse(
+                ApiResponseCredits(),
+                [],
+                ApiResponseThrottling()
+            )
+
+        fresh_item_info = response.data
+        j = 0
+        k = 0
+
+        for cached_item_info in sparse_cache:
+            if cached_item_info is None:
+                if not isinstance(fresh_item_info[k], LookupError):
+                    self._cache.put(self.__build_cache_key(items[j], options), fresh_item_info[k])
+                result[j] = fresh_item_info[k]
+                k += 1
+            else:
+                result[j] = cached_item_info
+            j += 1
+
+        response.data = result
+
+        return response
+
+    def lookup_asn(self, asn, **options):
+        return self.__lookup_asn(asn, options)
+
+    def lookup_ip(self, ip, **options):
+        if isinstance(ip, str):
+            return self.__lookup_ip(ip, options)
+        else:
+            raise ValueError("Invalid value for 'ip' parameter: " + ip)
+
+    def origin_lookup_asn(self, **options):
+        return self.__lookup_asn('AS', options)
+
+    def origin_lookup_ip(self, **options):
+        return self.__lookup_ip('', options)
+
+    def origin_parse_user_agent(self, **options):
+        return self._requestHandler.origin_parse_user_agent(options)
+
+    def __lookup_asn(self, asn, options):
+        return self.__lookup(
+            'AS' + str(asn) if IpregistryClient.__is_number(asn) else 'AS',
+            options, self._requestHandler.lookup_asn,
+            AutonomousSystem)
+
+    def __lookup_ip(self, ip, options):
+        return self.__lookup(ip, options, self._requestHandler.lookup_ip, IpInfo)
+
+    def __lookup(self, key, options, lookup_func, response_type):
+        cache_key = self.__build_cache_key(key, options)
+        cache_value = self._cache.get(cache_key)
+
+        if cache_value is None:
+            response = lookup_func(key, options)
+            if isinstance(response.data, response_type):
+                self._cache.put(cache_key, response.data)
+            return response
+
+        return ApiResponse(
+            ApiResponseCredits(),
+            cache_value,
+            ApiResponseThrottling()
+        )
+
+    def parse_user_agent(self, user_agent, **options):
+        response = self.batch_parse_user_agents([user_agent], **options)
+        response.data = response.data[0]
+        return response
+
+    @staticmethod
+    def __build_cache_key(key, options):
+        result = key
+
+        for key, value in options.items():
+            if isinstance(value, bool):
+                value = 'true' if value is True else 'false'
+            result += ';' + key + '=' + value
+
+        return result
+
+    @staticmethod
+    def __is_api_error(data):
+        return 'code' in data
+
+    @staticmethod
+    def __is_number(value):
+        try:
+            # Try converting the value to a float
+            float(value)
+            return True
+        except ValueError:
+            return False
+
+
+class IpregistryConfig:
+    def __init__(self, key, base_url="https://api.ipregistry.co", timeout=5):
+        """
+        Initialize the IpregistryConfig instance.
+
+        Parameters:
+        key (str): The API key for accessing the Ipregistry service.
+        base_url (str): The base URL for the Ipregistry API. Defaults to "https://api.ipregistry.co".
+                        There also exists a European Union (EU) base URL "https://eu.api.ipregistry.co"
+                        that can be used to ensure requests are handled by nodes hosted in the EU only.
+        timeout (int): The timeout duration (in seconds) for API requests. Defaults to 15 seconds.
+        """
+        self.api_key = key
+        self.base_url = base_url
+        self.timeout = timeout
+
+    def with_eu_base_url(self):
+        self.base_url = 'https://eu.api.ipregistry.co'
+        return self
+
+    def __str__(self):
+        """
+        Return a string representation of the IpregistryConfig instance.
+
+        Returns:
+        str: A string containing the API key, base URL, and timeout value.
+        """
+        return "api_key={}, base_url={}, timeout={}".format(self.api_key, self.base_url, self.timeout)