Merge pull request #362 from linode/proj/dc-get-well

Merge proj/dc-get-well into main

Author: yec-akamai

linode_api4/groups/account.py

@@ -4,6 +4,7 @@
 from linode_api4.groups import Group
 from linode_api4.objects import (
     Account,
+    AccountAvailability,
     AccountBetaProgram,
     AccountSettings,
     BetaProgram,
@@ -483,3 +484,15 @@ def join_beta_program(self, beta: Union[str, BetaProgram]):
         )
 
         return True
+
+    def availabilities(self, *filters):
+        """
+        Returns a list of all available regions and the resources which are NOT available
+        to the account.
+
+        API doc: TBD
+
+        :returns: a list of region availability information.
+        :rtype: PaginatedList of AccountAvailability
+        """
+        return self.client._get_and_filter(AccountAvailability, *filters)

linode_api4/objects/account.py

@@ -656,3 +656,19 @@ class AccountBetaProgram(Base):
         "ended": Property(is_datetime=True),
         "enrolled": Property(is_datetime=True),
     }
+
+
+class AccountAvailability(Base):
+    """
+    The resources information in a region which are NOT available to an account.
+
+    API doc: TBD
+    """
+
+    api_endpoint = "/account/availability/{region}"
+    id_attribute = "region"
+
+    properties = {
+        "region": Property(identifier=True),
+        "unavailable": Property(),
+    }

test/fixtures/account_availability.json

@@ -0,0 +1,51 @@
+{
+  "data": [
+    {
+      "region": "ap-west",
+      "unavailable": []
+    },
+    {
+      "region": "ca-central",
+      "unavailable": []
+    },
+    {
+      "region": "ap-southeast",
+      "unavailable": []
+    },
+    {
+      "region": "us-central",
+      "unavailable": []
+    },
+    {
+      "region": "us-west",
+      "unavailable": []
+    },
+    {
+      "region": "us-southeast",
+      "unavailable": []
+    },
+    {
+      "region": "us-east",
+      "unavailable": []
+    },
+    {
+      "region": "eu-west",
+      "unavailable": []
+    },
+    {
+      "region": "ap-south",
+      "unavailable": []
+    },
+    {
+      "region": "eu-central",
+      "unavailable": []
+    },
+    {
+      "region": "ap-northeast",
+      "unavailable": []
+    }
+  ],
+  "page": 1,
+  "pages": 1,
+  "results": 11
+}

test/fixtures/account_availability_us-east.json

@@ -0,0 +1,4 @@
+{
+  "region": "us-east",
+  "unavailable": []
+}

test/unit/linode_client_test.py

@@ -514,6 +514,18 @@ def test_account_transfer(self):
         self.assertEqual(transfer.region_transfers[0].quota, 5010)
         self.assertEqual(transfer.region_transfers[0].billable, 0)
 
+    def test_account_availabilities(self):
+        """
+        Tests that account availabilities can be retrieved
+        """
+        availabilities = self.client.account.availabilities()
+
+        self.assertEqual(len(availabilities), 11)
+        availability = availabilities[0]
+
+        self.assertEqual(availability.region, "ap-west")
+        self.assertEqual(availability.unavailable, [])
+
 
 class BetaProgramGroupTest(ClientBaseCase):
     """

test/unit/objects/account_test.py

@@ -3,6 +3,7 @@
 
 from linode_api4.objects import (
     Account,
+    AccountAvailability,
     AccountBetaProgram,
     AccountSettings,
     Database,
@@ -260,3 +261,20 @@ def test_account_beta_program_api_get(self):
             self.assertEqual(beta.ended, datetime(2018, 1, 2, 3, 4, 5))
 
             self.assertEqual(m.call_url, account_beta_url)
+
+
+class AccountAvailabilityTest(ClientBaseCase):
+    """
+    Test methods of the AccountAvailability
+    """
+
+    def test_account_availability_api_get(self):
+        region_id = "us-east"
+        account_availability_url = "/account/availability/{}".format(region_id)
+
+        with self.mock_get(account_availability_url) as m:
+            availability = AccountAvailability(self.client, region_id)
+            self.assertEqual(availability.region, region_id)
+            self.assertEqual(availability.unavailable, [])
+
+            self.assertEqual(m.call_url, account_availability_url)