feat: add support for 'Blob.custom_time' and lifecycle rules

google/cloud/storage/blob.py

@@ -50,6 +50,7 @@
 from google.resumable_media.requests import ResumableUpload
 
 from google.api_core.iam import Policy
+from google.api_core import datetime_helpers
 from google.cloud import exceptions
 from google.cloud._helpers import _bytes_to_unicode
 from google.cloud._helpers import _rfc3339_to_datetime
@@ -3174,6 +3175,35 @@ def updated(self):
         if value is not None:
             return _rfc3339_to_datetime(value)
 
+    @property
+    def custom_time(self):
+        """Retrieve the custom time for the object.
+
+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: :class:`datetime.date` or ``NoneType``
+        :returns: Date object parsed from iso8601 valid date, or
+                  ``None`` if the blob's resource has not been loaded from
+                  the server (see :meth:`reload`).
+        """
+        value = self._properties.get("customTime")
+        if value is not None:
+            return datetime_helpers.from_iso8601_date(value)
+
+    @custom_time.setter
+    def custom_time(self, value):
+        """Set the custom time for the object.
+
+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :type value: :class:`datetime.date` or ``NoneType``
+        :param value: (Optional) Set the custom time of blob.
+        """
+        if value is not None:
+            value = value.isoformat()
+
+        self._properties["customTime"] = value
+
 
 def _get_encryption_headers(key, source=False):
     """Builds customer encryption key headers

google/cloud/storage/bucket.py

@@ -170,6 +170,17 @@ class LifecycleRuleConditions(dict):
     :param number_of_newer_versions: (Optional) Apply rule action to versioned
                                      items having N newer versions.
 
+    :type days_since_custom_time: int
+    :param days_since_custom_time: (Optional) Apply rule action to items whose number of days
+                                   elapsed since the custom timestamp. This condition is relevant
+                                   only for versioned objects. The value of the field must be a non
+                                   negative integer. If it's zero, the object version will become
+                                   eligible for lifecycle action as soon as it becomes custom.
+
+    :type custom_time_before: :class:`datetime.date`
+    :param custom_time_before: (Optional) Apply rule action to items whose custom time is before this
+                                date. This condition is relevant only for versioned objects.
+
     :raises ValueError: if no arguments are passed.
     """
 
@@ -180,6 +191,8 @@ def __init__(
         is_live=None,
         matches_storage_class=None,
         number_of_newer_versions=None,
+        days_since_custom_time=None,
+        custom_time_before=None,
         _factory=False,
     ):
         conditions = {}
@@ -199,6 +212,12 @@ def __init__(
         if number_of_newer_versions is not None:
             conditions["numNewerVersions"] = number_of_newer_versions
 
+        if days_since_custom_time is not None:
+            conditions["daysSinceCustomTime"] = days_since_custom_time
+
+        if custom_time_before is not None:
+            conditions["customTimeBefore"] = custom_time_before.isoformat()
+
         if not _factory and not conditions:
             raise ValueError("Supply at least one condition")
 
@@ -245,6 +264,18 @@ def number_of_newer_versions(self):
         """Conditon's 'number_of_newer_versions' value."""
         return self.get("numNewerVersions")
 
+    @property
+    def days_since_custom_time(self):
+        """Conditon's 'days_since_custom_time' value."""
+        return self.get("daysSinceCustomTime")
+
+    @property
+    def custom_time_before(self):
+        """Conditon's 'custom_time_before' value."""
+        before = self.get("customTimeBefore")
+        if before is not None:
+            return datetime_helpers.from_iso8601_date(before)
+
 
 class LifecycleRuleDelete(dict):
     """Map a lifecycle rule deleting matching items.

tests/system/test_system.py

@@ -192,22 +192,34 @@ def test_bucket_create_w_alt_storage_class(self):
         self.assertEqual(created.storage_class, constants.ARCHIVE_STORAGE_CLASS)
 
     def test_lifecycle_rules(self):
+        import datetime
         from google.cloud.storage import constants
 
         new_bucket_name = "w-lifcycle-rules" + unique_resource_id("-")
+        custom_time_before = datetime.date(2018, 8, 1)
         self.assertRaises(
             exceptions.NotFound, Config.CLIENT.get_bucket, new_bucket_name
         )
         bucket = Config.CLIENT.bucket(new_bucket_name)
-        bucket.add_lifecycle_delete_rule(age=42)
+        bucket.add_lifecycle_delete_rule(
+            age=42,
+            number_of_newer_versions=3,
+            days_since_custom_time=2,
+            custom_time_before=custom_time_before,
+        )
         bucket.add_lifecycle_set_storage_class_rule(
             constants.COLDLINE_STORAGE_CLASS,
             is_live=False,
             matches_storage_class=[constants.NEARLINE_STORAGE_CLASS],
         )
 
         expected_rules = [
-            LifecycleRuleDelete(age=42),
+            LifecycleRuleDelete(
+                age=42,
+                number_of_newer_versions=3,
+                days_since_custom_time=2,
+                custom_time_before=custom_time_before,
+            ),
             LifecycleRuleSetStorageClass(
                 constants.COLDLINE_STORAGE_CLASS,
                 is_live=False,

tests/unit/test_blob.py

@@ -134,6 +134,8 @@ def _set_properties_helper(self, kms_key_name=None):
         CRC32C = "FACE0DAC"
         COMPONENT_COUNT = 2
         ETAG = "ETAG"
+        custom_time = datetime.date(2018, 8, 1)
+        CUSTOM_TIME = custom_time.isoformat()
         resource = {
             "id": BLOB_ID,
             "selfLink": SELF_LINK,
@@ -157,6 +159,7 @@ def _set_properties_helper(self, kms_key_name=None):
             "crc32c": CRC32C,
             "componentCount": COMPONENT_COUNT,
             "etag": ETAG,
+            "customTime": CUSTOM_TIME,
         }
 
         if kms_key_name is not None:
@@ -188,6 +191,7 @@ def _set_properties_helper(self, kms_key_name=None):
         self.assertEqual(blob.crc32c, CRC32C)
         self.assertEqual(blob.component_count, COMPONENT_COUNT)
         self.assertEqual(blob.etag, ETAG)
+        self.assertEqual(blob.custom_time, custom_time)
 
         if kms_key_name is not None:
             self.assertEqual(blob.kms_key_name, kms_key_name)
@@ -4146,6 +4150,40 @@ def test_updated_unset(self):
         blob = self._make_one("blob-name", bucket=BUCKET)
         self.assertIsNone(blob.updated)
 
+    def test_custom_time_getter(self):
+        BLOB_NAME = "blob-name"
+        bucket = _Bucket()
+        custom_time = datetime.date(2018, 8, 1)
+        CUSTOM_TIME = custom_time.isoformat()
+        properties = {"customTime": CUSTOM_TIME}
+        blob = self._make_one(BLOB_NAME, bucket=bucket, properties=properties)
+        self.assertEqual(blob.custom_time, custom_time)
+
+    def test_custom_time_setter(self):
+        BLOB_NAME = "blob-name"
+        bucket = _Bucket()
+        custom_time = datetime.date(2018, 8, 1)
+        blob = self._make_one(BLOB_NAME, bucket=bucket)
+        self.assertIsNone(blob.custom_time)
+        blob.custom_time = custom_time
+        self.assertEqual(blob.custom_time, custom_time)
+
+    def test_custom_time_setter_none_value(self):
+        BLOB_NAME = "blob-name"
+        bucket = _Bucket()
+        custom_time = datetime.date(2018, 8, 1)
+        CUSTOM_TIME = custom_time.isoformat()
+        properties = {"customTime": CUSTOM_TIME}
+        blob = self._make_one(BLOB_NAME, bucket=bucket, properties=properties)
+        self.assertEqual(blob.custom_time, custom_time)
+        blob.custom_time = None
+        self.assertIsNone(blob.custom_time)
+
+    def test_custom_time_unset(self):
+        BUCKET = object()
+        blob = self._make_one("blob-name", bucket=BUCKET)
+        self.assertIsNone(blob.custom_time)
+
     def test_from_string_w_valid_uri(self):
         from google.cloud.storage.blob import Blob
 

tests/unit/test_bucket.py

@@ -77,6 +77,8 @@ def test_ctor_w_created_before_and_is_live(self):
         self.assertEqual(conditions.is_live, False)
         self.assertIsNone(conditions.matches_storage_class)
         self.assertIsNone(conditions.number_of_newer_versions)
+        self.assertIsNone(conditions.days_since_custom_time)
+        self.assertIsNone(conditions.custom_time_before)
 
     def test_ctor_w_number_of_newer_versions(self):
         conditions = self._make_one(number_of_newer_versions=3)
@@ -88,9 +90,43 @@ def test_ctor_w_number_of_newer_versions(self):
         self.assertIsNone(conditions.matches_storage_class)
         self.assertEqual(conditions.number_of_newer_versions, 3)
 
+    def test_ctor_w_days_since_custom_time(self):
+        conditions = self._make_one(
+            number_of_newer_versions=3, days_since_custom_time=2
+        )
+        expected = {"numNewerVersions": 3, "daysSinceCustomTime": 2}
+        self.assertEqual(dict(conditions), expected)
+        self.assertIsNone(conditions.age)
+        self.assertIsNone(conditions.created_before)
+        self.assertIsNone(conditions.is_live)
+        self.assertIsNone(conditions.matches_storage_class)
+        self.assertEqual(conditions.number_of_newer_versions, 3)
+        self.assertEqual(conditions.days_since_custom_time, 2)
+
+    def test_ctor_w_custom_time_before(self):
+        import datetime
+
+        custom_time_before = datetime.date(2018, 8, 1)
+        conditions = self._make_one(
+            number_of_newer_versions=3, custom_time_before=custom_time_before
+        )
+        expected = {
+            "numNewerVersions": 3,
+            "customTimeBefore": custom_time_before.isoformat(),
+        }
+
+        self.assertEqual(dict(conditions), expected)
+        self.assertIsNone(conditions.age)
+        self.assertIsNone(conditions.created_before)
+        self.assertIsNone(conditions.is_live)
+        self.assertIsNone(conditions.matches_storage_class)
+        self.assertEqual(conditions.number_of_newer_versions, 3)
+        self.assertEqual(conditions.custom_time_before, custom_time_before)
+
     def test_from_api_repr(self):
         import datetime
 
+        custom_time_before = datetime.date(2018, 8, 1)
         before = datetime.date(2018, 8, 1)
         klass = self._get_target_class()
         resource = {
@@ -99,13 +135,17 @@ def test_from_api_repr(self):
             "isLive": True,
             "matchesStorageClass": ["COLDLINE"],
             "numNewerVersions": 3,
+            "daysSinceCustomTime": 2,
+            "customTimeBefore": custom_time_before.isoformat(),
         }
         conditions = klass.from_api_repr(resource)
         self.assertEqual(conditions.age, 10)
         self.assertEqual(conditions.created_before, before)
         self.assertEqual(conditions.is_live, True)
         self.assertEqual(conditions.matches_storage_class, ["COLDLINE"])
         self.assertEqual(conditions.number_of_newer_versions, 3)
+        self.assertEqual(conditions.days_since_custom_time, 2)
+        self.assertEqual(conditions.custom_time_before, custom_time_before)
 
 
 class Test_LifecycleRuleDelete(unittest.TestCase):