Merge pull request #5 from roaldnefs/add-delete-mixin

Add DeleteMixin to delete resources

Author: roaldnefs

docs/user/quickstart.rst

@@ -87,6 +87,11 @@ object by its name::
     >>> print(f"{domain.name} was registered on {domain.registrationDate}")
     transipdemonstratie.nl was registered on 2011-04-29
 
+We could also cancel a single :class:`Domain <transip.v6.objects.Domain>`
+object by its name::
+
+    >>> client.domains.delete('transipdemonstratie.nl')
+
 VPSs
 ----
 
@@ -112,6 +117,11 @@ object by its name::
     >>> print(f"{vps.name} runs {vps.operatingSystem} and has IP address: '{vps.ipAddress}'")
     transipdemo-vps runs FreeBSD 10.0-RELEASE and has IP address: '141.138.136.129'
 
+We could also cancel a single :class:`Vps <transip.v6.objects.Vps>`
+object by its name::
+
+    >>> client.vpss.delete('transipdemo-vps')
+
 Errors and Exceptions
 ---------------------
 

transip/mixins.py

@@ -49,6 +49,17 @@ def get(self, id: str, **kwargs) -> Optional[Type[ApiObject]]:
         return None
 
 
+class DeleteMixin:
+    """Delete a single ApiObject."""
+
+    client: TransIP
+    _path: str
+
+    def delete(self, id: str, **kwargs) -> None:
+        if self._path:
+            self.client.delete(f"{self._path}/{id}")
+
+
 class ListMixin:
     """Retrieve a list of ApiObjects.
 

transip/v6/services/domain.py

@@ -20,11 +20,11 @@
 from typing import Optional, Type
 
 from transip.base import ApiService, ApiObject
-from transip.mixins import GetMixin, ListMixin
+from transip.mixins import GetMixin, DeleteMixin, ListMixin
 from transip.v6.objects.domain import Domain
 
 
-class DomainService(GetMixin, ListMixin, ApiService):
+class DomainService(GetMixin, DeleteMixin, ListMixin, ApiService):
 
     _path: str = "/domains"
     _obj_cls: Optional[Type[ApiObject]] = Domain

transip/v6/services/vps.py

@@ -20,11 +20,11 @@
 from typing import Optional, Type
 
 from transip.base import ApiService, ApiObject
-from transip.mixins import GetMixin, ListMixin
+from transip.mixins import GetMixin, DeleteMixin, ListMixin
 from transip.v6.objects.vps import Vps
 
 
-class VpsService(GetMixin, ListMixin, ApiService):
+class VpsService(GetMixin, DeleteMixin, ListMixin, ApiService):
 
     _path: str = "/vps"
     _obj_cls: Optional[Type[ApiObject]] = Vps