Move HTTP API into separate class to lessen multi-inheritance

Author: akx

upcloud_api/__init__.py

@@ -10,7 +10,7 @@
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2015 UpCloud'
 
-from upcloud_api.cloud_manager.cloud_manager import CloudManager
+from upcloud_api.cloud_manager import CloudManager
 from upcloud_api.errors import UpCloudAPIError, UpCloudClientError
 from upcloud_api.firewall import FirewallRule
 from upcloud_api.host import Host

upcloud_api/cloud_manager/base.py upcloud_api/api.pyupcloud_api/cloud_manager/base.py renamed to upcloud_api/api.py

@@ -5,9 +5,9 @@
 from upcloud_api.errors import UpCloudAPIError
 
 
-class BaseAPI:
+class API:
     """
-    CloudManager base that handles basic HTTP communication with API.
+    Handles basic HTTP communication with API.
     """
 
     api = 'api.upcloud.com'

upcloud_api/cloud_manager/__init__.py

@@ -1,4 +1,6 @@
-from upcloud_api.cloud_manager.base import BaseAPI
+import base64
+
+from upcloud_api.api import API
 from upcloud_api.cloud_manager.firewall_mixin import FirewallManager
 from upcloud_api.cloud_manager.host_mixin import HostManager
 from upcloud_api.cloud_manager.ip_address_mixin import IPManager
@@ -7,3 +9,76 @@
 from upcloud_api.cloud_manager.server_mixin import ServerManager
 from upcloud_api.cloud_manager.storage_mixin import StorageManager
 from upcloud_api.cloud_manager.tag_mixin import TagManager
+
+
+class CloudManager(
+    ServerManager,
+    IPManager,
+    StorageManager,
+    FirewallManager,
+    TagManager,
+    NetworkManager,
+    HostManager,
+    ObjectStorageManager,
+):
+    """
+    CloudManager contains the core functionality of the upcloud API library.
+
+    All other managers are mixed in so code can be organized in corresponding sub-manager classes.
+    """
+
+    api: API
+
+    def __init__(self, username: str, password: str, timeout: int = 60) -> None:
+        """
+        Initiates CloudManager that handles all HTTP connections with UpCloud's API.
+
+        Optionally determine a timeout for API connections (in seconds). A timeout with the value
+        `None` means that there is no timeout.
+        """
+        if not username or not password:
+            raise Exception('Invalid credentials, please provide a username and password')
+
+        credentials = f'{username}:{password}'.encode()
+        encoded_credentials = base64.b64encode(credentials).decode()
+
+        self.api = API(
+            token=f'Basic {encoded_credentials}',
+            timeout=timeout,
+        )
+
+    def authenticate(self):
+        """
+        Authenticate.
+        """
+        return self.get_account()
+
+    def get_account(self):
+        """
+        Returns information on the user's account and resource limits.
+        """
+        return self.api.get_request('/account')
+
+    def get_zones(self):
+        """
+        Returns a list of available zones.
+        """
+        return self.api.get_request('/zone')
+
+    def get_timezones(self):
+        """
+        Returns a list of available timezones.
+        """
+        return self.api.get_request('/timezone')
+
+    def get_prices(self):
+        """
+        Returns a list of resource prices.
+        """
+        return self.api.get_request('/price')
+
+    def get_server_sizes(self):
+        """
+        Returns a list of available server configurations.
+        """
+        return self.api.get_request('/server_size')

upcloud_api/cloud_manager/cloud_manager.py

@@ -1,3 +1,4 @@
+from upcloud_api.api import API
 from upcloud_api.firewall import FirewallRule
 from upcloud_api.server import Server
 
@@ -17,13 +18,15 @@ class FirewallManager:
     directly.
     """
 
+    api: API
+
     # TODO: server_instance is unused?
     def get_firewall_rule(self, server_uuid, firewall_rule_position, server_instance=None):
         """
         Return a FirewallRule object based on server uuid and rule position.
         """
         url = f'/server/{server_uuid}/firewall_rule/{firewall_rule_position}'
-        res = self.get_request(url)
+        res = self.api.get_request(url)
         return FirewallRule(**res['firewall_rule'])
 
     def get_firewall_rules(self, server):
@@ -33,7 +36,7 @@ def get_firewall_rules(self, server):
         server_uuid, server_instance = uuid_and_instance(server)
 
         url = f'/server/{server_uuid}/firewall_rule'
-        res = self.get_request(url)
+        res = self.api.get_request(url)
 
         return [
             FirewallRule(server=server_instance, **firewall_rule)
@@ -51,7 +54,7 @@ def create_firewall_rule(self, server, firewall_rule_body):
 
         url = f'/server/{server_uuid}/firewall_rule'
         body = {'firewall_rule': firewall_rule_body}
-        res = self.post_request(url, body)
+        res = self.api.post_request(url, body)
 
         return FirewallRule(server=server_instance, **res['firewall_rule'])
 
@@ -60,7 +63,7 @@ def delete_firewall_rule(self, server_uuid, firewall_rule_position):
         Delete a firewall rule based on a server uuid and rule position.
         """
         url = f'/server/{server_uuid}/firewall_rule/{firewall_rule_position}'
-        return self.delete_request(url)
+        return self.api.delete_request(url)
 
     def configure_firewall(self, server, firewall_rule_bodies):
         """

upcloud_api/cloud_manager/firewall_mixin.py

@@ -1,3 +1,4 @@
+from upcloud_api.api import API
 from upcloud_api.host import Host
 
 
@@ -6,20 +7,22 @@ class HostManager:
     Functions for managing hosts. Intended to be used as a mixin for CloudManager.
     """
 
+    api: API
+
     def get_hosts(self):
         """
         Returns a list of available hosts, along with basic statistics of them when available.
         """
         url = '/host'
-        res = self.get_request(url)
+        res = self.api.get_request(url)
         return [Host(**host) for host in res['hosts']['host']]
 
     def get_host(self, id: str) -> Host:
         """
         Returns detailed information about a specific host.
         """
         url = f'/host/{id}'
-        res = self.get_request(url)
+        res = self.api.get_request(url)
         return Host(**res['host'])
 
     def modify_host(self, host: str, description: str) -> Host:
@@ -28,5 +31,5 @@ def modify_host(self, host: str, description: str) -> Host:
         """
         url = f'/host/{host}'
         body = {'host': {'description': description}}
-        res = self.patch_request(url, body)
+        res = self.api.patch_request(url, body)
         return Host(**res['host'])

upcloud_api/cloud_manager/host_mixin.py

@@ -1,3 +1,4 @@
+from upcloud_api.api import API
 from upcloud_api.ip_address import IPAddress
 
 
@@ -6,20 +7,22 @@ class IPManager:
     Functions for managing IP-addresses. Intended to be used as a mixin for CloudManager.
     """
 
+    api: API
+
     def get_ip(self, address: str) -> IPAddress:
         """
         Get an IPAddress object with the IP address (string) from the API.
 
         e.g manager.get_ip('80.69.175.210')
         """
-        res = self.get_request('/ip_address/' + address)
+        res = self.api.get_request('/ip_address/' + address)
         return IPAddress(cloud_manager=self, **res['ip_address'])
 
     def get_ips(self, ignore_ips_without_server=False):
         """
         Get all IPAddress objects from the API.
         """
-        res = self.get_request('/ip_address')
+        res = self.api.get_request('/ip_address')
         IPs = IPAddress._create_ip_address_objs(
             res['ip_addresses'], self, ignore_ips_without_server
         )
@@ -31,7 +34,7 @@ def attach_ip(self, server: str, family: str = 'IPv4') -> IPAddress:
         """
         body = {'ip_address': {'server': str(server), 'family': family}}
 
-        res = self.post_request('/ip_address', body)
+        res = self.api.post_request('/ip_address', body)
         return IPAddress(cloud_manager=self, **res['ip_address'])
 
     def modify_ip(self, ip_addr: str, ptr_record: str) -> IPAddress:
@@ -42,7 +45,7 @@ def modify_ip(self, ip_addr: str, ptr_record: str) -> IPAddress:
         """
         body = {'ip_address': {'ptr_record': ptr_record}}
 
-        res = self.put_request('/ip_address/' + str(ip_addr), body)
+        res = self.api.put_request('/ip_address/' + str(ip_addr), body)
         return IPAddress(cloud_manager=self, **res['ip_address'])
 
     def release_ip(self, ip_addr):
@@ -51,4 +54,4 @@ def release_ip(self, ip_addr):
 
         Accepts an IPAddress instance (object) or its address (string).
         """
-        return self.delete_request('/ip_address/' + str(ip_addr))
+        return self.api.delete_request('/ip_address/' + str(ip_addr))