Add a new DataFrame::renameEach()

Author: stloyd

composer.json

@@ -204,6 +204,7 @@
     },
     "extra": {
         "google/apiclient-services": [
+            "Drive",
             "Sheets"
         ]
     },

composer.lock

@@ -71,10 +71,11 @@ $service = google_sheets(
 );
 
 $sheetName = 'Flow test sheet';
-$spreadsheetId = google_create_spreadsheet(
+$spreadsheet = google_create_spreadsheet(
     $service,
     'Flow test spreadsheet',
     $sheetName,
+    'random@gmail.com'
 );
 
 (new Flow())
@@ -89,6 +90,6 @@ $spreadsheetId = google_create_spreadsheet(
             )
         )
     )
-    ->write(to_google_sheet($service, $spreadsheetId, $sheetName))
+    ->write(to_google_sheet($service, $spreadsheet->spreadsheetId, $sheetName))
     ->run();
 ```

documentation/components/adapters/google-sheet.md

@@ -19,10 +19,11 @@
     Sheets::SPREADSHEETS
 );
 
-$spreadsheetId = google_create_spreadsheet(
+$spreadsheet = google_create_spreadsheet(
     $service,
     'Flow test spreadsheet',
     $sheetName = 'Flow test sheet',
+    'random@gmail.com'
 );
 
 data_frame()
@@ -34,10 +35,10 @@
         ['id' => 5, 'text' => 'lorem ipsum'],
         ['id' => 6, 'text' => 'lorem ipsum'],
     ]))
-    ->write(to_google_sheet($service, $spreadsheetId, $sheetName))
+    ->write(to_google_sheet($service, $spreadsheet->spreadsheetId, $sheetName))
     ->run();
 
 data_frame()
-    ->read(from_google_sheet($service, $spreadsheetId, $sheetName))
+    ->read(from_google_sheet($service, $spreadsheet->spreadsheetId, $sheetName))
     ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
     ->run();

examples/topics/data_reading/google_sheet/code.php

@@ -19,10 +19,11 @@
     Sheets::SPREADSHEETS
 );
 
-$spreadsheetId = google_create_spreadsheet(
+$spreadsheet = google_create_spreadsheet(
     $service,
     'Flow test spreadsheet',
     $sheetName = 'Flow test sheet',
+    'random@gmail.com'
 );
 
 data_frame()
@@ -34,7 +35,7 @@
         ['id' => 5, 'text' => 'lorem ipsum'],
         ['id' => 6, 'text' => 'lorem ipsum'],
     ]))
-    ->write(to_google_sheet($service, $spreadsheetId, $sheetName))
+    ->write(to_google_sheet($service, $spreadsheet->spreadsheetId, $sheetName))
     ->run();
 
 data_frame()

examples/topics/data_writing/google_sheet/code.php

@@ -38,6 +38,7 @@
     },
     "extra": {
         "google/apiclient-services": [
+            "Drive",
             "Sheets"
         ]
     },

src/adapter/etl-adapter-google-sheet/composer.json

@@ -6,7 +6,8 @@
 
 use Flow\ETL\Attribute\{DocumentationDSL, Module, Type};
 use Google\Client;
-use Google\Service\Sheets;
+use Google\Service\Drive\Permission;
+use Google\Service\{Drive, Sheets};
 
 /**
  * @param array{type: string, project_id: string, private_key_id: string, private_key: string, client_email: string, client_id: string, auth_uri: string, token_uri: string, auth_provider_x509_cert_url: string, client_x509_cert_url: string}|Sheets $auth_config
@@ -116,8 +117,12 @@ function google_sheets(string|array $auth_config, string|array $scopes) : Sheets
 }
 
 #[DocumentationDSL(module: Module::GOOGLE_SHEET, type: Type::HELPER)]
-function google_create_spreadsheet(array|Sheets $auth_config, string $spreadsheet_name, string $sheet_name) : string
-{
+function google_create_spreadsheet(
+    array|Sheets $auth_config,
+    string $spreadsheet_name,
+    string $sheet_name,
+    string $shareWithEmail,
+) : Sheets\Spreadsheet {
     if ($auth_config instanceof Sheets) {
         $sheets = $auth_config;
     } else {
@@ -139,5 +144,21 @@ function google_create_spreadsheet(array|Sheets $auth_config, string $spreadshee
         ])
     );
 
-    return $spreadsheet->spreadsheetId;
+    // Ensure required drive scope is applied
+    $sheets->getClient()->addScope(Drive::DRIVE);
+
+    $drive = new Drive($sheets->getClient());
+    $drive->permissions->create(
+        $spreadsheet->spreadsheetId,
+        new Permission(
+            [
+                'type' => 'user',
+                'role' => 'reader',
+                'emailAddress' => $shareWithEmail,
+            ]
+        ),
+        ['fields' => 'id']
+    );
+
+    return $spreadsheet;
 }

src/adapter/etl-adapter-google-sheet/src/Flow/ETL/Adapter/GoogleSheet/DSL/functions.php

@@ -40,12 +40,15 @@ protected function setUp() : void
             self::markTestSkipped('auth.json.dist file contains not valid JSON');
         }
 
-        $this->spreadsheetId = google_create_spreadsheet(
+        $spreadsheet = google_create_spreadsheet(
             $this->service,
             'Flow test spreadsheet',
             self::SHEET_NAME,
+            'random@gmail.com'
         );
 
+        $this->spreadsheetId = $spreadsheet->spreadsheetId;
+
         $this->clearTestSheet();
     }