Env var support for Project ID & Subfolder

Resolves #7
craftcms · Feb 8, 2019 · a28cae9 · a28cae9
1 parent f955c9e
commit a28cae9
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Release Notes for Google Cloud Storage for Craft CMS
 
+## Unreleased
+
+### Added
+- The Project ID and Subfolder settings can now be set to environment variables. ([#7](https://github.com/craftcms/aws-s3/issues/7))
+
 ## 1.2.1 - 2019-02-06
 
 ### Fixed

diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
     "rss": "https://github.com/craftcms/google-cloud/commits/master.atom"
   },
   "require": {
-    "craftcms/cms": "^3.1.0",
+    "craftcms/cms": "^3.1.5",
     "superbalist/flysystem-google-storage": "^7.0.0"
   },
   "autoload": {

diff --git a/src/Volume.php b/src/Volume.php
@@ -134,8 +134,8 @@ public static function loadBucketList(string $projectId, string $keyFileContents
      */
     public function getRootUrl()
     {
-        if (($rootUrl = parent::getRootUrl()) !== false && $this->subfolder) {
-            $rootUrl .= rtrim($this->subfolder, '/').'/';
+        if (($rootUrl = parent::getRootUrl()) !== false) {
+            $rootUrl .= $this->_subfolder();
         }
         return $rootUrl;
     }
@@ -183,7 +183,7 @@ protected function createAdapter()
         $client = static::client($config);
         $bucket = $client->bucket($this->bucket);
 
-        return new GoogleStorageAdapter($client, $bucket, $this->subfolder);
+        return new GoogleStorageAdapter($client, $bucket, $this->_subfolder() ?: null);
     }
 
     /**
@@ -220,14 +220,27 @@ protected function addFileMetadataToConfig(array $config): array
     // Private Methods
     // =========================================================================
 
+    /**
+     * Returns the parsed subfolder path
+     * @return string
+     */
+    private function _subfolder(): string
+    {
+        if ($this->subfolder && ($subfolder = rtrim(Craft::parseEnv($this->subfolder), '/')) !== '') {
+            return $subfolder . '/';
+        }
+        return '';
+
+    }
+
     /**
      * Get the config array for Google Cloud Storage clients.
      *
      * @return array
      */
     private function _getConfigArray()
     {
-        $projectId = $this->projectId;
+        $projectId = Craft::parseEnv($this->projectId);
         $keyFileContents = $this->keyFileContents;
 
         return static::_buildConfigArray($projectId, $keyFileContents);

diff --git a/src/controllers/DefaultController.php b/src/controllers/DefaultController.php
@@ -35,7 +35,7 @@ public function actionLoadBucketData()
         $this->requireAcceptsJson();
 
         $request = Craft::$app->getRequest();
-        $projectId = $request->getRequiredBodyParam('projectId');
+        $projectId = Craft::parseEnv($request->getRequiredBodyParam('projectId'));
         $keyFileContents = $request->getRequiredBodyParam('keyFileContents');
 
         try {

diff --git a/src/resources/js/editVolume.js b/src/resources/js/editVolume.js
@@ -1,3 +1,5 @@
+$(document).ready(function() {
+
 var $googleProjectId = $('.google-project-id'),
 	$googleKeyFileContents = $('.google-key-file-contents'),
 	$googleBucketSelect = $('.google-bucket-select > select'),
@@ -91,4 +93,6 @@ var googleChangeExpiryValue = function ()
 };
 
 $('.google-expires-amount').keyup(googleChangeExpiryValue).change(googleChangeExpiryValue);
-$('.google-expires-period select').change(googleChangeExpiryValue);
+$('.google-expires-period select').change(googleChangeExpiryValue);
+
+});
diff --git a/src/templates/volumeSettings.html b/src/templates/volumeSettings.html
@@ -1,9 +1,10 @@
 {% import "_includes/forms" as forms %}
 
-{{ forms.textField({
+{{ forms.autosuggestField({
     label: "Project ID"|t('google-cloud'),
     id: 'projectId',
     name: 'projectId',
+    suggestEnvVars: true,
     value: volume.projectId,
     errors: volume.getErrors('projectId'),
     class: 'google-project-id',
@@ -47,12 +48,13 @@
     errors: volume.getErrors('bucket'),
 }, bucketInput) }}
 
-{{ forms.textField({
+{{ forms.autosuggestField({
     label: "Subfolder"|t('google-cloud'),
     instructions: "If you want to use a bucket’s subfolder as a Volume, specify the path to use here."|t('google-cloud'),
     id: 'subfolder',
     class: 'ltr',
     name: 'subfolder',
+    suggestEnvVars: true,
     value: volume.subfolder,
     errors: volume.getErrors('subfolder'),
     required: false,