feat: [DocumentAI] add quickstart sample (#1767)

Author: holtskinner

.gitignore

@@ -12,3 +12,4 @@ credentials.*
 .vscode/
 .kokoro/secrets.sh
 .phpunit.result.cache
+.DS_Store

.kokoro/secrets-example.sh

@@ -74,6 +74,9 @@ export DATASTORE_EVENTUALLY_CONSISTENT_RETRY_COUNT=
 export DLP_DEID_WRAPPED_KEY=
 export DLP_DEID_KEY_NAME=projects/$GOOGLE_PROJECT_ID/locations/global/keyRings/ci/cryptoKeys/ci
 
+# DocumentAI
+export GOOGLE_DOCUMENTAI_PROCESSOR_ID=
+
 # Firestore
 export FIRESTORE_PROJECT_ID=
 

.kokoro/secrets.sh.enc

@@ -0,0 +1,50 @@
+# Google Cloud Document AI Samples
+
+[![Open in Cloud Shell][shell_img]][shell_link]
+
+[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
+[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=documentai
+
+These samples show how to use the [Google Cloud Document AI][document-ai]
+
+This repository contains samples that use the [Cloud Document AI Client
+Library for PHP][google-cloud-php-documentai] to make REST calls as well as
+contains samples using the more-efficient (though sometimes more
+complex) [GRPC][grpc] API. The GRPC API also allows streaming requests.
+
+## Installation
+
+Install the dependencies for this library via [composer](https://getcomposer.org)
+
+    $ cd /path/to/php-docs-samples/documentai
+    $ composer install
+
+Configure your project using [Application Default Credentials][adc]
+
+    $ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
+
+## Usage
+
+Run `php src/SNIPPET_NAME.php`. The usage will print for each if no arguments
+are provided:
+
+## Troubleshooting
+
+If you get the following error, set the environment variable `GCLOUD_PROJECT` to your project ID:
+
+```
+[Google\Cloud\Core\Exception\GoogleException]
+No project ID was provided, and we were unable to detect a default project ID.
+```
+
+If you have not set a timezone you may get an error from php. This can be resolved by:
+
+  1. Finding where the php.ini is stored by running php -i | grep 'Configuration File'
+  1. Finding out your timezone from the list on this page: http://php.net/manual/en/timezones.php
+  1. Editing the php.ini file (or creating one if it doesn't exist)
+  1. Adding the timezone to the php.ini file e.g., adding the following line: date.timezone = "America/Los_Angeles"
+
+[document-ai]: https://cloud.google.com/document-ai/docs/overview
+[google-cloud-php-documentai]: https://cloud.google.com/php/docs/reference/cloud-document-ai/latest
+[grpc]: http://grpc.io
+[adc]: https://developers.google.com/identity/protocols/application-default-credentials

documentai/README.md

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-document-ai": "^1.0.1"
+    }
+}

documentai/composer.json

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2023 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.
+-->
+<phpunit bootstrap="../testing/bootstrap.php">
+    <testsuites>
+        <testsuite name="PHP documentai test">
+            <directory>test</directory>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./src</directory>
+            <file>quickstart.php</file>
+            <exclude>
+              <directory>./vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="PHPUNIT_TESTS" value="1"/>
+    </php>
+</phpunit>

documentai/phpunit.xml.dist

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright 2023 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.
+ */
+
+# [START documentai_quickstart]
+# Includes the autoloader for libraries installed with composer
+require __DIR__ . '/vendor/autoload.php';
+
+# Imports the Google Cloud client library
+use Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient;
+use Google\Cloud\DocumentAI\V1\RawDocument;
+
+$projectId = 'YOUR_PROJECT_ID'; # Your Google Cloud Platform project ID
+$location = 'us'; # Your Processor Location
+$processor = 'YOUR_PROCESSOR_ID'; # Your Processor ID
+
+# Create Client
+$client = new DocumentProcessorServiceClient();
+
+# Local File Path
+$documentPath = 'resources/invoice.pdf';
+
+# Read in File Contents
+$handle = fopen($documentPath, 'rb');
+$contents = fread($handle, filesize($documentPath));
+fclose($handle);
+
+# Load File Contents into RawDocument
+$rawDocument = new RawDocument([
+    'content' => $contents,
+    'mime_type' => 'application/pdf'
+]);
+
+# Fully-qualified Processor Name
+$name = $client->processorName($projectId, $location, $processor);
+
+# Make Processing Request
+$response = $client->processDocument($name, [
+    'rawDocument' => $rawDocument
+]);
+
+# Print Document Text
+printf('Document Text: %s', $response->getDocument()->getText());
+
+# [END documentai_quickstart]

documentai/quickstart.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright 2023 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.
+ */
+use Google\Cloud\TestUtils\TestTrait;
+use PHPUnit\Framework\TestCase;
+
+class quickstartTest extends TestCase
+{
+    use TestTrait;
+
+    protected static $tempFile;
+
+    public function setUp(): void
+    {
+        $processorId = $this->requireEnv('GOOGLE_DOCUMENTAI_PROCESSOR_ID');
+        self::$tempFile = sys_get_temp_dir() . '/documentai_quickstart.php';
+        $contents = file_get_contents(__DIR__ . '/../quickstart.php');
+        $contents = str_replace(
+            ['YOUR_PROJECT_ID', 'YOUR_PROCESSOR_ID', '__DIR__'],
+            [self::$projectId, $processorId, sprintf('"%s/.."', __DIR__)],
+            $contents
+        );
+        file_put_contents(self::$tempFile, $contents);
+    }
+
+    public function testQuickstart()
+    {
+        // Invoke quickstart.php
+        $output = $this->runSnippet(self::$tempFile);
+
+        $this->assertStringContainsString('Invoice', $output);
+    }
+}