Merge pull request #557 from KnpLabs/feature/google-cloud-client-adapter

[RFR] Feature/google cloud client adapter

Author: nicolasmure

.env.dist

@@ -2,6 +2,11 @@ AWS_KEY=
 AWS_SECRET=
 AWS_BUCKET=
 
+# see /doc/adapters/google-cloud-storage.md
+GCS_PROJECT_ID=
+GCS_BUCKET_NAME=
+GCS_JSON_KEY_FILE=/app/secrets/gaufrette-appId.json
+
 MONGO_URI=mongodb://mongodb:27017
 MONGO_DBNAME=gridfs_test
 

.gitignore

@@ -2,7 +2,10 @@ bin/*
 !bin/tests
 !bin/tests-all
 doc/.couscous
+tests/adapters/*
+!tests/adapters/*.dist
 vendor/
 .env
 composer.lock
 phpunit.xml
+secrets/

CHANGELOG.md

@@ -1,3 +1,12 @@
+v1.0.0
+======
+
+## New features
+
+- Google Cloud Storage Adapter (#557)
+
+Thank you @nicolasmure and @PanzerLlama for your contributions !
+
 v0.8.3
 ======
 

README.md

@@ -72,7 +72,7 @@ Requires the latest versions of :
 ```bash
 $ make dev
 ```
-and configure it as you want.
+and fill it with the credentials of the backend you want to use.
 
 2) Build the php docker image :
 ```bash

composer.json

@@ -36,7 +36,8 @@
         "mongodb/mongodb": "^1.1",
         "microsoft/azure-storage-blob": "^1.0",
         "akeneo/phpspec-skip-example-extension": "^4.0",
-        "liuggio/fastest": "^1.6"
+        "liuggio/fastest": "^1.6",
+        "google/cloud-storage": "~1.0"
     },
     "suggest": {
         "knplabs/knp-gaufrette-bundle": "to use with Symfony",
@@ -51,10 +52,12 @@
         "gaufrette/opencloud-adapter": "to use Opencloud adapter",
         "gaufrette/zip-adapter": "to use Zip adapter",
         "gaufrette/gridfs-adapter": "to use GridFS adapter",
-        "google/apiclient": "to use GoogleCloudStorage adapter",
+        "google/cloud-storage": "to use GoogleCloudStorage adapter",
         "ext-curl": "*",
         "ext-mbstring": "*",
-        "ext-fileinfo": "This extension is used to automatically detect the content-type of a file in the AwsS3, OpenCloud, AzureBlogStorage and GoogleCloudStorage adapters"
+        "ext-fileinfo": "This extension is used to automatically detect the content-type of a file in the AwsS3, OpenCloud, AzureBlogStorage and GoogleCloudStorage adapters",
+        "ext-mongodb": "*",
+        "mongodb/mongodb": "*"
     },
     "autoload": {
         "psr-0": { "Gaufrette": "src/" }

doc/adapters/google-cloud-storage.md

@@ -2,12 +2,22 @@
 currentMenu: google-cloud-storage
 ---
 
-# GoogleCloudStorage
+# 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
-GoogleCloudStorage adapter.
+This adapter requires an instance of `Google\Cloud\Storage\StorageClient`
+that has proper access rights to the bucket you want to use.
+
+For more details see:
+http://googlecloudplatform.github.io/google-cloud-php/
+https://console.cloud.google.com/
+
+In order to get started:
+
+1) Create a project in [Google Cloud Platform](https://console.cloud.google.com/).
+2) Create a bucket for the project in Storage.
+3) Create a Service Account in IAM & Admin section that can write access the bucket, download its key.json file.
+
+**At all times make sure you keep your key.json file private and nobody can access it from the Internet.**
 
 ## Example
 
@@ -16,24 +26,42 @@ GoogleCloudStorage adapter.
 
 use Gaufrette\Filesystem;
 use Gaufrette\Adapter\GoogleCloudStorage;
+use Google\Cloud\Storage\StorageClient;
+
+$storage = new StorageClient(array(
+    'projectId'     => 'your-project-id',
+    'keyFilePath'   => 'path/to/your/project/key.json'
+));
 
-$client = new \Google_Client();
-$client->setClientId('xxxxxxxxxxxxxxx.apps.googleusercontent.com');
-$client->setApplicationName('Gaufrette');
+# You can optionally set the directory in the bucket and the acl permissions for all uploaded files...
+# By default Cloud Storage applies the bucket's default object ACL to the object (uploaded file).
+# The example below gives read access to the uploaded files to anyone in the world
+# Note that the public URL of the file IS NOT the bucket's file url,
+# see https://cloud.google.com/storage/docs/access-public-data for details
 
-$cred = new \Google_Auth_AssertionCredentials(
-    '[email protected]',
-    array(\Google_Service_Storage::DEVSTORAGE_FULL_CONTROL),
-    file_get_contents('key.p12')
+$adapter = new GoogleCloudStorage($storage, 'bucket_name',
+    array(
+        'directory' => 'bucket_directory',
+        'acl'       => array(
+            'allUsers' => \Google\Cloud\Storage\Acl::ROLE_READER
+        )
+    )
+);
+
+$key = 'myAmazingFile.txt';
+
+$filesystem = new Filesystem($adapter);
+
+$filesystem->write($key, 'Uploaded at: '.date('Y-m-d @ H:i:s'), true);
+
+# optional
+$adapter->setMetadata($key,
+    array(
+        'FileDescription' => 'This is my file. There are many like it, but this one is mine.'
+    )
 );
-$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);
 ```
+
+Here you can find some more info regarding ACL:
+* [Creating and Managing Access Control Lists (ACLs)](https://cloud.google.com/storage/docs/access-control/create-manage-lists)
+* [Access Control Lists (ACLs)](https://cloud.google.com/storage/docs/access-control/lists)