feat: sample for authenticating GAPIC clients with an API key (#1990)

Author: bshaffer

auth/composer.json

@@ -2,6 +2,7 @@
     "require": {
         "google/apiclient": "^2.1",
         "google/cloud-storage": "^1.3",
+        "google/cloud-vision": "^1.9",
         "google/auth":"^1.0"
     },
     "scripts": {

auth/src/auth_cloud_apikey.php

@@ -0,0 +1,75 @@
+<?php
+/**
+ * Copyright 2024 Google Inc.
+ *
+ * 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.
+ */
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/auth/README.md
+ */
+
+# [START auth_cloud_apikey]
+namespace Google\Cloud\Samples\Auth;
+
+use Google\ApiCore\ApiException;
+use Google\ApiCore\InsecureCredentialsWrapper;
+use Google\ApiCore\PagedListResponse;
+use Google\Cloud\Vision\V1\Client\ProductSearchClient;
+use Google\Cloud\Vision\V1\ListProductsRequest;
+use Google\Cloud\Vision\V1\Product;
+
+/**
+ * Authenticate to a cloud API using an API key explicitly.
+ * Note: This only works for APIs with support for API keys.
+ *
+ * @param string $projectId     The Google Cloud project ID.
+ * @param string $location      The location name.
+ * @param string $apiKey        The API key.
+ */
+function auth_cloud_apikey(string $projectId, string $location, string $apiKey): void
+{
+    $formattedParent = ProductSearchClient::locationName($projectId, $location);
+
+    // Create a client.
+    $productSearchClient = new ProductSearchClient([
+        // STEP 1: Use an insecure credentials wrapper to bypass the application default credentials.
+        'credentials' => new InsecureCredentialsWrapper(),
+    ]);
+
+    // Prepare the request message.
+    $request = (new ListProductsRequest())
+        ->setParent($formattedParent);
+
+    // Call the API and handle any network failures.
+    try {
+        /** @var PagedListResponse $response */
+        $response = $productSearchClient->listProducts($request, [
+            // STEP 2: Pass in the API key with each RPC call as a "Call Option"
+            'headers' => ['x-goog-api-key' => [$apiKey]],
+        ]);
+
+        /** @var Product $element */
+        foreach ($response as $element) {
+            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
+        }
+    } catch (ApiException $ex) {
+        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
+    }
+}
+# [END auth_cloud_apikey]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/test/authTest.php

@@ -86,4 +86,14 @@ public function testAuthHttpExplicitCommand()
         ]);
         $this->assertStringContainsString(self::$bucketName, $output);
     }
+
+    public function testAuthCloudApiKey()
+    {
+        $output = $this->runFunctionSnippet('auth_cloud_apikey', [
+            'projectId' => self::$projectId,
+            'location' => 'us-central1',
+            'apiKey' => 'abc', // fake API key
+        ]);
+        $this->assertStringContainsString('API_KEY_INVALID', $output);
+    }
 }