FacebookAds\Http\Exception\RequestException

Complexity

Total Complexity

25

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

85.71%

Importance

Changes	3
Bugs	1	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	getResponse()	0	3	1
A	setResponse()	0	5	1
A	idx()	0	5	2
A	getErrorData()	0	16	1
D	create()	0	26	10
A	getHttpStatusCode()	0	3	1
A	getErrorSubcode()	0	3	1
A	getErrorUserTitle()	0	3	1
A	getErrorUserMessage()	0	3	1
A	getErrorBlameFieldSpecs()	0	3	1
A	isTransient()	0	11	4

<?php
/**
 * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

namespace FacebookAds\Http\Exception;

use FacebookAds\Exception\Exception;
use FacebookAds\Http\ResponseInterface;

class RequestException extends Exception {

  /**
   * @var ResponseInterface|null
   */
  protected $response;

  /**
   * @var int Status code for the response causing the exception
   */
  protected $statusCode;

  /**
   * @var int|null
   */
  protected $errorCode;

  /**
   * @var int|null
   */
  protected $errorSubcode;

  /**
   * @var string|null
   */
  protected $errorMessage;

  /**
   * @var string|null
   */
  protected $errorUserTitle;

  /**
   * @var string|null
   */
  protected $errorUserMessage;

  /**
   * @var int|null
   */
  protected $errorType;

  /**
   * @var array|null
   */
  protected $errorBlameFieldSpecs;

  /**
   * FIXME - v2.6 breaking change:
   *   make interface __contruct(ResponseInterface $response)
   *
   * @param array $response_data The response from the Graph API
   * @param int $status_code
   */
  public function __construct(
    array $response_data,
    $status_code) {

    $this->statusCode = $status_code;
    $error_data = static::getErrorData($response_data);

    parent::__construct($error_data['message'], $error_data['code']);

    $this->errorSubcode = $error_data['error_subcode'];
    $this->errorUserTitle = $error_data['error_user_title'];
    $this->errorUserMessage = $error_data['error_user_msg'];
    $this->errorBlameFieldSpecs = $error_data['error_blame_field_specs'];
  }

  /**
   * @return ResponseInterface|null
   */
  public function getResponse() {
    return $this->response;
  }

  /**
   * @param ResponseInterface $response
   * @return $this
   */
  public function setResponse(ResponseInterface $response) {
    $this->response = $response;

    return $this;
  }

  /**
   * @param array $array
   * @param string|int $key
   * @param mixed $default
   * @return mixed
   */
  protected static function idx(array $array, $key, $default = null) {
    return array_key_exists($key, $array)
      ? $array[$key]
      : $default;
  }

  /**
   * @param array $response_data
   * @return array
   */
  protected static function getErrorData(array $response_data) {
    $error_data = static::idx($response_data, 'error', array());

    return array(
      'code' =>
        static::idx($error_data, 'code', static::idx($response_data, 'code')),
      'error_subcode' => static::idx($error_data, 'error_subcode'),
      'message' => static::idx($error_data, 'message'),
      'error_user_title' => static::idx($error_data, 'error_user_title'),
      'error_user_msg' => static::idx($error_data, 'error_user_msg'),
      'error_blame_field_specs' =>
        static::idx(static::idx($error_data, 'error_data', array()),
          'blame_field_specs'),
      'type' => static::idx($error_data, 'type'),
    );
  }

  /**
   * Process an error payload from the Graph API and return the appropriate
   * exception subclass.
   * @param array $response_data the decoded response from the Graph API
   * @param int $status_code the HTTP response code
   * @return RequestException
   */
  public static function create(array $response_data, $status_code) {
    $error_data = static::getErrorData($response_data);
    if (in_array(
      $error_data['error_subcode'], array(458, 459, 460, 463, 464, 467))
      || in_array($error_data['code'], array(100, 102, 190))
      || $error_data['type'] === 'OAuthException') {

      return new AuthorizationException($response_data, $status_code);
    } elseif (in_array($error_data['code'], array(1, 2))) {

      return new ServerException($response_data, $status_code);
    } elseif (in_array($error_data['code'], array(4, 17, 341))) {

      return new ThrottleException($response_data, $status_code);
    } elseif ($error_data['code'] == 506) {

      return new ClientException($response_data, $status_code);
    } elseif ($error_data['code'] == 10
      || ($error_data['code'] >= 200 && $error_data['code'] <= 299)) {

      return new PermissionException($response_data, $status_code);
    } else {

      return new self($response_data, $status_code);
    }
  }

  /**
   * @return int
   */
  public function getHttpStatusCode() {
    return $this->statusCode;
  }

  /**
   * @return int|null
   */
  public function getErrorSubcode() {
    return $this->errorSubcode;
  }

  /**
   * @return string|null
   */
  public function getErrorUserTitle() {
    return $this->errorUserTitle;
  }

  /**
   * @return string|null
   */
  public function getErrorUserMessage() {
    return $this->errorUserMessage;
  }

  /**
   * @return array|null
   */
  public function getErrorBlameFieldSpecs() {
    return $this->errorBlameFieldSpecs;
  }

  /**
   * @return bool
   */
  public function isTransient() {
    if ($this->getResponse() !== null) {
      return false;
    }

    $body = $this->getResponse()->getBody();

The method getBody cannot be called on $this->getResponse() (of type null).

    return array_key_exists('error', $body)
      && array_key_exists('is_transient', $body['error'])
      && $body['error']['is_transient'];
  }
}