Modify exceptions when a whitelist may be present

src/Core/Exception/NotFoundException.php

@@ -22,5 +22,15 @@
  */
 class NotFoundException extends ServiceException
 {
-
+    /**
+     * Allows overriding message for injection of Whitelist Notice.
+     *
+     * @param string $message the new message
+     * @return void
+     * @access private
+     */
+    public function setMessage($message)
+    {
+        $this->message = $message;
+    }
 }

src/Core/GrpcRequestWrapper.php

@@ -216,6 +216,7 @@ private function convertToGoogleException(ApiException $ex)
                 break;
 
             case Grpc\STATUS_NOT_FOUND:
+            case Grpc\STATUS_UNIMPLEMENTED:
                 $exception = Exception\NotFoundException::class;
                 break;
 

src/Core/GrpcTrait.php

@@ -19,9 +19,10 @@
 
 use DateTime;
 use DateTimeZone;
-use Google\Auth\FetchAuthTokenCache;
 use Google\Auth\Cache\MemoryCacheItemPool;
+use Google\Auth\FetchAuthTokenCache;
 use Google\Cloud\Core\ArrayTrait;
+use Google\Cloud\Core\Exception\NotFoundException;
 use Google\Cloud\Core\GrpcRequestWrapper;
 use google\protobuf;
 
@@ -31,6 +32,7 @@
 trait GrpcTrait
 {
     use ArrayTrait;
+    use WhitelistTrait;
 
     /**
      * @var GrpcRequestWrapper Wrapper used to handle sending requests to the
@@ -53,17 +55,26 @@ public function setRequestWrapper(GrpcRequestWrapper $requestWrapper)
      *
      * @param callable $request
      * @param array $args
+     * @param bool $whitelisted
      * @return \Generator|array
      */
-    public function send(callable $request, array $args)
+    public function send(callable $request, array $args, $whitelisted = false)
     {
         $requestOptions = $this->pluckArray([
             'grpcOptions',
             'retries',
             'requestTimeout'
         ], $args[count($args) - 1]);
 
-        return $this->requestWrapper->send($request, $args, $requestOptions);
+        try {
+            return $this->requestWrapper->send($request, $args, $requestOptions);
+        } catch (NotFoundException $e) {
+            if ($whitelisted) {
+                throw $this->modifyWhitelistedError($e);
+            }
+
+            throw $e;
+        }
     }
 
     /**

src/Core/RestTrait.php

@@ -17,13 +17,16 @@
 
 namespace Google\Cloud\Core;
 
+use Google\Cloud\Core\Exception\NotFoundException;
+
 /**
  * Provides shared functionality for REST service implementations.
  */
 trait RestTrait
 {
     use ArrayTrait;
     use JsonTrait;
+    use WhitelistTrait;
 
     /**
      * @var RequestBuilder Builds PSR7 requests from a service definition.
@@ -64,22 +67,31 @@ public function setRequestWrapper(RequestWrapper $requestWrapper)
      * @param string $resource The resource type used for the request.
      * @param string $method The method used for the request.
      * @param array $options [optional] Options used to build out the request.
+     * @param array $whitelisted [optional]
      * @return array
      */
-    public function send($resource, $method, array $options = [])
+    public function send($resource, $method, array $options = [], $whitelisted = false)
     {
         $requestOptions = $this->pluckArray([
             'restOptions',
             'retries',
             'requestTimeout'
         ], $options);
 
-        return json_decode(
-            $this->requestWrapper->send(
-                $this->requestBuilder->build($resource, $method, $options),
-                $requestOptions
-            )->getBody(),
-            true
-        );
+        try {
+            return json_decode(
+                $this->requestWrapper->send(
+                    $this->requestBuilder->build($resource, $method, $options),
+                    $requestOptions
+                )->getBody(),
+                true
+            );
+        } catch (NotFoundException $e) {
+            if ($whitelisted) {
+                throw $this->modifyWhitelistedError($e);
+            }
+
+            throw $e;
+        }
     }
 }

src/Core/WhitelistTrait.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright 2017 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.
+ */
+
+namespace Google\Cloud\Core;
+
+use Google\Cloud\Core\Exception\NotFoundException;
+
+/**
+ * Manages exceptions for requests which may have whitelist restrictions.
+ */
+trait WhitelistTrait
+{
+    /**
+     * Modify the error message of a whitelisted exception.
+     *
+     * @param NotFoundException $e The exception.
+     * @return NotFoundException
+     */
+    private function modifyWhitelistedError(NotFoundException $e)
+    {
+        $e->setMessage('NOTE: Error may be due to Whitelist Restriction. ' . $e->getMessage());
+
+        return $e;
+    }
+}

src/PubSub/Connection/Grpc.php

@@ -288,33 +288,36 @@ public function acknowledge(array $args)
      */
     public function listSnapshots(array $args)
     {
+        $whitelisted = true;
         return $this->send([$this->subscriberClient, 'listSnapshots'], [
             $this->pluck('project', $args),
             $args
-        ]);
+        ], $whitelisted);
     }
 
     /**
      * @param array $args
      */
     public function createSnapshot(array $args)
     {
+        $whitelisted = true;
         return $this->send([$this->subscriberClient, 'createSnapshot'], [
             $this->pluck('name', $args),
             $this->pluck('subscription', $args),
             $args
-        ]);
+        ], $whitelisted);
     }
 
     /**
      * @param array $args
      */
     public function deleteSnapshot(array $args)
     {
+        $whitelisted = true;
         return $this->send([$this->subscriberClient, 'deleteSnapshot'], [
             $this->pluck('snapshot', $args),
             $args
-        ]);
+        ], $whitelisted);
     }
 
     /**
@@ -327,10 +330,11 @@ public function seek(array $args)
             $args['time'] = (new protobuf\Timestamp)->deserialize($time, $this->codec);
         }
 
+        $whitelisted = true;
         return $this->send([$this->subscriberClient, 'seek'], [
             $this->pluck('subscription', $args),
             $args
-        ]);
+        ], $whitelisted);
     }
 
     /**

src/PubSub/Connection/Rest.php

@@ -214,31 +214,35 @@ public function acknowledge(array $args)
      */
     public function listSnapshots(array $args)
     {
-        return $this->send('snapshots', 'list', $args);
+        $whitelisted = true;
+        return $this->send('snapshots', 'list', $args, $whitelisted);
     }
 
     /**
      * @param array $args
      */
     public function createSnapshot(array $args)
     {
-        return $this->send('snapshots', 'create', $args);
+        $whitelisted = true;
+        return $this->send('snapshots', 'create', $args, $whitelisted);
     }
 
     /**
      * @param array $args
      */
     public function deleteSnapshot(array $args)
     {
-        return $this->send('snapshots', 'delete', $args);
+        $whitelisted = true;
+        return $this->send('snapshots', 'delete', $args, $whitelisted);
     }
 
     /**
      * @param array $args
      */
     public function seek(array $args)
     {
-        return $this->send('subscriptions', 'seek', $args);
+        $whitelisted = true;
+        return $this->send('subscriptions', 'seek', $args, $whitelisted);
     }
 
     /**