Support IP2Proxy Web Service.

Author: ip2location

ChangeLog

@@ -1,3 +1,6 @@
+3.3.0	2021-08-18
+	* Support IP2Proxy Web Service.
+
 3.2.1	2021-07-19
 	* Removed unused code.
 

IP2Proxy.py

@@ -19,13 +19,45 @@
 import socket
 import ipaddress
 import os
+import json
+import re
 
 if sys.version < '3':
+    import urllib, httplib
+    def urlencode(x):
+        return urllib.urlencode(x)
+    def httprequest(x, usessl):
+        try:
+            # conn = httplib.HTTPConnection("api.ip2proxy.com")
+            if (usessl is True):
+                conn = httplib.HTTPSConnection("api.ip2proxy.com")
+            else:
+                conn = httplib.HTTPConnection("api.ip2proxy.com")
+            conn.request("GET", "/?" + x)
+            res = conn.getresponse()
+            return json.loads(res.read())
+        except:
+            return None
     def u(x):
         return x.decode('utf-8')
     def b(x):
         return str(x)
 else:
+    import urllib.parse, http.client
+    def urlencode(x):
+        return urllib.parse.urlencode(x)
+    def httprequest(x, usessl):
+        try:
+            # conn = http.client.HTTPConnection("api.ip2proxy.com")
+            if (usessl is True):
+                conn = http.client.HTTPSConnection("api.ip2proxy.com")
+            else:
+                conn = http.client.HTTPConnection("api.ip2proxy.com")
+            conn.request("GET", "/?" + x)
+            res = conn.getresponse()
+            return json.loads(res.read())
+        except:
+            return None
     def u(x):
         if isinstance(x, bytes):
             return x.decode()
@@ -53,7 +85,7 @@ def inet_pton(t, addr):
         return out_addr_p.raw
     socket.inet_pton = inet_pton
 
-_VERSION = '3.2.1' 
+_VERSION = '3.3.0' 
 _NO_IP = 'MISSING IP ADDRESS'
 _FIELD_NOT_SUPPORTED = 'NOT SUPPORTED'
 _INVALID_IP_ADDRESS  = 'INVALID IP ADDRESS'
@@ -623,3 +655,37 @@ def _get_record(self, ip):
                     high = mid - 1
                 else:
                     low = mid + 1
+
+class IP2ProxyWebService(object):
+    ''' IP2Proxy web service '''
+    def __init__(self,apikey,package,usessl=True):
+        if ((re.match(r"^[0-9A-Z]{10}$", apikey) == None) and (apikey != 'demo')):
+            raise ValueError("Please provide a valid IP2Proxy web service API key.")
+        if (re.match(r"^PX[0-9]+$", package) == None):
+            package = 'PX1'
+        self.apikey = apikey
+        self.package = package
+        self.usessl = usessl
+
+    def lookup(self,ip):
+        '''This function will look the given IP address up in IP2Proxy web service.'''
+        parameters = urlencode((("ip", ip), ("key", self.apikey), ("package", self.package)))
+        response = httprequest(parameters, self.usessl)
+        if (response == None):
+            return False
+        if (('response' in response) and (response['response'] != "OK")):
+            raise IP2ProxyAPIError(response['response'])
+        return response
+
+    def getcredit(self):
+        '''Get the remaing credit in your IP2Proxy web service account.'''
+        parameters = urlencode((("key", self.apikey), ("check", True)))
+        response = httprequest(parameters, self.usessl)
+        if (response == None):
+            return 0
+        if ('response' in response is False):
+            return 0
+        return response['response']
+
+class IP2ProxyAPIError(Exception):
+    """Raise for IP2Proxy API Error Message"""

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: IP2Proxy
-Version: 3.2.1
+Version: 3.3.0
 Summary: Python API for IP2Proxy database
 Home-page: http://www.ip2location.com
 Author: IP2Location

README.md

@@ -35,7 +35,18 @@ Below are the methods supported in this library.
 |get_threat|Return the threat types reported to proxy's IP address or domain name.|
 |get_provider|Returns the VPN service provider name if available.|
 
+## Web Service
+
+Below is the description of the functions available in the **Web Service** lookup.
+
+| Method Name | Description                                                  |
+| ----------- | ------------------------------------------------------------ |
+| Constructor | Expect 3 input parameters:IP2Proxy API Key.Package (PX1 - PX10)Use HTTPS or HTTP |
+| lookup      | Return the proxy information in array.<ul><li>countryCode</li><li>countryName</li><li>regionName</li><li>cityName</li><li>isp</li><li>domain</li><li>usageType</li><li>asn</li><li>as</li><li>lastSeen</li><li>threat</li><li>proxyType</li><li>isProxy</li></ul> |
+| getcredit   | Return remaining credit of the web service account.          |
+
 ## Requirements
+
 1. Python 2.2 and above
 
 ## Installation
@@ -100,6 +111,13 @@ print ('Provider: ' + record['provider'])
 
 # close IP2Proxy BIN database
 db.close()
+
+# Web Service
+ws = IP2Proxy.IP2ProxyWebService("demo","PX11",True)
+rec = ws.lookup("8.8.8.8")
+print (rec)
+print ("\n")
+print ("Credit Remaining: {}\n".format(ws.getcredit()))
 ```
 
 ## Proxy Type

example.py

@@ -45,4 +45,11 @@
 print ('Provider: ' + record['provider'])
 
 # close IP2Proxy BIN database
-db.close()
+db.close()
+
+# Web Service
+ws = IP2Proxy.IP2ProxyWebService("demo","PX11",True)
+rec = ws.lookup("8.8.8.8")
+print (rec)
+print ("\n")
+print ("Credit Remaining: {}\n".format(ws.getcredit()))

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="IP2Proxy",
-    version="3.2.1", 
+    version="3.3.0", 
     author="IP2Location",
     author_email="support@ip2location.com",
     description="Python API for IP2Proxy database. It can be used to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.",

tests/test_webservice.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+import pytest
+
+import IP2Proxy
+
+apikey = "demo"
+package = "PX11"
+usessl = True
+
+ws = IP2Proxy.IP2ProxyWebService(apikey,package,usessl)
+
+def testcountrycode():
+    # ws = IP2Proxy.IP2ProxyWebService(apikey,package,usessl)
+    rec = ws.lookup("8.8.8.8")
+    assert rec['country_code'] == "US", "Test failed because country code not same."
+
+def testgetcredit():
+    credit = ws.getcredit()
+    assert str(credit).isdigit() == True, "Test failed because it is no a digit value."
+
+def testfunctionexist():
+    functions_list = ['lookup', 'getcredit']
+    for x in range(len(functions_list)): 
+        assert hasattr(ws, functions_list[x]) == True, "Function did not exist."