First commit.

Author: ip2whois

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 IP2WHOIS.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+# IP2WHOIS Python SDK
+
+This Python module enables user to easily implement the checking of WHOIS information for a particular domain into their solution using the API from [https://www.ip2whois.com](https://www.ip2whois.com/). It is a WHOIS lookup api that helps users to obtain domain information, WHOIS record, by using a domain name. The WHOIS API returns a comprehensive WHOIS data such as creation date, updated date, expiration date, domain age, the contact information of the registrant, mailing address, phone number, email address, nameservers the domain is using and much more. IP2WHOIS supports the query for [1113 TLDs and 634 ccTLDs](https://www.ip2whois.com/tld-cctld-supported).
+
+This module requires API key to function. You may sign up for a free API key at https://www.ip2whois.com/register.
+
+# Installation
+
+To install this module type the following:
+
+```bash
+pip install IP2WHOIS
+```
+
+# Usage Example
+
+### Lookup Domain Information
+
+#### Object Properties
+
+| Property Name | Property Type | Description  |
+| ------------- | ------------- | ------------ |
+| domain        | string        | Domain name. |
+
+```python
+import ip2whois
+
+# Configures IP2WHOIS API key
+ip2whois_init = ip2whois.Api('YOUR_API_KEY')
+
+# Lookup domain information
+parameter = {'domain': 'example.com'}
+results = ip2whois_init.lookup(parameter)
+print(results)
+```
+
+### Convert Normal Text to Punycode
+
+#### Object Properties
+
+| Property Name | Property Type | Description  |
+| ------------- | ------------- | ------------ |
+| domain        | string        | Domain name. |
+
+```python
+import ip2whois
+
+# Configures IP2WHOIS API key
+ip2whois_init = ip2whois.Api('YOUR_API_KEY')
+
+
+# Convert normal text to punycode
+parameter = {'domain': 'xn--tst-qla.de'}
+result = ip2whois_init.getPunycode(parameter)
+print(result)
+```
+
+### Convert Punycode to Normal Text
+
+#### Object Properties
+
+| Property Name | Property Type | Description  |
+| ------------- | ------------- | ------------ |
+| domain        | string        | Domain name. |
+
+```python
+import ip2whois
+
+# Configures IP2WHOIS API key
+ip2whois_init = ip2whois.Api('YOUR_API_KEY')
+
+
+# Convert punycode to normal text
+parameter = {'domain': 'täst.de'}
+result = ip2whois_init.getNormalText(parameter)
+print(result)
+```
+
+# LICENCE
+
+See the LICENSE file.

example.py

@@ -0,0 +1,19 @@
+import ip2whois
+
+# Configures IP2WHOIS API key
+ip2whois_init = ip2whois.Api('YOUR_API_KEY')
+
+# Lookup domain information
+parameter = {'domain': 'example.com'}
+results = ip2whois_init.lookup(parameter)
+print(results)
+
+# Convert normal text to punycode
+parameter = {'domain': 'xn--tst-qla.de'}
+result = ip2whois_init.getPunycode(parameter)
+print(result)
+
+# Convert punycode to normal text
+parameter = {'domain': 'täst.de'}
+result = ip2whois_init.getNormalText(parameter)
+print(result)

setup.py

@@ -0,0 +1,38 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="IP2WHOIS",
+    version="1.0.0",
+    author="IP2WHOIS",
+    author_email="support@ip2whois.com",
+    description="IP2WHOIS Python SDK to help user to check WHOIS information for a particular domain.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/ip2whois/ip2whois-python",
+    license='MIT',
+    keywords='WHOIS',
+    project_urls={
+        'Official Website': 'https://www.ip2location.com',
+    },
+    python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*',
+    # packages=setuptools.find_packages(),
+    package_dir={"": "src"},
+    packages=setuptools.find_packages(where="src"),
+    tests_require=['pytest>=3.0.6'],
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        'Programming Language :: Python :: 2.7',
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)

src/ip2whois/__init__.py

@@ -0,0 +1 @@
+from ip2whois.api import Api

src/ip2whois/api.py

@@ -0,0 +1,66 @@
+import json
+import sys
+
+# Compability support for Python 2.7
+if sys.version < '3':
+    import urllib, httplib
+    def urlencode(x):
+        return urllib.urlencode(x)
+    def httprequest(x, usessl):
+        try:
+            if (usessl is True):
+                conn = httplib.HTTPSConnection("api.ip2whois.com")
+            else:
+                conn = httplib.HTTPConnection("api.ip2whois.com")
+            conn.request("GET", "/v2?" + x)
+            res = conn.getresponse()
+            return json.loads(res.read())
+        except:
+            return None
+else:
+    import urllib.parse, http.client
+    def urlencode(x):
+        return urllib.parse.urlencode(x)
+    def httprequest(x, usessl):
+        try:
+            if (usessl is True):
+                conn = http.client.HTTPSConnection("api.ip2whois.com")
+            else:
+                conn = http.client.HTTPConnection("api.ip2whois.com")
+            conn.request("GET", "/v2?" + x)
+            res = conn.getresponse()
+            return json.loads(res.read())
+        except:
+            return None
+
+class Api:
+    def __init__(self, apikey, usessl=True):
+        self.apikey = apikey
+        self.usessl = usessl
+    
+    def lookup(self, params = {}):
+
+         try:
+             parameters = urlencode((("key", self.apikey), ("format", 'json'), ("domain", params['domain'] if "domain" in params else '')))
+             response = httprequest(parameters, self.usessl)
+             return response
+         except:
+             return None
+    
+    def getPunycode(self, params = {}):
+         domain = params['domain'] if "domain" in params else ''
+         # return domain.encode('ascii').decode('idna')
+         if sys.version < '3':
+            converted_result = unicode(domain).encode('ascii').decode('idna')
+            return converted_result.encode('utf-8')
+         else:
+            return domain.encode('ascii').decode('idna')
+    
+    def getNormalText(self, params = {}):
+         domain = params['domain'] if "domain" in params else ''
+         # return domain.encode('idna').decode('ascii')
+         if sys.version < '3':
+            converted_result = domain.encode('idna').decode('ascii')
+            return converted_result.encode('utf-8')
+         else:
+            return domain.encode('idna').decode('ascii')

tests/conftest.py

@@ -0,0 +1,5 @@
+import pytest
+
+@pytest.fixture(scope = 'module')
+def global_data():
+    return {'apikey': "YOUR_API_KEY"}

tests/test_api.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+import pytest
+import json
+
+import ip2whois
+
+def test_lookup(global_data):
+    ip2whois_init = ip2whois.Api(global_data["apikey"])
+    parameter = {'domain': 'example.c'}
+    results = ip2whois_init.lookup(parameter)
+    # assert results['error_message'] == 'API key not found.'
+    if (global_data["apikey"] == 'YOUR_API_KEY'):
+        assert results['error']['error_message'] == 'API key not found.'
+    else:
+        assert results['error']['error_message'] == 'Invalid domain.'
+
+# def test_api_key_exist(global_data, capsys):
+    # if (global_data["apikey"] == 'YOUR_API_KEY'):
+        # with capsys.disabled():
+            # print ("You could enter a IP2WHOIS API Key in tests/conftest.py for real web service calling test.")
+            # print ("You could sign up for a free API key at https://www.ip2whois.com/register if you do not have one.")
+        # assert global_data["apikey"] == "YOUR_API_KEY"
+    # else:
+        # assert global_data["apikey"] != "YOUR_API_KEY"
+
+def test_function_exist(global_data):
+    ip2whois_init = ip2whois.Api(global_data["apikey"])
+    errors = []
+    functions_list = ['lookup', 'getPunycode', 'getNormalText']
+    for x in range(len(functions_list)): 
+        # assert hasattr(mbv, functions_list[x]) == True, "Function did not exist."
+        if (hasattr(ip2whois_init, functions_list[x]) is False):
+            errors.append("Function " + functions_list[x] + " did not exist.")
+    # assert no error message has been registered, else print messages
+    assert not errors, "errors occured:\n{}".format("\n".join(errors))
+
+def test_get_puny_code(global_data):
+    ip2whois_init = ip2whois.Api(global_data["apikey"])
+    parameter = {'domain': 'xn--tst-qla.de'}
+    result = ip2whois_init.getPunycode(parameter)
+    assert result == "täst.de"
+
+def test_get_normal_text(global_data):
+    ip2whois_init = ip2whois.Api(global_data["apikey"])
+    parameter = {'domain': 'täst.de'}
+    result = ip2whois_init.getNormalText(parameter)
+    assert result == "xn--tst-qla.de"