Merge pull request #7 from roaldnefs/add-ssh-keys-service

Add SshKeyService to list, retrieve and delete SSH-keys

Author: roaldnefs

requirements/tests.txt

@@ -1,3 +1,4 @@
 mypy
 pytest
-flake8
+flake8
+responses

tests/services/__init__.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 Roald Nefs <info@roaldnefs.com>
+#
+# This file is part of python-transip.
+
+# python-transip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# python-transip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public License
+# along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
+
+from typing import Type, List
+import responses  # type: ignore
+
+from transip import TransIP
+from transip.v6.objects import SshKey
+
+
+@responses.activate
+def test_ssh_keys_list(transip_minimal_client: Type[TransIP]) -> None:
+    responses.add(
+        responses.GET,
+        "https://api.transip.nl/v6/ssh-keys",
+        json={
+            "sshKeys": [{
+                "id": 123,
+                "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDf2pxWX/yhUBDyk2LPhvRtI0LnVO8PyR5Zt6AHrnhtLGqK+8YG9EMlWbCCWrASR+Q1hFQG example",
+                "description": "Jim key",
+                "creationDate": "2020-12-01 15:25:01",
+                "fingerprint": "bb:22:43:69:2b:0d:3e:16:58:91:27:8a:62:29:97:d1"
+            }]
+        },
+        status=200,
+    )
+    
+    ssh_keys: List[Type[SshKey]] = transip_minimal_client.ssh_keys.list()
+    ssh_key: Type[SshKey] = ssh_keys[0] 
+    assert len(ssh_keys) == 1
+    assert ssh_key.get_id() == 123  # type: ignore
+
+
+@responses.activate
+def test_ssh_keys_get(transip_minimal_client: Type[TransIP]) -> None:
+    responses.add(
+        responses.GET,
+        "https://api.transip.nl/v6/ssh-keys/123",
+        json={
+            "sshKey": {
+                "id": 123,
+                "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDf2pxWX/yhUBDyk2LPhvRtI0LnVO8PyR5Zt6AHrnhtLGqK+8YG9EMlWbCCWrASR+Q1hFQG example",
+                "description": "Jim key",
+                "creationDate": "2020-12-01 15:25:01",
+                "fingerprint": "bb:22:43:69:2b:0d:3e:16:58:91:27:8a:62:29:97:d1"
+            }
+        },
+        status=200,
+    )
+    
+    ssh_key_id: int = 123
+    ssh_key: Type[SshKey] = transip_minimal_client.ssh_keys.get(ssh_key_id)
+    assert ssh_key.get_id() == 123  # type: ignore
+
+
+@responses.activate
+def test_ssh_keys_delete(transip_minimal_client: Type[TransIP]) -> None:
+    responses.add(
+        responses.DELETE,
+        "https://api.transip.nl/v6/ssh-keys/123",
+        status=204,
+    )
+    
+    ssh_key_id: int = 123
+    try:
+        transip_minimal_client.ssh_keys.delete(ssh_key_id)
+    except Exception as exc:
+        assert False, f"'transip.TransIP.ssh_keys.delete' raised an exception {exc}"

tests/services/test_ssh_keys.py

@@ -68,6 +68,7 @@ def __init__(
             services.AvailabilityZoneService(self)  # type: ignore
         )
         self.domains: Type[Any] = services.DomainService(self)  # type: ignore
+        self.ssh_keys: Type[Any] = services.SshKeyService(self)  # type: ignore
         self.vpss: Type[Any] = services.VpsService(self)  # type: ignore
 
     @property
@@ -171,12 +172,14 @@ def request(
             method, path, data=data, json=json, params=params
         )
 
-        try:
-            return response.json()
-        except Exception:
-            raise TransIPParsingError(
-                message="Failed to parse the API response as JSON"
-            )
+        if response.text:
+            try:
+                return response.json()
+            except Exception:
+                raise TransIPParsingError(
+                    message="Failed to parse the API response as JSON"
+                )
+        return None
 
     def get(
         self,
@@ -292,5 +295,5 @@ def delete(
             TransIPHTTPError: When the return code of the request is not 2xx
         """
         return self.request(
-            "GET", path, params=params
+            "DELETE", path, params=params
         )

transip/__init__.py

@@ -19,4 +19,5 @@
 
 from transip.v6.objects.availability_zone import AvailabilityZone  # noqa: 401
 from transip.v6.objects.domain import Domain  # noqa: 401
+from transip.v6.objects.ssh_key import SshKey  # noqa: 401
 from transip.v6.objects.vps import Vps  # noqa: 401

transip/v6/objects/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 Roald Nefs <info@roaldnefs.com>
+#
+# This file is part of python-transip.
+
+# python-transip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# python-transip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public License
+# along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
+
+from transip.base import ApiObject
+
+
+class SshKey(ApiObject):
+
+    _id_attr: str = "id"

transip/v6/objects/ssh_key.py

@@ -19,4 +19,5 @@
 
 from transip.v6.services.availability_zone import AvailabilityZoneService  # noqa: 401
 from transip.v6.services.domain import DomainService  # noqa: 401
+from transip.v6.services.ssh_key import SshKeyService  # noqa: 401
 from transip.v6.services.vps import VpsService  # noqa: 401

transip/v6/services/__init__.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 Roald Nefs <info@roaldnefs.com>
+#
+# This file is part of python-transip.
+
+# python-transip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# python-transip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public License
+# along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
+
+from typing import Optional, Type
+
+from transip.base import ApiService, ApiObject
+from transip.mixins import GetMixin, DeleteMixin, ListMixin
+from transip.v6.objects.ssh_key import SshKey
+
+
+class SshKeyService(GetMixin, DeleteMixin, ListMixin, ApiService):
+
+    _path: str = "/ssh-keys"
+    _obj_cls: Optional[Type[ApiObject]] = SshKey
+
+    _resp_list_attr: str = "sshKeys"
+    _resp_get_attr: str = "sshKey"