brandon14/fossabot-commander

<?php

/**
 * This file is part of the brandon14/fossabot-commander package.
 *
 * MIT License
 *
 * Copyright (c) 2023-2024 Brandon Clothier
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission 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.
 *
 */

declare(strict_types=1);

namespace Brandon14\FossabotCommander\Contracts\Exceptions;

use Throwable;
use DateTimeImmutable;

use function date_create_immutable;

/**
 * Exception thrown when making a Fossabot API call, and it results in a rate limit throttled response (429).
 *
 * @noinspection PhpClassNamingConventionInspection
 *
 * @see https://docs.fossabot.com/variables/customapi#rate-limits
 *
 * @author Brandon Clothier <brandon14125@gmail.com>
 */
final class RateLimitException extends FossabotApiException
{
    /**
     * Total size of rate limit bucket.
     */
    private int $total;

    /**
     * Remaining request in bucket.
     */
    private int $remaining;

    /**
     * Time when rate limit bucket is refilled.
     */
    private DateTimeImmutable $resetsAt;

    /**
     * Constructs a new RateLimitException class.
     *
     * @param string         $fossabotCode Error code from Fossabot API response
     * @param string         $errorClass   Error class (error param) from Fossabot API response
     * @param string         $errorMessage Error message from Fossabot API response
     * @param int            $total        Total size of rate limit bucket
     * @param int            $remaining    Remaining request in bucket
     * @param int            $resetsAt     Time when rate limit bucket is refilled
     * @param array|null     $body         Parsed HTTP body from Fossabot API exception
     * @param Throwable|null $previous     Previous exception
     */
    public function __construct(
        string $fossabotCode,
        string $errorClass,
        string $errorMessage,
        int $total,
        int $remaining,
        int $resetsAt,
        ?array $body = null,
        ?Throwable $previous = null
    ) {
        $this->total = $total;
        $this->remaining = $remaining;

        // This should never happen.
        // @codeCoverageIgnoreStart
        try {
            $this->resetsAt = (new DateTimeImmutable())->setTimestamp($resetsAt);
        } catch (Throwable $exception) {
            $this->resetsAt = date_create_immutable()->setTimestamp($resetsAt);
        }
        // @codeCoverageIgnoreEnd

        parent::__construct(
            $fossabotCode,
            $errorClass,
            $errorMessage,
            429,
            $body,
            $previous,
        );
    }

    /**
     * Total size of rate limit bucket.
     */
    public function total(): int
    {
        return $this->total;
    }

    /**
     * Remaining request in bucket.
     */
    public function remaining(): int
    {
        return $this->remaining;
    }

    /**
     * Time when rate limit bucket is refilled.
     */
    public function resetsAt(): DateTimeImmutable
    {
        return $this->resetsAt;
    }
}