python3-core-api-client 0.1__tar.gz → 0.3__tar.gz

{python3_core_api_client-0.1 → python3_core_api_client-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-core-api-client
-Version: 0.1
+Version: 0.3
 Summary: Python client for Core API.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
@@ -52,7 +52,7 @@ Refer to the [API documentation](https://core-api.cyberfusion.io/) for informati
 
 Initialise the `CoreApiConnector` with your username and password **or** API key.
 
-The connector takes care of authentication, and offers several resources (such as `virtual_hosts`) and endpoints (i.e. `list_virtual_hosts`).
+The connector takes care of authentication, and offers several resources (e.g. `virtual_hosts`) and endpoints (e.g. `list_virtual_hosts`).
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -78,7 +78,7 @@ This client takes care of authentication.
 
 If authentication using username and password fails, `cyberfusion.CoreApiClient.exceptions.AuthenticationException` is thrown.
 
-If authentication using API key fails, the regular `CallException` exception fis raised.
+If authentication using API key fails, the regular `CallException` exception is raised.
 
 Don't have an API user? Contact Cyberfusion.
 
@@ -86,8 +86,6 @@ Don't have an API user? Contact Cyberfusion.
 
 The client uses a fluent interface to build requests.
 
-To view all possible requests:
-
 - Start with the connector
 - Go to the desired resource
 - Call the desired endpoint
@@ -115,7 +113,7 @@ connector.mail_domains.create_mail_domain(
 
 Models are validated before sending the request (using [Pydantic](https://docs.pydantic.dev/latest/)). If invalid data is provided, `pydantic.ValidationError` is thrown.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -135,15 +133,44 @@ connector.mail_aliases.create_mail_alias(
 # throw pydantic.ValidationError
 ```
 
-The exception will provide more details about the validation errors.
+The exception has an `errors()` method to get all validation errors.
+
+Code example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+import pydantic
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+try:
+    connector.mail_aliases.create_mail_alias(
+        MailAliasCreateRequest(
+            local_part='&^@$#^&@$#^&',
+            mail_domain_id=1,
+        )
+    )
+except pydantic.ValidationError as e:
+    errors = e.errors()
+
+for error in errors:
+    print(error['loc'])
+    print(error['msg'])
+    print(error['type'])
+```
 
 ## Responses
 
 ### Get model from response
 
-Calling a n endpoint returns the resource model.
+Calling an endpoint returns the resource model.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -169,6 +196,8 @@ mail_domain_resource = connector.mail_domains.create_mail_domain(
 
 If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
 
+The exception includes the response, and the HTTP status code.
+
 ## Enums
 
 Some properties only accept certain values (enums).
@@ -191,7 +220,7 @@ connector = CoreApiConnector(
 )
 ```
 
-Don't pass a custom session? A default one is created, including retries.
+Don't pass a custom session? A default one is created, with retries enabled.
 
 ### Manual requests
 
@@ -215,7 +244,7 @@ response.headers
 response.failed
 ```
 
-To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail`.
+To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail` instead of `send`. It takes the same parameters.
 
 ### Generating models
 

{python3_core_api_client-0.1 → python3_core_api_client-0.3}/README.md

@@ -41,7 +41,7 @@ Refer to the [API documentation](https://core-api.cyberfusion.io/) for informati
 
 Initialise the `CoreApiConnector` with your username and password **or** API key.
 
-The connector takes care of authentication, and offers several resources (such as `virtual_hosts`) and endpoints (i.e. `list_virtual_hosts`).
+The connector takes care of authentication, and offers several resources (e.g. `virtual_hosts`) and endpoints (e.g. `list_virtual_hosts`).
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -67,7 +67,7 @@ This client takes care of authentication.
 
 If authentication using username and password fails, `cyberfusion.CoreApiClient.exceptions.AuthenticationException` is thrown.
 
-If authentication using API key fails, the regular `CallException` exception fis raised.
+If authentication using API key fails, the regular `CallException` exception is raised.
 
 Don't have an API user? Contact Cyberfusion.
 
@@ -75,8 +75,6 @@ Don't have an API user? Contact Cyberfusion.
 
 The client uses a fluent interface to build requests.
 
-To view all possible requests:
-
 - Start with the connector
 - Go to the desired resource
 - Call the desired endpoint
@@ -104,7 +102,7 @@ connector.mail_domains.create_mail_domain(
 
 Models are validated before sending the request (using [Pydantic](https://docs.pydantic.dev/latest/)). If invalid data is provided, `pydantic.ValidationError` is thrown.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -124,15 +122,44 @@ connector.mail_aliases.create_mail_alias(
 # throw pydantic.ValidationError
 ```
 
-The exception will provide more details about the validation errors.
+The exception has an `errors()` method to get all validation errors.
+
+Code example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+import pydantic
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+try:
+    connector.mail_aliases.create_mail_alias(
+        MailAliasCreateRequest(
+            local_part='&^@$#^&@$#^&',
+            mail_domain_id=1,
+        )
+    )
+except pydantic.ValidationError as e:
+    errors = e.errors()
+
+for error in errors:
+    print(error['loc'])
+    print(error['msg'])
+    print(error['type'])
+```
 
 ## Responses
 
 ### Get model from response
 
-Calling a n endpoint returns the resource model.
+Calling an endpoint returns the resource model.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -158,6 +185,8 @@ mail_domain_resource = connector.mail_domains.create_mail_domain(
 
 If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
 
+The exception includes the response, and the HTTP status code.
+
 ## Enums
 
 Some properties only accept certain values (enums).
@@ -180,7 +209,7 @@ connector = CoreApiConnector(
 )
 ```
 
-Don't pass a custom session? A default one is created, including retries.
+Don't pass a custom session? A default one is created, with retries enabled.
 
 ### Manual requests
 
@@ -204,7 +233,7 @@ response.headers
 response.failed
 ```
 
-To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail`.
+To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail` instead of `send`. It takes the same parameters.
 
 ### Generating models
 

{python3_core_api_client-0.1 → python3_core_api_client-0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-core-api-client"
-version = "0.1"
+version = "0.3"
 description = "Python client for Core API."
 readme = "README.md"
 authors = [

python3_core_api_client-0.3/src/cyberfusion/CoreApiClient/_encoders.py

@@ -0,0 +1,14 @@
+import datetime
+from json import JSONEncoder
+from ipaddress import IPv4Address, IPv6Address
+from typing import Any
+
+
+class CustomEncoder(JSONEncoder):
+    def default(self, o: Any) -> str:
+        if isinstance(o, datetime.date):
+            return o.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+        elif isinstance(o, (IPv6Address, IPv4Address)):
+            return str(o)
+
+        return super().default(o)

{python3_core_api_client-0.1 → python3_core_api_client-0.3}/src/cyberfusion/CoreApiClient/connector.py

@@ -1,8 +1,7 @@
 import json
 from typing import Optional, Tuple
-from urllib.parse import urlparse
 
-from cyberfusion.CoreApiClient._encoders import DatetimeEncoder
+from cyberfusion.CoreApiClient._encoders import CustomEncoder
 from cyberfusion.CoreApiClient.exceptions import CallException, AuthenticationException
 
 from requests.sessions import Session
@@ -17,7 +16,7 @@ import importlib.metadata
 from cyberfusion.CoreApiClient.http import Response
 
 
-class CoreApiConnector:
+class CoreApiClient:
     def __init__(
         self,
         base_url: str = "https://core-api.cyberfusion.io",
@@ -50,10 +49,6 @@ class CoreApiConnector:
 
         self.requests_session = requests_session or self.get_default_requests_session()
 
-    @property
-    def root_url(self) -> str:
-        return urlparse(self.base_url)._replace(path="").geturl()
-
     @property
     def authentication_headers(self) -> Dict[str, str]:
         headers = {}
@@ -73,7 +68,7 @@ class CoreApiConnector:
 
             if login:
                 response = self.requests_session.post(
-                    "".join([self.root_url, "/api/v1/login/access-token"]),
+                    "".join([self.base_url, "/api/v1/login/access-token"]),
                     data={"username": self.username, "password": self.password},
                     verify=certifi.where(),
                     timeout=60,
@@ -113,13 +108,13 @@ class CoreApiConnector:
         url = "".join([self.base_url, path])
 
         if data and content_type == "application/json":
-            data = json.dumps(data, cls=DatetimeEncoder)
+            data = json.dumps(data, cls=CustomEncoder)
 
         if query_parameters:
             for key, value in query_parameters.items():
                 if isinstance(value, datetime.datetime):
                     query_parameters[key] = json.loads(
-                        json.dumps(value, cls=DatetimeEncoder)
+                        json.dumps(value, cls=CustomEncoder)
                     )
 
         requests_response = self.requests_session.request(
@@ -181,6 +176,8 @@ class CoreApiConnector:
 
         return session
 
+
+class CoreApiConnector(CoreApiClient):
     @cached_property
     def login(self) -> resources.login.Login:
         return resources.login.Login(self)

{python3_core_api_client-0.1 → python3_core_api_client-0.3}/src/python3_core_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-core-api-client
-Version: 0.1
+Version: 0.3
 Summary: Python client for Core API.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
@@ -52,7 +52,7 @@ Refer to the [API documentation](https://core-api.cyberfusion.io/) for informati
 
 Initialise the `CoreApiConnector` with your username and password **or** API key.
 
-The connector takes care of authentication, and offers several resources (such as `virtual_hosts`) and endpoints (i.e. `list_virtual_hosts`).
+The connector takes care of authentication, and offers several resources (e.g. `virtual_hosts`) and endpoints (e.g. `list_virtual_hosts`).
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -78,7 +78,7 @@ This client takes care of authentication.
 
 If authentication using username and password fails, `cyberfusion.CoreApiClient.exceptions.AuthenticationException` is thrown.
 
-If authentication using API key fails, the regular `CallException` exception fis raised.
+If authentication using API key fails, the regular `CallException` exception is raised.
 
 Don't have an API user? Contact Cyberfusion.
 
@@ -86,8 +86,6 @@ Don't have an API user? Contact Cyberfusion.
 
 The client uses a fluent interface to build requests.
 
-To view all possible requests:
-
 - Start with the connector
 - Go to the desired resource
 - Call the desired endpoint
@@ -115,7 +113,7 @@ connector.mail_domains.create_mail_domain(
 
 Models are validated before sending the request (using [Pydantic](https://docs.pydantic.dev/latest/)). If invalid data is provided, `pydantic.ValidationError` is thrown.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -135,15 +133,44 @@ connector.mail_aliases.create_mail_alias(
 # throw pydantic.ValidationError
 ```
 
-The exception will provide more details about the validation errors.
+The exception has an `errors()` method to get all validation errors.
+
+Code example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+import pydantic
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+try:
+    connector.mail_aliases.create_mail_alias(
+        MailAliasCreateRequest(
+            local_part='&^@$#^&@$#^&',
+            mail_domain_id=1,
+        )
+    )
+except pydantic.ValidationError as e:
+    errors = e.errors()
+
+for error in errors:
+    print(error['loc'])
+    print(error['msg'])
+    print(error['type'])
+```
 
 ## Responses
 
 ### Get model from response
 
-Calling a n endpoint returns the resource model.
+Calling an endpoint returns the resource model.
 
-For example:
+Code example:
 
 ```python
 from cyberfusion.CoreApiClient.connector import CoreApiConnector
@@ -169,6 +196,8 @@ mail_domain_resource = connector.mail_domains.create_mail_domain(
 
 If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
 
+The exception includes the response, and the HTTP status code.
+
 ## Enums
 
 Some properties only accept certain values (enums).
@@ -191,7 +220,7 @@ connector = CoreApiConnector(
 )
 ```
 
-Don't pass a custom session? A default one is created, including retries.
+Don't pass a custom session? A default one is created, with retries enabled.
 
 ### Manual requests
 
@@ -215,7 +244,7 @@ response.headers
 response.failed
 ```
 
-To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail`.
+To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail` instead of `send`. It takes the same parameters.
 
 ### Generating models
 

python3_core_api_client-0.1/src/cyberfusion/CoreApiClient/_encoders.py

@@ -1,7 +0,0 @@
-import datetime
-from json import JSONEncoder
-
-
-class DatetimeEncoder(JSONEncoder):
-    def default(self, o: datetime.datetime) -> str:
-        return o.strftime("%Y-%m-%dT%H:%M:%S.%fZ")