Add option to toggle API format version (#1644)

* Add option to toggle API format version

* Fix tests

* Use phpunit mock

* Force trusty in builds

* Fix style

Author: jdpedrie

.travis.yml

@@ -1,4 +1,5 @@
 language: php
+dist: trusty
 
 services:
   - memcached
@@ -44,4 +45,3 @@ before_script:
 script:
   - vendor/bin/phpunit
   - if [[ "$RUN_PHP_CS" == "true" ]]; then vendor/bin/phpcs src --standard=style/ruleset.xml -np; fi
-

src/Google/Client.php

@@ -142,6 +142,10 @@ public function __construct(array $config = array())
           // Service class used in Google_Client::verifyIdToken.
           // Explicitly pass this in to avoid setting JWT::$leeway
           'jwt' => null,
+
+          // Setting api_format_v2 will return more detailed error messages
+          // from certain APIs.
+          'api_format_v2' => false
         ],
         $config
     );
@@ -796,6 +800,13 @@ public function execute(RequestInterface $request, $expectedClass = null)
         . $this->getLibraryVersion()
     );
 
+    if ($this->config['api_format_v2']) {
+        $request = $request->withHeader(
+            'X-GOOG-API-FORMAT-VERSION',
+            2
+        );
+    }
+
     // call the authorize method
     // this is where most of the grunt work is done
     $http = $this->authorize();
@@ -1056,6 +1067,18 @@ public function getHttpClient()
     return $this->http;
   }
 
+  /**
+   * Set the API format version.
+   *
+   * `true` will use V2, which may return more useful error messages.
+   *
+   * @param bool $value
+   */
+  public function setApiFormatV2($value)
+  {
+    $this->config['api_format_v2'] = (bool) $value;
+  }
+
   protected function createDefaultHttpClient()
   {
     $options = ['exceptions' => false];

tests/Google/ClientTest.php

@@ -19,8 +19,10 @@
  */
 
 use GuzzleHttp\Client;
-use GuzzleHttp\Event\RequestEvents;
-use Psr\Http\Message\Request;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use Prophecy\Argument;
+use Psr\Http\Message\RequestInterface;
 
 class Google_ClientTest extends BaseTest
 {
@@ -684,4 +686,25 @@ public function testTokenCallback()
 
     $this->assertTrue($called);
   }
+
+  public function testExecuteWithFormat()
+  {
+    $this->onlyGuzzle6();
+
+    $client = new Google_Client([
+      'api_format_v2' => true
+    ]);
+
+    $guzzle = $this->getMock('GuzzleHttp\Client');
+    $guzzle->expects($this->once())
+      ->method('send')
+      ->with($this->callback(function (RequestInterface $request) {
+        return $request->getHeaderLine('X-GOOG-API-FORMAT-VERSION') === '2';
+      }))->will($this->returnValue(new Response(200, [], null)));
+
+    $client->setHttpClient($guzzle);
+
+    $request = new Request('POST', 'http://foo.bar/');
+    $client->execute($request);
+  }
 }