update IP related code, add missing fields

Author: elnygren

test/conftest.py

@@ -24,17 +24,19 @@ def manager():
     return upcloud_api.CloudManager("testuser", "mock-api-password")
 
 
+def read_from_file(filename):
+    filename = filename.replace("/", "_")
+    cwd = os.path.dirname(__file__)
+    f = open(cwd + '/json_data/'+filename, 'r')
+    return f.read()
+
+
 class Mock(object):
     base_url = 'https://api.upcloud.com/1.2'
 
     @staticmethod
     def read_from_file(filename):
-
-        filename = filename.replace("/", "_")
-
-        cwd = os.path.dirname(__file__)
-        f = open(cwd + '/json_data/'+filename, 'r')
-        return f.read()
+        return read_from_file(filename)
 
     @staticmethod
     def mock_get(target, response_file=None):

test/json_data/ip_address.json

@@ -4,18 +4,21 @@
             {
                 "access": "private",
                 "address": "10.1.0.101",
+                "family": "IPv4",
                 "ptr_record": "",
                 "server": "008c365d-d307-4501-8efc-cd6d3bb0e494"
             },
             {
                 "access": "private",
                 "address": "10.1.0.115",
+                "family": "IPv4",
                 "ptr_record": "",
                 "server": "00887721-4fad-4e9c-b781-6f2265753f11"
             },
             {
                 "access": "private",
                 "address": "10.1.1.97",
+                "family": "IPv4",
                 "ptr_record": "",
                 "server": "00ee2cf4-91c9-4e7a-89b9-a8087e32896b"
             }

test/json_data/ip_address_10.1.0.101.json

@@ -2,6 +2,8 @@
     "ip_address": {
         "access": "private",
         "address": "10.1.0.101",
+        "family": "IPv4",
+        "part_of_plan": "yes",
         "ptr_record": "a.ptr.record",
         "server": "008c365d-d307-4501-8efc-cd6d3bb0e494"
     }

test/json_data/ip_address_post.json

@@ -2,6 +2,7 @@
     "ip_address": {
         "access": "private",
         "address": "10.1.0.101",
+        "family": "IPv4",
         "ptr_record": "a.ptr.record",
         "server": "00798b85-efdc-41ca-8021-f6ef457b8531"
     }

test/json_data/server_00798b85-efdc-41ca-8021-f6ef457b8531.json

@@ -8,11 +8,13 @@
 			"ip_address" : [
 				{
 					"access" : "private",
-					"address" : "10.0.0.0"
+					"address" : "10.0.0.0",
+					"family": "IPv4"
 				},
 				{
 					"access" : "public",
-					"address" : "0.0.0.0"
+					"address" : "0.0.0.0",
+					"family": "IPv4"
 				}
 			]
 		},

test/test_apidoc/README.md

@@ -0,0 +1,3 @@
+
+These tests cover cases from the UpCloud API Documentation.
+The client should follow the official doc as closely as possible.

test/test_apidoc/test_10_ip_addresses.py

@@ -0,0 +1,54 @@
+from __future__ import unicode_literals
+from __future__ import print_function
+from __future__ import division
+from __future__ import absolute_import
+
+
+from upcloud_api import IPAddress, Server
+from conftest import Mock, read_from_file
+import json
+import responses
+
+class TestIP(object):
+
+    def test_ip_in_server_creation(self):
+        """IPAddress in server creation.
+
+        https://www.upcloud.com/api/8-servers/#create-server
+        """
+        ip1 = IPAddress(family='IPv4', access='public')
+        ip2 = IPAddress(family='IPv6', access='private')
+        assert ip1.to_dict() == {'family': 'IPv4', 'access': 'public'}
+        assert ip2.to_dict() == {'family': 'IPv6', 'access': 'private'}
+
+    def test_ip_in_server_details(self):
+        """IPAddress in server details.
+
+        https://www.upcloud.com/api/8-servers/#get-server-details
+        """
+        ip = IPAddress(access='private', address='10.0.0.0', family='IPv4')
+        assert ip.to_dict() == {
+            'access': 'private',
+            'address': '10.0.0.0',
+            'family' : 'IPv4'
+        }
+
+        data = read_from_file('server_00798b85-efdc-41ca-8021-f6ef457b8531.json')
+        s = Server(**json.loads(data))
+        for ip in s.ip_addresses:
+            assert set(ip.to_dict().keys()) == set(['address', 'family', 'access'])
+
+    def test_ip_details(self):
+        """IPAdress LIST/GET.
+
+        https://www.upcloud.com/api/10-ip-addresses/#list-ip-addresses
+        """
+        ip = IPAddress(**json.loads(read_from_file('ip_address_10.1.0.101.json'))['ip_address'])
+        assert ip.to_dict() == {
+            'access': 'private',
+            'address': '10.1.0.101',
+            'family': 'IPv4',
+            'part_of_plan': 'yes',
+            'ptr_record': 'a.ptr.record',
+            'server': '008c365d-d307-4501-8efc-cd6d3bb0e494'
+        }

upcloud_api/ip_address.py

@@ -1,25 +1,32 @@
 from __future__ import unicode_literals
 from upcloud_api import UpCloudResource
 
+
 class IPAddress(UpCloudResource):
     """
     Class representation of the API's IP address. Extends UpCloudResource.
 
     Attributes:
     access -- "public" or "private"
     address -- the actual IPAddress (string)
+    family -- IPv4 or IPv6
+    part_of_plan -- yes/no string indicating whether this belongs to a preconfigured plan or not
     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.
-    ptr_record and server are present only if /server/uuid endpoint was used.
+
+    Note that all of the fields are not always available depending on the API call, 
+    consult the official API docs for details.
     """
 
     ATTRIBUTES = {
-        'family': 'IPv4',
         'access': None,
         'address': None,
-        'ptr_record': None
+        'family': 'IPv4',
+        'part_of_plan': None,
+        'ptr_record': None,
+        'server': None,
     }
 
     def save(self):