mailbox-org-api 2.4__tar.gz → 2.5.1__tar.gz

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/PKG-INFO

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

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/mailbox_org_api/APIClient.py

@@ -24,7 +24,7 @@ class APIClient:
     Object for API Client
     """
 
-    def __init__(self, debug_output=False, max_retries=5):
+    def __init__(self, debug_output=False, max_retries=5, request_timeout: int = 30):
         # URL of the API
         self.url = "https://api.mailbox.org/v1/"
 
@@ -60,6 +60,8 @@ class APIClient:
         adapter = HTTPAdapter(max_retries=retry_strategy)
         self.session.mount('https://', adapter)
 
+        self.request_timeout = request_timeout
+
     # Increment the request ID
     def get_jsonrpc_id(self):
         """Method to create the JSON RPC request ID. """
@@ -90,20 +92,26 @@ class APIClient:
             # Check if any parameter is 'password' or 'pass'.
             # Check explicit for these strings as not to interfere with possible other
             # parameters containing a substring.
+            sensitive_keys = ['password', 'pass', 'password_hash', 'new_account_password', 'token',
+                              'HPLS-AUTH', 'auth_id', 'telephone_password']
             for param in print_request['params']:
-                if param == 'password' or param == 'pass':
-                    # If True, replace the logged value with 'xxx'
+                if param in sensitive_keys:
                     print_request['params'][param] = 'xxx'
 
             # Print the clean version of the request
             print('API full request:\t', print_request)
 
-        api_response = self.session.post(self.url, data=json.dumps(request))
         try:
-            api_response = api_response.json()
+            response = self.session.post(self.url, json=request, timeout=self.request_timeout)
+            response.raise_for_status()
         except RequestException as error:
-            print('Non-JSON response received.\nFull response:\t', api_response,
-                  '\nError:', {error})
+            raise APIError(message=f"HTTP request failed: {error}", code=-32000) from error
+
+        try:
+            api_response = response.json()
+        except (ValueError, requests.exceptions.JSONDecodeError) as error:
+            print(f'API Full response: {response.content}')
+            raise APIError(message="Non-JSON response received from API", code=-32700) from error
         if self.debug_output:
             print('API full response:\t', api_response)
 
@@ -150,8 +158,9 @@ class APIClient:
         api_response = self.api_request('deauth', {})
         if api_response:
             # The auth header is stripped
-            self.session.headers.pop("HPLS-AUTH")
+            self.session.headers.pop("HPLS-AUTH", None)
             self.auth_id = None
+            self.level = None
             self.session.close()
         return api_response
 
@@ -283,22 +292,25 @@ class APIClient:
         """
         Function to get a specific invoice object for an account
         :param account: the account name
-        :param invoice_id: the id of the invoice to request
+        :param invoice_id: the ID of the invoice to request
         :return: the invoice as an Invoice object
         """
         # Get all invoices for the account
         invoice_list = self.account_invoice_list(account)
 
-        # Initialize the Invoice object
-        invoice = Invoice(account, invoice_id)
-
-        # Retrieve the other data for the invoice from the invoice list
-        for i in invoice_list:
-            if i['invoice_id'] == invoice_id:
-                invoice.date = i['date']
-                invoice.status = i['status']
-                invoice.token = i['token']
-        return invoice
+        # Iterate over all invoices and create an object if the ID matches
+        for invoice in invoice_list:
+            if invoice['invoice_id'] == invoice_id:
+                # Initialize the Invoice object
+                invoice = Invoice(account, invoice_id)
+                # Retrieve the other data for the invoice from the invoice list
+                for i in invoice_list:
+                    if i['invoice_id'] == invoice_id:
+                        invoice.date = i['date']
+                        invoice.status = i['status']
+                        invoice.token = i['token']
+                return invoice
+        raise ValueError('Invoice not found')
 
     def account_invoice_get_list(self, account: str) -> list:
         """
@@ -584,7 +596,7 @@ class APIClient:
         if 'password' in kwargs and 'password_hash' in kwargs:
             raise KeyError('''Simultaneous usage of 'password' and 'password_hash' not allowed.''')
 
-        if 'additional_mail_quota' in kwargs or 'additional_cloud_quota' in kwargs and 'plan' not in kwargs:
+        if ('additional_mail_quota' in kwargs or 'additional_cloud_quota' in kwargs) and 'plan' not in kwargs:
             raise KeyError('''If setting additional quota, 'plan' must be given.''')
 
         # Check for each argument in kwargs if it is a valid function parameter.
@@ -618,7 +630,8 @@ class APIClient:
         :param password: the password to set
         :return: the response for the request
         """
-        return self.api_request('mail.set', {'mail': mail, 'password': password, 'require_reset': True})
+        return self.api_request('mail.set', {'mail': mail, 'password': password,
+                                             'require_reset_password': True})
 
     def mail_set_plan(self, mail: str, plan: str) -> dict:
         """
@@ -922,10 +935,16 @@ class APIClient:
         if mail_addresses_to_add is None and mail_addresses_to_remove is None:
             raise ValueError('mail_addresses_to_add or mail_addresses_to_remove are required')
 
-        params = {'group_id': group_id, 'display_name': display_name, 'mail_addresses_to_add': mail_addresses_to_add,
-                  'mail_addresses_to_remove': mail_addresses_to_remove}
-        if account:
-            params['account'] = account
+        raw_params = {
+            'group_id': group_id,
+            'display_name': display_name,
+            'mail_addresses_to_add': mail_addresses_to_add,
+            'mail_addresses_to_remove': mail_addresses_to_remove,
+            'account': account,
+        }
+        # Filter out any keys whose values are None so they aren't serialized as `null`
+        params = {k: v for k, v in raw_params.items() if v is not None}
+
         return self.api_request('group.set', params)
 
     def mail_passwordreset_listmethods(self, mail: str) -> dict:
@@ -1014,8 +1033,15 @@ class APIClient:
         :param adminmail: admin email address of the mailing list (optional).
         :return: the mailbox API response for the request - True if the mailing list was changed, error code otherwise.
         """
-        return self.api_request('mailinglist.set', {'mailinglist': mailinglist, 'account': account,
-                                                    'password': password, 'adminmail': adminmail})
+        raw_params = {
+            'mailinglist': mailinglist,
+            'account': account,
+            'password': password,
+            'adminmail': adminmail
+        }
+        # Filter out any keys whose values are None so they aren't serialized as `null`
+        params = {k: v for k, v in raw_params.items() if v is not None}
+        return self.api_request('mailinglist.set', params)
 
     def mailinglist_del(self, mailinglist: str, account: str) -> dict:
         """
@@ -1066,21 +1092,26 @@ class APIClient:
         :param spam_folder: name of the spam folder.
         :return: the response for the request - True if adding was successful, error code otherwise.
         """
-        return self.api_request('additionalmailaccount.add', {'new_account_mail': new_account_mail,
-                                                              'new_account_password': new_account_password,
-                                                              'parent_mail': parent_mail,
-                                                              'primary_address': primary_address,
-                                                              'mail_server': mail_server, 'mail_port': str(mail_port),
-                                                              'transport_server': transport_server,
-                                                              'transport_port': str(transport_port),
-                                                              'mail_secure': mail_secure,
-                                                              'mail_starttls': mail_starttls,
-                                                              'transport_secure': transport_secure,
-                                                              'transport_starttls': transport_starttls,
-                                                              'trash_folder': trash_folder,
-                                                              'sent_folder': sent_folder,
-                                                              'drafts_folder': drafts_folder,
-                                                              'spam_folder': spam_folder})
+        raw_params = {
+            'new_account_mail': new_account_mail,
+            'new_account_password': new_account_password,
+            'parent_mail': parent_mail,
+            'primary_address': primary_address,
+            'mail_server': mail_server, 'mail_port': str(mail_port),
+            'transport_server': transport_server,
+            'transport_port': str(transport_port),
+            'mail_secure': mail_secure,
+            'mail_starttls': mail_starttls,
+            'transport_secure': transport_secure,
+            'transport_starttls': transport_starttls,
+            'trash_folder': trash_folder,
+            'sent_folder': sent_folder,
+            'drafts_folder': drafts_folder,
+            'spam_folder': spam_folder
+        }
+        # Filter out any keys whose values are None so they aren't serialized as `null`
+        params = {k: v for k, v in raw_params.items() if v is not None}
+        return self.api_request('additionalmailaccount.add', params)
 
     def additionalmailaccount_delete(self, parent_mail: str, account_mail: str) -> dict:
         """
@@ -1111,16 +1142,13 @@ class APIClient:
                                 {'delete_mail_accounts_and_domains': delete_mail_accounts_and_domains})
 
 
-def validate_params(allowed: dict, actual: dict) -> bool | None:
+def validate_params(allowed: dict, actual: dict) -> bool:
     for arg in actual:
         if arg not in allowed:
             raise ValueError(f'Parameter {arg} not a valid parameter.')
-
         if not isinstance(actual[arg], allowed[arg]):
             raise TypeError(f'Attribute {arg} must be of type {str(allowed[arg])}. {str(type(actual[arg]))} given')
-        else:
-            return True
-    return None
+    return True
 
 
 def bool2str(state: bool) -> str:

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/mailbox_org_api.egg-info/PKG-INFO

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

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/pyproject.toml

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

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/setup.py

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

{mailbox_org_api-2.4 → mailbox_org_api-2.5.1}/tests/TestAPIClient.py

@@ -379,6 +379,9 @@ class TestAPIClient:
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
         mail = test_id + '@' + domain
+
+        # Ensure that the plan supports capabilities
+        api.mail_set_plan(mail, 'standard')
         for i in capabilities:
             api.mail_capabilities_set(mail, [i])
             # The API returns a list of capabilities
@@ -406,7 +409,7 @@ class TestAPIClient:
         api.auth(api_test_user, api_test_pass)
         mails = api.mail_list(domain)
         mail = mails[0]['mail']
-        plans = ['premium', 'light', 'standard']
+        plans = ['premium', 'standard']
         for plan in plans:
             api.mail_set_plan(mail, plan)
             assert str(api.mail_get(mail)['plan']).lower() == plan
@@ -468,16 +471,17 @@ class TestAPIClient:
         mail = test_id + '@' + domain
         additional_mail_quota = 23
         api.mail_set_additional_mail_quota(mail, additional_mail_quota)
-        assert additional_mail_quota == api.mail_get(mail)['additional_mail_quota']
+        assert int(api.mail_get(mail)['additional_mail_quota']) == additional_mail_quota
         api.deauth()
 
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_set_additional_cloud_quota(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
         mail = test_id + '@' + domain
         additional_cloud_quota = 42
         api.mail_set_additional_cloud_quota(mail, additional_cloud_quota)
-        assert additional_cloud_quota == api.mail_get(mail)['additional_cloud_quota']
+        assert int(api.mail_get(mail)['additional_cloud_quota']) == additional_cloud_quota
         api.deauth()
 
     @pytest.mark.depends(name="test_mail_add")