add support for Metros

Signed-off-by: Marques Johansson <mjohansson@equinix.com>

Author: displague

README.md

@@ -89,7 +89,7 @@ manager = packet.Manager(auth_token="yourapiauthtoken")
 
 device = manager.create_device(project_id='project-id',
                                hostname='node-name-of-your-choice',
-                               plan='baremetal_1', facility='ewr1',
+                               plan='baremetal_1', metro='sv',
                                operating_system='ubuntu_18_04')
 print(device)
 ```

packet/Device.py

@@ -28,6 +28,7 @@ def __init__(self, data, manager):
         self.customdata = data.get("customdata", None)
         self.operating_system = OperatingSystem(data["operating_system"])
         self.facility = data.get("facility")
+        self.metro = data.get("metro")
         self.project = data.get("project")
         self.ssh_keys = data.get("ssh_keys")
         self.project_lite = data.get("project_lite")

packet/DeviceBatch.py

@@ -8,6 +8,7 @@ def __init__(self, data):
         self.plan = data.get("plan")
         self.operating_system = data.get("operating_system")
         self.facility = data.get("facility")
+        self.metro = data.get("metro")
         self.quantity = data.get("quantity")
 
     def __str__(self):

packet/IPAddress.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: LGPL-3.0-only
 
 from .Facility import Facility
+from .Metro import Metro
 
 
 class IPAddress:
@@ -23,6 +24,7 @@ def __init__(self, data, manager):
         self.project = data.get("project")
         self.project_lite = data.get("project_lite")
         self.facility = Facility(data.get("facility"))
+        self.metro = Metro(data.get("metro"))
         self.details = data.get("details")
         self.assigned_to = data.get("assigned_to")
         self.interface = data.get("interface")

packet/Manager.py

@@ -10,6 +10,7 @@
 from .SSHKey import SSHKey
 from .Project import Project
 from .Facility import Facility
+from .Metro import Metro
 from .OperatingSystem import OperatingSystem
 from .Volume import Volume
 from .BGPConfig import BGPConfig
@@ -41,6 +42,14 @@ def list_facilities(self, params={}):
             facilities.append(facility)
         return facilities
 
+    def list_metros(self, params={}):
+        data = self.call_api("metros", params=params)
+        metros = list()
+        for jsoned in data["metros"]:
+            metro = Metro(jsoned)
+            metros.append(metro)
+        return metros
+
     def list_plans(self, params={}):
         data = self.call_api("plans", params=params)
         plans = list()
@@ -121,8 +130,8 @@ def create_device(
         project_id,
         hostname,
         plan,
-        facility,
-        operating_system,
+        facility="",
+        operating_system="",
         always_pxe=False,
         billing_cycle="hourly",
         features={},
@@ -139,11 +148,11 @@ def create_device(
         hardware_reservation_id="",
         storage={},
         customdata={},
+        metro="",
     ):
 
         params = {
             "billing_cycle": billing_cycle,
-            "facility": facility,
             "features": features,
             "hostname": hostname,
             "locked": locked,
@@ -157,6 +166,10 @@ def create_device(
             "userdata": userdata,
         }
 
+        if metro != "":
+            params["metro"] = metro
+        if facility != "":
+            params["facility"] = facility
         if hardware_reservation_id != "":
             params["hardware_reservation_id"] = hardware_reservation_id
         if storage:
@@ -319,6 +332,23 @@ def validate_capacity(self, servers):
             else:
                 raise e
 
+    # servers is a list of tuples of metro, plan, and quantity.
+    def validate_metro_capacity(self, servers):
+        params = {"servers": []}
+        for server in servers:
+            params["servers"].append(
+                {"facility": server[0], "plan": server[1], "quantity": server[2]}
+            )
+
+        try:
+            data = self.call_api("/capacity/metros", "POST", params)
+            return all(s["available"] for s in data["servers"])
+        except PacketError as e:  # pragma: no cover
+            if e.args[0] == "Error 503: Service Unavailable":
+                return False
+            else:
+                raise e
+
     def get_spot_market_prices(self, params={}):
         data = self.call_api("/market/spot/prices", params=params)
         return data["spot_market_prices"]
@@ -405,20 +435,24 @@ def reserve_ip_address(
         project_id,
         type,
         quantity,
-        facility,
+        facility="",
         details=None,
         comments=None,
         tags=list(),
+        metro="",
     ):
         request = {
             "type": type,
             "quantity": quantity,
-            "facility": facility,
             "details": details,
             "comments": comments,
             "tags": tags,
         }
 
+        if facility != "":
+            request["facility"] = facility
+        if metro != "":
+            request["metro"] = metro
         data = self.call_api(
             "/projects/%s/ips" % project_id, params=request, type="POST"
         )
@@ -575,15 +609,18 @@ def list_vlans(self, project_id, params=None):
         return vlans
 
     def create_vlan(
-        self, project_id, facility, vxlan=None, vlan=None, description=None
+        self, project_id, facility="", vxlan=None, vlan=None, description=None, metro=""
     ):
         params = {
             "project_id": project_id,
-            "facility": facility,
             "vxlan": vxlan,
             "vlan": vlan,
             "description": description,
         }
+        if facility != "":
+            params["facility"] = facility
+        if metro != "":
+            params["metro"] = metro
         data = self.call_api(
             "projects/%s/virtual-networks" % project_id, type="POST", params=params
         )
@@ -638,14 +675,12 @@ def create_packet_connections(self, params):
             "project_id": params["project_id"],
             "provider_id": params["provider_id"],
             "provider_payload": params["provider_payload"],
-            "facility": params["facility"],
             "port_speed": params["port_speed"],
             "vlan": params["vlan"],
         }
-        if "tags" in params:
-            body["tags"] = params["tags"]
-        if "description" in params:
-            body["description"] = params["description"]
+        for opt in ["tags", "description", "facility", "metro"]:
+            if opt in params:
+                body[opt] = params[opt]
 
         data = self.call_api("/packet-connect/connections", type="POST", params=body)
         return data

packet/Metro.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+# SPDX-License-Identifier: LGPL-3.0-only
+
+
+class Metro:
+    def __init__(self, data):
+        self.id = data.get("id")
+        self.code = data.get("code")
+        self.name = data.get("name")
+        self.country = data.get("country")
+
+    def __str__(self):
+        return "%s" % self.code
+
+    def __repr__(self):
+        return "{}: {}".format(self.__class__.__name__, self.id)

packet/Vlan.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: LGPL-3.0-only
 from packet import Project
 from .Facility import Facility
+from .Metro import Metro
 
 
 class Vlan:
@@ -15,9 +16,11 @@ def __init__(self, data, manager):
         self.vxlan = data.get("vxlan")
         self.internet_gateway = data.get("internet_gateway")
         self.facility_code = data.get("facility_code")
+        self.metro_code = data.get("metro_code")
         self.created_at = data.get("created_at")
 
         self.facility = Facility(data.get("facility"))
+        self.metro = Metro(data.get("metro"))
         try:
             project_data = self.manager.call_api(
                 data["assigned_to"]["href"], type="GET"

packet/__init__.py

@@ -13,6 +13,7 @@
 from .Email import Email  # noqa
 from .Event import Event  # noqa
 from .Facility import Facility  # noqa
+from .Metro import Metro  # noqa
 from .OperatingSystem import OperatingSystem  # noqa
 from .Plan import Plan  # noqa
 from .Project import Project  # noqa

test/test_packet.py

@@ -25,6 +25,13 @@ def test_list_facilities(self):
             repr(facility)
             self.assertIsInstance(facility, packet.Facility)
 
+    def test_list_metros(self):
+        metros = self.manager.list_metros()
+        for metro in metros:
+            str(metro)
+            repr(metro)
+            self.assertIsInstance(metro, packet.Metro)
+
     def test_list_plans(self):
         plans = self.manager.list_plans()
         for plan in plans: