Jérémy Munsch
81aabdab72
This removes api authentification with token in favor of signature method. Refactorize code and clean up. It add more unit test plus code coverage in test/converage. - Added config.api.timestampTimeout - Added Helper::signRequest This calculates the request signature - Added more unit tests and extend code coverage. - Added rate limiter for web routes - Added RemoveSpaces Sanitizer on api requests - Added stress test suite - Changed AuthServiceProvider api-token to api-hmac - Changed CustomerSeeder to have at least of customer activated (for unit tests) - Changed used transation for saveing multiple models - Changed, in ServiceController generateApiToken to generateServicePassword - Changed, timestamp has to be send in request with a DateTime format, it also has to a UTC value - Composer added brianium/paratest - Composer update - Fixed case where removing single optin could be the wrong one (not for the good service) - Fixed customer delete - Fixed customer would not be resolved by brand. - Fixed Really check that request is json checking body content, preventing sending malformed requests - Remove ApiError::needAuth - Removed api_token - Removed ApiController::authenticate - Removed config.api.tokenTimeout - Removed Header check or usage because of HAProxy doing weird stuff - Removed lock files from gitignore - Removed memcached dependency - Removed unused questions resources api routes - Removed workspace file Migrations - Added unique index on services.bearer_token - Changed customer_id on customer_answer is nullable - Changed services.bearer_pwd length to 312 (the size of the token) - Dropped services.api_token and service.api_token_date
104 lines
2.3 KiB
PHP
104 lines
2.3 KiB
PHP
<?php
|
|
|
|
namespace App\Exceptions\Api\V2;
|
|
|
|
use App\Enums\ApiError;
|
|
use Exception;
|
|
use Illuminate\Support\Facades\Log;
|
|
use Throwable;
|
|
|
|
/**
|
|
* This would be thrown if any of the case
|
|
* referenced in \App\Enums\ApiError would
|
|
* occur within the crm
|
|
*
|
|
* On the client an ApiErrorException would
|
|
* also be throw with the ApiError corresponding to
|
|
* the situation
|
|
*
|
|
* @package LDCCrmClient
|
|
* @subpackage exceptions
|
|
*/
|
|
class ApiErrorException extends Exception
|
|
{
|
|
/**
|
|
* Api Error
|
|
* This value makes the error more explicit.
|
|
* Handling these errors are normal as inputs or
|
|
* request may be undesired or refused by the crm.
|
|
*
|
|
* @var \App\Enums\ApiError
|
|
*/
|
|
protected $error;
|
|
|
|
/**
|
|
* This is an explicit error message,
|
|
* ou may print this to the front or not depending
|
|
* on $error value
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $message;
|
|
|
|
/**
|
|
* This is the http code returned by the crm.
|
|
* This value could be used to handle errors.
|
|
* But please take in consideration $error first
|
|
*
|
|
* @var integer
|
|
*/
|
|
protected $httpCode;
|
|
|
|
/**
|
|
* Create a new exception base on ApiError enum.
|
|
*
|
|
* @param ApiError $error
|
|
* @param integer $httpCode
|
|
* @param string $message
|
|
* @param Throwable|null $previous
|
|
*/
|
|
public function __construct(ApiError $error, int $httpCode = 400, string $message = '', Throwable $previous = null)
|
|
{
|
|
$this->error = $error;
|
|
$this->message = $message;
|
|
$this->httpCode = $httpCode;
|
|
parent::__construct(
|
|
strlen($this->message) ? $this->message : $error->label,
|
|
$error->value,
|
|
$previous
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the Api Error
|
|
*
|
|
* @return ApiError
|
|
*/
|
|
public function getApiError(): ApiError
|
|
{
|
|
return $this->error;
|
|
}
|
|
|
|
/**
|
|
* Get the http code
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getStatusCode(): int
|
|
{
|
|
return $this->httpCode;
|
|
}
|
|
|
|
/**
|
|
* This is used by laravel only.
|
|
* It uses Log class to print the error.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function report()
|
|
{
|
|
// @codeCoverageIgnoreStart
|
|
Log::debug(sprintf('CRM API: %s', $this->getMessage()));
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
}
|