/**
* Sends a request to the API.
*
* @param string $request_type
* The type of HTTP request being made.
* Expected to be one of: REQUEST_TYPE_GET, REQUEST_TYPE_POST
* REQUEST_TYPE_PATCH, REQUEST_TYPE_PUT or REQUEST_TYPE_DELETE.
* @param string $api_end_point
* The relative url for the endpoint. All endpoints are assumed to be
* relative to 'https://api.cloudflare.com/client/v4/'.
* @param array $request_params
* (Optional) Associative array of parameters to be passed with the HTTP
* request.
*
* @return \CloudFlarePhpSdk\ApiTypes\CloudFlareApiResponse
* The response from the Api
*
* @throws \CloudFlarePhpSdk\Exceptions\CloudFlareApiException
* Exception at the application level.
* @throws \CloudFlarePhpSdk\Exceptions\CloudFlareHttpException
* Exception at the Http level.
*/
protected function makeRequest($request_type, $api_end_point, $request_params = [])
{
// Default the number of pages returned by the API to MAX.
if (!isset($request_params['per_page'])) {
$request_params['per_page'] = self::MAX_ITEMS_PER_PAGE;
}
// This check seems superfluous. However, the Api only returns a http 400
// code. This proactive check gives us more information.
$is_api_key_valid = strlen($this->apikey) == CloudFlareAPI::API_KEY_LENGTH;
$is_api_key_alpha_numeric = ctype_alnum($this->apikey);
$is_api_key_lower_case = !preg_match('/[A-Z]/', $this->apikey);
if (!$is_api_key_valid) {
throw new CloudFlareInvalidCredentialException("Invalid Api Key: Key should be 37 chars long.", 403);
}
if (!$is_api_key_alpha_numeric) {
throw new CloudFlareInvalidCredentialException('Invalid Api Key: Key can only contain alphanumeric characters.', 403);
}
if (!$is_api_key_lower_case) {
throw new CloudFlareInvalidCredentialException('Invalid Api Key: Key can only contain lowercase or numerical characters.', 403);
}
try {
switch ($request_type) {
case self::REQUEST_TYPE_GET:
$this->lastHttpResponse = $this->client->get($api_end_point, ['query' => $request_params]);
break;
case self::REQUEST_TYPE_POST:
$this->lastHttpResponse = $this->client->post($api_end_point, ['data' => $request_params]);
break;
case self::REQUEST_TYPE_PATCH:
$this->lastHttpResponse = $this->client->patch($api_end_point, ['json' => $request_params]);
break;
case self::REQUEST_TYPE_PUT:
$this->lastHttpResponse = $this->client->put($api_end_point, ['json' => $request_params]);
break;
case self::REQUEST_TYPE_DELETE:
$this->lastHttpResponse = $this->client->delete($api_end_point, ['json' => $request_params]);
break;
}
} catch (ServerException $se) {
$http_response_code = $se->getCode();
$http_response_message = $se->getMessage();
throw new CloudFlareHttpException($http_response_message, $http_response_code, $se->getPrevious());
} catch (RequestException $re) {
$http_response_code = $re->getCode();
$http_response_message = $re->getMessage();
if ($http_response_code == 403) {
throw new CloudFlareInvalidCredentialException("Unfortunately your credentials failed to authenticate against the CloudFlare API. Please enter valid credentials.", 403);
} else {
throw new CloudFlareTimeoutException($http_response_message, $http_response_code, $re->getPrevious());
}
}
$http_response_code = $this->lastHttpResponse->getStatusCode();
$is_status_code_good = $http_response_code == '200' || $http_response_code == '301';
// HTTP level error.
if (!$is_status_code_good) {
$http_response_message = $this->lastHttpResponse->getReasonPhrase();
throw new CloudFlareHttpException($http_response_message, $http_response_code, NULL);
}
// Note this behavior was introduced in Guzzle 6.
$response_body = (string) $this->lastHttpResponse->getBody();
$this->lastApiResponse = new CloudFlareApiResponse($response_body);
$json_decode_failure = is_null($this->lastApiResponse);
if ($json_decode_failure) {
throw new CloudFlareApiException($http_response_code, NULL, "Unable to decode response payload.", NULL);
}
$is_request_successful = $this->lastApiResponse->isSuccess();
// See https://api.cloudflare.com/#responses
$has_errors_from_api = count($this->lastApiResponse->getErrors()) > 0;
// Application level error.
if (!$is_request_successful || $has_errors_from_api) {
$http_response_message = $this->lastHttpResponse->getReasonPhrase();
throw new CloudFlareApiException($http_response_code, NULL, $http_response_message, NULL);
}
return $this->lastApiResponse;
}
