👽 Fix Google Cloud Storage adapter (#664)

Author: Nek-

.gitignore

@@ -10,3 +10,4 @@ phpunit.xml
 tests/adapters/*
 !tests/adapters/*.dist
 vendor/
+tests/Gaufrette/Functional/adapters/*.php

CHANGELOG.md

@@ -1,4 +1,11 @@
 
+v0.11.0
+=======
+
+## Added
+
+- Google Cloud Storage: options to automatically create bucket if not exists
+
 v0.10.0
 =======
 

Makefile

@@ -24,7 +24,7 @@ docker.all-deps: docker.deps ## Install dependencies
 	docker/run-task php${PHP_VERSION} composer require --no-update \
 		aws/aws-sdk-php:^3.158 \
 		rackspace/php-opencloud:^1.9.2 \
-		google/apiclient:^1.1.3 \
+		google/apiclient:^2.12 \
 		doctrine/dbal:^2.3 \
 		league/flysystem:^1.0 \
 		microsoft/azure-storage-blob:^1.0 \

doc/adapters/google-cloud-storage.md

@@ -6,7 +6,7 @@ currentMenu: google-cloud-storage
 
 To use the GoogleCloudStorage adapter you will need to create a connection using the [Google APIs Client Library for PHP]
 (https://github.com/google/google-api-php-client) and create a Client ID/Service Account in your [Developers Console]
-(https://console.developers.google.com/). You can then create the `\Google_Service_Storage` which is required for the
+(https://console.developers.google.com/). You can then create the `\Google\Service\Storage` which is required for the
 GoogleCloudStorage adapter.
 
 ## Example
@@ -17,23 +17,30 @@ GoogleCloudStorage adapter.
 use Gaufrette\Filesystem;
 use Gaufrette\Adapter\GoogleCloudStorage;
 
-$client = new \Google_Client();
-$client->setClientId('xxxxxxxxxxxxxxx.apps.googleusercontent.com');
-$client->setApplicationName('Gaufrette');
+$keyFileLocation = '/home/me/path/to/service-auth-key.json';
+$bucketName = 'gaufrette-bucket-test-' . uniqid();
+$projectId = 'your-project-id-000';
+$bucketLocation = 'EUROPE-WEST9';
+
+putenv('GOOGLE_APPLICATION_CREDENTIALS=' . $keyFileLocation);
 
-$cred = new \Google_Auth_AssertionCredentials(
-    '[email protected]',
-    array(\Google_Service_Storage::DEVSTORAGE_FULL_CONTROL),
-    file_get_contents('key.p12')
+$client = new \Google\Client();
+$client->setApplicationName('Gaufrette');
+$client->addScope(Google\Service\Storage::DEVSTORAGE_FULL_CONTROL);
+$client->useApplicationDefaultCredentials();
+
+$service = new \Google\Service\Storage($client);
+$adapter = new GoogleCloudStorage(
+    $service,
+    $bucketName,
+    [
+        // Options to set for automatic creation of the bucket
+        GoogleCloudStorage::OPTION_CREATE_BUCKET_IF_NOT_EXISTS => true,
+        GoogleCloudStorage::OPTION_PROJECT_ID => $projectId,
+        GoogleCloudStorage::OPTION_LOCATION => $bucketLocation,
+    ],
+    true
 );
-$client->setAssertionCredentials($cred);
-if ($client->getAuth()->isAccessTokenExpired()) {
-    $client->getAuth()->refreshTokenWithAssertion($cred);
-}
-
-$service = new \Google_Service_Storage($client);
-$adapter = new Gaufrette\Adapter\GoogleCloudStorage($service, $config['gcsBucket'], array(
-    'acl' => 'public',
-), true);
+
 $filesystem = new Gaufrette\Filesystem($adapter);
 ```

src/Gaufrette/Adapter/GoogleCloudStorage.php

@@ -3,6 +3,12 @@
 namespace Gaufrette\Adapter;
 
 use Gaufrette\Adapter;
+use Google\Service\Storage;
+use Google\Service\Storage\Bucket;
+use Google\Service\Storage\StorageObject;
+use Google\Service\Exception as ServiceException;
+use Google\Service\Storage\BucketIamConfiguration;
+use Google\Service\Storage\BucketIamConfigurationUniformBucketLevelAccess;
 use GuzzleHttp;
 
 /**
@@ -12,37 +18,44 @@
  */
 class GoogleCloudStorage implements Adapter, MetadataSupporter, ListKeysAware
 {
+    public const OPTION_CREATE_BUCKET_IF_NOT_EXISTS = 'create';
+    public const OPTION_PROJECT_ID = 'project_id';
+    public const OPTION_LOCATION = 'bucket_location';
+    public const OPTION_STORAGE_CLASS = 'storage_class';
+
     protected $service;
     protected $bucket;
-    protected $options;
+    protected $options = [
+        self::OPTION_CREATE_BUCKET_IF_NOT_EXISTS => false,
+        self::OPTION_STORAGE_CLASS => 'STANDARD',
+        'directory' => '',
+        'acl' => 'private',
+    ];
     protected $bucketExists;
     protected $metadata = [];
     protected $detectContentType;
 
     /**
-     * @param \Google_Service_Storage $service           The storage service class with authenticated
+     * @param Storage $service           The storage service class with authenticated
      *                                                   client and full access scope
      * @param string                  $bucket            The bucket name
      * @param array                   $options           Options can be directory and acl
      * @param bool                    $detectContentType Whether to detect the content type or not
      */
     public function __construct(
-        \Google_Service_Storage $service,
+        Storage $service,
         $bucket,
         array $options = [],
         $detectContentType = false
     ) {
-        if (!class_exists(\Google_Service_Storage::class)) {
+        if (!class_exists(Storage::class)) {
             throw new \LogicException('You need to install package "google/apiclient" to use this adapter');
         }
 
         $this->service = $service;
         $this->bucket = $bucket;
         $this->options = array_replace(
-            [
-                'directory' => '',
-                'acl' => 'private',
-            ],
+            $this->options,
             $options
         );
 
@@ -80,6 +93,7 @@ public function getBucket()
      */
     public function setBucket($bucket)
     {
+        $this->bucketExists = null;
         $this->bucket = $bucket;
     }
 
@@ -145,7 +159,7 @@ public function write($key, $content)
             unset($metadata['ContentType']);
         }
 
-        $object = new \Google_Service_Storage_StorageObject();
+        $object = new StorageObject();
         $object->name = $path;
 
         if (isset($metadata['ContentDisposition'])) {
@@ -182,7 +196,7 @@ public function write($key, $content)
             }
 
             return $object->getSize();
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
             return false;
         }
     }
@@ -197,7 +211,7 @@ public function exists($key)
 
         try {
             $this->service->objects->get($this->bucket, $path);
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
             return false;
         }
 
@@ -235,7 +249,7 @@ public function delete($key)
 
         try {
             $this->service->objects->delete($this->bucket, $path);
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
             return false;
         }
 
@@ -259,7 +273,7 @@ public function rename($sourceKey, $targetKey)
         try {
             $this->service->objects->copy($this->bucket, $sourcePath, $this->bucket, $targetPath, $object);
             $this->service->objects->delete($this->bucket, $sourcePath);
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
             return false;
         }
 
@@ -301,7 +315,7 @@ public function listKeys($prefix = '')
         $reflectionProperty->setAccessible(true);
         $reflectionProperty->setValue($list, 'items');
 
-        /** @var \Google_Service_Storage_StorageObject $object */
+        /** @var StorageObject $object */
         foreach ($list as $object) {
             $keys[] = $object->name;
         }
@@ -347,7 +361,39 @@ protected function ensureBucketExists()
             $this->bucketExists = true;
 
             return;
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
+            if ($this->options[self::OPTION_CREATE_BUCKET_IF_NOT_EXISTS]) {
+                if (!isset($this->options[self::OPTION_PROJECT_ID])) {
+                    throw new \RuntimeException(
+                        sprintf('Option "%s" missing, cannot create bucket', self::OPTION_PROJECT_ID)
+                    );
+                }
+                if (!isset($this->options[self::OPTION_LOCATION])) {
+                    throw new \RuntimeException(
+                        sprintf('Option "%s" missing, cannot create bucket', self::OPTION_LOCATION)
+                    );
+                }
+
+                $bucketIamConfigDetail = new BucketIamConfigurationUniformBucketLevelAccess();
+                $bucketIamConfigDetail->setEnabled(true);
+                $bucketIam = new BucketIamConfiguration();
+                $bucketIam->setUniformBucketLevelAccess($bucketIamConfigDetail);
+                $bucket = new Bucket();
+                $bucket->setName($this->bucket);
+                $bucket->setLocation($this->options[self::OPTION_LOCATION]);
+                $bucket->setStorageClass($this->options[self::OPTION_STORAGE_CLASS]);
+                $bucket->setIamConfiguration($bucketIam);
+
+                $this->service->buckets->insert(
+                    $this->options[self::OPTION_PROJECT_ID],
+                    $bucket
+                );
+
+                $this->bucketExists = true;
+
+                return;
+            }
+
             $this->bucketExists = false;
 
             throw new \RuntimeException(
@@ -372,13 +418,13 @@ protected function computePath($key)
      * @param string $path
      * @param array  $options
      *
-     * @return bool|\Google_Service_Storage_StorageObject
+     * @return bool|StorageObject
      */
     private function getObjectData($path, $options = [])
     {
         try {
             return $this->service->objects->get($this->bucket, $path, $options);
-        } catch (\Google_Service_Exception $e) {
+        } catch (ServiceException $e) {
             return false;
         }
     }

tests/Gaufrette/Functional/Adapter/GoogleCloudStorageTest.php

@@ -2,6 +2,8 @@
 
 namespace Gaufrette\Functional\Adapter;
 
+use Gaufrette\Adapter\GoogleCloudStorage;
+
 /**
  * Functional tests for the GoogleCloudStorage adapter.
  *
@@ -15,18 +17,16 @@ class GoogleCloudStorageTest extends FunctionalTestCase
     /**
      * @test
      * @group functional
-     *
-     * @expectedException \RuntimeException
      */
     public function shouldThrowExceptionIfBucketMissing()
     {
+        $this->expectException(\RuntimeException::class);
         /** @var \Gaufrette\Adapter\GoogleCloudStorage $adapter */
         $adapter = $this->filesystem->getAdapter();
-        $oldBucket = $adapter->getOptions();
+        $adapter->setOptions([GoogleCloudStorage::OPTION_CREATE_BUCKET_IF_NOT_EXISTS => false]);
         $adapter->setBucket('Gaufrette-' . mt_rand());
 
         $adapter->read('foo');
-        $adapter->setBucket($oldBucket);
     }
 
     /**

tests/Gaufrette/Functional/adapters/GoogleCloudStorage.php.dist

@@ -1,23 +1,28 @@
 <?php
 
-$client_id = 'xxxxxxxxxxxxxxx.apps.googleusercontent.com';
-$service_account_name = '[email protected]';
-$key_file_location = 'key.p12';
-$bucket_name = 'mybucket';
+use Gaufrette\Adapter\GoogleCloudStorage;
 
-$client = new \Google_Client();
+$keyFileLocation = '/home/me/path/to/service-auth-key.json';
+$bucketName = 'gaufrette-bucket-test-' . uniqid();
+$projectId = 'your-project-id-000';
+$bucketLocation = 'EUROPE-WEST9';
+
+putenv('GOOGLE_APPLICATION_CREDENTIALS=' . $keyFileLocation);
+
+$client = new \Google\Client();
 $client->setApplicationName('Gaufrette');
+$client->addScope(Google\Service\Storage::DEVSTORAGE_FULL_CONTROL);
+$client->useApplicationDefaultCredentials();
 
-$key = file_get_contents($key_file_location);
-$cred = new \Google_Auth_AssertionCredentials(
-    $service_account_name,
-    array(\Google_Service_Storage::DEVSTORAGE_FULL_CONTROL),
-    $key
-);
-$client->setAssertionCredentials($cred);
-if ($client->getAuth()->isAccessTokenExpired()) {
-    $client->getAuth()->refreshTokenWithAssertion($cred);
-}
+$service = new \Google\Service\Storage($client);
 
-$service = new \Google_Service_Storage($client);
-return new Gaufrette\Adapter\GoogleCloudStorage($service, $bucket_name, array(), true);
+return new GoogleCloudStorage(
+    $service,
+    $bucketName,
+    [
+        GoogleCloudStorage::OPTION_CREATE_BUCKET_IF_NOT_EXISTS => true,
+        GoogleCloudStorage::OPTION_PROJECT_ID => $projectId,
+        GoogleCloudStorage::OPTION_LOCATION => $bucketLocation,
+    ],
+    true
+);