Viewing file:  Client.php (20.34 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace Vonage;
use Composer\InstalledVersions;
use Http\Client\HttpClient;
use InvalidArgumentException;
use Laminas\Diactoros\Request;
use Laminas\Diactoros\Uri;
use Lcobucci\JWT\Token;
use Psr\Container\ContainerInterface;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use RuntimeException;
use Vonage\Account\ClientFactory;
use Vonage\Application\ClientFactory as ApplicationClientFactory;
use Vonage\Client\APIResource;
use Vonage\Client\Credentials\Basic;
use Vonage\Client\Credentials\Container;
use Vonage\Client\Credentials\CredentialsInterface;
use Vonage\Client\Credentials\Gnp;
use Vonage\Client\Credentials\Handler\BasicHandler;
use Vonage\Client\Credentials\Handler\SignatureBodyFormHandler;
use Vonage\Client\Credentials\Handler\SignatureBodyHandler;
use Vonage\Client\Credentials\Handler\SignatureQueryHandler;
use Vonage\Client\Credentials\Handler\TokenBodyFormHandler;
use Vonage\Client\Credentials\Handler\TokenBodyHandler;
use Vonage\Client\Credentials\Handler\TokenQueryHandler;
use Vonage\Client\Credentials\Keypair;
use Vonage\Client\Credentials\SignatureSecret;
use Vonage\Client\Exception\Exception as ClientException;
use Vonage\Client\Factory\FactoryInterface;
use Vonage\Client\Factory\MapFactory;
use Vonage\Conversion\ClientFactory as ConversionClientFactory;
use Vonage\Entity\EntityInterface;
use Vonage\Insights\ClientFactory as InsightsClientFactory;
use Vonage\Meetings\ClientFactory as MeetingsClientFactory;
use Vonage\Numbers\ClientFactory as NumbersClientFactory;
use Vonage\NumberVerification\ClientFactory as NumberVerificationClientFactory;
use Vonage\Redact\ClientFactory as RedactClientFactory;
use Vonage\Secrets\ClientFactory as SecretsClientFactory;
use Vonage\SimSwap\ClientFactory as SimSwapClientFactory;
use Vonage\SMS\ClientFactory as SMSClientFactory;
use Vonage\Subaccount\ClientFactory as SubaccountClientFactory;
use Vonage\Messages\ClientFactory as MessagesClientFactory;
use Vonage\Users\ClientFactory as UsersClientFactory;
use Vonage\Verify\ClientFactory as VerifyClientFactory;
use Vonage\Verify2\ClientFactory as Verify2ClientFactory;
use Vonage\Conversation\ClientFactory as ConversationClientFactory;
use Vonage\Verify\Verification;
use Vonage\Voice\ClientFactory as VoiceClientFactory;
use Vonage\Logger\{LoggerAwareInterface, LoggerTrait};
use function array_key_exists;
use function array_merge;
use function call_user_func_array;
use function http_build_query;
use function implode;
use function is_null;
use function json_encode;
use function method_exists;
use function set_error_handler;
use function str_replace;
use function strpos;
/**
* Vonage API Client, allows access to the API from PHP.
*
* @method Account\Client account()
* @method Meetings\Client meetings()
* @method Messages\Client messages()
* @method Application\Client applications()
* @method Conversion\Client conversion()
* @method Conversation\Client conversation()
* @method Insights\Client insights()
* @method Numbers\Client numbers()
* @method NumberVerification\Client numberVerification()
* @method Redact\Client redact()
* @method Secrets\Client secrets()
* @method SimSwap\Client simswap()
* @method SMS\Client sms()
* @method Subaccount\Client subaccount()
* @method Users\Client users()
* @method Verify\Client verify()
* @method Verify2\Client verify2()
* @method Voice\Client voice()
* @method Vonage\Video\Client video()
*
* @property string restUrl
* @property string apiUrl
*/
class Client implements LoggerAwareInterface
{
use LoggerTrait;
public const BASE_API = 'https://api.nexmo.com';
public const BASE_REST = 'https://rest.nexmo.com';
protected CredentialsInterface $credentials;
protected ClientInterface $client;
protected mixed $debug = false;
protected ContainerInterface $factory;
/**
* @var LoggerInterface
*/
protected $logger;
protected array $options = ['show_deprecations' => false, 'debug' => false];
public string $apiUrl;
public string $restUrl;
/**
* Create a new API client using the provided credentials.
*/
public function __construct(
CredentialsInterface $credentials,
$options = [],
?ClientInterface $client = null
) {
if (is_null($client)) {
// Since the user did not pass a client, try and make a client
// using the Guzzle 6 adapter or Guzzle 7 (depending on availability)
[$guzzleVersion] = explode('@', (string) InstalledVersions::getVersion('guzzlehttp/guzzle'), 1);
$guzzleVersion = (float) $guzzleVersion;
if ($guzzleVersion >= 6.0 && $guzzleVersion < 7) {
/** @noinspection CallableParameterUseCaseInTypeContextInspection */
/** @noinspection PhpUndefinedNamespaceInspection */
/** @noinspection PhpUndefinedClassInspection */
$client = new \Http\Adapter\Guzzle6\Client();
}
if ($guzzleVersion >= 7.0 && $guzzleVersion < 8.0) {
$client = new \GuzzleHttp\Client();
}
}
$this->setHttpClient($client);
if (
!($credentials instanceof Container) &&
!($credentials instanceof Basic) &&
!($credentials instanceof SignatureSecret) &&
!($credentials instanceof Keypair) &&
!($credentials instanceof Gnp)
) {
throw new RuntimeException('unknown credentials type: ' . $credentials::class);
}
$this->credentials = $credentials;
$this->options = array_merge($this->options, $options);
// If they've provided an app name, validate it
if (isset($options['app'])) {
$this->validateAppOptions($options['app']);
}
// Set the default URLs. Keep the constants for
// backwards compatibility
$this->apiUrl = static::BASE_API;
$this->restUrl = static::BASE_REST;
// If they've provided alternative URLs, use that instead
// of the defaults
if (isset($options['base_rest_url'])) {
$this->restUrl = $options['base_rest_url'];
}
if (isset($options['base_api_url'])) {
$this->apiUrl = $options['base_api_url'];
}
if (isset($options['debug'])) {
$this->debug = $options['debug'];
}
$services = [
// Registered Services by name
'account' => ClientFactory::class,
'applications' => ApplicationClientFactory::class,
'conversion' => ConversionClientFactory::class,
'conversation' => ConversationClientFactory::class,
'insights' => InsightsClientFactory::class,
'numbers' => NumbersClientFactory::class,
'numberVerification' => NumberVerificationClientFactory::class,
'meetings' => MeetingsClientFactory::class,
'messages' => MessagesClientFactory::class,
'redact' => RedactClientFactory::class,
'secrets' => SecretsClientFactory::class,
'simswap' => SimSwapClientFactory::class,
'sms' => SMSClientFactory::class,
'subaccount' => SubaccountClientFactory::class,
'users' => UsersClientFactory::class,
'verify' => VerifyClientFactory::class,
'verify2' => Verify2ClientFactory::class,
'voice' => VoiceClientFactory::class,
// Additional utility classes
APIResource::class => APIResource::class,
Client::class => fn () => $this
];
if (class_exists('Vonage\Video\ClientFactory')) {
$services['video'] = 'Vonage\Video\ClientFactory';
} else {
$services['video'] = function (): never {
throw new \RuntimeException('Please install @vonage/video to use the Video API');
};
}
$this->setFactory(
new MapFactory(
$services,
$this
)
);
// Disable throwing E_USER_DEPRECATED notices by default, the user can turn it on during development
if (array_key_exists('show_deprecations', $this->options) && ($this->options['show_deprecations'] == true)) {
set_error_handler(
static fn (
int $errno,
string $errstr,
?string $errfile = null,
?int $errline = null,
?array $errorcontext = null
) => true,
E_USER_DEPRECATED
);
}
}
public function getRestUrl(): string
{
return $this->restUrl;
}
public function getApiUrl(): string
{
return $this->apiUrl;
}
/**
* Set the Http Client to used to make API requests.
*
* This allows the default http client to be swapped out for a HTTPlug compatible
* replacement.
*/
public function setHttpClient(ClientInterface $client): self
{
$this->client = $client;
return $this;
}
/**
* Get the Http Client used to make API requests.
*/
public function getHttpClient(): ClientInterface
{
return $this->client;
}
/**
* Set the factory used to create API specific clients.
*/
public function setFactory(FactoryInterface $factory): self
{
$this->factory = $factory;
return $this;
}
public function getFactory(): ContainerInterface
{
return $this->factory;
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public static function signRequest(RequestInterface $request, SignatureSecret $credentials): RequestInterface
{
$handler = match ($request->getHeaderLine('content-type')) {
'application/json' => new SignatureBodyHandler(),
'application/x-www-form-urlencoded' => new SignatureBodyFormHandler(),
default => new SignatureQueryHandler(),
};
return $handler($request, $credentials);
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public static function authRequest(RequestInterface $request, Basic $credentials): RequestInterface
{
switch ($request->getHeaderLine('content-type')) {
case 'application/json':
if (static::requiresBasicAuth($request)) {
$handler = new BasicHandler();
} elseif (static::requiresAuthInUrlNotBody($request)) {
$handler = new TokenQueryHandler();
} else {
$handler = new TokenBodyHandler();
}
break;
case 'application/x-www-form-urlencoded':
$handler = new TokenBodyFormHandler();
break;
default:
if (static::requiresBasicAuth($request)) {
$handler = new BasicHandler();
} else {
$handler = new TokenQueryHandler();
}
break;
}
return $handler($request, $credentials);
}
/**
* @throws ClientException
*/
public function generateJwt($claims = []): Token
{
if (method_exists($this->credentials, "generateJwt")) {
return $this->credentials->generateJwt($claims);
}
throw new ClientException($this->credentials::class . ' does not support JWT generation');
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public function get(string $url, array $params = []): ResponseInterface
{
$queryString = '?' . http_build_query($params);
$url .= $queryString;
$request = new Request($url, 'GET');
return $this->send($request);
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public function post(string $url, array $params): ResponseInterface
{
$request = new Request(
$url,
'POST',
'php://temp',
['content-type' => 'application/json']
);
$request->getBody()->write(json_encode($params));
return $this->send($request);
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public function postUrlEncoded(string $url, array $params): ResponseInterface
{
$request = new Request(
$url,
'POST',
'php://temp',
['content-type' => 'application/x-www-form-urlencoded']
);
$request->getBody()->write(http_build_query($params));
return $this->send($request);
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public function put(string $url, array $params): ResponseInterface
{
$request = new Request(
$url,
'PUT',
'php://temp',
['content-type' => 'application/json']
);
$request->getBody()->write(json_encode($params));
return $this->send($request);
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
public function delete(string $url): ResponseInterface
{
$request = new Request(
$url,
'DELETE'
);
return $this->send($request);
}
/**
* Wraps the HTTP Client, creates a new PSR-7 request adding authentication, signatures, etc.
*
* @throws ClientExceptionInterface
*/
public function send(RequestInterface $request): ResponseInterface
{
// Allow any part of the URI to be replaced with a simple search
if (isset($this->options['url'])) {
foreach ($this->options['url'] as $search => $replace) {
$uri = (string)$request->getUri();
$new = str_replace($search, $replace, $uri);
if ($uri !== $new) {
$request = $request->withUri(new Uri($new));
}
}
}
// The user agent must be in the following format:
// LIBRARY-NAME/LIBRARY-VERSION LANGUAGE-NAME/LANGUAGE-VERSION [APP-NAME/APP-VERSION]
// See https://github.com/Vonage/client-library-specification/blob/master/SPECIFICATION.md#reporting
$userAgent = [];
// Library name
$userAgent[] = 'vonage-php/' . $this->getVersion();
// Language name
$userAgent[] = 'php/' . PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION;
// If we have an app set, add that to the UA
if (isset($this->options['app'])) {
$app = $this->options['app'];
$userAgent[] = $app['name'] . '/' . $app['version'];
}
// Set the header. Build by joining all the parts we have with a space
$request = $request->withHeader('User-Agent', implode(' ', $userAgent));
/** @noinspection PhpUnnecessaryLocalVariableInspection */
$response = $this->client->sendRequest($request);
if ($this->debug) {
$id = uniqid('', true);
$request->getBody()->rewind();
$response->getBody()->rewind();
$this->log(
LogLevel::DEBUG,
'Request ' . $id,
[
'url' => $request->getUri()->__toString(),
'headers' => $request->getHeaders(),
'body' => explode("\n", $request->getBody()->__toString())
]
);
$this->log(
LogLevel::DEBUG,
'Response ' . $id,
[
'headers ' => $response->getHeaders(),
'body' => explode("\n", $response->getBody()->__toString())
]
);
$request->getBody()->rewind();
$response->getBody()->rewind();
}
return $response;
}
protected function validateAppOptions($app): void
{
$disallowedCharacters = ['/', ' ', "\t", "\n"];
foreach (['name', 'version'] as $key) {
if (!isset($app[$key])) {
throw new InvalidArgumentException('app.' . $key . ' has not been set');
}
foreach ($disallowedCharacters as $char) {
if (str_contains((string) $app[$key], $char)) {
throw new InvalidArgumentException('app.' . $key . ' cannot contain the ' . $char . ' character');
}
}
}
}
public function __call($name, $args)
{
if (!$this->factory->has($name)) {
throw new RuntimeException('no api namespace found: ' . $name);
}
$collection = $this->factory->get($name);
if (empty($args)) {
return $collection;
}
return call_user_func_array($collection, $args);
}
/**
* @noinspection MagicMethodsValidityInspection
*/
public function __get($name)
{
if (!$this->factory->has($name)) {
throw new RuntimeException('no api namespace found: ' . $name);
}
return $this->factory->get($name);
}
public function getDebug(): mixed
{
return $this->debug;
}
public function setDebug(mixed $debug): Client
{
$this->debug = $debug;
return $this;
}
/**
* @deprecated Use the Verify Client, this shouldn't be here and will be removed.
*/
public function serialize(EntityInterface $entity): string
{
if ($entity instanceof Verification) {
return $this->verify()->serialize($entity);
}
throw new RuntimeException('unknown class `' . $entity::class . '``');
}
protected function getVersion(): string
{
return InstalledVersions::getVersion('vonage/client-core');
}
public function getLogger(): ?LoggerInterface
{
if (!$this->logger && $this->getFactory()->has(LoggerInterface::class)) {
$this->setLogger($this->getFactory()->get(LoggerInterface::class));
}
return $this->logger;
}
public function getCredentials(): CredentialsInterface
{
return $this->credentials;
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
protected static function requiresBasicAuth(RequestInterface $request): bool
{
$path = $request->getUri()->getPath();
$isSecretManagementEndpoint = str_starts_with($path, '/accounts') && str_contains($path, '/secrets');
$isApplicationV2 = str_starts_with($path, '/v2/applications');
return $isSecretManagementEndpoint || $isApplicationV2;
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
protected static function requiresAuthInUrlNotBody(RequestInterface $request): bool
{
$path = $request->getUri()->getPath();
$isRedact = str_starts_with($path, '/v1/redact');
$isMessages = str_starts_with($path, '/v1/messages');
return $isRedact || $isMessages;
}
/**
* @deprecated Use a configured APIResource with a HandlerInterface
* Request business logic is being removed from the User Client Layer.
*/
protected function needsKeypairAuthentication(RequestInterface $request): bool
{
$path = $request->getUri()->getPath();
$isCallEndpoint = str_starts_with($path, '/v1/calls');
$isRecordingUrl = str_starts_with($path, '/v1/files');
$isStitchEndpoint = str_starts_with($path, '/beta/conversation');
$isUserEndpoint = str_starts_with($path, '/beta/users');
return $isCallEndpoint || $isRecordingUrl || $isStitchEndpoint || $isUserEndpoint;
}
}
|