abstract class BaseApiAbstract in TMGMT Translator Smartling 8.3

Class BaseApiAbstract

@package Smartling\Api

Hierarchy

• class \Smartling\BaseApiAbstract

15 files declare their use of BaseApiAbstract

ApiTestAbstract.php in vendor/smartling/api-sdk-php/tests/unit/ApiTestAbstract.php

AuditLogApi.php in vendor/smartling/api-sdk-php/src/AuditLog/AuditLogApi.php

AuthTokenProvider.php in vendor/smartling/api-sdk-php/src/AuthApi/AuthTokenProvider.php

BaseApiAbstractTest.php in vendor/smartling/api-sdk-php/tests/unit/BaseApiAbstractTest.php

BatchApi.php in vendor/smartling/api-sdk-php/src/Batch/BatchApi.php

... See full list

File

vendor/smartling/api-sdk-php/src/BaseApiAbstract.php, line 21

Namespace

Smartling

abstract class BaseApiAbstract {
  const CLIENT_LIB_ID_SDK = 'smartling-api-sdk-php';
  const CLIENT_LIB_ID_VERSION = '3.6.2';
  const CLIENT_USER_AGENT_EXTENSION = '(no extensions)';
  const HTTP_METHOD_GET = 'get';
  const HTTP_METHOD_POST = 'post';
  const HTTP_METHOD_DELETE = 'delete';
  const HTTP_METHOD_PUT = 'put';
  private static $currentClientId = self::CLIENT_LIB_ID_SDK;
  private static $currentClientVersion = self::CLIENT_LIB_ID_VERSION;
  private static $currentClientUserAgentExtension = self::CLIENT_USER_AGENT_EXTENSION;

  /**
   * @param string $currentClientUserAgentExtension
   */
  public static function setCurrentClientUserAgentExtension($currentClientUserAgentExtension) {
    self::$currentClientUserAgentExtension = $currentClientUserAgentExtension;
  }

  /**
   * @return string
   */
  public static function getCurrentClientUserAgentExtension() {
    return self::$currentClientUserAgentExtension;
  }

  /**
   * @return string
   */
  public static function getCurrentClientId() {
    return self::$currentClientId;
  }

  /**
   * @param string $currentClientId
   */
  public static function setCurrentClientId($currentClientId) {
    self::$currentClientId = $currentClientId;
  }

  /**
   * @return string
   */
  public static function getCurrentClientVersion() {
    return self::$currentClientVersion;
  }

  /**
   * @param string $currentClientVersion
   */
  public static function setCurrentClientVersion($currentClientVersion) {
    self::$currentClientVersion = $currentClientVersion;
  }

  /**
   * PHP equivalent to 'YYYY-MM-DDThh:mm:ssZ'
   */
  const PATTERN_DATE_TIME_ISO_8601 = 'Y-m-d\\TH:i:s\\Z';

  /**
   * Project Id in Smartling dashboard
   *
   * @var string
   */
  private $projectId;

  /**
   * Smartling API base url.
   *
   * @var string
   */
  private $baseUrl;

  /**
   * @var AuthApiInterface
   */
  private $auth;

  /**
   * Http Client abstraction.
   *
   * @var ClientInterface
   */
  private $httpClient;

  /**
   * Logger.
   *
   * @var LoggerInterface
   */
  private $logger;

  /**
   * @return string
   */
  protected function getProjectId() {
    return $this->projectId;
  }

  /**
   * @param string $projectId
   */
  protected function setProjectId($projectId) {
    $this->projectId = $projectId;
  }

  /**
   * @return string
   */
  protected function getBaseUrl() {
    return $this->baseUrl;
  }

  /**
   * @param string $baseUrl
   */
  protected function setBaseUrl($baseUrl) {
    $this->baseUrl = $baseUrl;
  }

  /**
   * @return AuthApiInterface
   */
  protected function getAuth() {
    return $this->auth;
  }

  /**
   * @param AuthApiInterface $auth
   */
  protected function setAuth(AuthApiInterface $auth) {
    $this->auth = $auth;
  }

  /**
   * @return ClientInterface
   */
  protected function getHttpClient() {
    return $this->httpClient;
  }

  /**
   * @param ClientInterface $httpClient
   */
  protected function setHttpClient($httpClient) {
    $this->httpClient = $httpClient;
  }

  /**
   * @return LoggerInterface
   */
  protected function getLogger() {
    return $this->logger;
  }

  /**
   * @param LoggerInterface $logger
   */
  protected function setLogger($logger) {
    $this->logger = $logger;
  }

  /**
   * BaseApiAbstract constructor.
   *
   * @param string $projectId
   * @param ClientInterface $client
   * @param LoggerInterface $logger
   * @param string|null $service_url
   */
  public function __construct($projectId, ClientInterface $client, $logger = null, $service_url = null) {
    $this
      ->setProjectId($projectId);
    $this
      ->setHttpClient($client);
    if (is_null($logger)) {
      $logger = new DevNullLogger();
    }
    $this
      ->setLogger($logger);
    $this
      ->setBaseUrl(rtrim($service_url, '/') . '/' . $projectId);
  }

  /**
   * @param string $serviceUrl
   * @param bool $debug
   *
   * @return Client
   */
  protected static function initializeHttpClient($serviceUrl, $debug = false) {
    $client = new Client([
      'base_uri' => $serviceUrl,
      'debug' => $debug,
      'headers' => [
        'User-Agent' => vsprintf('%s/%s %s %s', [
          self::getCurrentClientId(),
          self::getCurrentClientVersion(),
          self::getCurrentClientUserAgentExtension(),
          GuzzleHttp\default_user_agent(),
        ]),
      ],
    ]);
    return $client;
  }

  /**
   * OOP wrapper for fopen() function.
   *
   * @param string $realPath
   *   Real path for file.
   *
   * @return resource
   *
   * @throws \Smartling\Exceptions\SmartlingApiException
   */
  protected function readFile($realPath) {
    $stream = @fopen($realPath, 'r');
    if (!$stream) {
      throw new SmartlingApiException("File {$realPath} was not able to be read.");
    }
    else {
      return $stream;
    }
  }
  protected function getDefaultRequestData($parametersType, $parameters, $auth = true, $httpErrors = false) {
    $options = [
      'headers' => [
        'Accept' => 'application/json',
      ],
      'exceptions' => $httpErrors,
    ];
    if ($auth) {
      $accessToken = $this
        ->getAuth()
        ->getAccessToken();
      $tokenType = $this
        ->getAuth()
        ->getTokenType();
      $options['headers']['Authorization'] = vsprintf('%s %s', [
        $tokenType,
        $accessToken,
      ]);
    }
    $options[$parametersType] = $parameters;
    return $options;
  }

  /**
   * @param mixed $requestData
   *
   * @return array
   */
  protected function processBodyOptions($requestData = []) {
    if (!empty($requestData['multipart'])) {
      $body = [];
      foreach ($requestData['multipart'] as $key => $value) {

        // Hack to cast FALSE to '0' instead of empty string.
        if (is_bool($value)) {
          $value = (int) $value;
        }
        if (is_array($value)) {
          foreach ($value as $_item) {
            $body[] = [
              'name' => $key . '[]',
              'contents' => (string) $_item,
            ];
          }
        }
        else {
          $body[] = [
            'name' => $key,
            'contents' => $value,
          ];
        }
      }
      $requestData['multipart'] = $body;
    }
    return $requestData;
  }

  /**
   * @param string $uri
   *
   * @return string
   */
  private function normalizeUri($uri = '') {
    return rtrim($this
      ->getBaseUrl(), '/') . '/' . ltrim($uri, '/');
  }

  /**
   * @param Response $response
   * @throws SmartlingApiException
   */
  private function checkAuthenticationError(Response $response) {

    //Special handling for 401 error - authentication error => expire token
    if (401 === (int) $response
      ->getStatusCode()) {
      if (!$this
        ->getAuth() instanceof AuthApiInterface) {
        $type = gettype($this
          ->getAuth());
        if ('object' === $type) {
          $type .= '::' . get_class($this
            ->getAuth());
        }
        throw new SmartlingApiException('AuthProvider expected to be instance of AuthApiInterface, type given:' . $type, 401);
      }
      else {
        $this
          ->getAuth()
          ->resetToken();
      }
    }
  }

  /**
   * @param Response $response
   * @throws SmartlingApiException
   */
  private function processErrors(Response $response) {

    // Catch all errors from Smartling and throw appropriate exception.
    if (400 <= (int) $response
      ->getStatusCode()) {
      $this
        ->processError($response);
    }
  }

  /**
   * @param Response $response
   * @throws SmartlingApiException
   */
  private function processError(Response $response) {
    try {
      $json = json_decode($response
        ->getBody(), true);
      if (is_null($json) || !array_key_exists('response', $json) || !is_array($json['response']) || !array_key_exists('errors', $json['response']) || empty($json['response']['errors'])) {
        $message = 'Bad response format from Smartling';
        $this
          ->getLogger()
          ->error($message);
        throw new SmartlingApiException($message);
      }
      $error_msg = array_map(function ($a) {
        return $a['message'];
      }, $json['response']['errors']);
      $message = implode(' || ', $error_msg);
      $this
        ->getLogger()
        ->error($message);
      throw new SmartlingApiException($json['response']['errors'], $response
        ->getStatusCode());
    } catch (RuntimeException $e) {
      $message = vsprintf('Bad response format from Smartling: %s', [
        $response
          ->getBody(),
      ]);
      $this
        ->getLogger()
        ->error($message);
      throw new SmartlingApiException($message, 0, $e);
    }
  }

  /**
   * @param $uri
   * @param array $options
   * @param $method
   * @param bool $returnRawResponseBody
   * @return  mixed.
   *          true on SUCCESS and empty data
   *          string on $returnRawResponseBody = true
   *          array otherwise
   * @throws \Smartling\Exceptions\SmartlingApiException
   */
  protected function sendRequest($uri, array $options, $method, $returnRawResponseBody = false) {
    $endpoint = $this
      ->normalizeUri($uri);

    // Dump full request data to log except sensitive data.
    $logRequestData = $options;
    if (isset($logRequestData['headers']['Authorization'])) {
      $logRequestData['headers']['Authorization'] = substr($logRequestData['headers']['Authorization'], 0, 12) . '*****';
    }
    if (isset($logRequestData['json']) && is_array($logRequestData['json']) && isset($logRequestData['json']['userIdentifier'])) {
      $logRequestData['json']['userIdentifier'] = substr($logRequestData['json']['userIdentifier'], 0, 5) . '*****';
      $logRequestData['json']['userSecret'] = substr($logRequestData['json']['userSecret'], 0, 5) . '*****';
    }
    $toLog = [
      'request' => [
        'endpoint' => $endpoint,
        'method' => $method,
        'requestData' => $logRequestData,
      ],
    ];
    $serialized = var_export($toLog, true);
    $this
      ->getLogger()
      ->debug($serialized);
    try {
      $options = $this
        ->processBodyOptions($options);
      $response = $this
        ->getHttpClient()
        ->request($method, $endpoint, $options);
      if (401 === (int) $response
        ->getStatusCode() && !$this instanceof AuthApiInterface) {
        $this
          ->getLogger()
          ->notice('Got unexpected 401 response code, trying to reauth carefully...');
        $this
          ->getAuth()
          ->resetToken();
        $response = $this
          ->getHttpClient()
          ->request($method, $endpoint, $options);
      }
    } catch (RequestException $e) {
      $message = vsprintf('Guzzle:RequestException: %s', [
        $e
          ->getMessage(),
      ]);
      $this
        ->getLogger()
        ->error($message);
      throw new SmartlingApiException($message, 0, $e);
    } catch (\LogicException $e) {
      $message = vsprintf('Guzzle:LogicException: %s', [
        $e
          ->getMessage(),
      ]);
      $this
        ->getLogger()
        ->error($message);
      throw new SmartlingApiException($message, 0, $e);
    } catch (\Exception $e) {
      $message = vsprintf('Guzzle:Exception: %s', [
        $e
          ->getMessage(),
      ]);
      $this
        ->getLogger()
        ->error($message);
      throw new SmartlingApiException($message, 0, $e);
    }

    // Dump full response to log except sensitive data.
    $logResponseData = (string) $response
      ->getBody();
    $logResponseData = preg_replace('/(accessToken":".{5})([^"]+)/', '${1}*****', $logResponseData);
    $logResponseData = preg_replace('/(refreshToken":".{5})([^"]+)/', '${1}*****', $logResponseData);
    $this
      ->getLogger()
      ->debug(json_encode([
      'response' => [
        'statusCode' => $response
          ->getStatusCode(),
        'headers' => $response
          ->getHeaders(),
        'body' => $logResponseData,
      ],
    ], JSON_UNESCAPED_UNICODE | JSON_FORCE_OBJECT));
    if (400 <= (int) $response
      ->getStatusCode()) {
      $this
        ->checkAuthenticationError($response);
      $this
        ->processErrors($response);
    }
    if ($returnRawResponseBody) {
      return $response
        ->getBody();
    }
    else {
      try {
        $json = json_decode($response
          ->getBody(), true);
        if (!array_key_exists('response', $json) || !is_array($json['response']) || empty($json['response']['code']) || !in_array($json['response']['code'], [
          'SUCCESS',
          'ACCEPTED',
        ])) {
          $this
            ->processError($response);
        }
        return !empty($json['response']['data']) ? $json['response']['data'] : true;
      } catch (RuntimeException $e) {
        $this
          ->processError($response);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BaseApiAbstract::$auth	private	property
BaseApiAbstract::$baseUrl	private	property	Smartling API base url.
BaseApiAbstract::$currentClientId	private static	property
BaseApiAbstract::$currentClientUserAgentExtension	private static	property
BaseApiAbstract::$currentClientVersion	private static	property
BaseApiAbstract::$httpClient	private	property	Http Client abstraction.
BaseApiAbstract::$logger	private	property	Logger.
BaseApiAbstract::$projectId	private	property	Project Id in Smartling dashboard
BaseApiAbstract::checkAuthenticationError	private	function
BaseApiAbstract::CLIENT_LIB_ID_SDK		constant
BaseApiAbstract::CLIENT_LIB_ID_VERSION		constant
BaseApiAbstract::CLIENT_USER_AGENT_EXTENSION		constant
BaseApiAbstract::getAuth	protected	function
BaseApiAbstract::getBaseUrl	protected	function
BaseApiAbstract::getCurrentClientId	public static	function
BaseApiAbstract::getCurrentClientUserAgentExtension	public static	function
BaseApiAbstract::getCurrentClientVersion	public static	function
BaseApiAbstract::getDefaultRequestData	protected	function		1
BaseApiAbstract::getHttpClient	protected	function
BaseApiAbstract::getLogger	protected	function
BaseApiAbstract::getProjectId	protected	function
BaseApiAbstract::HTTP_METHOD_DELETE		constant
BaseApiAbstract::HTTP_METHOD_GET		constant
BaseApiAbstract::HTTP_METHOD_POST		constant
BaseApiAbstract::HTTP_METHOD_PUT		constant
BaseApiAbstract::initializeHttpClient	protected static	function
BaseApiAbstract::normalizeUri	private	function
BaseApiAbstract::PATTERN_DATE_TIME_ISO_8601		constant	PHP equivalent to 'YYYY-MM-DDThh:mm:ssZ'
BaseApiAbstract::processBodyOptions	protected	function		3
BaseApiAbstract::processError	private	function
BaseApiAbstract::processErrors	private	function
BaseApiAbstract::readFile	protected	function	OOP wrapper for fopen() function.
BaseApiAbstract::sendRequest	protected	function
BaseApiAbstract::setAuth	protected	function
BaseApiAbstract::setBaseUrl	protected	function
BaseApiAbstract::setCurrentClientId	public static	function
BaseApiAbstract::setCurrentClientUserAgentExtension	public static	function
BaseApiAbstract::setCurrentClientVersion	public static	function
BaseApiAbstract::setHttpClient	protected	function
BaseApiAbstract::setLogger	protected	function
BaseApiAbstract::setProjectId	protected	function
BaseApiAbstract::__construct	public	function	BaseApiAbstract constructor.	3