Hryvinskyi\InvisibleCaptcha\Model\ReCaptcha\Response

Complexity

Total Complexity

18

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isSuccess()	0	3	1
A	__construct()	0	14	1
B	fromJson()	0	35	10
A	getAction()	0	3	1
A	getErrorCodes()	0	3	1
A	getScore()	0	3	1
A	toArray()	0	9	1
A	getChallengeTs()	0	3	1
A	getHostname()	0	3	1

<?php
/**
 * Copyright (c) 2019. Volodymyr Hryvinskyi.  All rights reserved.
 * @author: <mailto:volodymyr@hryvinskyi.com>
 * @github: <https://github.com/hryvinskyi>
 */

namespace Hryvinskyi\InvisibleCaptcha\Model\ReCaptcha;

use Hryvinskyi\Base\Helper\Json;

/**
 * The response returned from the service.
 */
class Response
{
    /**
     * Success or failure.
     * @var boolean
     */
    private $success = false;

    /**
     * Error code strings.
     *
     * @var array
     */
    private $errorCodes = [];

    /**
     * The hostname of the site where the reCAPTCHA was solved.
     *
     * @var string
     */
    private $hostname;

    /**
     * Timestamp of the challenge load (ISO format yyyy-MM-dd'T'HH:mm:ssZZ)
     *
     * @var string
     */
    private $challengeTs;

    /**
     * Score assigned to the request
     *
     * @var float
     */
    private $score;

    /**
     * Action as specified by the page
     *
     * @var string
     */
    private $action;

    /**
     * Build the response from the expected JSON returned by the service.
     *
     * @param string $json
     *
     * @return Response
     */
    public static function fromJson($json): Response
    {
        $responseData = Json::decode($json);

        if (!$responseData) {
            return new Response(false, [VerifyReCaptcha::E_INVALID_JSON]);
        }

        $hostname = isset($responseData['hostname']) ? $responseData['hostname'] : null;
        $challengeTs = isset($responseData['challenge_ts']) ? $responseData['challenge_ts'] : null;
        $score = isset($responseData['score']) ? floatval($responseData['score']) : null;
        $action = isset($responseData['action']) ? $responseData['action'] : null;

        if (isset($responseData['success']) && $responseData['success'] == true) {
            return new Response(true, [], $hostname, $challengeTs, $score, $action);
        }

        if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
            return new Response(
                false,
                $responseData['error-codes'],
                $hostname,
                $challengeTs,
                $score,
                $action
            );
        }

        return new Response(
            false,
            [VerifyReCaptcha::E_UNKNOWN_ERROR],
            $hostname,
            $challengeTs,
            $score,
            $action
        );
    }

    /**
     * Response constructor.
     *
     * @param bool $success
     * @param array $errorCodes
     * @param string|null $hostname
     * @param string|null $challengeTs
     * @param float|null $score
     * @param string|null $action
     */
    public function __construct(
        bool $success,
        array $errorCodes = [],
        ?string $hostname = null,
        ?string $challengeTs = null,
        ?float $score = null,
        ?string $action = null
    ) {
        $this->success = $success;
        $this->hostname = $hostname;
        $this->challengeTs = $challengeTs;
        $this->score = $score;
        $this->action = $action;
        $this->errorCodes = $errorCodes;
    }

    /**
     * Is success?
     *
     * @return boolean
     */
    public function isSuccess(): bool
    {
        return $this->success;
    }

    /**
     * Get error codes.
     *
     * @return array
     */
    public function getErrorCodes(): array
    {
        return $this->errorCodes;
    }

    /**
     * Get hostname.
     *
     * @return string
     */
    public function getHostname(): ?string
    {
        return $this->hostname;
    }

    /**
     * Get challenge timestamp
     *
     * @return string
     */
    public function getChallengeTs(): ?string
    {
        return $this->challengeTs;
    }

    /**
     * Get score
     *
     * @return float
     */
    public function getScore(): ?float
    {
        return $this->score;
    }

    /**
     * Get action
     *
     * @return string
     */
    public function getAction(): ?string
    {
        return $this->action;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        return [
            'success'          => $this->isSuccess(),
            'hostname'         => $this->getHostname(),
            'challenge_ts'     => $this->getChallengeTs(),
            'score'            => $this->getScore(),
            'action'           => $this->getAction(),
            'error-codes'      => $this->getErrorCodes(),
        ];
    }
}