README

PSR-compliant distributed rate limiting engine supporting Redis, MongoDB, and MySQL with adaptive exponential backoff.

🚀 Overview

Maatify Rate Limiter is a fully decoupled, PSR-compliant rate-limiting engine designed for:

• Native PHP
• Slim Framework
• Laravel Middleware
• Custom API Gateways

It provides distributed rate-limiting with adaptive exponential backoff, unified across:

• Redis
• MongoDB
• MySQL

Why this library?

• Zero storage lock-in
• Unified attempt/status/reset API
• Global per-IP rate limit
• Adaptive Exponential Backoff (2ⁿ)
• Full PSR-7 / PSR-15 middleware compatibility
• PHPStan Level Max ready

✅ Supported Drivers

📦 Installation

composer require maatify/rate-limiter

⚡ Quick Usage

use Maatify\RateLimiter\Resolver\RateLimiterResolver;
use Maatify\RateLimiter\Enums\RateLimitActionEnum;
use Maatify\RateLimiter\Enums\PlatformEnum;

$resolver = new RateLimiterResolver(['driver' => 'redis']);
$limiter  = $resolver->resolve();

$status = $limiter->attempt(
    '127.0.0.1',
    RateLimitActionEnum::LOGIN,
    PlatformEnum::WEB
);

echo $status->remaining;

📘 Full usage examples (Native, Slim, Laravel, API, Enums, Backoff): ➡️ examples/Examples.md

🧩 Key Features

• Unified API: attempt(), status(), reset()
• Global Per-IP Limit
• Adaptive Exponential Backoff
• DTO-based Response Model
• PSR-7 / PSR-15 Middleware Ready
• Custom Enum Contracts
• Driver Resolver
• Strict Validation & Type Safety
• PHPStan Level Max

📄 Documentation

• Arabic Documentation
• Usage Examples
• Changelog
• Security Policy

🧱 Dependencies Overview

maatify/rate-limiter relies on PSR standards and selected open-source libraries.

🔌 Direct Open-Source Dependencies

🧪 Testing

composer test

Runs:

• Driver consistency tests
• Resolver tests
• Middleware header tests
• Backoff & global limit tests
• Coverage reporting

🪪 License

MIT License © Maatify.dev — Free to use, modify, and distribute with attribution.

👤 Author

Engineered by Mohamed Abdulalim (@megyptm)
Backend Lead & Technical Architect — https://www.maatify.dev

🤝 Contributors

Special thanks to the Maatify.dev engineering team and all open-source contributors. Your efforts help make this library stable, secure, and production-ready.

Before opening a Pull Request, please read:

• Contributing Guide
• Code of Conduct

_{Built with ❤️ by Maatify.dev — Unified Ecosystem for Modern PHP Libraries}