Add 'Bucket.notification' factory. (#3958)

Toward #3956.
googleapis · Sep 15, 2017 · 327347e · 327347e
1 parent 71dff99
commit 327347e
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 0 deletions.
diff --git a/storage/google/cloud/storage/bucket.py b/storage/google/cloud/storage/bucket.py
@@ -35,6 +35,7 @@
 from google.cloud.storage.acl import DefaultObjectACL
 from google.cloud.storage.blob import Blob
 from google.cloud.storage.blob import _get_encryption_headers
+from google.cloud.storage.notification import BucketNotification
 
 
 def _blobs_page_start(iterator, page, response):
@@ -159,6 +160,28 @@ def blob(self, blob_name, chunk_size=None, encryption_key=None):
         return Blob(name=blob_name, bucket=self, chunk_size=chunk_size,
                     encryption_key=encryption_key)
 
+    def notification(self, topic_name,
+                     topic_project=None,
+                     custom_attributes=None,
+                     event_types=None,
+                     blob_name_prefix=None,
+                     payload_format=None):
+        """Factory:  create a notification resource for the bucket.
+
+        See: :class:`google.cloud.storage.notification.BucketNotification`
+        for parameters.
+
+        :rtype: :class:`google.cloud.storage.notification.BucketNotification`
+        """
+        return BucketNotification(
+            self, topic_name,
+            topic_project=topic_project,
+            custom_attributes=custom_attributes,
+            event_types=event_types,
+            blob_name_prefix=blob_name_prefix,
+            payload_format=payload_format,
+        )
+
     def exists(self, client=None):
         """Determines whether or not this bucket exists.
 

diff --git a/storage/tests/unit/test_bucket.py b/storage/tests/unit/test_bucket.py
@@ -72,6 +72,63 @@ def test_blob(self):
         self.assertEqual(blob.chunk_size, CHUNK_SIZE)
         self.assertEqual(blob._encryption_key, KEY)
 
+    def test_notification_defaults(self):
+        from google.cloud.storage.notification import BucketNotification
+
+        PROJECT = 'PROJECT'
+        BUCKET_NAME = 'BUCKET_NAME'
+        TOPIC_NAME = 'TOPIC_NAME'
+        client = _Client(_Connection(), project=PROJECT)
+        bucket = self._make_one(client, name=BUCKET_NAME)
+
+        notification = bucket.notification(TOPIC_NAME)
+
+        self.assertIsInstance(notification, BucketNotification)
+        self.assertIs(notification.bucket, bucket)
+        self.assertEqual(notification.topic_project, PROJECT)
+        self.assertIsNone(notification.custom_attributes)
+        self.assertIsNone(notification.event_types)
+        self.assertIsNone(notification.blob_name_prefix)
+        self.assertIsNone(notification.payload_format)
+
+    def test_notification_explicit(self):
+        from google.cloud.storage.notification import (
+            BucketNotification,
+            OBJECT_FINALIZE_EVENT_TYPE,
+            OBJECT_DELETE_EVENT_TYPE,
+            JSON_API_V1_PAYLOAD_FORMAT)
+
+        PROJECT = 'PROJECT'
+        BUCKET_NAME = 'BUCKET_NAME'
+        TOPIC_NAME = 'TOPIC_NAME'
+        TOPIC_ALT_PROJECT = 'topic-project-456'
+        CUSTOM_ATTRIBUTES = {
+            'attr1': 'value1',
+            'attr2': 'value2',
+        }
+        EVENT_TYPES = [OBJECT_FINALIZE_EVENT_TYPE, OBJECT_DELETE_EVENT_TYPE]
+        BLOB_NAME_PREFIX = 'blob-name-prefix/'
+        client = _Client(_Connection(), project=PROJECT)
+        bucket = self._make_one(client, name=BUCKET_NAME)
+
+        notification = bucket.notification(
+            TOPIC_NAME,
+            topic_project=TOPIC_ALT_PROJECT,
+            custom_attributes=CUSTOM_ATTRIBUTES,
+            event_types=EVENT_TYPES,
+            blob_name_prefix=BLOB_NAME_PREFIX,
+            payload_format=JSON_API_V1_PAYLOAD_FORMAT,
+        )
+
+        self.assertIsInstance(notification, BucketNotification)
+        self.assertIs(notification.bucket, bucket)
+        self.assertEqual(notification.topic_project, TOPIC_ALT_PROJECT)
+        self.assertEqual(notification.custom_attributes, CUSTOM_ATTRIBUTES)
+        self.assertEqual(notification.event_types, EVENT_TYPES)
+        self.assertEqual(notification.blob_name_prefix, BLOB_NAME_PREFIX)
+        self.assertEqual(
+            notification.payload_format, JSON_API_V1_PAYLOAD_FORMAT)
+
     def test_bucket_name_value(self):
         bucket_name = 'testing123'
         mixin = self._make_one(name=bucket_name)