feat(storage): add two new samples (GoogleCloudPlatform#1437)

Author: jdpedrie

storage/src/download_public_file.php

@@ -0,0 +1,67 @@
+
+/**
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_download_public_file]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Download a public file using anonymous credentials.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ * @param string $objectName The name of your Cloud Storage object.
+ * @param string $destination The local destination to save the object.
+ */
+function download_public_file($bucketName, $objectName, $destination)
+{
+    // $bucketName = 'my-bucket';
+    // $objectName = 'my-object';
+    // $destination = '/home/admin/downloads/my-object';
+
+    // create a storage client without authentication
+    $storage = new StorageClient([
+    ]);
+
+    $bucket = $storage->bucket($bucketName);
+    $object = $bucket->object($objectName);
+
+    // set `shouldSignRequest` to false to force the client to not authenticate.
+    // if you do not have any client configuration enabled (i.e. application
+    // default credentials), that option can be omitted.
+    $object->downloadToFile($destination, [
+        'shouldSignRequest' => false,
+    ]);
+
+    printf(
+        'Downloaded public object %s from bucket %s to %s',
+        $objectName,
+        $bucketName,
+        $destination
+    );
+}
+# [END storage_download_public_file]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/src/set_bucket_public_iam.php

@@ -0,0 +1,60 @@
+
+/**
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_set_bucket_public_iam]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Update the specified bucket's IAM configuration to make it publicly accessible.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ */
+function set_bucket_public_iam($bucketName)
+{
+    // $bucketName = 'my-bucket';
+
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+
+    $policy = $bucket->iam()->policy(['requestedPolicyVersion' => 3]);
+    $policy['version'] = 3;
+
+    $role = 'roles/storage.objectViewer';
+    $members = ['allUsers'];
+
+    $policy['bindings'][] = [
+        'role' => $role,
+        'members' => $members
+    ];
+
+    $bucket->iam()->setPolicy($policy);
+
+    printf('Bucket %s is now public', $bucketName);
+}
+# [END storage_set_bucket_public_iam]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/test/IamTest.php

@@ -260,4 +260,31 @@ public function testRemoveBucketConditionalIamBinding()
         }
         $this->assertFalse($foundBinding);
     }
+
+    public function testSetBucketPublicIam()
+    {
+        $bucket = self::$storage->createBucket(uniqid('samples-public-iam-'));
+
+        $output = self::runFunctionSnippet('set_bucket_public_iam', [
+            $bucket->name(),
+        ]);
+
+        $this->assertEquals(
+            sprintf('Bucket %s is now public', $bucket->name()),
+            $output
+        );
+
+        $policy = $bucket->iam()->policy();
+        $hasBinding = false;
+        foreach ($policy['bindings'] as $binding) {
+            if ($binding['role'] == 'roles/storage.objectViewer' && $binding['members'] = ['allUsers']) {
+                $hasBinding = true;
+                break;
+            }
+        }
+
+        $bucket->delete();
+
+        $this->assertTrue($hasBinding, 'has public viewable iam binding');
+    }
 }

storage/test/storageTest.php

@@ -769,6 +769,42 @@ public function testDeleteFileArchivedGeneration()
         );
     }
 
+    public function testDownloadPublicObject()
+    {
+        $bucket = self::$storage->createBucket(uniqid('samples-download-public-object-'));
+
+        self::runFunctionSnippet('set_bucket_public_iam', [
+            $bucket->name(),
+        ]);
+
+        $object = self::$storage->bucket(self::$bucketName)->upload('test content', [
+            'name' => uniqid('samples-download-public-object-'),
+        ]);
+
+        $downloadTo = tempnam(sys_get_temp_dir(), '/tests/' . $object->name());
+
+        $output = self::runFunctionSnippet('download_public_file', [
+            self::$bucketName,
+            $object->name(),
+            $downloadTo,
+        ]);
+
+        $object->delete();
+        $bucket->delete();
+
+        $this->assertEquals(
+            sprintf(
+                'Downloaded public object %s from bucket %s to %s',
+                $object->name(),
+                self::$bucketName,
+                $downloadTo,
+            ),
+            $output
+        );
+
+        $this->assertFileExists($downloadTo);
+    }
+
     private function keyName()
     {
         return sprintf(