Introduction of Auth Handlers per API client (#344)

* Introduce structure to allow credentials to be injected into clients

* Import trait into all of the clients. Add a test in anticipation of the factories generating clients

* Added preferred types for individual clients where possible

* take out oauth as it isnt being used yet

* more oauth removals

* remove the preferred trait. Instead we're going to use a handler in the API resource

* More unused imports, refactored account API to take out the marked secret deprecations

* fix tests to pull out the secrets from the account API

* make me more modern php please

* This should technically cover the structure of auth before rolling out the factories

* WIP

* More WIP

* Add handlers for all remaining clients

* Add handlers in the test mocks

* Mountain of deprecations and rewrites of failing tests

Author: SecondeJK

src/Account/Client.php

@@ -38,64 +38,18 @@ class Client implements ClientAwareInterface, APIClient
     use ClientAwareTrait;
 
     /**
-     * @var APIResource
+     * @var APIResource|null
      */
-    protected $accountAPI;
+    protected ?APIResource $accountAPI;
 
-    /**
-     * @var APIResource
-     */
-    protected $secretsAPI;
-
-    public function __construct(?APIResource $accountAPI = null, ?APIResource $secretsAPI = null)
+    public function __construct(?APIResource $accountAPI = null)
     {
         $this->accountAPI = $accountAPI;
-        $this->secretsAPI = $secretsAPI;
-    }
-
-    /**
-     * Shim to handle older instantiations of this class
-     *
-     * @deprecated Will remove in v3
-     */
-    public function getAccountAPI(): APIResource
-    {
-        if (is_null($this->accountAPI)) {
-            $api = new APIResource();
-            $api->setClient($this->getClient())
-                ->setBaseUrl($this->getClient()->getRestUrl())
-                ->setIsHAL(false)
-                ->setBaseUri('/account')
-                ->setCollectionName('');
-            $this->accountAPI = $api;
-        }
-
-        return clone $this->accountAPI;
     }
 
     public function getAPIResource(): APIResource
     {
-        return $this->getAccountAPI();
-    }
-
-    /**
-     * Shim to handle older instantiations of this class
-     *
-     * @deprecated Will remove in v3
-     */
-    public function getSecretsAPI(): APIResource
-    {
-        if (is_null($this->secretsAPI)) {
-            $api = new APIResource();
-            $api->setClient($this->getClient())
-                ->setBaseUrl($this->getClient()->getApiUrl())
-                ->setIsHAL(false)
-                ->setBaseUri('/accounts')
-                ->setCollectionName('');
-            $this->secretsAPI = $api;
-        }
-
-        return clone $this->secretsAPI;
+        return $this->accountAPI;
     }
 
     /**
@@ -105,7 +59,7 @@ public function getSecretsAPI(): APIResource
      */
     public function getPrefixPricing($prefix): array
     {
-        $api = $this->getAccountAPI();
+        $api = $this->getAPIResource();
         $api->setBaseUri('/account/get-prefix-pricing/outbound');
         $api->setCollectionName('prices');
 
@@ -171,7 +125,7 @@ public function getVoicePrice(string $country): VoicePrice
      */
     protected function makePricingRequest($country, $pricingType): array
     {
-        $api = $this->getAccountAPI();
+        $api = $this->getAPIResource();
         $api->setBaseUri('/account/get-pricing/outbound/' . $pricingType);
         $results = $api->search(new KeyValueFilter(['country' => $country]));
         $data = $results->getPageData();
@@ -194,7 +148,7 @@ protected function makePricingRequest($country, $pricingType): array
      */
     public function getBalance(): Balance
     {
-        $data = $this->getAccountAPI()->get('get-balance', [], ['accept' => 'application/json']);
+        $data = $this->getAPIResource()->get('get-balance', [], ['accept' => 'application/json']);
 
         if (is_null($data)) {
             throw new ClientException\Server('No results found');
@@ -209,7 +163,8 @@ public function getBalance(): Balance
      */
     public function topUp($trx): void
     {
-        $api = $this->getAccountAPI();
+        $api = $this->getAPIResource();
+        // @TODO why is this re-setting the base URL
         $api->setBaseUri('/account/top-up');
         $api->submit(['trx' => $trx]);
     }
@@ -223,7 +178,7 @@ public function topUp($trx): void
      */
     public function getConfig(): Config
     {
-        $api = $this->getAccountAPI();
+        $api = $this->getAPIResource();
         $api->setBaseUri('/account/settings');
         $body = $api->submit();
 
@@ -262,7 +217,7 @@ public function updateConfig(array $options): Config
             $params['drCallBackUrl'] = $options['dr_callback_url'];
         }
 
-        $api = $this->getAccountAPI();
+        $api = $this->getAPIResource();
         $api->setBaseUri('/account/settings');
 
         $rawBody = $api->submit($params);
@@ -281,89 +236,4 @@ public function updateConfig(array $options): Config
             $body['max-calls-per-second']
         );
     }
-
-    /**
-     * @deprecated use the Vonage\Secrets\Client::list method
-     *
-     * @throws ClientExceptionInterface
-     * @throws ClientException\Exception
-     * @throws InvalidResponseException
-     */
-    public function listSecrets(string $apiKey): SecretCollection
-    {
-        trigger_error('Vonage\Account\Client::listSecrets is deprecated, please use the Vonage\Secrets\Client::list method', E_USER_DEPRECATED);
-        $api = $this->getSecretsAPI();
-
-        $data = $api->get($apiKey . '/secrets');
-        return new SecretCollection($data['_embedded']['secrets'], $data['_links']);
-    }
-
-    /**
-     * @deprecated use the Vonage\Secrets\Client::get method
-     *
-     * @throws ClientExceptionInterface
-     * @throws ClientException\Exception
-     * @throws InvalidResponseException
-     */
-    public function getSecret(string $apiKey, string $secretId): Secret
-    {
-        trigger_error('Vonage\Account\Client::getSecret is deprecated, please use the Vonage\Secrets\Client::get method', E_USER_DEPRECATED);
-        $api = $this->getSecretsAPI();
-
-        $data = $api->get($apiKey . '/secrets/' . $secretId);
-        return new Secret($data);
-    }
-
-    /**
-     * Create a new account secret
-     *
-     * @deprecated use the Vonage\Secrets\Client::create method
-     *
-     * @throws ClientExceptionInterface
-     * @throws ClientRequestException
-     * @throws ClientException\Exception
-     * @throws InvalidResponseException
-     * @throws ClientValidationException
-     */
-    public function createSecret(string $apiKey, string $newSecret): Secret
-    {
-        trigger_error('Vonage\Account\Client::createSecret is deprecated, please use the Vonage\Secrets\Client::create method', E_USER_DEPRECATED);
-        $api = $this->getSecretsAPI();
-        $api->setBaseUri('/accounts/' . $apiKey . '/secrets');
-
-        try {
-            $response = $api->create(['secret' => $newSecret]);
-        } catch (ClientRequestException $e) {
-            // @deprecated Throw a Validation exception to preserve old behavior
-            // This will change to a general Request exception in the future
-            $rawResponse = json_decode(@$e->getResponse()->getBody()->getContents(), true);
-
-            if (array_key_exists('invalid_parameters', $rawResponse)) {
-                throw new ClientValidationException(
-                    $e->getMessage(),
-                    $e->getCode(),
-                    null,
-                    $rawResponse['invalid_parameters']
-                );
-            }
-
-            throw $e;
-        }
-
-        return new Secret($response);
-    }
-
-    /**
-     * @deprecated use the Vonage\Secrets\Client::revoke method
-     *
-     * @throws ClientExceptionInterface
-     * @throws ClientException\Exception
-     */
-    public function deleteSecret(string $apiKey, string $secretId): void
-    {
-        trigger_error('Vonage\Account\Client::deleteSecret is deprecated, please use the Vonage\Secrets\Client::revoke method', E_USER_DEPRECATED);
-        $api = $this->getSecretsAPI();
-        $api->setBaseUri('/accounts/' . $apiKey . '/secrets');
-        $api->delete($secretId);
-    }
 }

src/Account/ClientFactory.php

@@ -13,6 +13,7 @@
 
 use Psr\Container\ContainerInterface;
 use Vonage\Client\APIResource;
+use Vonage\Client\Credentials\Handler\BasicHandler;
 
 class ClientFactory
 {
@@ -24,11 +25,9 @@ public function __invoke(ContainerInterface $container): Client
             ->setBaseUrl($accountApi->getClient()->getRestUrl())
             ->setIsHAL(false)
             ->setBaseUri('/account')
+            ->setAuthHandler(new BasicHandler())
         ;
 
-        $secretsApi = $container->make(APIResource::class);
-        $secretsApi->setBaseUri('/accounts');
-
-        return new Client($accountApi, $secretsApi);
+        return new Client($accountApi);
     }
 }

src/Account/Secret.php

@@ -13,6 +13,7 @@
 
 use Psr\Container\ContainerInterface;
 use Vonage\Client\APIResource;
+use Vonage\Client\Credentials\Handler\BasicHandler;
 
 class ClientFactory
 {
@@ -22,7 +23,8 @@ public function __invoke(ContainerInterface $container): Client
         $api = $container->make(APIResource::class);
         $api
             ->setBaseUri('/v2/applications')
-            ->setCollectionName('applications');
+            ->setCollectionName('applications')
+            ->setAuthHandler(new BasicHandler());
 
         return new Client($api, new Hydrator());
     }