nextstage-brasil/ns-util

Metodos e classes de utilidades diversas

1.78.24 2025-03-13 10:42 UTC

Requires

• php: >=7.4
• firebase/php-jwt: ^6.10
• laravel/serializable-closure: ^1.3 || ^2
• league/flysystem: ^1.0 || ^3.0
• league/flysystem-aws-s3-v3: ^1.0 || ^3.0
• nelexa/zip: ^3.3 || ^4.0
• phpmailer/phpmailer: ^6.9
• predis/predis: ^2.3
• sendgrid/sendgrid: ^7
• smottt/wideimage: ^1.1

Requires (Dev)

• phpunit/phpunit: *

Apache-2.0

• Nextstage

README

Examples

API

• Atention: onError and onSuccess order on middlewares is important

<?php

use AppLibrary\App;
use JDrel\NsLibrary\Entities\Logs;
use NsUtil\Api;
use NsUtil\Helper;
use NsUtil\Services\RateLimiter;

if (is_dir(__DIR__ . '/../../_build/')) {
    error_reporting(E_ALL);
}

include __DIR__ . '/../../vendor/autoload.php';

App::init();
App::setDevelopeMode();
$namespace = Helper::getPsr4Name() . '\\Routers';

// Api
$api = new Api();
$headers = $api->getHeaders(true);
$resource = Helper::name2CamelCase($api->getConfigData()['rest']['resource']);
$apikey = $api->getHeaders(true)['apikey'] ?? $api->getConfigData()['ParamsRouter'][3] ?? '-1';

// Rotas liberadas sem precisar de autenticação de usuário
$freeRoutes = ['version', 'webhooks', 'cpuAgent'];

// log de uso
$hit = (new Logs([
    'appnameLog' => 'Api Consume',
    'textLog' => $apikey,
    'extrasLog' => [
        'route' => $resource,
        'headers' => $headers,
        'payload' => $api->getBody()
    ]
]))->save();

// Rate, Middlewares and Resolver
$dados = [];
$api
    ->onError(fn ($param1, $param2) => $hit->setExtrasLog(array_merge($hit->getExtrasLog('array'), ['response' => ['data' => $param1, 'code' => $param2]]))->save())
    ->onSuccess(fn ($param1, $param2) => $hit->setExtrasLog(array_merge($hit->getExtrasLog('array'), ['response' => ['code' => $param2]]))->save())
    ->rateLimit(3, 60)
    ->middleware('Invalid APIKEY', 403, fn () => in_array($resource, $freeRoutes) ? true : App::validaApiKey($apikey))
    ->rest($namespace);

Rate Limit

// to clear:
// php nsutil rate:clear {appkey_or_IP}

try {
    // rate 120 calls by ip per minute
    RateLimiter::byIP(120, RateLimiter::PER_MINUTE);

    // rate 100 calls per apikey per day
    RateLimiter::byKey('my-app-key-1', 100, RateLimiter::PER_DAY);

    // Exception on error to connect on redis
} catch (RedisConnectionException $exc) {
    http_response_code($exc->getCode() ?? 400);
    echo "REDIS-ERROR: " . $exc->getMessage() . PHP_EOL;
    // Too many requests (429)
} catch (TooManyRequestException $exc) {
    http_response_code($exc->getCode());
    echo $exc->getMessage() . PHP_EOL;
    // Others exceptions
} catch (Exception $exc) {
    http_response_code($exc->getCode() ?? 400);
    echo "ERROR: " . $exc->getMessage() . PHP_EOL;
}

Composer local

Configure a .env com o parametro LOCAL_COMPOSER listando os paths absoutos a serem atualizados localmente Ex.: LOCAL_COMPOSER="/home/user/apps/app1;/home/user/apps/app2"

Dentro deste projeto será atualizado a pasta /vendor/nextstage-brasil/ns-util/src com a cópia do conteudo deste projeto.

Para executar: sudo php nsutil composer:local

Atenção: se executar isso dentro de um docker não ira funcionar, pois os paths não estarão disponiveis.