refactor IP, Firewall and Tags

Author: Elias Nygren

README.md

@@ -191,8 +191,8 @@ servers     = manager.get_servers()
 server1     = manager.get_server(UUID) # e.g servers[0].uuid
 storages    = manager.get_storages()
 storage1    = manager.get_storage(UUID) # e.g sever1.storage_devices[0].uuid
-ip_addrs    = manager.get_IPs()
-ip_addr     = manager.get_IP(address) # e.g server1.ip_addresses[0].address
+ip_addrs    = manager.get_ips()
+ip_addr     = manager.get_ip(address) # e.g server1.ip_addresses[0].address
 
 ```
 

docs/IP-address-mixin.md

@@ -19,38 +19,38 @@ manager.method()
 
 
 ```python
-def get_IP(self, address):
+def get_ip(self, address):
 	"""
-	Get an IP_address object with the IP address (string) from the API.
-	e.g manager.get_IP("80.69.175.210")
+	Get an IPAddress object with the IP address (string) from the API.
+	e.g manager.get_ip("80.69.175.210")
 	"""
 ```
 
 ```python
-def get_IPs(self):
+def get_ips(self):
 	"""
-	Get all IP_address objects from the API.
+	Get all IPAddress objects from the API.
 	"""
 ```
 
 ```python
-def attach_IP(self, server, family="IPv4"):
+def attach_ip(self, server, family="IPv4"):
 	"""
-	Attach a new (random) IP_address to the given server (object or UUID)
+	Attach a new (random) IPAddress to the given server (object or UUID)
 	"""
 ```
 ```python
-def modify_IP(self, IP_addr, ptr_record):
+def modify_ip(self, ip_addr, ptr_record):
 	"""
 	Modify an IP address' ptr-record (Reverse DNS).
-	Accepts an IP_address instance (object) or its address (string).
+	Accepts an IPAddress instance (object) or its address (string).
 	"""
 ```
 
 ```python
-def release_IP(self, IP_addr):
+def release_ip(self, ip_addr):
 	"""
-	Destroy an IP_address. Returns an empty object.
-	Accepts an IP_address instance (object) or its address (string).
+	Destroy an IPAddress. Returns an empty object.
+	Accepts an IPAddress instance (object) or its address (string).
 	"""
 ```

docs/IP-address.md

@@ -21,8 +21,8 @@ CloudManager returns IP-address objects.
 
 ```python
 
-manager.get_IPs()
-manager.get_IP("185.20.31.125")
+manager.get_ips()
+manager.get_ip("185.20.31.125")
 
 ```
 
@@ -33,19 +33,19 @@ The new IP-address must be attached to a server and has a random address.
 ```python
 
 # params: server uuid or a Server object and family, for which default is IPv4
-manager.attach_IP(server_uuid)
-manager.attach_IP(server_uuid, "IPv4")
-manager.attach_IP(server_uuid, "IPv6")
-manager.attach_IP(Server)
-manager.attach_IP(Server, "IPv4")
-manager.attach_IP(Server, "IPv6")
+manager.attach_ip(server_uuid)
+manager.attach_ip(server_uuid, "IPv4")
+manager.attach_ip(server_uuid, "IPv6")
+manager.attach_ip(Server)
+manager.attach_ip(Server, "IPv4")
+manager.attach_ip(Server, "IPv6")
 
 
 # or use Server instance
 server = manager.get_server(uuid)
-server.add_IP() # default is IPv4
-server.add_IP("IPv4")
-server.add_IP("IPv6")
+server.add_ip() # default is IPv4
+server.add_ip("IPv4")
+server.add_ip("IPv6")
 
 ```
 
@@ -55,7 +55,7 @@ At the moment only the ptr_record (reverse DNS) of an IP can be changed.
 
 ```python
 
-ip = manager.get_IP("185.20.31.125")
+ip = manager.get_ip("185.20.31.125")
 ip.ptr_record = "the.new.ptr.record"
 ip.save()
 
@@ -65,7 +65,7 @@ ip.save()
 
 ```python
 
-ip = manager.get_IP("185.20.31.125")
+ip = manager.get_ip("185.20.31.125")
 ip.destroy()
 
 ```

docs/Server.md

@@ -121,15 +121,15 @@ server.remove_storage(storage)
 
 ### IP-addresses
 
-A Server's Storages can be attached and detached with `.add_IP()` and `.remove_IP()`. Both requests issue an API request instantly. Note that the attached IP is allocated randomly as UpCloud's does not (yet) support floating IPs.
+A Server's Storages can be attached and detached with `.add_ip()` and `.remove_ip()`. Both requests issue an API request instantly. Note that the attached IP is allocated randomly as UpCloud's does not (yet) support floating IPs.
 
 ```python
 
 # attach
-IP = server.add_IP()
+IP = server.add_ip()
 
 # detach
-server.remove_IP(IP)
+server.remove_ip(IP)
 
 ```
 

test/helpers/infra_helpers.py

@@ -50,7 +50,7 @@ def server_test(manager, server):
     server.memory_amount = '1024'
     server.save()
 
-    server.add_IP()
+    server.add_ip()
 
     storage = manager.create_storage(size=10, tier='maxiops', zone=ZONE.London)
     server.add_storage(storage)

test/test_ip_manager.py

@@ -10,48 +10,48 @@ class TestIP(object):
     @responses.activate
     def test_get_ip(self, manager):
         data = Mock.mock_get('ip_address/10.1.0.101')
-        ip_addr = manager.get_IP('10.1.0.101')
+        ip_addr = manager.get_ip('10.1.0.101')
 
-        assert type(ip_addr).__name__ == 'IP_address'
+        assert type(ip_addr).__name__ == 'IPAddress'
         assert ip_addr.address == '10.1.0.101'
-        assert ip_addr.ptr == 'a.ptr.record'
+        assert ip_addr.ptr_record == 'a.ptr.record'
 
     @responses.activate
     def test_get_ips(self, manager):
         data = Mock.mock_get('ip_address')
-        ip_addrs = manager.get_IPs()
+        ip_addrs = manager.get_ips()
 
         for ip_addr in ip_addrs:
-            assert type(ip_addr).__name__ == 'IP_address'
+            assert type(ip_addr).__name__ == 'IPAddress'
 
     @responses.activate
     def test_modify_ip_oop(self, manager):
         # get ip
         data = Mock.mock_get('ip_address/10.1.0.101')
-        ip_addr = manager.get_IP('10.1.0.101')
+        ip_addr = manager.get_ip('10.1.0.101')
 
         # put ip
         data = Mock.mock_put('ip_address/10.1.0.101')
-        ip_addr.ptr = 'my.ptr.record'
+        ip_addr.ptr_record = 'my.ptr.record'
         ip_addr.save()
 
-        assert ip_addr.ptr == 'my.ptr.record'
+        assert ip_addr.ptr_record == 'my.ptr.record'
 
     @responses.activate
     def test_modify_ip(self, manager):
         data = Mock.mock_put('ip_address/10.1.0.101')
-        ip_addr = manager.modify_IP('10.1.0.101', ptr_record='my.ptr.record')
+        ip_addr = manager.modify_ip('10.1.0.101', ptr_record='my.ptr.record')
 
-        assert ip_addr.ptr == 'my.ptr.record'
+        assert ip_addr.ptr_record == 'my.ptr.record'
 
     @responses.activate
     def test_modify_ip(self, manager):
         data = Mock.mock_put('ip_address/10.1.0.101')
-        ip_addr = manager.modify_IP('10.1.0.101', ptr_record='my.ptr.record')
-        assert ip_addr.ptr == 'my.ptr.record'
+        ip_addr = manager.modify_ip('10.1.0.101', ptr_record='my.ptr.record')
+        assert ip_addr.ptr_record == 'my.ptr.record'
 
     @responses.activate
     def test_ip_delete(self, manager):
         Mock.mock_delete('ip_address/10.1.0.101')
-        res = manager.release_IP('10.1.0.101')
+        res = manager.release_ip('10.1.0.101')
         assert res == {}

test/test_server.py

@@ -71,17 +71,17 @@ def test_restart_server(self, manager):
     assert server.state == 'maintenance'
 
   @responses.activate
-  def test_attach_and_detach_IP(self, manager):
+  def test_attach_and_detach_ip(self, manager):
     data = Mock.mock_get('server/00798b85-efdc-41ca-8021-f6ef457b8531')
     server = manager.get_server('00798b85-efdc-41ca-8021-f6ef457b8531')
     assert len(server.ip_addresses) == 2
 
     data = Mock.mock_post('ip_address')
-    server.add_IP()
+    server.add_ip()
     assert len(server.ip_addresses) == 3
 
     Mock.mock_delete('ip_address/'+server.ip_addresses[2].address)
-    server.remove_IP(server.ip_addresses[2])
+    server.remove_ip(server.ip_addresses[2])
     assert len(server.ip_addresses) == 2
 
   @responses.activate

test/test_server_creation.py

@@ -159,7 +159,7 @@ def test_create_server(self, manager):
 
         # assert ips and storages have correct types
         assert type(server1.storage_devices[0]).__name__ == 'Storage'
-        assert type(server1.ip_addresses[0]).__name__ == 'IP_address'
+        assert type(server1.ip_addresses[0]).__name__ == 'IPAddress'
 
         # assert new data was populated
         assert server1.video_model == 'cirrus'
@@ -196,7 +196,7 @@ def test_create_server_with_dict(self, manager):
 
         # assert ips and storages have correct types
         assert type(server1.storage_devices[0]).__name__ == 'Storage'
-        assert type(server1.ip_addresses[0]).__name__ == 'IP_address'
+        assert type(server1.ip_addresses[0]).__name__ == 'IPAddress'
 
         # assert new data was populated
         assert server1.video_model == 'cirrus'

upcloud_api/__init__.py

@@ -13,9 +13,10 @@
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2015 Elias Nygren'
 
+from upcloud_api.upcloud_resource import UpCloudResource
 from upcloud_api.errors import UpCloudAPIError
 from upcloud_api.storage import Storage
-from upcloud_api.ip_address import IP_address
+from upcloud_api.ip_address import IPAddress
 from upcloud_api.server import Server, login_user_block
 from upcloud_api.firewall import FirewallRule
 from upcloud_api.tools import OperatingSystems, ZONE

upcloud_api/cloud_manager/firewall_mixin.py

@@ -1,8 +1,14 @@
 from __future__ import unicode_literals
 from __future__ import absolute_import
 
-from upcloud_api import FirewallRule
+from upcloud_api import FirewallRule, Server
 
+def uuid_and_instance(server):
+    """server => uuid, instance"""
+    if isinstance(server, Server):
+        return server.uuid, server
+    else:
+        return server, None
 
 class FirewallManager(object):
     """
@@ -12,40 +18,42 @@ class FirewallManager(object):
     directly.
     """
 
-    def get_firewall_rule(self, server_uuid, firewall_rule_position):
+    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 = '/server/{0}/firewall_rule/{1}'.format(server_uuid, firewall_rule_position)
         res = self.get_request(url)
         return FirewallRule(**res['firewall_rule'])
 
-    def get_firewall_rules(self, server_uuid):
+    def get_firewall_rules(self, server):
         """
-        Return all FirewallRule objects based on a server uuid.
+        Return all FirewallRule objects based on a server instance or uuid.
         """
-        url = '/server/{0}/firewall_rule'.format(server_uuid)
+        server_uuid, server_instance = uuid_and_instance(server)
 
+        url = '/server/{0}/firewall_rule'.format(server_uuid)
         res = self.get_request(url)
 
-        firewall_rules = []
-        for firewall_rule in res['firewall_rules']['firewall_rule']:
-            firewall_rules.append(FirewallRule(**firewall_rule))
+        return [
+            FirewallRule(server=server_instance, **firewall_rule)
+            for firewall_rule in res['firewall_rules']['firewall_rule']
+        ]
 
-        return firewall_rules
-
-    def create_firewall_rule(self, server_uuid, firewall_rule_body):
+    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().
         Returns a FirewallRule object.
         """
-        url = '/server/{0}/firewall_rule'.format(server_uuid)
+        server_uuid, server_instance = uuid_and_instance(server)
 
+        url = '/server/{0}/firewall_rule'.format(server_uuid)
         body = {'firewall_rule': firewall_rule_body}
         res = self.post_request(url, body)
-        return FirewallRule(**res['firewall_rule'])
+
+        return FirewallRule(server=server_instance, **res['firewall_rule'])
 
     def delete_firewall_rule(self, server_uuid, firewall_rule_position):
         """
@@ -54,13 +62,13 @@ def delete_firewall_rule(self, server_uuid, firewall_rule_position):
         url = '/server/{0}/firewall_rule/{1}'.format(server_uuid, firewall_rule_position)
         return self.request('DELETE', url)
 
-    def configure_firewall(self, UUID, firewall_rule_bodies):
+    def configure_firewall(self, server, firewall_rule_bodies):
         """
         Helper for calling create_firewall_rule in series for a list of firewall_rule_bodies.
         """
-        FirewallRules = []
-        for rule in firewall_rule_bodies:
-            FirewallRule = self.create_firewall_rule(UUID, rule)
-            FirewallRules.append(FirewallRule)
+        server_uuid, server_instance = uuid_and_instance(server)
 
-        return FirewallRules
+        return [
+            self.create_firewall_rule(server_uuid, rule)
+            for rule in firewall_rule_bodies
+        ]