Merge branch 'dev' into monitor-api

Author: pmajali

.github/workflows/e2e-test.yml

@@ -232,7 +232,7 @@ jobs:
     steps:
       - name: Notify Slack
         id: main_message
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -264,7 +264,7 @@ jobs:
 
       - name: Test summary thread
         if: success()
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}

.github/workflows/nightly-smoke-tests.yml

@@ -45,7 +45,7 @@ jobs:
 
       - name: Notify Slack
         if: always() && github.repository == 'linode/linode_api4-python'
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}

.github/workflows/publish-pypi.yaml

@@ -5,7 +5,11 @@ on:
     types: [ published ]
 jobs:
   pypi-release:
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     runs-on: ubuntu-latest
+    environment: pypi-release
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -25,5 +29,3 @@ jobs:
 
       - name: Publish the release artifacts to PyPI
         uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # pin@release/v1.12.4
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/release-notify-slack.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - name: Notify Slack - Main Message
         id: main_message
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}

linode_api4/groups/object_storage.py

@@ -21,6 +21,7 @@
     ObjectStorageCluster,
     ObjectStorageKeyPermission,
     ObjectStorageKeys,
+    ObjectStorageQuota,
 )
 from linode_api4.util import drop_null_keys
 
@@ -517,3 +518,18 @@ def object_url_create(
             )
 
         return MappedObject(**result)
+
+    def quotas(self, *filters):
+        """
+        Lists the active ObjectStorage-related quotas applied to your account.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quotas
+
+        :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 Object Storage Quotas that matched the query.
+        :rtype: PaginatedList of ObjectStorageQuota
+        """
+        return self.client._get_and_filter(ObjectStorageQuota, *filters)

linode_api4/objects/account.py

@@ -601,7 +601,7 @@ def entity(self):
             )
         return self.cls(self._client, self.id)
 
-    def _serialize(self):
+    def _serialize(self, *args, **kwargs):
         """
         Returns this grant in as JSON the api will accept.  This is only relevant
         in the context of UserGrants.save
@@ -668,7 +668,7 @@ def _grants_dict(self):
 
         return grants
 
-    def _serialize(self):
+    def _serialize(self, *args, **kwargs):
         """
         Returns the user grants in as JSON the api will accept.
         This is only relevant in the context of UserGrants.save

linode_api4/objects/base.py

@@ -114,6 +114,9 @@ def _flatten_base_subclass(obj: "Base") -> Optional[Dict[str, Any]]:
 
     @property
     def dict(self):
+        return self._serialize()
+
+    def _serialize(self, is_put: bool = False) -> Dict[str, Any]:
         result = vars(self).copy()
         cls = type(self)
 
@@ -123,7 +126,7 @@ def dict(self):
             elif isinstance(v, list):
                 result[k] = [
                     (
-                        item.dict
+                        item._serialize(is_put=is_put)
                         if isinstance(item, (cls, JSONObject))
                         else (
                             self._flatten_base_subclass(item)
@@ -136,7 +139,7 @@ def dict(self):
             elif isinstance(v, Base):
                 result[k] = self._flatten_base_subclass(v)
             elif isinstance(v, JSONObject):
-                result[k] = v.dict
+                result[k] = v._serialize(is_put=is_put)
 
         return result
 
@@ -278,9 +281,9 @@ def save(self, force=True) -> bool:
                     data[key] = None
 
             # Ensure we serialize any values that may not be already serialized
-            data = _flatten_request_body_recursive(data)
+            data = _flatten_request_body_recursive(data, is_put=True)
         else:
-            data = self._serialize()
+            data = self._serialize(is_put=True)
 
         resp = self._client.put(type(self).api_endpoint, model=self, data=data)
 
@@ -316,7 +319,7 @@ def invalidate(self):
 
         self._set("_populated", False)
 
-    def _serialize(self):
+    def _serialize(self, is_put: bool = False):
         """
         A helper method to build a dict of all mutable Properties of
         this object
@@ -345,7 +348,7 @@ def _serialize(self):
 
         # Resolve the underlying IDs of results
         for k, v in result.items():
-            result[k] = _flatten_request_body_recursive(v)
+            result[k] = _flatten_request_body_recursive(v, is_put=is_put)
 
         return result
 
@@ -503,7 +506,7 @@ def make_instance(cls, id, client, parent_id=None, json=None):
         return Base.make(id, client, cls, parent_id=parent_id, json=json)
 
 
-def _flatten_request_body_recursive(data: Any) -> Any:
+def _flatten_request_body_recursive(data: Any, is_put: bool = False) -> Any:
     """
     This is a helper recursively flatten the given data for use in an API request body.
 
@@ -515,15 +518,18 @@ def _flatten_request_body_recursive(data: Any) -> Any:
     """
 
     if isinstance(data, dict):
-        return {k: _flatten_request_body_recursive(v) for k, v in data.items()}
+        return {
+            k: _flatten_request_body_recursive(v, is_put=is_put)
+            for k, v in data.items()
+        }
 
     if isinstance(data, list):
-        return [_flatten_request_body_recursive(v) for v in data]
+        return [_flatten_request_body_recursive(v, is_put=is_put) for v in data]
 
     if isinstance(data, Base):
         return data.id
 
     if isinstance(data, MappedObject) or issubclass(type(data), JSONObject):
-        return data.dict
+        return data._serialize(is_put=is_put)
 
     return data

linode_api4/objects/linode.py

@@ -400,7 +400,7 @@ class ConfigInterface(JSONObject):
     def __repr__(self):
         return f"Interface: {self.purpose}"
 
-    def _serialize(self):
+    def _serialize(self, *args, **kwargs):
         purpose_formats = {
             "public": {"purpose": "public", "primary": self.primary},
             "vlan": {
@@ -510,16 +510,16 @@ def _populate(self, json):
 
         self._set("devices", MappedObject(**devices))
 
-    def _serialize(self):
+    def _serialize(self, is_put: bool = False):
         """
         Overrides _serialize to transform interfaces into json
         """
-        partial = DerivedBase._serialize(self)
+        partial = DerivedBase._serialize(self, is_put=is_put)
         interfaces = []
 
         for c in self.interfaces:
             if isinstance(c, ConfigInterface):
-                interfaces.append(c._serialize())
+                interfaces.append(c._serialize(is_put=is_put))
             else:
                 interfaces.append(c)
 
@@ -1927,8 +1927,8 @@ def _populate(self, json):
         ndist = [Image(self._client, d) for d in self.images]
         self._set("images", ndist)
 
-    def _serialize(self):
-        dct = Base._serialize(self)
+    def _serialize(self, is_put: bool = False):
+        dct = Base._serialize(self, is_put=is_put)
         dct["images"] = [d.id for d in self.images]
         return dct
 

linode_api4/objects/object_storage.py

@@ -51,6 +51,16 @@ class ObjectStorageEndpoint(JSONObject):
     s3_endpoint: Optional[str] = None
 
 
+@dataclass
+class ObjectStorageQuotaUsage(JSONObject):
+    """
+    ObjectStorageQuotaUsage contains the fields of an object storage quota usage information.
+    """
+
+    quota_limit: int = 0
+    usage: int = 0
+
+
 class ObjectStorageType(Base):
     """
     An ObjectStorageType represents the structure of a valid Object Storage type.
@@ -566,3 +576,42 @@ class ObjectStorageKeys(Base):
         "limited": Property(),
         "regions": Property(unordered=True),
     }
+
+
+class ObjectStorageQuota(Base):
+    """
+    An Object Storage related quota information on your account.
+    Object Storage Quota related features are under v4beta and may not currently be available to all users.
+
+    API documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota
+    """
+
+    api_endpoint = "/object-storage/quotas/{quota_id}"
+    id_attribute = "quota_id"
+
+    properties = {
+        "quota_id": Property(identifier=True),
+        "quota_name": Property(),
+        "endpoint_type": Property(),
+        "s3_endpoint": Property(),
+        "description": Property(),
+        "quota_limit": Property(),
+        "resource_metric": Property(),
+    }
+
+    def usage(self):
+        """
+        Gets usage data for a specific ObjectStorage Quota resource you can have on your account and the current usage for that resource.
+
+        API documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota-usage
+
+        :returns: The Object Storage Quota usage.
+        :rtype: ObjectStorageQuotaUsage
+        """
+
+        result = self._client.get(
+            f"{type(self).api_endpoint}/usage",
+            model=self,
+        )
+
+        return ObjectStorageQuotaUsage.from_json(result)

linode_api4/objects/serializable.py

@@ -1,5 +1,5 @@
 import inspect
-from dataclasses import dataclass
+from dataclasses import dataclass, fields
 from enum import Enum
 from types import SimpleNamespace
 from typing import (
@@ -9,6 +9,7 @@
     List,
     Optional,
     Set,
+    Type,
     Union,
     get_args,
     get_origin,
@@ -71,6 +72,13 @@ class JSONObject(metaclass=JSONFilterableMetaclass):
     are None.
     """
 
+    put_class: ClassVar[Optional[Type["JSONObject"]]] = None
+    """
+    An alternative JSONObject class to use as the schema for PUT requests.
+    This prevents read-only fields from being included in PUT request bodies,
+    which in theory will result in validation errors from the API.
+    """
+
     def __init__(self):
         raise NotImplementedError(
             "JSONObject is not intended to be constructed directly"
@@ -154,19 +162,25 @@ def from_json(cls, json: Dict[str, Any]) -> Optional["JSONObject"]:
 
         return obj
 
-    def _serialize(self) -> Dict[str, Any]:
+    def _serialize(self, is_put: bool = False) -> Dict[str, Any]:
         """
         Serializes this object into a JSON dict.
         """
         cls = type(self)
+
+        if is_put and cls.put_class is not None:
+            cls = cls.put_class
+
+        cls_field_keys = {field.name for field in fields(cls)}
+
         type_hints = get_type_hints(cls)
 
         def attempt_serialize(value: Any) -> Any:
             """
             Attempts to serialize the given value, else returns the value unchanged.
             """
             if issubclass(type(value), JSONObject):
-                return value._serialize()
+                return value._serialize(is_put=is_put)
 
             return value
 
@@ -175,6 +189,10 @@ def should_include(key: str, value: Any) -> bool:
             Returns whether the given key/value pair should be included in the resulting dict.
             """
 
+            # During PUT operations, keys not present in the put_class should be excluded
+            if key not in cls_field_keys:
+                return False
+
             if cls.include_none_values or key in cls.always_include:
                 return True
 

test/fixtures/object-storage_quotas.json

@@ -0,0 +1,25 @@
+{
+  "data": [
+    {
+      "quota_id": "obj-objects-us-ord-1",
+      "quota_name": "Object Storage Maximum Objects",
+      "description": "Maximum number of Objects this customer is allowed to have on this endpoint.",
+      "endpoint_type": "E1",
+      "s3_endpoint": "us-iad-1.linodeobjects.com",
+      "quota_limit": 50,
+      "resource_metric": "object"
+    },
+    {
+      "quota_id": "obj-bucket-us-ord-1",
+      "quota_name": "Object Storage Maximum Buckets",
+      "description": "Maximum number of buckets this customer is allowed to have on this endpoint.",
+      "endpoint_type": "E1",
+      "s3_endpoint": "us-iad-1.linodeobjects.com",
+      "quota_limit": 50,
+      "resource_metric": "bucket"
+    }
+  ],
+  "page": 1,
+  "pages": 1,
+  "results": 2
+}

test/fixtures/object-storage_quotas_obj-objects-us-ord-1.json

@@ -0,0 +1,9 @@
+{
+  "quota_id": "obj-objects-us-ord-1",
+  "quota_name": "Object Storage Maximum Objects",
+  "description": "Maximum number of Objects this customer is allowed to have on this endpoint.",
+  "endpoint_type": "E1",
+  "s3_endpoint": "us-iad-1.linodeobjects.com",
+  "quota_limit": 50,
+  "resource_metric": "object"
+}

test/fixtures/object-storage_quotas_obj-objects-us-ord-1_usage.json

@@ -0,0 +1,4 @@
+{
+  "quota_limit": 100,
+  "usage": 10
+}