feat(compute): add cloud-client compute sample (GoogleCloudPlatform#1305)

bshaffer · web-flow · commit 22dc3a344e2a · 2021-03-19T15:39:54.000-07:00
diff --git a/compute/helloworld/README.md b/compute/helloworld/README.md
@@ -2,44 +2,9 @@
 
 ## Description
 This is a simple web-based example of calling the Google Compute Engine API
-in PHP.
+in PHP. These samples include calling the API with both the
+[Google API client](api-client) and [Google Cloud Client](cloud-client) (alpha).
 
-## Prerequisites
-Please make sure that all of the following is installed before trying to run
-the sample application.
 
-- [PHP 5.2.x or higher](http://www.php.net/)
-- [PHP Curl extension](http://www.php.net/manual/en/intro.curl.php)
-- [PHP JSON extension](http://php.net/manual/en/book.json.php)
-- The [`google-api-php-client`](https://github.com/google/google-api-php-client)
-  library checked out locally
-
-## Setup Authentication
-NOTE: This README assumes that you have enabled access to the Google Compute
-Engine API via the Google API Console page.
-
-1) Visit https://code.google.com/apis/console/?api=compute to register your
-application.
-- Click on "API Access" in the left column
-- Click the button labeled "Create an OAuth2 client ID..." if you have not
-  generated any client IDs, or "Create another client ID..." if you have
-- Give your application a name and click "Next"
-- Select "Web Application" as the "Application type"
-- Click "Create client ID"
-- Click "Edit settings..." for your new client ID
-- Under the redirect URI, enter the location of your application
-- Click "Update"
-- Click on "Overview" in the left column and note the Project ID
-
-2) Update app.php with the redirect uri, consumer key, secret, and Project ID
-obtained in step 1.
-- Update `YOUR_CLIENT_ID` with your oauth2 client id.
-- Update `YOUR_CLIENT_SECRET` with your oauth2 client secret.
-- Update `YOUR_REDIRECT_URI` with the fully qualified
-  redirect URI.
-- Update `YOUR_GOOGLE_COMPUTE_ENGINE_PROJECT` with your Project ID from the
-  API Console.
-
-## Running the Sample Application
-3) Load app.php on your web server, and visit the appropriate website in
-your web browser.
+ * [Google Cloud Client](cloud-client) (**Recommended**): Under active development, currently in alpha.
+ * [Google API client](api-client): Stable and generally available, but no longer under active development
diff --git a/compute/helloworld/api-client/README.md b/compute/helloworld/api-client/README.md
@@ -0,0 +1,45 @@
+# Google Compute Engine PHP Sample Application
+
+## Description
+This is a simple web-based example of calling the Google Compute Engine API
+in PHP.
+
+## Prerequisites
+Please make sure that all of the following is installed before trying to run
+the sample application.
+
+- [PHP 5.2.x or higher](http://www.php.net/)
+- [PHP Curl extension](http://www.php.net/manual/en/intro.curl.php)
+- [PHP JSON extension](http://php.net/manual/en/book.json.php)
+- The [`google-api-php-client`](https://github.com/google/google-api-php-client)
+  library checked out locally
+
+## Setup Authentication
+NOTE: This README assumes that you have enabled access to the Google Compute
+Engine API via the Google API Console page.
+
+1) Visit https://code.google.com/apis/console/?api=compute to register your
+application.
+- Click on "API Access" in the left column
+- Click the button labeled "Create an OAuth2 client ID..." if you have not
+  generated any client IDs, or "Create another client ID..." if you have
+- Give your application a name and click "Next"
+- Select "Web Application" as the "Application type"
+- Click "Create client ID"
+- Click "Edit settings..." for your new client ID
+- Under the redirect URI, enter the location of your application
+- Click "Update"
+- Click on "Overview" in the left column and note the Project ID
+
+2) Update app.php with the redirect uri, consumer key, secret, and Project ID
+obtained in step 1.
+- Update `YOUR_CLIENT_ID` with your oauth2 client id.
+- Update `YOUR_CLIENT_SECRET` with your oauth2 client secret.
+- Update `YOUR_REDIRECT_URI` with the fully qualified
+  redirect URI.
+- Update `YOUR_GOOGLE_COMPUTE_ENGINE_PROJECT` with your Project ID from the
+  API Console.
+
+## Running the Sample Application
+3) Load app.php on your web server, and visit the appropriate website in
+your web browser.
diff --git a/compute/helloworld/api-client/app.php b/compute/helloworld/api-client/app.php
diff --git a/compute/helloworld/api-client/composer.json b/compute/helloworld/api-client/composer.json
@@ -0,0 +1,13 @@
+{
+    "require": {
+        "google/apiclient": "^2.9"
+    },
+    "scripts": {
+        "pre-autoload-dump": "Google\\Task\\Composer::cleanup"
+    },
+    "extra": {
+        "google/apiclient-services": [
+            "Compute"
+        ]
+    }
+}
diff --git a/compute/helloworld/cloud-client/README.md b/compute/helloworld/cloud-client/README.md
@@ -0,0 +1,22 @@
+# Google Compute Engine PHP Sample Application
+
+## Description
+
+This is a simple web-based example of calling the Google Compute Engine API
+in PHP.
+
+## Prerequisites
+
+ * Run `composer install` in this directory to install the `google/cloud-compute`
+library.
+ * Follow [Getting started with authentication](https://cloud.google.com/docs/authentication/getting-started) to authenticate with Service Account credentials.
+
+## Running the Sample Application
+
+Run app.php on your web server:
+
+```
+php -S localhost:8080
+```
+
+Visit the website (http://localhost:8080/app.php) in your web browser.
diff --git a/compute/helloworld/cloud-client/app.php b/compute/helloworld/cloud-client/app.php
@@ -0,0 +1,162 @@
+<?php
+/*
+ * Copyright 2021 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.
+ */
+
+require_once 'vendor/autoload.php';
+
+use Google\Cloud\Compute\V1\InstancesClient;
+use Google\Cloud\Compute\V1\ZonesClient;
+use Google\Cloud\Compute\V1\MachineTypesClient;
+use Google\Cloud\Compute\V1\ImagesClient;
+use Google\Cloud\Compute\V1\FirewallsClient;
+use Google\Cloud\Compute\V1\NetworksClient;
+use Google\Cloud\Compute\V1\DisksClient;
+use Google\Cloud\Compute\V1\GlobalOperationsClient;
+use Google\Protobuf\Internal\Message;
+
+/**
+ * Set these variables to your project and zone.
+ */
+$projectId = 'php-docs-samples-kokoro';
+$zoneName = 'us-central1-f';
+
+// Instantiate clients for calling the Compute API.
+$instancesClient = new InstancesClient();
+$zonesClient = new ZonesClient();
+$disksClient = new DisksClient();
+$machineTypesClient = new MachineTypesClient();
+$imagesClient = new ImagesClient();
+$firewallsClient = new FirewallsClient();
+$networksClient = new NetworksClient();
+$globalOperationsClient = new GlobalOperationsClient();
+
+/**
+ * Helper function to pretty-print a Protobuf message.
+ */
+function print_message(Message $message)
+{
+    return json_encode(
+        json_decode($message->serializeToJsonString(), true),
+        JSON_PRETTY_PRINT
+    );
+}
+?>
+<!doctype html>
+<html>
+    <head><meta charset="utf-8"></head>
+    <body>
+        <header><h1>Google Cloud Compute Sample App</h1></header>
+        <div class="main-content">
+            <h2 class="collapsible">List Instances</h2>
+            <div id="listInstances" class="collapsible-content">
+                <?php foreach ($instancesClient->list_($projectId, $zoneName) as $instance): ?>
+                    <pre><?= print_message($instance) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Zones</h2>
+            <div id="listZones" class="collapsible-content">
+                <?php foreach ($zonesClient->list_($projectId) as $zone): ?>
+                    <pre><?= print_message($zone) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Disks</h2>
+            <div id="listDisks" class="collapsible-content">
+                <?php foreach ($disksClient->list_($projectId, $zoneName) as $disk): ?>
+                    <pre><?= print_message($disk) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Machine Types</h2>
+            <div id="listMachineTypes" class="collapsible-content">
+                <?php foreach ($machineTypesClient->list_($projectId, $zoneName) as $machineType): ?>
+                    <pre><?= print_message($machineType) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Images</h2>
+            <div id="listImages" class="collapsible-content">
+                <?php foreach ($imagesClient->list_($projectId) as $image): ?>
+                    <pre><?= print_message($image) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Firewalls</h2>
+            <div id="listFirewalls" class="collapsible-content">
+                <?php foreach ($firewalls = $firewallsClient->list_($projectId) as $firewall): ?>
+                    <pre><?= print_message($firewall) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Networks</h2>
+            <div id="listNetworks" class="collapsible-content">
+                <?php foreach ($networksClient->list_($projectId) as $network): ?>
+                    <pre><?= print_message($network) ?></pre>
+                <?php endforeach ?>
+            </div>
+
+            <h2 class="collapsible">List Operations</h2>
+            <div id="listGlobalOperations" class="collapsible-content">
+                <?php foreach ($globalOperationsClient->list_($projectId) as $operation): ?>
+                    <pre><?= print_message($operation) ?></pre>
+                <?php endforeach ?>
+            </div>
+        </div>
+    </body>
+</html>
+
+<style>
+.collapsible {
+  background-color: #eee;
+  color: #444;
+  cursor: pointer;
+  padding: 18px;
+  width: 100%;
+  border: none;
+  text-align: left;
+  outline: none;
+  font-size: 15px;
+}
+
+.active, .collapsible:hover {
+  background-color: #ccc;
+}
+
+.collapsible-content {
+  padding: 0 18px;
+  display: none;
+  overflow: hidden;
+  background-color: #f1f1f1;
+}
+</style>
+
+<script>
+  var coll = document.getElementsByClassName("collapsible");
+  var i;
+
+  for (i = 0; i < coll.length; i++) {
+    coll[i].addEventListener("click", function() {
+      this.classList.toggle("active");
+      var content = this.nextElementSibling;
+      if (content.style.display === "block") {
+        content.style.display = "none";
+      } else {
+        content.style.display = "block";
+      }
+    });
+  }
+</script>
diff --git a/compute/helloworld/cloud-client/composer.json b/compute/helloworld/cloud-client/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-compute": "^0.1.0"
+    }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "require": {
 +        "google/cloud-compute": "^0.1.0"
 +    }
 +}