Add ObjectDeleteMixin to delete ApiObjects

Add `transip.mixins.ObjectDeleteMixin` to allow
`transip.base.ApiObjects` instances to call `self.delete()`.

Signed-off-by: Roald Nefs <info@roaldnefs.com>

Author: roaldnefs

tests/services/test_ssh_keys.py

@@ -61,6 +61,16 @@ def test_delete(self) -> None:
         except Exception as exc:
             assert False, f"'transip.TransIP.ssh_keys.delete' raised an exception {exc}"
 
+    @responses.activate
+    def test_delete_object(self) -> None:
+        ssh_key_id: int = 123
+        ssh_key: Type[SshKey] = self.client.ssh_keys.get(ssh_key_id)
+
+        try:
+            ssh_key.delete()  # type: ignore
+        except Exception as exc:
+            assert False, f"'transip.v6.objects.SshKey.delete' raised an exception {exc}"
+
     @responses.activate
     def test_create(self) -> None:
         ssh_key_data: Dict[str, str] = {

transip/mixins.py

@@ -20,7 +20,7 @@
 from typing import Optional, List, Type, Dict, Any, Tuple, Union
 
 from transip import TransIP
-from transip.base import ApiObject
+from transip.base import ApiObject, ApiService
 
 
 # Typing alias for the _create_attrs attribute in the CreateMixin
@@ -66,6 +66,16 @@ def delete(self, id: str, **kwargs) -> None:
             self.client.delete(f"{self.path}/{id}")
 
 
+class ObjectDeleteMixin:
+    """Delete a single ApiObject."""
+
+    service: ApiService
+
+    def delete(self) -> None:
+        if self.get_id():  # type: ignore
+            self.service.delete(self.get_id())  # type: ignore
+
+
 class ListMixin:
     """Retrieve a list of ApiObjects.
 

transip/v6/objects.py

@@ -22,6 +22,7 @@
 from transip.base import ApiService, ApiObject
 from transip.mixins import (
     GetMixin, DeleteMixin, ListMixin, CreateMixin, UpdateMixin,
+    ObjectDeleteMixin,
     CreateAttrsTuple, UpdateAttrsTuple
 )
 
@@ -39,7 +40,7 @@ class AvailabilityZoneService(ListMixin, ApiService):
     _resp_list_attr: str = "availabilityZones"
 
 
-class SshKey(ApiObject):
+class SshKey(ObjectDeleteMixin, ApiObject):
 
     _id_attr: str = "id"