more actions for storage (GoogleCloudPlatform#130)

Author: bshaffer

storage/api/README.md

@@ -29,6 +29,21 @@ This simple command-line application demonstrates how to invoke Google Cloud Sto
     my-project-name-bucket2
     my-project-name-bucket3
 ```
+6.  Run `php listObjects.php YOUR_PROJECT_NAME YOUR_BUCKET_NAME` where YOUR_PROJECT_NAME is the
+    project associated with the credentials from **step 2** and YOUR_BUCKET_NAME is a bucket from the list of bucket names in **step 5**.
+
+    ```sh
+    $ php listBuckets.php my-project-name my-project-name-bucket1
+    my-project-name-bucket1-object1
+    my-project-name-bucket1-object2
+    my-project-name-bucket1-object3
+```
+7.  Run `php listObjects.php YOUR_PROJECT_NAME YOUR_BUCKET_NAME YOUR_OBJECT_NAME` where YOUR_PROJECT_NAME is the project associated with the credentials from **step 2** and YOUR_BUCKET_NAME is a bucket from the list of bucket names in **step 5** and YOUR_OBJECT_NAME is an object name from the list of objects in **step 6**.
+
+    ```sh
+    $ php downloadObject.php my-project-name my-project-name-bucket1 my-project-name-bucket1-object1 myfile.txt
+    File written to myfile.txt
+```
 
 
 ## Contributing changes

storage/api/downloadObject.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+
+// [START all]
+// composer autoloading
+require_once __DIR__ . '/vendor/autoload.php';
+
+// grab the first argument
+if (empty($argv[3])) {
+    die("usage: php downloadObject [project_id] [bucket_name] [object_name]"
+        . " [optional_download_name]\n");
+}
+
+$projectId = $argv[1];
+$bucketName = $argv[2];
+$objectName = $argv[3];
+$downloadName = isset($argv[4]) ? $argv[4] : $argv[3];
+
+// Authenticate your API Client
+$client = new Google_Client();
+$client->useApplicationDefaultCredentials();
+$client->addScope(Google_Service_Storage::DEVSTORAGE_FULL_CONTROL);
+
+$storage = new Google_Service_Storage($client);
+
+try {
+    // Google Cloud Storage API request to retrieve the list of objects in your
+    // project.
+    $object = $storage->objects->get($bucketName, $objectName);
+} catch (Google_Service_Exception $e) {
+    // The bucket doesn't exist!
+    if ($e->getCode() == 404) {
+        exit(sprintf("Invalid bucket or object names (\"%s\", \"%s\")\n",
+            $bucketName, $objectName));
+    }
+    throw $e;
+}
+
+// build the download URL
+$uri = sprintf('https://storage.googleapis.com/%s/%s?alt=media&generation=%s',
+    $bucketName, $objectName, $object->generation);
+$http = $client->authorize();
+$response = $http->get($uri);
+
+if ($response->getStatusCode() != 200) {
+    exit('download failed!' . $response->getBody());
+}
+if (file_exists($downloadName)) {
+    exit(sprintf("File \"%s\" exists! Cowardly refusing to overwrite it\n",
+        $downloadName));
+}
+
+// write the file
+file_put_contents($downloadName, $response->getBody());
+echo sprintf("File written to %s\n", $downloadName);
+
+// [END all]

storage/api/listObjects.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+
+// [START all]
+// composer autoloading
+require_once __DIR__ . '/vendor/autoload.php';
+
+// grab the first argument
+if (empty($argv[2])) {
+    die("usage: php listBuckets [project_id] [bucket_name]\n");
+}
+
+$projectId = $argv[1];
+$bucketName = $argv[2];
+
+// Authenticate your API Client
+$client = new Google_Client();
+$client->useApplicationDefaultCredentials();
+$client->addScope(Google_Service_Storage::DEVSTORAGE_FULL_CONTROL);
+
+$storage = new Google_Service_Storage($client);
+
+try {
+    // Google Cloud Storage API request to retrieve the list of objects in your project.
+    $objects = $storage->objects->listObjects($bucketName);
+} catch (Google_Service_Exception $e) {
+    // The bucket doesn't exist!
+    if ($e->getCode() == 404) {
+        exit(sprintf("Invalid bucket name \"%s\"\n", $bucketName));
+    }
+    throw $e;
+}
+
+foreach ($objects['items'] as $object) {
+    printf("%s\n", $object->getName());
+}
+// [END all]

storage/api/test/downloadObjectTest.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+class downloadObjectTest extends PHPUnit_Framework_TestCase
+{
+    protected static $hasCredentials;
+
+    public static function setUpBeforeClass()
+    {
+        $path = getenv('GOOGLE_APPLICATION_CREDENTIALS');
+        self::$hasCredentials = $path && file_exists($path) &&
+            filesize($path) > 0;
+    }
+
+    public function test()
+    {
+        if (!self::$hasCredentials) {
+            $this->markTestSkipped('No application credentials were found.');
+        }
+
+        if (!$bucketName = getenv('GOOGLE_BUCKET_NAME')) {
+            $this->markTestSkipped('GOOGLE_BUCKET_NAME must be set.');
+        }
+
+        if (!$objectName = getenv('GOOGLE_OBJECT_NAME')) {
+            $this->markTestSkipped('GOOGLE_OBJECT_NAME must be set.');
+        }
+
+        // Invoke listBuckets.php, and fake first argument.
+        global $argc, $argv;
+        $argv[1] = getenv('GOOGLE_PROJECT_ID');
+        $argv[2] = $bucketName;
+        $argv[3] = $objectName;
+        $argv[4] = sprintf('%s/%s-%s', sys_get_temp_dir(), rand(), $objectName);
+
+        // Capture stdout.
+        ob_start();
+        include __DIR__ . '/../downloadObject.php';
+        $result = ob_get_contents();
+        ob_end_clean();
+
+        // Make sure it looks correct
+        $this->assertContains('File written to ' . $argv[4], $result);
+        $this->assertTrue(file_exists($argv[4]));
+    }
+}

storage/api/test/listBucketsTest.php

@@ -31,6 +31,10 @@ public function test()
             $this->markTestSkipped('No application credentials were found.');
         }
 
+        if (!$bucketName = getenv('GOOGLE_BUCKET_NAME')) {
+            $this->markTestSkipped('GOOGLE_BUCKET_NAME must be set.');
+        }
+
         // Invoke listBuckets.php, and fake first argument.
         global $argc, $argv;
         $argv[1] = getenv('GOOGLE_PROJECT_ID');
@@ -42,6 +46,6 @@ public function test()
         ob_end_clean();
 
         // Make sure it looks correct
-        $this->assertContains('cloud-samples-tests-php-bucket', $result);
+        $this->assertContains($bucketName, $result);
     }
 }

storage/api/test/listObjectsTest.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+class listObjectsTest extends PHPUnit_Framework_TestCase
+{
+    protected static $hasCredentials;
+
+    public static function setUpBeforeClass()
+    {
+        $path = getenv('GOOGLE_APPLICATION_CREDENTIALS');
+        self::$hasCredentials = $path && file_exists($path) &&
+            filesize($path) > 0;
+    }
+
+    public function test()
+    {
+        if (!self::$hasCredentials) {
+            $this->markTestSkipped('No application credentials were found.');
+        }
+
+        if (!$bucketName = getenv('GOOGLE_BUCKET_NAME')) {
+            $this->markTestSkipped('GOOGLE_BUCKET_NAME must be set.');
+        }
+
+        if (!$objectName = getenv('GOOGLE_OBJECT_NAME')) {
+            $this->markTestSkipped('GOOGLE_OBJECT_NAME must be set.');
+        }
+
+        // Invoke listBuckets.php, and fake first argument.
+        global $argc, $argv;
+        $argv[1] = getenv('GOOGLE_PROJECT_ID');
+        $argv[2] = $bucketName;
+
+        // Capture stdout.
+        ob_start();
+        include __DIR__ . '/../listObjects.php';
+        $result = ob_get_contents();
+        ob_end_clean();
+
+        // Make sure it looks correct
+        $this->assertContains($objectName, $result);
+    }
+}