Merge pull request #329 from linode/dev

Release v5.8.0

Author: lgarber-akamai

Makefile

@@ -62,6 +62,10 @@ lint: build
 testint:
 	python3 -m pytest test/integration/${INTEGRATION_TEST_PATH}${MODEL_COMMAND} ${TEST_CASE_COMMAND}
 
+@PHONEY: testunit
+testunit:
+	python3 -m python test/unit
+
 @PHONEY: smoketest
 smoketest:
 	pytest -m smoke test/integration --disable-warnings

linode_api4/groups/__init__.py

@@ -2,6 +2,7 @@
 from .group import *  # isort: skip
 
 from .account import *
+from .beta import *
 from .database import *
 from .domain import *
 from .image import *

linode_api4/groups/account.py

@@ -1,8 +1,12 @@
+from typing import Union
+
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
     Account,
+    AccountBetaProgram,
     AccountSettings,
+    BetaProgram,
     Event,
     Invoice,
     Login,
@@ -448,3 +452,34 @@ def user_create(self, email, username, restricted=True):
 
         u = User(self.client, result["username"], result)
         return u
+
+    def enrolled_betas(self, *filters):
+        """
+        Returns a list of all Beta Programs an account is enrolled in.
+
+        API doc: TBD
+
+        :returns: a list of Beta Programs.
+        :rtype: PaginatedList of AccountBetaProgram
+        """
+        return self.client._get_and_filter(AccountBetaProgram, *filters)
+
+    def join_beta_program(self, beta: Union[str, BetaProgram]):
+        """
+        Enrolls an account into a beta program.
+
+        API doc: TBD
+
+        :param beta: The object or id of a beta program to join.
+        :type beta: BetaProgram or str
+
+        :returns: A boolean indicating whether the account joined a beta program successfully.
+        :rtype: bool
+        """
+
+        self.client.post(
+            "/account/betas",
+            data={"id": beta.id if isinstance(beta, BetaProgram) else beta},
+        )
+
+        return True

linode_api4/groups/beta.py

@@ -0,0 +1,24 @@
+from linode_api4.groups import Group
+from linode_api4.objects import BetaProgram
+
+
+class BetaProgramGroup(Group):
+    """
+    This group encapsulates all endpoints under /betas, including viewing
+    available active beta programs.
+    """
+
+    def betas(self, *filters):
+        """
+        Returns a list of available active Beta Programs.
+
+        API Documentation: TBD
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Beta Programs that matched the query.
+        :rtype: PaginatedList of BetaProgram
+        """
+        return self.client._get_and_filter(BetaProgram, *filters)

linode_api4/linode_client.py

@@ -12,6 +12,7 @@
 from linode_api4.errors import ApiError, UnexpectedResponseError
 from linode_api4.groups import (
     AccountGroup,
+    BetaProgramGroup,
     DatabaseGroup,
     DomainGroup,
     ImageGroup,
@@ -61,6 +62,7 @@ def __init__(
         retry_rate_limit_interval=1.0,
         retry_max=5,
         retry_statuses=None,
+        ca_path=None,
     ):
         """
         The main interface to the Linode API.
@@ -95,11 +97,14 @@ def __init__(
         :param retry_statuses: Additional HTTP response statuses to retry on.
                                By default, the client will retry on 408, 429, and 502
                                responses.
+        :param ca_path: The path to a CA file to use for API requests in this client.
+        :type ca_path: str
         """
         self.base_url = base_url
         self._add_user_agent = user_agent
         self.token = token
         self.page_size = page_size
+        self.ca_path = ca_path
 
         retry_forcelist = [408, 429, 502]
 
@@ -188,6 +193,9 @@ def __init__(
         #: Access methods related to Event polling - See :any:`PollingGroup` for more information.
         self.polling = PollingGroup(self)
 
+        #: Access methods related to Beta Program - See :any:`BetaProgramGroup` for more information.
+        self.beta = BetaProgramGroup(self)
+
     @property
     def _user_agent(self):
         return "{}python-linode_api4/{} {}".format(
@@ -263,7 +271,9 @@ def _api_call(
         if data is not None:
             body = json.dumps(data)
 
-        response = method(url, headers=headers, data=body)
+        response = method(
+            url, headers=headers, data=body, verify=self.ca_path or True
+        )
 
         warning = response.headers.get("Warning", None)
         if warning:

linode_api4/login_client.py

@@ -324,7 +324,11 @@ def serialize(scopes):
 
 class LinodeLoginClient:
     def __init__(
-        self, client_id, client_secret, base_url="https://login.linode.com"
+        self,
+        client_id,
+        client_secret,
+        base_url="https://login.linode.com",
+        ca_path=None,
     ):
         """
         Create a new LinodeLoginClient.  These clients do not make any requests
@@ -339,10 +343,13 @@ def __init__(
         :param base_url: The URL for Linode's OAuth server.  This should not be
                          changed.
         :type base_url: str
+        :param ca_path: The path to the CA file to use for requests run by this client.
+        :type ca_path: str
         """
         self.base_url = base_url
         self.client_id = client_id
         self.client_secret = client_secret
+        self.ca_path = ca_path
 
     def _login_uri(self, path):
         return "{}{}".format(self.base_url, path)
@@ -423,6 +430,7 @@ def oauth_redirect():
                 "client_id": self.client_id,
                 "client_secret": self.client_secret,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:
@@ -467,6 +475,7 @@ def refresh_oauth_token(self, refresh_token):
                 "client_secret": self.client_secret,
                 "refresh_token": refresh_token,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:
@@ -501,6 +510,7 @@ def expire_token(self, token):
                 "client_secret": self.client_secret,
                 "token": token,
             },
+            verify=self.ca_path or True,
         )
 
         if r.status_code != 200:

linode_api4/objects/__init__.py

@@ -17,3 +17,4 @@
 from .object_storage import *
 from .lke import *
 from .database import *
+from .beta import *

linode_api4/objects/account.py

@@ -637,3 +637,20 @@ def save(self):
         self._populate(result)
 
         return True
+
+
+class AccountBetaProgram(Base):
+    """
+    The details and enrollment information of a Beta program that an account is enrolled in.
+    """
+
+    api_endpoint = "/account/betas/{id}"
+
+    properties = {
+        "id": Property(identifier=True),
+        "label": Property(),
+        "description": Property(),
+        "started": Property(is_datetime=True),
+        "ended": Property(is_datetime=True),
+        "enrolled": Property(is_datetime=True),
+    }

linode_api4/objects/beta.py

@@ -0,0 +1,22 @@
+from linode_api4.objects import Base, Property
+
+
+class BetaProgram(Base):
+    """
+    Beta program is a new product or service that's not generally available to all customers.
+    User with permissions can enroll into a beta program and access the functionalities.
+
+    API Documentation: TBD
+    """
+
+    api_endpoint = "/betas/{id}"
+
+    properties = {
+        "id": Property(identifier=True),
+        "label": Property(),
+        "description": Property(),
+        "started": Property(is_datetime=True),
+        "ended": Property(is_datetime=True),
+        "greenlight_only": Property(),
+        "more_info": Property(),
+    }

test/fixtures/account_betas.json

@@ -0,0 +1,15 @@
+{
+   "data": [
+        {
+            "id": "cool", 
+            "label": "\r\n\r\nRepellat consequatur sunt qui.", 
+            "enrolled": "2018-01-02T03:04:05",
+            "description": "Repellat consequatur sunt qui. Fugit eligendi ipsa et assumenda ea aspernatur esse. A itaque iste distinctio qui voluptas eum enim ipsa.", 
+            "started": "2018-01-02T03:04:05", 
+            "ended": "2018-01-02T03:04:05"
+        }
+   ],
+   "page": 1, 
+   "pages": 1, 
+   "results": 1
+}

test/fixtures/account_betas_cool.json

@@ -0,0 +1,8 @@
+{
+    "id": "cool", 
+    "label": "\r\n\r\nRepellat consequatur sunt qui.", 
+    "enrolled": "2018-01-02T03:04:05",
+    "description": "Repellat consequatur sunt qui. Fugit eligendi ipsa et assumenda ea aspernatur esse. A itaque iste distinctio qui voluptas eum enim ipsa.", 
+    "started": "2018-01-02T03:04:05", 
+    "ended": "2018-01-02T03:04:05"
+}

test/fixtures/betas.json

@@ -0,0 +1,24 @@
+{
+    "data": [
+        {
+            "id": "active_closed", 
+            "label": "active closed beta", 
+            "description": "An active closed beta", 
+            "started": "2023-07-19T15:23:43", 
+            "ended": null, 
+            "greenlight_only": true, 
+            "more_info": "a link with even more info"
+        }, 
+        {
+            "id": "limited",
+            "label": "limited beta", 
+            "description": "An active limited beta", 
+            "started": "2023-07-19T15:23:43", 
+            "ended": null, "greenlight_only": false, 
+            "more_info": "a link with even more info"
+        }
+    ], 
+    "page": 1, 
+    "pages": 1, 
+    "results": 2
+}

test/fixtures/betas_active.json

@@ -0,0 +1,9 @@
+{
+    "id": "active", 
+    "label": "active closed beta", 
+    "description": "An active closed beta", 
+    "started": "2018-01-02T03:04:05", 
+    "ended": null, 
+    "greenlight_only": true, 
+    "more_info": "a link with even more info"
+}

test/unit/base.py

@@ -36,7 +36,7 @@ def load_json(url):
     return FIXTURES.get_fixture(formatted_url)
 
 
-def mock_get(url, headers=None, data=None):
+def mock_get(url, headers=None, data=None, **kwargs):
     """
     Loads the response from a JSON file
     """