Merge pull request #101 from akx/session-refactor

Session refactor (composition over multi-inheritance!)

Author: ajmyyra

test/test_storage.py

@@ -127,6 +127,7 @@ def test_create_storage_import(self, manager):
 
     @responses.activate
     def test_upload_file_for_storage_import(self, manager):
+        # TODO: this test probably doesn't correctly test for the actual format of the data being uploaded
         data = Mock.mock_post(
             "storage/01d4fcd4-e446-433b-8a9c-551a1284952e/import", ignore_data_field=True
         )

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,13 +5,12 @@
 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'
-    api_v = '1.3'
+    api_root = 'https://api.upcloud.com/1.3'
 
     def __init__(self, token, timeout=None):
         """
@@ -20,27 +19,21 @@ def __init__(self, token, timeout=None):
         self.token = token
         self.timeout = timeout
 
-    def request(self, method, endpoint, body=None, params=None, timeout=-1, request_to_api=True):
+    def api_request(self, method, endpoint, body=None, params=None, timeout=-1):
         """
-        Perform a request with a given body to a given endpoint in UpCloud's API or UpCloud's uploader session.
+        Perform a request with a given JSON body to a given endpoint in UpCloud's API.
 
         Handles errors with __error_middleware.
         """
         if method not in {'GET', 'POST', 'PUT', 'PATCH', 'DELETE'}:
             raise Exception('Invalid/Forbidden HTTP method')
 
-        # TODO: revise the semantics of `request_to_api` and where it is set to False
-        url = 'https://api.upcloud.com/' + self.api_v + endpoint if request_to_api else endpoint
+        url = f'{self.api_root}{endpoint}'
         headers = {'Authorization': self.token, 'User-Agent': self._get_user_agent()}
 
-        headers['Content-Type'] = (
-            'application/json' if request_to_api else 'application/octet-stream'
-        )
-
-        if body and request_to_api:
+        if body:
             data = json.dumps(body)
-        elif body and not request_to_api:
-            data = body
+            headers['Content-Type'] = 'application/json'
         else:
             data = None
 
@@ -61,33 +54,31 @@ def get_request(self, endpoint, params=None, timeout=-1):
         """
         Perform a GET request to a given endpoint in UpCloud's API.
         """
-        return self.request('GET', endpoint, params=params, timeout=timeout)
+        return self.api_request('GET', endpoint, params=params, timeout=timeout)
 
     def post_request(self, endpoint, body=None, timeout=-1):
         """
         Perform a POST request to a given endpoint in UpCloud's API.
         """
-        return self.request('POST', endpoint, body=body, timeout=timeout)
+        return self.api_request('POST', endpoint, body=body, timeout=timeout)
 
-    def put_request(self, endpoint, body=None, timeout=-1, request_to_api=True):
+    def put_request(self, endpoint, body=None, timeout=-1):
         """
-        Perform a PUT request to a given endpoint in UpCloud's API or UpCloud's uploader session.
+        Perform a PUT request to a given endpoint in UpCloud's API.
         """
-        return self.request(
-            'PUT', endpoint, body=body, timeout=timeout, request_to_api=request_to_api
-        )
+        return self.api_request('PUT', endpoint, body=body, timeout=timeout)
 
     def patch_request(self, endpoint, body=None, timeout=-1):
         """
         Perform a PATCH request to a given endpoint in UpCloud's API.
         """
-        return self.request('PATCH', endpoint, body=body, timeout=timeout)
+        return self.api_request('PATCH', endpoint, body=body, timeout=timeout)
 
     def delete_request(self, endpoint, timeout=-1):
         """
         Perform a DELETE request to a given endpoint in UpCloud's API.
         """
-        return self.request('DELETE', endpoint, timeout=timeout)
+        return self.api_request('DELETE', endpoint, timeout=timeout)
 
     def __error_middleware(self, res, res_json):
         """

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'])