Moved Secrets to own client (#275)

Author: dragonmantank

src/Account/Client.php

@@ -283,25 +283,31 @@ public function updateConfig(array $options): Config
     }
 
     /**
+     * @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);
@@ -311,6 +317,8 @@ public function getSecret(string $apiKey, string $secretId): Secret
     /**
      * Create a new account secret
      *
+     * @deprecated use the Vonage\Secrets\Client::create method
+     *
      * @throws ClientExceptionInterface
      * @throws ClientRequestException
      * @throws ClientException\Exception
@@ -319,6 +327,7 @@ public function getSecret(string $apiKey, string $secretId): Secret
      */
     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');
 
@@ -345,11 +354,14 @@ public function createSecret(string $apiKey, string $newSecret): Secret
     }
 
     /**
+     * @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/Secret.php

@@ -18,6 +18,9 @@
 use function get_class;
 use function trigger_error;
 
+/**
+ * @deprecated Use the Vonage\Secrets\Secret object instead
+ */
 class Secret implements ArrayAccess
 {
     protected $data;

src/Client.php

@@ -47,6 +47,7 @@
 use Vonage\Message\Client as MessageClient;
 use Vonage\Numbers\ClientFactory as NumbersClientFactory;
 use Vonage\Redact\ClientFactory as RedactClientFactory;
+use Vonage\Secrets\ClientFactory as SecretsClientFactory;
 use Vonage\SMS\ClientFactory as SMSClientFactory;
 use Vonage\User\Collection as UserCollection;
 use Vonage\Verify\ClientFactory as VerifyClientFactory;
@@ -83,6 +84,7 @@
  * @method Insights\Client insights()
  * @method Numbers\Client numbers()
  * @method Redact\Client redact()
+ * @method Secrets\Client secrets()
  * @method SMS\Client sms()
  * @method Verify\Client  verify()
  * @method Voice\Client voice()
@@ -212,6 +214,7 @@ public function __construct(CredentialsInterface $credentials, $options = [], ?C
                     'insights' => InsightsClientFactory::class,
                     'numbers' => NumbersClientFactory::class,
                     'redact' => RedactClientFactory::class,
+                    'secrets' => SecretsClientFactory::class,
                     'sms' => SMSClientFactory::class,
                     'verify' => VerifyClientFactory::class,
                     'voice' => VoiceClientFactory::class,

src/Client/Factory/FactoryInterface.php

@@ -22,4 +22,6 @@ interface FactoryInterface
     public function hasApi(string $api): bool;
 
     public function getApi(string $api);
+
+    public function make(string $key);
 }

src/Secrets/Client.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Vonage\Secrets;
+
+use Vonage\Client\APIClient;
+use Vonage\Client\APIResource;
+use Vonage\Entity\Hydrator\ArrayHydrator;
+use Vonage\Entity\IterableAPICollection;
+
+class Client implements APIClient
+{
+    /**
+     * @var APIResource
+     */
+    protected $api;
+
+    public function __construct(APIResource $api)
+    {
+        $this->api = $api;
+    }
+
+    public function getAPIResource(): APIResource
+    {
+        return $this->api;
+    }
+
+    public function get(string $accountId, string $id): Secret
+    {
+        $data = $this->api->get("${accountId}/secrets/${id}");
+
+        return new Secret($data);
+    }
+
+    public function list(string $accountId): IterableAPICollection
+    {
+        $collection = $this->api->search(null, "/accounts/${accountId}/secrets");
+        $hydrator = new ArrayHydrator();
+        $hydrator->setPrototype(new Secret());
+        $collection->setHydrator($hydrator);
+
+        return $collection;
+    }
+
+    public function create(string $accountId, string $secret): Secret
+    {
+        $response = $this->api->create(['secret' => $secret], "/${accountId}/secrets");
+        return new Secret($response);
+    }
+
+    public function revoke(string $accountId, string $id)
+    {
+        $this->api->delete("${accountId}/secrets/${id}");
+    }
+}

src/Secrets/ClientFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Vonage Client Library for PHP
+ *
+ * @copyright Copyright (c) 2016-2020 Vonage, Inc. (http://vonage.com)
+ * @license https://github.com/Vonage/vonage-php-sdk-core/blob/master/LICENSE.txt Apache License 2.0
+ */
+
+declare(strict_types=1);
+
+namespace Vonage\Secrets;
+
+use Vonage\Client\APIResource;
+use Vonage\Client\Factory\FactoryInterface;
+
+class ClientFactory
+{
+    public function __invoke(FactoryInterface $container): Client
+    {
+        $api = $container->make(APIResource::class);
+        $api->setBaseUri('/accounts')
+            ->setCollectionName('secrets');
+
+        return new Client($api);
+    }
+}

src/Secrets/Secret.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Vonage\Secrets;
+
+use DateTimeImmutable;
+use DateTimeInterface;
+use Vonage\Entity\Hydrator\ArrayHydrateInterface;
+
+class Secret implements ArrayHydrateInterface
+{
+    /**
+     * @var DateTimeImmutable
+     */
+    protected $createdAt;
+
+    /**
+     * @var string
+     */
+    protected $id;
+
+    public function __construct(array $data = [])
+    {
+        if (!empty($data)) {
+            $this->fromArray($data);
+        }
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function getCreatedAt(): DateTimeInterface
+    {
+        return $this->createdAt;
+    }
+
+    public function fromArray(array $data)
+    {
+        $this->id = $data['id'];
+        $this->createdAt = new DateTimeImmutable($data['created_at']);
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'id' => $this->id,
+            'created_at' => $this->createdAt->format('Y-m-d\TH:i:s\Z'),
+        ];
+    }
+}

test/Account/ClientTest.php

@@ -455,7 +455,7 @@ public function testListSecrets(): void
             return true;
         }))->shouldBeCalledTimes(1)->willReturn($this->getResponse('secret-management/list'));
 
-        $this->accountClient->listSecrets('abcd1234');
+        @$this->accountClient->listSecrets('abcd1234');
     }
 
     /**
@@ -471,7 +471,7 @@ public function testListSecretsServerError(): void
             Argument::any()
         )->willReturn($this->getGenericResponse('500', 500));
 
-        $this->accountClient->listSecrets('abcd1234');
+        @$this->accountClient->listSecrets('abcd1234');
     }
 
     /**
@@ -487,7 +487,7 @@ public function testListSecretsRequestError(): void
             Argument::any()
         )->willReturn($this->getGenericResponse('401', 401));
 
-        $this->accountClient->listSecrets('abcd1234');
+        @$this->accountClient->listSecrets('abcd1234');
     }
 
     /**
@@ -507,7 +507,7 @@ public function testGetSecret(): void
             return true;
         }))->shouldBeCalledTimes(1)->willReturn($this->getResponse('secret-management/get'));
 
-        $this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**
@@ -523,7 +523,7 @@ public function testGetSecretsServerError(): void
             Argument::any()
         )->willReturn($this->getGenericResponse('500', 500));
 
-        $this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**
@@ -539,7 +539,7 @@ public function testGetSecretsRequestError(): void
             Argument::any()
         )->willReturn($this->getGenericResponse('401', 401));
 
-        $this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->getSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**
@@ -558,7 +558,7 @@ public function testCreateSecret(): void
             return true;
         }))->shouldBeCalledTimes(1)->willReturn($this->getResponse('secret-management/create'));
 
-        $this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
+        @$this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
     }
 
     /**
@@ -576,7 +576,7 @@ public function testCreateSecretsServerError(): void
             Argument::any()
         )->willReturn($this->getGenericResponse('500', 500));
 
-        $this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
+        @$this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
     }
 
     /**
@@ -592,7 +592,7 @@ public function testCreateSecretsRequestError(): void
 
         $this->vonageClient->send(Argument::any())->willReturn($this->getGenericResponse('401', 401));
 
-        $this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
+        @$this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
     }
 
     /**
@@ -606,12 +606,12 @@ public function testCreateSecretsValidationError(): void
         try {
             $this->vonageClient->send(Argument::any())
                 ->willReturn($this->getResponse('secret-management/create-validation', 400));
-            $this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
+            @$this->accountClient->createSecret('abcd1234', 'example-4PI-secret');
         } catch (ValidationException $e) {
             $this->assertEquals(
                 'Bad Request: The request failed due to validation errors. ' .
-                'See https://developer.nexmo.com/api-errors/account/secret-management#validation ' .
-                'for more information',
+                    'See https://developer.nexmo.com/api-errors/account/secret-management#validation ' .
+                    'for more information',
                 $e->getMessage()
             );
             $this->assertEquals(
@@ -642,7 +642,7 @@ public function testDeleteSecret(): void
             return true;
         }))->shouldBeCalledTimes(1)->willReturn($this->getResponse('secret-management/delete'));
 
-        $this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**
@@ -653,7 +653,7 @@ public function testDeleteSecretsServerError(): void
     {
         $this->expectException(ClientException\Server::class);
         $this->vonageClient->send(Argument::any())->willReturn($this->getGenericResponse('500', 500));
-        $this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**
@@ -664,7 +664,7 @@ public function testDeleteSecretsRequestError(): void
     {
         $this->expectException(ClientException\Request::class);
         $this->vonageClient->send(Argument::any())->willReturn($this->getGenericResponse('401', 401));
-        $this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
+        @$this->accountClient->deleteSecret('abcd1234', 'ad6dc56f-07b5-46e1-a527-85530e625800');
     }
 
     /**

test/HTTPTestTrait.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace VonageTest;
+
+use Laminas\Diactoros\Response;
+
+trait HTTPTestTrait
+{
+    use Psr7AssertionTrait;
+
+    /**
+     * Get the API response we'd expect for a call to the API.
+     */
+    protected function getResponse(string $type = 'success', int $status = 200): Response
+    {
+        return new Response(fopen($this->responsesDir . '/' . $type . '.json', 'rb'), $status);
+    }
+}