v0.1.0

Author: randoum

.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Unit test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    env:
+      PHONE_VAL_API_KEY: ${{ secrets.API_KEY }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies, and python_core module
+        run: |
+          pip3 install -r requirements.txt
+          python setup.py install --user
+
+      - name: Run test
+        run: |
+          python3 -m unittest tests/test_python_core.py
+

.gitignore

@@ -0,0 +1,7 @@
+build
+dist
+**/__pycache__
+python_core.egg-info
+dev_test.py
+.vscode
+*.history

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Abstract
+
+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,11 @@
+# AbstractAPI python-core library
+
+Pure Python library for using [Abstract API](https://www.abstractapi.com/). This is core library that has some shared logic and functions used by other libraries.
+
+# See other
+
+To use and maintain this library, please see the following:
+
+- [Python Email Validation](https://github.com/abstractapi/python-email-validation)
+- [Python IP Geolocation](https://github.com/abstractapi/python-ip-geolocation)
+- [Python Phone Validation](https://github.com/abstractapi/python-phone-validation)

python_core/__init__.py

@@ -0,0 +1 @@
+from .python_core import HttpEndpoint

python_core/exceptions/__init__.py

@@ -0,0 +1 @@
+from .exceptions import HttpResponseException, APIException

python_core/exceptions/exceptions.py

@@ -0,0 +1,86 @@
+class HttpResponseException(Exception):
+    """
+    An Exception caused by bad Http response code
+    Http codes >= 400
+    """
+
+    def __init__(self, http_code, msg):
+        """
+        An Exception caused by bad Http response code
+        Http codes >= 400
+
+        Args:
+            http_code (int): http response status code that caused the error,
+                             will determine the type of exception message
+            msg (str): the system exec info, traceback is kept and we add msg to it
+        """
+        self.http_code = http_code
+        self.msg = msg
+
+    def __str__(self):
+
+
+        output = f"""
+            [ HttpResponseException ]
+            {self.http_code} -- {self.msg}\n
+            Make sure that : \n
+            - subdomain is valid\n
+            - good connection to internet\n
+            - avoid using VPN
+
+        """
+
+        return output
+
+
+class APIException(Exception):
+    """
+    An Exception caused by an API response with
+    an error, the recieved error message/description
+    will be raised
+    """
+
+    def __init__(self, http_code, msg):
+        """
+        An Exception caused by an API response with
+        an error, the recieved error message/description
+        will be raised
+
+        Args:
+            http_code (int): the response http code
+            msg (str): the system exec info, traceback is kept and we add msg to it
+        """
+        self.http_code = http_code
+        self.msg = msg
+
+    def __str__(self):
+
+        if self.http_code == 401:
+            output = f"""
+                [ HttpResponseException ]
+                {self.http_code} -- {self.msg}\n
+                [[ Unauthorized ]] Make sure that : \n
+                - API key is valid\n
+
+            """
+        elif self.http_code == 400:
+            output = f"""
+                [ HttpResponseException ]
+                {self.http_code} -- {self.msg}\n
+                [[ Bad Request ]] Make sure that : \n
+                - Request params are valid (valid phone number / valid IP address ...)\n
+
+            """
+        else:
+            output = f"""
+                [ HttpResponseException ]
+                {self.http_code} -- {self.msg}\n
+                Make sure that : \n
+                - subdomain is valid\n
+                - connection to internet\n
+                - avoid using VPN
+
+            """
+
+        return output
+

python_core/python_core.py

@@ -0,0 +1,57 @@
+from python_core.exceptions.exceptions import HttpResponseException, APIException
+import requests
+import sys
+
+
+class HttpEndpoint:
+    """
+    HttpEndpoint class, one instance per endpoint, offers get/post HTTP methods
+    and handles both HTTP errors and API errors
+    """
+
+
+    def __init__(self, endpoint_subdomain, global_req_params):
+        """
+        HttpEndpoint class, one instance per endpoint, offers get/post HTTP methods
+        and handles both HTTP errors and API errors
+
+        Args:
+            endpoint (string): endpoint URL
+            global_req_params (dict): dict of global params included in each request
+        """
+
+        self.endpoint_subdomain = endpoint_subdomain
+        self.endpoint = f"https://{endpoint_subdomain}.abstractapi.com/v1/"
+        self.global_req_params = global_req_params
+
+
+    def get(self, req_params):
+        """
+        Make a get request to the endpoint
+
+        Args:
+            req_params (dict): dict of params included in this request
+        """
+
+        # requests raises only connection related exceptions, unless exlicitly
+        # configured to raise Http exceptions
+        try:
+            response = requests.get(
+                url=self.endpoint,
+                params={
+                    **self.global_req_params,
+                    **req_params
+                }
+            )
+        except requests.exceptions.RequestException as req_exc:
+
+            # RequestExceptions are expressive: ConnectionError, ConnectTimeout, InvalidURL, InvalidHeader
+            # Other Http exceptions are explained with a msg
+            raise HttpResponseException(-1, sys.exc_info())
+
+        if response.ok:
+            result = response.json()
+            return result
+        else:
+            # Will give a hint to the cause of this exception
+            raise APIException(response.status_code, sys.exc_info())

requirements.txt

@@ -0,0 +1,8 @@
+certifi==2020.12.5
+chardet==4.0.0
+idna==2.10
+plotly==4.14.3
+requests==2.25.1
+urllib3==1.26.4
+wincertstore==0.2
+python-dotenv==0.17.0

setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+
+# Set the library's long description to the repo's README.md
+with open('README.md', 'r') as readme_file:
+    readme = readme_file.read()
+
+requirements = ['requests>=2']
+
+setup(
+    name='python_core',
+    version='0.1.0',
+    author='Benjamin Bouchet',
+    author_email='<[email protected]>',
+    description='HTTP client to call AbstractAPI endpoints.',
+    long_description=readme,
+    long_description_content_type='text/markdown',
+    url='https://github.com/abstractapi/python-core',
+    packages=find_packages(),
+    install_requires=requirements,
+    classifiers=[
+        'Programming Language :: Python :: 3.6',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+    ],
+)

tests/test_python_core.py

@@ -0,0 +1,57 @@
+import unittest
+import os, sys
+from dotenv import load_dotenv
+
+load_dotenv()
+
+PHONE_VAL_API_KEY = os.getenv('PHONE_VAL_API_KEY')
+
+from python_core import HttpEndpoint
+
+class TestHttpEndpoint(unittest.TestCase):
+    def __init__(self, *args, **kwargs):
+
+        super(TestHttpEndpoint, self).__init__(*args, **kwargs)
+        self.http_endpoint = HttpEndpoint(
+            "https://phonevalidation.abstractapi.com/v1/", {'lang' : 'python'}
+        )
+
+    def test_no_config(self):
+
+        try:
+            # Some tests can change this to test with a wrong endpoint
+            # make sure it's right here
+            self.http_endpoint.endpoint = "https://phonevalidation.abstractapi.com/v1/"
+
+            self.http_endpoint.get({
+                "api_key" : PHONE_VAL_API_KEY,
+                "phone" : "14154582468",
+
+            })
+        except Exception as e:
+            self.fail(sys.exc_info())
+
+    def test_wrong_endpoint(self):
+
+        with self.assertRaises(Exception):
+            self.http_endpoint.endpoint = "https://www.google.com"
+
+            self.http_endpoint.get({
+                "api_key" : PHONE_VAL_API_KEY,
+                "phone" : "14154582468"
+            })
+
+
+    def test_wrong_get_param(self):
+
+        with self.assertRaises(Exception):
+            self.http_endpoint.endpoint = "https://phonevalidation.abstractapi.com/v1/"
+
+            self.http_endpoint.get({
+                "api_key" : PHONE_VAL_API_KEY,
+                "not_phone" : "14154582468"
+            })
+
+
+if __name__ == '__main__':
+    unittest.main()