server.to_dict and server.tag

Author: Elias Nygren

upcloud/cloud_manager/server_mixin.py

@@ -8,7 +8,7 @@
 standard_library.install_aliases()
 from builtins import object
 from ..ip_address import IP_address
-from ..storage import Storage 
+from ..storage import Storage
 
 from ..server import Server
 
@@ -22,15 +22,17 @@ class ServerManager(object):
 
 	def get_servers(self, populate=False):
 		"""
-		Returns a list of (populated or unpopulated) Server instances. 
+		Returns a list of (populated or unpopulated) Server instances.
 		Populate = False (default) => 1 API request, returns unpopulated Server instances.
 		Populate = True => Does 1 + n API requests (n = # of servers), returns populated Server instances.
 		"""
-		
-		servers = self.get_request("/server")["servers"]["server"]		
+
+		servers = self.get_request("/server")["servers"]["server"]
 
 		server_list = list()
 		for server in servers:
+			# remove the extra "tag" dict to simplify accessing tags
+			server['tags'] = server['tags']['tag']
 			server_list.append( Server(server, cloud_manager = self) )
 
 		if( populate ):
@@ -39,30 +41,30 @@ def get_servers(self, populate=False):
 
 		return server_list
 
-	
+
 	def get_server(self, UUID):
 		"""
 		Returns a (populated) Server instance.
 		"""
 		server, IP_addresses, storages = self.get_server_data(UUID)
-		
-		return Server(	server, 
-						ip_addresses = IP_addresses, 
-						storage_devices = storages, 
+
+		return Server(	server,
+						ip_addresses = IP_addresses,
+						storage_devices = storages,
 						populated = True,
 						cloud_manager = self )
 
 
 	def create_server(self, server):
 		"""
-		Creates a server and its storages based on a (locally created) Server object. 
+		Creates a server and its storages based on a (locally created) Server object.
 		Populates the given Server instance with the API response.
 
 		Example:
 		server1 = Server( core_number = 1,
-					memory_amount = 512, 
-					hostname = "my.example.1", 
-					zone = ZONE.London, 
+					memory_amount = 512,
+					hostname = "my.example.1",
+					zone = ZONE.London,
 					storage_devices = [
 						Storage(os = "Ubuntu 14.04", size=10, tier=maxiops, title='The OS drive'),
 						Storage(size=10),
@@ -75,7 +77,7 @@ def create_server(self, server):
 		- size defaults to 10,
 		- title defaults to hostname + " OS disk" and hostname + " storage disk id" (id is a running starting from 1)
 		- tier defaults to maxiops
-		- valid operating systems are: 
+		- valid operating systems are:
 			"CentOS 6.5", "CentOS 7.0"
 			"Debian 7.8"
 			"Ubuntu 12.04", "Ubuntu 14.04"
@@ -86,14 +88,14 @@ def create_server(self, server):
 		body = server.prepare_post_body()
 
 		res = self.post_request("/server", body)
-		
+
 		# Populate subobjects
 		IP_addresses = IP_address._create_ip_address_objs( res["server"].pop("ip_addresses"), cloud_manager = self )
 		storages = Storage._create_storage_objs( res["server"].pop("storage_devices"), cloud_manager = self )
 
-		server._reset( res["server"], 
-					ip_addresses = IP_addresses, 
-					storage_devices = storages, 
+		server._reset( res["server"],
+					ip_addresses = IP_addresses,
+					storage_devices = storages,
 					cloud_manager = self,
 					populated = True)
 		return server
@@ -113,36 +115,39 @@ def modify_server(self, UUID, **kwargs):
 
 		res = self.request("PUT", "/server/" + UUID, body)
 		server = res["server"]
-		
+
 		# Populate subobjects
 		IP_addresses = IP_address._create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
 		storages = Storage._create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
 
-		return Server(	server, 
-						ip_addresses = IP_addresses, 
-						storage_devices = storages, 
+		return Server(	server,
+						ip_addresses = IP_addresses,
+						storage_devices = storages,
 						populated = True,
 						cloud_manager = self )
 
 
 	def delete_server(self, UUID):
 		"""
-		DELETE '/server/UUID'. Permanently destroys the virtual machine. 
+		DELETE '/server/UUID'. Permanently destroys the virtual machine.
 		DOES NOT remove the storage disks.
 
 		Returns an empty object.
 		"""
 		return self.request("DELETE", "/server/" + UUID)
-	
-	
+
+
 	def get_server_data(self, UUID):
 		"""
-		Returns '/server/uuid' data in Python dict. 
+		Returns '/server/uuid' data in Python dict.
 		Creates object representations of any IP-address and Storage.
 		"""
-		data = self.get_request("/server/" + UUID)		
+		data = self.get_request("/server/" + UUID)
 		server = data["server"]
-		
+
+		# remove the extra "tag" dict to simplify accessing tags
+		server['tags'] = server['tags']['tag']
+
 		# Populate subobjects
 		IP_addresses = IP_address._create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
 		storages = Storage._create_storage_objs( server.pop("storage_devices"), cloud_manager = self )

upcloud/server.py

@@ -19,8 +19,6 @@ class Server(BaseAPI):
 	updateable_fields = [ 	"boot_order", "core_number", "firewall", "hostname", "memory_amount",
 							"nic_model", "title", "timezone", "video_model", "vnc", "vnc_password" ]
 
-	post_fields = []
-
 
 	def __init__(self, *initial_data, **kwargs):
 		object.__setattr__(self, "populated", False)
@@ -238,5 +236,33 @@ def prepare_post_body(self):
 		return body
 
 
+	def to_dict(self):
+		fields = dict(vars(self).items())
+
+		if self.populated:
+			fields['ip_addresses'] = []
+			fields['storage_devices'] = []
+
+			for ip in self.ip_addresses:
+				fields['ip_addresses'].append({
+					'address': ip.address,
+					'access': ip.access,
+					'family': ip.family
+				})
+
+			for storage in self.storage_devices:
+				fields['storage_devices'].append({
+					"address": storage.address,
+					"storage": storage.uuid,
+					"storage_size": storage.size,
+					"storage_title": storage.title,
+					"type": storage.type,
+				})
+
+		del fields['populated']
+		del fields['cloud_manager']
+		return fields
+
+
 	def __str__(self):
 		return "Server: " + self.hostname