Adds Storage v2 signed url sample (GoogleCloudPlatform#887)

Author: jkwlui

storage/composer.json

@@ -37,6 +37,7 @@
             "src/get_bucket_policy_only.php",
             "src/get_object_acl.php",
             "src/get_object_acl_for_entity.php",
+            "src/get_object_v2_signed_url.php",
             "src/get_requester_pays_status.php",
             "src/get_retention_policy.php",
             "src/get_default_event_based_hold.php",

storage/src/get_object_v2_signed_url.php

@@ -0,0 +1,47 @@
+
+/**
+ * Copyright 2019 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_generate_signed_url]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Generate a v2 signed URL for downloading an object.
+ *
+ * @param string $bucketName the name of your Google Cloud bucket.
+ * @param string $objectName the name of your Google Cloud object.
+ *
+ * @return void
+ */
+function get_object_v2_signed_url($bucketName, $objectName)
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $object = $bucket->object($objectName);
+    # This URL is valid for 1 hour
+    $url = $object->signedUrl(new \DateTime('next hour'));
+
+    printf('The signed url for %s is %s\n', $objectName, $url);
+}
+# [END storage_generate_signed_url]

storage/storage.php

@@ -458,7 +458,7 @@
     )
     ->addArgument('project', InputArgument::REQUIRED, 'Your billable Google Cloud Project ID')
     ->addArgument('bucket', InputArgument::REQUIRED, 'The Cloud Storage bucket name')
-    ->addArgument('object', InputArgument::REQUIRED, 'The Cloud Storage bucket name')
+    ->addArgument('object', InputArgument::REQUIRED, 'The Cloud Storage object name')
     ->addArgument('upload-from', InputArgument::REQUIRED, 'Path to the file to upload')
     ->addArgument('kms-key-name', InputArgument::REQUIRED, 'KMS key ID used to encrypt objects server side.')
     ->setCode(function ($input, $output) {
@@ -470,6 +470,23 @@
         upload_with_kms_key($projectId, $bucketName, $objectName, $uploadFrom, $kmsKeyName);
     });
 
+$application->add(new Command('get-object-v2-signed-url'))
+    ->setDescription('Generate a v2 signed URL for downloading an object.')
+    ->setHelp(<<
+The %command.name% command generates a v2 signed URL for downloading an object.
+
+php %command.full_name% --help
+
+EOF
+    )
+    ->addArgument('bucket', InputArgument::REQUIRED, 'The Cloud Storage bucket name')
+    ->addArgument('object', InputArgument::REQUIRED, 'The Cloud Storage object name')
+    ->setCode(function ($input, $output) {
+        $bucketName = $input->getArgument('bucket');
+        $objectName = $input->getArgument('object');
+        get_object_v2_signed_url($bucketName, $objectName);
+    });
+
 // for testing
 if (getenv('PHPUNIT_TESTS') === '1') {
     return $application;

storage/test/ObjectSignedUrlTest.php

@@ -0,0 +1,59 @@
+
+/**
+ * Copyright 2019 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.
+ */
+
+namespace Google\Cloud\Samples\Storage\Tests;
+
+use Google\Cloud\TestUtils\TestTrait;
+use Google\Cloud\TestUtils\ExecuteCommandTrait;
+use Google\Cloud\Storage\StorageClient;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Unit Tests for RequesterPaysCommand.
+ */
+class ObjectSignedUrlTest extends TestCase
+{
+    use TestTrait;
+    use ExecuteCommandTrait;
+
+    private static $bucketName;
+    private static $objectName;
+    private static $commandFile = __DIR__ . '/../storage.php';
+
+    /** @beforeClass */
+    public static function setUpObject()
+    {
+        $storage = new StorageClient();
+        self::$bucketName = self::requireEnv('GOOGLE_STORAGE_BUCKET');
+        self::$objectName = sprintf('test-object-%s', time());
+        $storage
+            ->bucket(self::$bucketName)
+            ->upload("test file content", [
+                'name' => self::$objectName
+            ]);
+    }
+
+    public function testGetV2SignedUrl()
+    {
+        $output = $this->runCommand('get-object-v2-signed-url', [
+            'bucket' => self::$bucketName,
+            'object' => self::$objectName,
+        ]);
+
+        $this->assertContains("The signed url for " . self::$objectName . " is", $output);
+    }
+}