Merge pull request #97 from akx/misc-fixes

A handful of miscellaneous fixes + TODOs

Author: ajmyyra

upcloud_api/cloud_manager/base.py

@@ -29,6 +29,7 @@ def request(self, method, endpoint, body=None, params=None, timeout=-1, request_
         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
         headers = {'Authorization': self.token, 'User-Agent': self._get_user_agent()}
 
@@ -45,8 +46,9 @@ def request(self, method, endpoint, body=None, params=None, timeout=-1, request_
 
         call_timeout = timeout if timeout != -1 else self.timeout
 
-        APIcall = getattr(requests, method.lower())
-        res = APIcall(url, data=data, params=params, headers=headers, timeout=call_timeout)
+        res = requests.request(
+            method=method, url=url, data=data, params=params, headers=headers, timeout=call_timeout
+        )
 
         if res.text:
             res_json = res.json()

upcloud_api/cloud_manager/cloud_manager.py

@@ -27,12 +27,12 @@ class CloudManager(
     """
     CloudManager contains the core functionality of the upcloud API library.
 
-    All other managers are mixed in so code can be organized in corresponding submanager classes.
+    All other managers are mixed in so code can be organized in corresponding sub-manager classes.
     """
 
     def __init__(self, username: str, password: str, timeout: int = 60) -> None:
         """
-        Initiates CloudManager that handles all HTTP conections with UpCloud's API.
+        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.
@@ -43,8 +43,10 @@ def __init__(self, username: str, password: str, timeout: int = 60) -> None:
         credentials = f'{username}:{password}'.encode()
         encoded_credentials = base64.b64encode(credentials).decode()
 
-        self.token = f'Basic {encoded_credentials}'
-        self.timeout = timeout
+        super().__init__(
+            token=f'Basic {encoded_credentials}',
+            timeout=timeout,
+        )
 
     def authenticate(self):
         """

upcloud_api/cloud_manager/firewall_mixin.py

@@ -17,6 +17,7 @@ class FirewallManager:
     directly.
     """
 
+    # 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.
@@ -43,7 +44,7 @@ def create_firewall_rule(self, server, firewall_rule_body):
         """
         Create a new firewall rule for a given server uuid.
 
-        The rule can begiven as a dict or with FirewallRule.prepare_post_body().
+        The rule can be given as a dict or with FirewallRule.prepare_post_body().
         Returns a FirewallRule object.
         """
         server_uuid, server_instance = uuid_and_instance(server)

upcloud_api/cloud_manager/network_mixin.py

@@ -57,7 +57,7 @@ def create_network(
                 },
             }
         }
-
+        # TODO: fix duplication c.f. modify_network
         if router:
             body['network']['router'] = router
         if dhcp_default_route:

upcloud_api/cloud_manager/object_storage_mixin.py

@@ -11,7 +11,7 @@ class ObjectStorageManager:
 
     def get_object_storages(self):
         """
-        List all Object Storage devices on the account or those which the subaccount has permissions.
+        List all Object Storage devices on the account or those which the sub-account has permissions.
         """
         url = '/object-storage'
         res = self.get_request(url)

upcloud_api/ip_address.py

@@ -13,7 +13,7 @@ class IPAddress(UpCloudResource):
     ptr_record -- the reverse DNS name (string)
     server -- the UUID of the server this IP is attached to (string)
 
-    The only updateable field is the ptr_record.
+    The only updatable field is the ptr_record.
 
     Note that all of the fields are not always available depending on the API call,
     consult the official API docs for details.

upcloud_api/server.py

@@ -211,12 +211,12 @@ def add_ip(self, family: str = 'IPv4') -> IPAddress:
         self.ip_addresses.append(IP)
         return IP
 
-    def remove_ip(self, IPAddress: IPAddress) -> None:
+    def remove_ip(self, ip_address: IPAddress) -> None:
         """
         Release the specified IP-address from the server.
         """
-        self.cloud_manager.release_ip(IPAddress.address)
-        self.ip_addresses.remove(IPAddress)
+        self.cloud_manager.release_ip(ip_address.address)
+        self.ip_addresses.remove(ip_address)
 
     def add_storage(
         self,
@@ -410,6 +410,7 @@ def to_dict(self):
         del fields['cloud_manager']
         return fields
 
+    # TODO: strict is unused?
     def get_ip(self, access='public', addr_family=None, strict=None):
         """
         Return the server's IP address.

upcloud_api/storage.py

@@ -24,7 +24,7 @@ def _reset(self, **kwargs) -> None:
         Reset after repopulating from API.
         """
 
-        # there are some inconsistenciens in the API regarding these
+        # there are some inconsistencies in the API regarding these
         # note: this could be written in fancier ways, but this way is simpler
 
         if 'uuid' in kwargs:

upcloud_api/tag.py

@@ -25,7 +25,7 @@ def _reset(self, **kwargs) -> None:
         """
         Reset the objects attributes.
 
-        Accepts servers as either unflattened or flattened UUID strings or Server objects.
+        Accepts servers as either un-flattened or flattened UUID strings or Server objects.
         """
         super()._reset(**kwargs)
 

upcloud_api/utils.py

@@ -10,7 +10,7 @@ def try_it_n_times(operation, expected_error_codes, custom_error='operation fail
 
     Raises if the API call fails with an error_code that is not expected.
     Raises if the API call has not succeeded within n attempts.
-    Waits 3 seconds betwee each attempt.
+    Waits 3 seconds between each attempt.
     """
     for i in itertools.count():
         try: