domaintools-api-test-upload 2.4.1__tar.gz → 2.5.0__tar.gz

{domaintools_api_test_upload-2.4.1/domaintools_api_test_upload.egg-info → domaintools_api_test_upload-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: domaintools_api_test_upload
-Version: 2.4.1
+Version: 2.5.0
 Summary: DomainTools Official Python API
 Author-email: DomainTools <integrations@domaintools.com>
 License: The MIT License (MIT)
@@ -321,3 +321,43 @@ results = api.nod(sessionID="my-session-id", after=-7200)
 for partial_result in results.response() # generator that holds NOD feeds data for the past 2 hours and is expected to request multiple times
     # do things to partial_result
 ```
+
+
+Running E2E Tests Locally
+===================
+For now, e2e tests only covers proxy and ssl testing. We are expected to broaden our e2e tests to other scenarios moving forward.
+To add more e2e tests, put these in the `../tests/e2e` folder.
+
+## Preparation
+- Create virtual environment.
+    ```bash
+        python3 -m venv venv
+    ```
+
+- Activate virtual environment
+    ```bash
+        source venv/bin/activate
+    ```
+
+- Install dependencies.
+    ```bash
+        pip install -r requirements/development.txt
+    ```
+
+- From the python_api project root directory, install the package.
+    ```bash
+        pip install -e .
+    ```
+
+- Export api credentials to use.
+    ```bash
+        export TEST_USER=<user-key>
+        export TEST_KEY=<api-key>
+    ```
+
+## Run the end-to-end test script
+- Before running the test, be sure that docker is running.
+- Execute the e2e test script .
+    ```bash
+        sh tests/e2e/scripts/test_e2e_runner.sh
+    ```

{domaintools_api_test_upload-2.4.1 → domaintools_api_test_upload-2.5.0}/README.md

@@ -270,4 +270,44 @@ results = api.nod(sessionID="my-session-id", after=-7200)
 
 for partial_result in results.response() # generator that holds NOD feeds data for the past 2 hours and is expected to request multiple times
     # do things to partial_result
-```
+```
+
+
+Running E2E Tests Locally
+===================
+For now, e2e tests only covers proxy and ssl testing. We are expected to broaden our e2e tests to other scenarios moving forward.
+To add more e2e tests, put these in the `../tests/e2e` folder.
+
+## Preparation
+- Create virtual environment.
+    ```bash
+        python3 -m venv venv
+    ```
+
+- Activate virtual environment
+    ```bash
+        source venv/bin/activate
+    ```
+
+- Install dependencies.
+    ```bash
+        pip install -r requirements/development.txt
+    ```
+
+- From the python_api project root directory, install the package.
+    ```bash
+        pip install -e .
+    ```
+
+- Export api credentials to use.
+    ```bash
+        export TEST_USER=<user-key>
+        export TEST_KEY=<api-key>
+    ```
+
+## Run the end-to-end test script
+- Before running the test, be sure that docker is running.
+- Execute the e2e test script .
+    ```bash
+        sh tests/e2e/scripts/test_e2e_runner.sh
+    ```

domaintools_api_test_upload-2.5.0/VERSION

@@ -0,0 +1 @@
+2.5.0

{domaintools_api_test_upload-2.4.1 → domaintools_api_test_upload-2.5.0}/domaintools/_version.py

@@ -20,4 +20,4 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 """
 
-current = "2.4.1"
+current = "2.5.0"

{domaintools_api_test_upload-2.4.1 → domaintools_api_test_upload-2.5.0}/domaintools/api.py

@@ -1,8 +1,10 @@
 from datetime import datetime, timedelta, timezone
-from hashlib import sha1, sha256, md5
+from hashlib import sha1, sha256
 from hmac import new as hmac
+from typing import Union
 
 import re
+import ssl
 
 from domaintools.constants import Endpoint, ENDPOINT_TO_SOURCE_MAP, FEEDS_PRODUCTS_LIST, OutputFormat
 from domaintools._version import current as version
@@ -24,7 +26,7 @@ from domaintools.filters import (
 from domaintools.utils import validate_feeds_parameters
 
 
-AVAILABLE_KEY_SIGN_HASHES = ["sha1", "sha256", "md5"]
+AVAILABLE_KEY_SIGN_HASHES = ["sha1", "sha256"]
 
 
 def delimited(items, character="|"):
@@ -76,7 +78,7 @@ class API(object):
         self.username = username
         self.key = key
         self.https = https
-        self.verify_ssl = verify_ssl
+        self.verify_ssl = self._get_ssl_default_context(verify_ssl)
         self.rate_limit = rate_limit
         self.proxy_url = proxy_url
         self.extra_request_params = {}
@@ -92,9 +94,12 @@ class API(object):
         if proxy_url and not isinstance(proxy_url, str):
             raise Exception("Proxy URL must be a string. For example: '127.0.0.1:8888'")
 
+    def _get_ssl_default_context(self, verify_ssl: Union[str, bool]):
+        return ssl.create_default_context(cafile=verify_ssl) if isinstance(verify_ssl, str) else verify_ssl
+
     def _build_api_url(self, api_url=None, api_port=None):
         """Build the API url based on the given url and port. Defaults to `https://api.domaintools.com`"""
-        rest_api_url = "https://api.domaintools.com.test"
+        rest_api_url = "https://api.domaintools.com"
         if api_url:
             rest_api_url = api_url
 

{domaintools_api_test_upload-2.4.1 → domaintools_api_test_upload-2.5.0/domaintools_api_test_upload.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: domaintools_api_test_upload
-Version: 2.4.1
+Version: 2.5.0
 Summary: DomainTools Official Python API
 Author-email: DomainTools <integrations@domaintools.com>
 License: The MIT License (MIT)
@@ -321,3 +321,43 @@ results = api.nod(sessionID="my-session-id", after=-7200)
 for partial_result in results.response() # generator that holds NOD feeds data for the past 2 hours and is expected to request multiple times
     # do things to partial_result
 ```
+
+
+Running E2E Tests Locally
+===================
+For now, e2e tests only covers proxy and ssl testing. We are expected to broaden our e2e tests to other scenarios moving forward.
+To add more e2e tests, put these in the `../tests/e2e` folder.
+
+## Preparation
+- Create virtual environment.
+    ```bash
+        python3 -m venv venv
+    ```
+
+- Activate virtual environment
+    ```bash
+        source venv/bin/activate
+    ```
+
+- Install dependencies.
+    ```bash
+        pip install -r requirements/development.txt
+    ```
+
+- From the python_api project root directory, install the package.
+    ```bash
+        pip install -e .
+    ```
+
+- Export api credentials to use.
+    ```bash
+        export TEST_USER=<user-key>
+        export TEST_KEY=<api-key>
+    ```
+
+## Run the end-to-end test script
+- Before running the test, be sure that docker is running.
+- Execute the e2e test script .
+    ```bash
+        sh tests/e2e/scripts/test_e2e_runner.sh
+    ```

{domaintools_api_test_upload-2.4.1 → domaintools_api_test_upload-2.5.0}/tests/test_api.py

@@ -342,11 +342,20 @@ def test_exception_handling():
         API("notauser", "notakey").domain_search("amazon").data()
     with pytest.raises(
         ValueError,
-        match=r"Invalid value 'notahash' for 'key_sign_hash'. Values available are sha1,sha256,md5",
+        match=r"Invalid value 'notahash' for 'key_sign_hash'. Values available are sha1,sha256",
     ):
         API("notauser", "notakey", always_sign_api_key=True, key_sign_hash="notahash").domain_search("amazon")
 
 
+@vcr.use_cassette
+def test_md5_is_not_supported():
+    with pytest.raises(
+        ValueError,
+        match=r"Invalid value 'md5' for 'key_sign_hash'. Values available are sha1,sha256",
+    ):
+        API("notauser", "notakey", always_sign_api_key=True, key_sign_hash="md5").domain_search("amazon")
+
+
 @vcr.use_cassette
 def test_rate_limiting():
     domain_searches = ["google"] * 31
@@ -377,6 +386,7 @@ def test_formats():
 
 
 @vcr.use_cassette
+@pytest.mark.skip(reason="Iris endpoint is already deprecated in light of enrich and investigate")
 def test_iris():
     with pytest.raises(ValueError):
         api.iris()

domaintools_api_test_upload-2.4.1/VERSION

@@ -1 +0,0 @@
-2.4.1