Merge pull request #2506 from tseaver/1982-storage-add_compose

tseaver · web-flow · commit da2b0235afa8 · 2016-10-06T14:14:33.000-04:00
Add 'Blob.compose' API wrapper method.
diff --git a/packages/google-cloud-storage/google/cloud/storage/blob.py b/packages/google-cloud-storage/google/cloud/storage/blob.py
@@ -655,6 +655,32 @@ def make_public(self, client=None):
         self.acl.all().grant_read()
         self.acl.save(client=client)
 
+    def compose(self, sources, client=None):
+        """Concatenate source blobs into this one.
+
+        :type sources: list of :class:`Blob`
+        :param sources: blobs whose contents will be composed into this blob.
+
+        :type client: :class:`~google.cloud.storage.client.Client` or
+                      ``NoneType``
+        :param client: Optional. The client to use.  If not passed, falls back
+                       to the ``client`` stored on the blob's bucket.
+
+        :raises: :exc:`ValueError` if this blob does not have its
+                 :attr:`content_type` set.
+        """
+        if self.content_type is None:
+            raise ValueError("Destination 'content_type' not set.")
+        client = self._require_client(client)
+        request = {
+            'sourceObjects': [{'name': source.name} for source in sources],
+            'destination': self._properties.copy(),
+        }
+        api_response = client.connection.api_request(
+            method='POST', path=self.path + '/compose', data=request,
+            _target_object=self)
+        self._set_properties(api_response)
+
     cache_control = _scalar_property('cacheControl')
     """HTTP 'Cache-Control' header for this object.
 
diff --git a/packages/google-cloud-storage/unit_tests/test_blob.py b/packages/google-cloud-storage/unit_tests/test_blob.py
@@ -1102,6 +1102,98 @@ def test_make_public(self):
         self.assertEqual(kw[0]['data'], {'acl': permissive})
         self.assertEqual(kw[0]['query_params'], {'projection': 'full'})
 
+    def test_compose_wo_content_type_set(self):
+        SOURCE_1 = 'source-1'
+        SOURCE_2 = 'source-2'
+        DESTINATION = 'destinaton'
+        connection = _Connection()
+        client = _Client(connection)
+        bucket = _Bucket(client=client)
+        source_1 = self._makeOne(SOURCE_1, bucket=bucket)
+        source_2 = self._makeOne(SOURCE_2, bucket=bucket)
+        destination = self._makeOne(DESTINATION, bucket=bucket)
+
+        with self.assertRaises(ValueError):
+            destination.compose(sources=[source_1, source_2])
+
+    def test_compose_minimal(self):
+        from six.moves.http_client import OK
+        SOURCE_1 = 'source-1'
+        SOURCE_2 = 'source-2'
+        DESTINATION = 'destinaton'
+        RESOURCE = {
+            'etag': 'DEADBEEF'
+        }
+        after = ({'status': OK}, RESOURCE)
+        connection = _Connection(after)
+        client = _Client(connection)
+        bucket = _Bucket(client=client)
+        source_1 = self._makeOne(SOURCE_1, bucket=bucket)
+        source_2 = self._makeOne(SOURCE_2, bucket=bucket)
+        destination = self._makeOne(DESTINATION, bucket=bucket)
+        destination.content_type = 'text/plain'
+
+        destination.compose(sources=[source_1, source_2])
+
+        self.assertEqual(destination.etag, 'DEADBEEF')
+
+        SENT = {
+            'sourceObjects': [
+                {'name': source_1.name},
+                {'name': source_2.name},
+            ],
+            'destination': {
+                'contentType': 'text/plain',
+            },
+        }
+        kw = connection._requested
+        self.assertEqual(len(kw), 1)
+        self.assertEqual(kw[0]['method'], 'POST')
+        self.assertEqual(kw[0]['path'], '/b/name/o/%s/compose' % DESTINATION)
+        self.assertEqual(kw[0]['data'], SENT)
+
+    def test_compose_w_additional_property_changes(self):
+        from six.moves.http_client import OK
+        SOURCE_1 = 'source-1'
+        SOURCE_2 = 'source-2'
+        DESTINATION = 'destinaton'
+        RESOURCE = {
+            'etag': 'DEADBEEF'
+        }
+        after = ({'status': OK}, RESOURCE)
+        connection = _Connection(after)
+        client = _Client(connection)
+        bucket = _Bucket(client=client)
+        source_1 = self._makeOne(SOURCE_1, bucket=bucket)
+        source_2 = self._makeOne(SOURCE_2, bucket=bucket)
+        destination = self._makeOne(DESTINATION, bucket=bucket)
+        destination.content_type = 'text/plain'
+        destination.content_language = 'en-US'
+        destination.metadata = {'my-key': 'my-value'}
+
+        destination.compose(sources=[source_1, source_2])
+
+        self.assertEqual(destination.etag, 'DEADBEEF')
+
+        SENT = {
+            'sourceObjects': [
+                {'name': source_1.name},
+                {'name': source_2.name},
+            ],
+            'destination': {
+                'contentType': 'text/plain',
+                'contentLanguage': 'en-US',
+                'metadata': {
+                    'my-key': 'my-value',
+                }
+            },
+        }
+        kw = connection._requested
+        self.assertEqual(len(kw), 1)
+        self.assertEqual(kw[0]['method'], 'POST')
+        self.assertEqual(kw[0]['path'], '/b/name/o/%s/compose' % DESTINATION)
+        self.assertEqual(kw[0]['data'], SENT)
+
     def test_cache_control_getter(self):
         BLOB_NAME = 'blob-name'
         bucket = _Bucket()
