mailbox-org-api 2.0__tar.gz → 2.1__tar.gz

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.0
+Version: 2.1
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/mailbox_org_api/APIClient.py

@@ -3,9 +3,10 @@ Module for the mailbox Business API client
 """
 import json
 import requests
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+from requests.exceptions import RequestException
 import typing_extensions
-from requests import RequestException
-
 from mailbox_org_api.APIError import APIError
 from mailbox_org_api.Account import Account
 from mailbox_org_api.Mail import Mail
@@ -19,8 +20,7 @@ class APIClient:
     """
     Object for API Client
     """
-
-    def __init__(self, debug_output=False):
+    def __init__(self, debug_output=False, max_retries=5):
         # URL of the API
         self.url = "https://api.mailbox.org/v1/"
 
@@ -35,6 +35,27 @@ class APIClient:
 
         self.debug_output = debug_output
 
+        # Initialize the session
+        self.session = requests.Session()
+
+        # Set default headers for the session
+        self.session.headers.update({
+            'Content-Type': 'application/json',
+        })
+
+        # Retry strategy
+        retry_strategy = Retry(
+            total=max_retries,
+            backoff_factor=0.5,
+            # Retry on these specific HTTP status codes
+            status_forcelist=[429, 500, 502, 503, 504],
+            # Allow retries for POST requests
+            allowed_methods=["HEAD", "GET", "OPTIONS", "POST"]
+        )
+
+        adapter = HTTPAdapter(max_retries=retry_strategy)
+        self.session.mount('https://', adapter)
+
     # Increment the request ID
     def get_jsonrpc_id(self):
         """Method to create the JSON RPC request ID. """
@@ -73,8 +94,7 @@ class APIClient:
             # Print the clean version of the request
             print('API full request:\t', print_request)
 
-        api_response = requests.post(
-            self.url, data=json.dumps(request), headers=headers)
+        api_response = self.session.post(self.url, data=json.dumps(request))
         try:
             api_response = api_response.json()
         except RequestException as error:
@@ -115,7 +135,7 @@ class APIClient:
             self.auth_id = str(api_response["session"])
             print('Auth ID:', self.auth_id)
             # The auth-header is added to the list of headers, as it has to be provided with each call
-            headers.update({"HPLS-AUTH": self.auth_id})
+            self.session.headers.update({"HPLS-AUTH": self.auth_id})
         return api_response
 
     def deauth(self) -> dict:
@@ -126,8 +146,9 @@ class APIClient:
         api_response = self.api_request('deauth',{})
         if api_response:
             # The auth header is stripped
-            del headers["HPLS-AUTH"]
+            self.session.headers.pop("HPLS-AUTH")
             self.auth_id = None
+            self.session.close()
         return api_response
 
     def hello_world(self):
@@ -431,7 +452,7 @@ class APIClient:
         """
         return self.api_request('domain.validate.spf', {'domain':domain})
 
-    def mail_list(self, domain, details: bool = False, page_size: int = None, page: int = None, sort_field: str = None,
+    def mail_list(self, domain: str, details: bool = False, page_size: int = None, page: int = None, sort_field: str = None,
                   sort_order: str = None) -> dict:
         """
         Function to list all mailboxes
@@ -454,8 +475,8 @@ class APIClient:
 
         # Check values (without triggering a KeyError)
         # Logic: If page_size exists and is > 1, ensure page is also > 1
-        if params.get('page_size', 0) > 1 >= params.get('page', 0):
-            raise ValueError(f'''If 'page_size' is used, 'page' must be specified''')
+        if params.get('page_size', 0) >= 1 > params.get('page', 0):
+            raise ValueError(f'''If 'page_size' is used, a 'page' >0 must be specified''')
 
         # 3. Use walrus operator to assign a value to a variable, but only if it exists
         if (field := params.get('sort_field')) and field not in mail_list_sort_field:

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/mailbox_org_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.0
+Version: 2.1
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mailbox-org-api"
-version = "2.0"
+version = "2.1"
 authors = [
   { name="Hendrik Schlange", email="mail@heshsum.de" },
 ]

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages, setup
 setup(
     name='mailbox_org_api',
     packages=find_packages(),
-    version='2.0',
+    version='2.1',
     description='A library to access the mailbox.org Business API',
     author='Hendrik Schlange',
     install_requires=['requests'],

{mailbox_org_api-2.0 → mailbox_org_api-2.1}/tests/TestAPIClient.py

@@ -63,6 +63,14 @@ class TestAPIClient:
         assert api.jsonrpc_id == 1
         api.deauth()
 
+    def test_deauth(self):
+        api = APIClient.APIClient()
+        assert api.session.headers.get('HPLS-AUTH') is None
+        api.auth(api_test_user, api_test_pass)
+        assert api.session.headers.get('HPLS-AUTH') is not None
+        api.deauth()
+        assert api.session.headers.get('HPLS-AUTH') is None
+
     def test_account_get(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -226,6 +234,11 @@ class TestAPIClient:
                 ['MAIL_BLACKLIST', 'MAIL_SPAMPROTECTION', 'MAIL_PASSWORDRESET_SMS', 'MAIL_BACKUPRECOVER'])
         assert mails[0]['plan'] in ['premium', 'standard', 'light']
         assert mails[0]['creation_date'] is not None
+        paginated_mails = api.mail_list(domain, page_size=50, page=1)
+        assert paginated_mails is not None
+        assert paginated_mails['totalHits'] is not None
+        assert paginated_mails['totalPages'] is not None
+        assert paginated_mails['results'] is not None
         with pytest.raises(APIError):
             api.mail_list(domain, page = 2)
         with pytest.raises(APIError):