Add API test resource (#30)

Author: roaldnefs

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes in **python-transip** are documented below.
 
 ## [Unreleased]
 ### Added
-- This CHANGELOG file to be able to list all notable changes for each version of **python-transip**.
+- This `CHANGELOG.md` file to be able to list all notable changes for each version of **python-transip**.
+- The `transip.v6.objects.ApiTestService` service to allow calling the test resource to make sure everything is working.
 
 [Unreleased]: https://github.com/roaldnefs/python-transip/compare/v0.3.0...HEAD

tests/fixtures/general.json

@@ -1,4 +1,11 @@
 [
+    {
+        "method": "GET",
+        "url": "https://api.transip.nl/v6/api-test",
+        "json": {"ping": "pong"},
+        "status": 200,
+        "content_type": "application/json"
+    },
     {
         "method": "GET",
         "url": "https://api.transip.nl/v6/products",

tests/services/test_api_test.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 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/>.
+
+import responses  # type: ignore
+import unittest
+
+from transip import TransIP
+
+from tests.utils import load_responses_fixtures
+
+
+class ApiTestTest(unittest.TestCase):
+    """Test the ApiTestService."""
+
+    client: TransIP
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        """Set up a minimal TransIP client for using the API test services."""
+        cls.client = TransIP(access_token='ACCESS_TOKEN')
+
+    def setUp(self) -> None:
+        """Setup mocked responses for the '/api-test' endpoint."""
+        load_responses_fixtures("general.json")
+
+    @responses.activate
+    def test_test(self) -> None:
+        """Test if the API test returns True."""
+        self.assertTrue(self.client.api_test.test())  # type: ignore

tests/services/test_domains.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020, 2012 Roald Nefs <info@roaldnefs.com>
+# Copyright (C) 2020, 2021 Roald Nefs <info@roaldnefs.com>
 #
 # This file is part of python-transip.
 #
@@ -43,13 +43,13 @@ def setUp(self) -> None:
 
     @responses.activate
     def test_get(self) -> None:
-        domain: Domain = self.client.domains.get("example.com")
+        domain: Domain = self.client.domains.get("example.com")  # type: ignore
 
         assert domain.get_id() == "example.com"  # type: ignore
 
     @responses.activate
     def test_contacts_list(self) -> None:
-        domain: Domain = self.client.domains.get("example.com")
+        domain: Domain = self.client.domains.get("example.com")  # type: ignore
         contacts: List[Domain] = domain.contacts.list()  # type: ignore
         contact: Domain = contacts[0]
 
@@ -58,7 +58,7 @@ def test_contacts_list(self) -> None:
 
     @responses.activate
     def test_nameservers_list(self) -> None:
-        domain: Domain = self.client.domains.get("example.com")
+        domain: Domain = self.client.domains.get("example.com")  # type: ignore
         nameservers: List[Nameserver] = domain.nameservers.list()  # type: ignore
         nameserver: Nameserver = nameservers[0]
 
@@ -67,7 +67,7 @@ def test_nameservers_list(self) -> None:
 
     @responses.activate
     def test_dns_list(self) -> None:
-        domain: Domain = self.client.domains.get("example.com")
+        domain: Domain = self.client.domains.get("example.com")  # type: ignore
         entries: List[DnsEntry] = domain.dns.list()  # type: ignore
         entry: DnsEntry = entries[0]
 
@@ -82,7 +82,7 @@ def test_dns_create(self) -> None:
             "type": "A",
             "content": "127.0.0.1"
         }
-        domain: Domain = self.client.domains.get("example.com")
+        domain: Domain = self.client.domains.get("example.com")  # type: ignore
         domain.dns.create(dns_entry_data)  # type: ignore
 
         assert len(responses.calls) == 2

tests/services/test_invoices.py

@@ -41,7 +41,7 @@ def setUp(self) -> None:
 
     @responses.activate
     def test_list(self) -> None:
-        invoices: List[Invoice] = self.client.invoices.list()
+        invoices: List[Invoice] = self.client.invoices.list()  # type: ignore
         invoice: Invoice = invoices[0]
 
         assert len(invoices) == 1
@@ -50,6 +50,6 @@ def test_list(self) -> None:
     @responses.activate
     def test_get(self) -> None:
         invoice_id: str = "F0000.1911.0000.0004"
-        invoice: Invoice = self.client.invoices.get(invoice_id)
+        invoice: Invoice = self.client.invoices.get(invoice_id)  # type: ignore
 
         assert invoice.get_id() == "F0000.1911.0000.0004"  # type: ignore

tests/services/test_ssh_keys.py

@@ -42,7 +42,7 @@ def setUp(self) -> None:
 
     @responses.activate
     def test_list(self) -> None:
-        ssh_keys: List[SshKey] = self.client.ssh_keys.list()
+        ssh_keys: List[SshKey] = self.client.ssh_keys.list()  # type: ignore
         ssh_key: SshKey = ssh_keys[0]
 
         assert len(ssh_keys) == 1
@@ -51,22 +51,22 @@ def test_list(self) -> None:
     @responses.activate
     def test_get(self) -> None:
         ssh_key_id: int = 123
-        ssh_key: SshKey = self.client.ssh_keys.get(ssh_key_id)
+        ssh_key: SshKey = self.client.ssh_keys.get(ssh_key_id)  # type: ignore
 
         assert ssh_key.get_id() == 123  # type: ignore
 
     @responses.activate
     def test_delete(self) -> None:
         ssh_key_id: int = 123
         try:
-            self.client.ssh_keys.delete(ssh_key_id)
+            self.client.ssh_keys.delete(ssh_key_id)  # type: ignore
         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: SshKey = self.client.ssh_keys.get(ssh_key_id)
+        ssh_key: SshKey = self.client.ssh_keys.get(ssh_key_id)  # type: ignore
 
         try:
             ssh_key.delete()  # type: ignore
@@ -79,7 +79,7 @@ def test_create(self) -> None:
             "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDf2pxWX/yhUBDyk2LPhvRtI0LnVO8PyR5Zt6AHrnhtLGqK+8YG9EMlWbCCWrASR+Q1hFQG example",
             "description": "Jim key"
         }
-        self.client.ssh_keys.create(ssh_key_data)
+        self.client.ssh_keys.create(ssh_key_data)  # type: ignore
 
         assert len(responses.calls) == 1
 
@@ -91,6 +91,8 @@ def test_update(self) -> None:
         }
 
         try:
-            self.client.ssh_keys.update(ssh_key_id, ssh_key_data)
+            self.client.ssh_keys.update(  # type: ignore
+                ssh_key_id, ssh_key_data
+            )
         except Exception as exc:
             assert False, f"'transip.TransIP.ssh_keys.update' raised an exception {exc}"

transip/__init__.py

@@ -18,7 +18,8 @@
 # along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
 """Wrapper for the TransIP API."""
 
-from typing import Dict, Optional, Any, Type, Union
+from typing import Dict, Optional, Any, Type, Union, TYPE_CHECKING
+from types import ModuleType
 
 import importlib
 import requests
@@ -36,6 +37,12 @@
 __license__ = "LGPL3"
 
 
+if TYPE_CHECKING:
+    # Imports only needed for type checking. These will not be imported at
+    # runtime.
+    from transip.base import ApiService
+
+
 class TransIP:
     """Represents a TransIP server connection.
 
@@ -76,17 +83,28 @@ def __init__(
         self._set_auth_info()
 
         # Dynamically import the services for the specified API version
-        objects = importlib.import_module(f"transip.v{api_version}.objects")
+        objects: ModuleType = (
+            importlib.import_module(f"transip.v{api_version}.objects")
+        )
 
-        self.availability_zones: Type[Any] = (
+        self.api_test: Type['ApiService'] = (
+            objects.ApiTestService(self)  # type: ignore
+        )
+        self.availability_zones: Type['ApiService'] = (
             objects.AvailabilityZoneService(self)  # type: ignore
         )
-        self.domains: Type[Any] = objects.DomainService(self)  # type: ignore
-        self.invoices: Type[Any] = (
+        self.domains: Type['ApiService'] = (
+            objects.DomainService(self)  # type: ignore
+        )
+        self.invoices: Type['ApiService'] = (
             objects.InvoiceService(self)  # type: ignore
         )
-        self.ssh_keys: Type[Any] = objects.SshKeyService(self)  # type: ignore
-        self.vpss: Type[Any] = objects.VpsService(self)  # type: ignore
+        self.ssh_keys: Type['ApiService'] = (
+            objects.SshKeyService(self)  # type: ignore
+        )
+        self.vpss: Type['ApiService'] = (
+            objects.VpsService(self)  # type: ignore
+        )
 
     @property
     def url(self) -> str:

transip/v6/objects.py

@@ -27,6 +27,23 @@
 )
 
 
+class ApiTestService(ApiService):
+
+    _path: str = "/api-test"
+
+    def test(self):
+        """
+        A simple test to make sure everything is working.
+
+        Returns:
+            bool: True if everything is working, False otherwise.
+        """
+        response = self.client.get(f"{self.path}")
+        if response.get('ping') == 'pong':
+            return True
+        return False
+
+
 class AvailabilityZone(ApiObject):
 
     _id_attr: str = "name"