Pinterest\Http\Response

Complexity

Total Complexity

20

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

53.66%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	ok()	0	7	3
A	getError()	0	4	2
A	rateLimited()	0	4	1
A	parseJson()	0	9	2
A	result()	0	4	1
A	setResult()	0	6	1
A	getRequest()	0	4	1
A	getStatusCode()	0	4	1
A	getHeaders()	0	4	1
A	getHeader()	0	6	2
A	getRateLimit()	0	6	2
A	getRemainingRequests()	0	6	2

<?php

/*
 * This file is part of the Pinterest PHP library.
 *
 * (c) Hans Ott <hansott@hotmail.be>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.md.
 *
 * Source: https://github.com/hansott/pinterest-php
 */

namespace Pinterest\Http;

use Pinterest\Http\Exceptions\MalformedJson;

/**
 * The response class.
 *
 * @author Hans Ott <hansott@hotmail.be>
 * @author Toon Daelman <spinnewebber_toon@hotmail.com>
 */
final class Response
{
    /**
     * The parsed response body.
     *
     * @var mixed
     */
    public $body;

    /**
     * The response status code.
     *
     * @var int
     */
    private $statusCode;

    /**
     * The raw response body.
     *
     * @var string
     */
    private $rawBody;

    /**
     * The HTTP headers.
     *
     * @var array
     */
    private $headers;

    /**
     * The processed result.
     *
     * @var mixed
     */
    private $result;

    /**
     * The request object.
     *
     * @var Request
     */
    private $request;

    /**
     * The constructor.
     *
     * @param Request $request    The request object.
     * @param int     $statusCode The status code.
     * @param string  $rawBody    The raw response body.
     * @param array   $headers    A key => value representation of response headers.
     */
    public function __construct(Request $request, $statusCode, $rawBody, array $headers)
    {
        $this->request = $request;
        $this->statusCode = (int) $statusCode;
        $this->rawBody = (string) $rawBody;
        $this->body = $this->parseJson($this->rawBody);
        $this->headers = $headers;
    }

    /**
     * Checks if the response is okay.
     *
     * @return bool Whether the response is okay.
     */
    public function ok()
    {
        return
            !isset($this->body->error)
            && $this->statusCode >= 200
            && $this->statusCode < 300;
    }

    /**
     * Get the HTTP status code.
     *
     * @return int
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Get the error message.
     *
     * @return null|string
     */
    public function getError()
    {
        return !empty($this->body->message) ? (string) $this->body->message : null;
    }

    /**
     * Checks if the response is rate-limited.
     *
     * @return bool Whether the response is rate-limited.
     */
    public function rateLimited()
    {
        return $this->statusCode === 429;
    }

    /**
     * Parse the response json.
     *
     * @param string $rawBody The raw response body.
     * @param bool   $toArray Return as array?
     *
     * @throws MalformedJson
     *
     * @return mixed The parsed json.
     */
    private function parseJson($rawBody, $toArray = false)
    {
        $json = json_decode($rawBody, $toArray);
        if (json_last_error() === JSON_ERROR_NONE) {
            return $json;
        } else {
            throw new MalformedJson();
        }
    }

    /**
     * Get the processed result.
     *
     * @return mixed The processed result.
     */
    public function result()
    {
        return $this->result;
    }

    /**
     * Set the processed result.
     *
     * @param mixed $result The result.
     *
     * @return $this
     */
    public function setResult($result)
    {
        $this->result = $result;

        return $this;
    }

    /**
     * Get the request object.
     *
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Get the HTTP Headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Get a specific HTTP header.
     *
     * @param string $header
     *
     * @return string|null The header value.
     */
    public function getHeader($header)
    {
        return isset($this->headers[$header])
            ? $this->headers[$header]
            : null;
    }

    /**
     * Get the rate-limit.
     *
     * @return int|null The rate-limit.
     */
    public function getRateLimit()
    {
        $limit = $this->getHeader('X-Ratelimit-Limit');

        return is_numeric($limit) ? (int) $limit : null;
    }

    /**
     * Get the remaining requests before reaching the rate-limit.
     *
     * @return int|null The remaining requests.
     */
    public function getRemainingRequests()
    {
        $remaining = $this->getHeader('X-Ratelimit-Remaining');

        return is_numeric($remaining) ? (int) $remaining : null;
    }
}