From 6bcbc39a22bffe3231da05a199cee5c1f5befcb5 Mon Sep 17 00:00:00 2001
From: Pedro Carmo <pedro.carmo@kununu.com>
Date: Thu, 23 May 2024 18:03:55 +0100
Subject: [PATCH] Add interfaces to be possible the mock of the client, batch
 and service

---
 src/Client.php                | 15 ++++---
 src/GoogleClientInterface.php | 75 +++++++++++++++++++++++++++++++++++
 src/Http/Batch.php            |  8 ++--
 src/Http/BatchInterface.php   | 14 +++++++
 src/Service.php               | 11 ++---
 src/ServiceInterface.php      | 10 +++++
 6 files changed, 116 insertions(+), 17 deletions(-)
 create mode 100644 src/GoogleClientInterface.php
 create mode 100644 src/Http/BatchInterface.php
 create mode 100644 src/ServiceInterface.php

diff --git a/src/Client.php b/src/Client.php
index c7724bd08..c46df16b3 100644
--- a/src/Client.php
+++ b/src/Client.php
@@ -50,7 +50,7 @@
  * The Google API Client
  * https://github.com/google/google-api-php-client
  */
-class Client
+class Client implements GoogleClientInterface
 {
     const LIBVER = "2.12.6";
     const USER_AGENT_SUFFIX = "google-api-php-client/";
@@ -65,7 +65,7 @@ class Client
     private $auth;
 
     /**
-     * @var ClientInterface $http
+     * @var GoogleClientInterface $http
      */
     private $http;
 
@@ -312,7 +312,7 @@ public function refreshTokenWithAssertion()
 
     /**
      * Fetches a fresh access token with a given assertion token.
-     * @param ClientInterface $authHttp optional.
+     * @param GoogleClientInterface $authHttp optional.
      * @return array access token
      */
     public function fetchAccessTokenWithAssertion(ClientInterface $authHttp = null)
@@ -444,9 +444,8 @@ public function createAuthUrl($scope = null, array $queryParams = [])
     /**
      * Adds auth listeners to the HTTP client based on the credentials
      * set in the Google API Client object
-     *
-     * @param ClientInterface $http the http client object.
-     * @return ClientInterface the http client object
+     * @param GoogleClientInterface $http the http client object.
+     * @return GoogleClientInterface the http client object
      */
     public function authorize(ClientInterface $http = null)
     {
@@ -1193,7 +1192,7 @@ protected function createDefaultCache()
 
     /**
      * Set the Http Client object
-     * @param ClientInterface $http
+     * @param GoogleClientInterface $http
      */
     public function setHttpClient(ClientInterface $http)
     {
@@ -1201,7 +1200,7 @@ public function setHttpClient(ClientInterface $http)
     }
 
     /**
-     * @return ClientInterface
+     * @return GoogleClientInterface
      */
     public function getHttpClient()
     {
diff --git a/src/GoogleClientInterface.php b/src/GoogleClientInterface.php
new file mode 100644
index 000000000..143180c14
--- /dev/null
+++ b/src/GoogleClientInterface.php
@@ -0,0 +1,75 @@
+<?php
+declare(strict_types=1);
+
+namespace Google;
+
+use GuzzleHttp\ClientInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Psr\Http\Message\RequestInterface;
+use Psr\Log\LoggerInterface;
+
+interface GoogleClientInterface
+{
+    public function __construct(array $config = []);
+    public function getLibraryVersion();
+    public function authenticate($code);
+    public function fetchAccessTokenWithAuthCode($code, $codeVerifier = null);
+    public function refreshTokenWithAssertion();
+    public function fetchAccessTokenWithAssertion(ClientInterface $authHttp = null);
+    public function refreshToken($refreshToken);
+    public function fetchAccessTokenWithRefreshToken($refreshToken = null);
+    public function createAuthUrl($scope = null, array $queryParams = []);
+    public function authorize(ClientInterface $http = null);
+    public function useApplicationDefaultCredentials($useAppCreds = true);
+    public function isUsingApplicationDefaultCredentials();
+    public function setAccessToken($token);
+    public function getAccessToken();
+    public function getRefreshToken();
+    public function isAccessTokenExpired();
+    public function getAuth();
+    public function setAuth($auth);
+    public function setClientId($clientId);
+    public function getClientId();
+    public function setClientSecret($clientSecret);
+    public function getClientSecret();
+    public function setRedirectUri($redirectUri);
+    public function getRedirectUri();
+    public function setState($state);
+    public function setAccessType($accessType);
+    public function setApprovalPrompt($approvalPrompt);
+    public function setLoginHint($loginHint);
+    public function setApplicationName($applicationName);
+    public function setRequestVisibleActions($requestVisibleActions);
+    public function setDeveloperKey($developerKey);
+    public function setHostedDomain($hd);
+    public function setPrompt($prompt);
+    public function setOpenidRealm($realm);
+    public function setIncludeGrantedScopes($include);
+    public function setTokenCallback(callable $tokenCallback);
+    public function revokeToken($token = null);
+    public function verifyIdToken($idToken = null);
+    public function setScopes($scope_or_scopes);
+    public function addScope($scope_or_scopes);
+    public function getScopes();
+    public function prepareScopes();
+    public function execute(RequestInterface $request, $expectedClass = null);
+    public function setUseBatch($useBatch);
+    public function isAppEngine();
+    public function setConfig($name, $value);
+    public function getConfig($name, $default = null);
+    public function setAuthConfigFile($file);
+    public function setAuthConfig($config);
+    public function setSubject($subject);
+    public function setDefer($defer);
+    public function shouldDefer();
+    public function getOAuth2Service();
+    public function setCache(CacheItemPoolInterface $cache);
+    public function getCache();
+    public function setCacheConfig(array $cacheConfig);
+    public function setLogger(LoggerInterface $logger);
+    public function getLogger();
+    public function setHttpClient(ClientInterface $http);
+    public function getHttpClient();
+    public function setApiFormatV2($value);
+    public function getUniverseDomain();
+}
diff --git a/src/Http/Batch.php b/src/Http/Batch.php
index d16708f20..406b338a0 100644
--- a/src/Http/Batch.php
+++ b/src/Http/Batch.php
@@ -17,7 +17,7 @@
 
 namespace Google\Http;
 
-use Google\Client;
+use Google\GoogleClientInterface;
 use Google\Service\Exception as GoogleServiceException;
 use GuzzleHttp\Psr7;
 use GuzzleHttp\Psr7\Request;
@@ -32,7 +32,7 @@
  * requests. To start a new batch, be sure to create a new instance of this
  * class.
  */
-class Batch
+class Batch implements BatchInterface
 {
     const BATCH_PATH = 'batch';
 
@@ -47,7 +47,7 @@ class Batch
     /** @var array service requests to be executed. */
     private $requests = [];
 
-    /** @var Client */
+    /** @var GoogleClientInterface */
     private $client;
 
     private $rootUrl;
@@ -55,7 +55,7 @@ class Batch
     private $batchPath;
 
     public function __construct(
-        Client $client,
+        GoogleClientInterface $client,
         $boundary = false,
         $rootUrl = null,
         $batchPath = null
diff --git a/src/Http/BatchInterface.php b/src/Http/BatchInterface.php
new file mode 100644
index 000000000..fb8e3b8c9
--- /dev/null
+++ b/src/Http/BatchInterface.php
@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace Google\Http;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+interface BatchInterface
+{
+    public function add(RequestInterface $request, $key = false);
+    public function execute();
+    public function parseResponse(ResponseInterface $response, $classes = []);
+}
diff --git a/src/Service.php b/src/Service.php
index 8c8fe5fa7..cd9ac2d8a 100644
--- a/src/Service.php
+++ b/src/Service.php
@@ -18,9 +18,10 @@
 namespace Google;
 
 use Google\Http\Batch;
+use Google\Http\BatchInterface;
 use TypeError;
 
-class Service
+class Service implements ServiceInterface
 {
     public $batchPath;
     /**
@@ -37,7 +38,7 @@ class Service
 
     public function __construct($clientOrConfig = [])
     {
-        if ($clientOrConfig instanceof Client) {
+        if ($clientOrConfig instanceof GoogleClientInterface) {
             $this->client = $clientOrConfig;
         } elseif (is_array($clientOrConfig)) {
             $this->client = new Client($clientOrConfig ?: []);
@@ -51,8 +52,8 @@ public function __construct($clientOrConfig = [])
     }
 
     /**
-   * Return the associated Google\Client class.
-   * @return \Google\Client
+   * Return the associated Google\GoogleClientInterface class.
+   * @return \Google\GoogleClientInterface
    */
     public function getClient()
     {
@@ -62,7 +63,7 @@ public function getClient()
     /**
    * Create a new HTTP Batch handler for this service
    *
-   * @return Batch
+   * @return BatchInterface
    */
     public function createBatch()
     {
diff --git a/src/ServiceInterface.php b/src/ServiceInterface.php
new file mode 100644
index 000000000..8a3fbb56f
--- /dev/null
+++ b/src/ServiceInterface.php
@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace Google;
+
+interface ServiceInterface
+{
+    public function getClient();
+    public function createBatch();
+}