PHPackages maize-tech/laravel-remote-rule - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. maize-tech/laravel-remote-rule ActiveLibrary[API Development](/categories/api) maize-tech/laravel-remote-rule ============================== Laravel Remote Rule 2.2.0(2y ago)295533[4 PRs](https://github.com/maize-tech/laravel-remote-rule/pulls)MITPHPPHP ^8.0CI passing Since Oct 20Pushed 1mo ago4 watchersCompare [ Source](https://github.com/maize-tech/laravel-remote-rule)[ Packagist](https://packagist.org/packages/maize-tech/laravel-remote-rule)[ Docs](https://github.com/maize-tech/laravel-remote-rule)[ GitHub Sponsors](https://github.com/maize-tech)[ RSS](/packages/maize-tech-laravel-remote-rule/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (4)Dependencies (11)Versions (9)Used By (0) ![Social Card of Laravel Remote Rule](/art/socialcard-light.png) Laravel Remote Rule =================== [](#laravel-remote-rule) [![Latest Version on Packagist](https://camo.githubusercontent.com/06fafffed131964bd680e8a3f9cfe1915785e9ea34707e4d1556c3ba601dbfdb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d61697a652d746563682f6c61726176656c2d72656d6f74652d72756c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/maize-tech/laravel-remote-rule)[![GitHub Tests Action Status](https://camo.githubusercontent.com/3c27b4f75fde727b1544b85d9da38ed6d8dee634e4996001af65e0374bc082a2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6d61697a652d746563682f6c61726176656c2d72656d6f74652d72756c652f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/maize-tech/laravel-remote-rule/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/022aaa99429ec069ccc1853002d5377db49b88fbfaf2f8b07aa0694ec5385ac6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6d61697a652d746563682f6c61726176656c2d72656d6f74652d72756c652f7068702d63732d66697865722e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/maize-tech/laravel-remote-rule/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/9694eb0245bbfd9ada2c611bfb8db1950cf1b4b6d58bb842809d34526f7f5c94/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d61697a652d746563682f6c61726176656c2d72656d6f74652d72756c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/maize-tech/laravel-remote-rule) Easily validate data attributes through a remote request. This package allows you to define a subset of custom rules to validate an incoming request data through an api call to a remote service. An example usage could be an application with an open registration form which should only allow a list of emails given by a remote service. You can find an example in the [Usage](#usage) section. Installation ------------ [](#installation) You can install the package via composer: ``` composer require maize-tech/laravel-remote-rule ``` You can publish and run the migrations with: ``` php artisan vendor:publish --provider="Maize\RemoteRule\RemoteRuleServiceProvider" --tag="remote-rule-migrations" php artisan migrate ``` You can publish the config file with: ``` php artisan vendor:publish --provider="Maize\RemoteRule\RemoteRuleServiceProvider" --tag="remote-rule-config" ``` This is the content of the published config file: ``` return [ /* |-------------------------------------------------------------------------- | Config model |-------------------------------------------------------------------------- | | Here you may specify the fully qualified class name of the config model. | */ 'config_model' => Maize\RemoteRule\Models\RemoteRuleConfig::class, /* |-------------------------------------------------------------------------- | Attribute cast |-------------------------------------------------------------------------- | | Here you may specify the cast type for all model attributes who contain | sensitive data. | All attributes listed below will be encrypted by default when creating or | updating a model instance. You can disable this behaviour by removing | the attribute cast from the array. | */ 'attribute_cast' => [ 'url' => 'encrypted', 'method' => 'encrypted', 'headers' => 'encrypted:array', 'json' => 'encrypted:array', ], /* |-------------------------------------------------------------------------- | Debug mode |-------------------------------------------------------------------------- | | Here you may enable or disable the debug mode. If enabled, the rule will | throw an exception instead of validating the attribute. | */ 'debug' => false, /* |-------------------------------------------------------------------------- | Validation message |-------------------------------------------------------------------------- | | Here you may specify the message thrown if the validation rule fails. | */ 'validation_message' => 'The :attribute must be valid.', ]; ``` Usage ----- [](#usage) ### Basic [](#basic) To use the package you can create a class which extends the `RemoteRule` abstract class. ``` use Maize\RemoteRule\RemoteRule; class EmailRule extends RemoteRule { // } ``` You can then create a new `RemoteRuleConfig` instance with the snake case name of the class you just created. The model will contain the url of the remote service used to send the request along with the request method (usually `POST` or `GET`) and, if needed, the custom headers, json body and timeout. We add this data to a database table as we consider it sensitive information, and we want to avoid hard-coding it to the codebase. All entries of the `remote_rule_configs` database table are indeed encrypted by default (can be disabled in the configs). You can create a remote rule config in your console with tinker: ``` php artisan tinker ``` ``` \Maize\RemoteRule\Models\RemoteRuleConfig::query()->create([ 'name' => 'email_rule', 'url' => 'test.example.com', 'method' => 'POST', 'headers' => [], // can be null if no custom headers are required 'json' => [], // can be null if no custom json body is required 'timeout' => 10, // can be null if you want to use the default timeout ]); ``` That's all! You can now just add your new custom rule to the validation array: ``` use Illuminate\Support\Facades\Validator; $email = 'my-email@example.com'; Validator::make([ 'email' => $email, ], [ 'email' => [ 'string', 'email', new EmailRule, ], ])->validated(); ``` Under the hood, the validation rule will send a request to the given url with the custom headers and body (where we append the attribute name and its value) and check whether the response is successful or not. ### Custom response status code [](#custom-response-status-code) You can change the expected response status code by overriding the `isSuccessful` method in your custom rule. ``` use Maize\RemoteRule\RemoteRule; use Illuminate\Http\Client\Response; class EmailRule extends RemoteRule { protected function isSuccessful(Response $response): bool { return $response->status() === 204; } } ``` ### Custom body attribute [](#custom-body-attribute) By default, all custom rules will append the attribute key-value pair to the request body, where the key is the name of the validated attribute, and the value is the input value of the form. You can change the body attribute sent to the remote service by overriding the `getBodyAttribute` method in your custom rule. ``` use Maize\RemoteRule\RemoteRule; class EmailRule extends RemoteRule { protected function getBodyAttribute(): array { return ['custom_attribute' => $this->value]; } } ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Enrico De Lazzari](https://github.com/enricodelazzari) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 43 — FairBetter than 91% of packages Maintenance61 Regular maintenance activity Popularity24 Limited adoption so far Community16 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~299 days Total 4 Last Release 764d ago Major Versions 1.0.0 → 2.0.02022-02-15 PHP version history (2 changes)1.0.0PHP ^7.4|^8.0 2.0.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/848d3feb1799fbdb3ff475a4398017f9bc2b94c5cba4dd69d414af62a856fcc4?d=identicon)[maize-tech](/maintainers/maize-tech) --- Top Contributors [![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (22 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (16 commits)")[![enricodelazzari](https://avatars.githubusercontent.com/u/10452445?v=4)](https://github.com/enricodelazzari "enricodelazzari (15 commits)")[![frestifo](https://avatars.githubusercontent.com/u/138138732?v=4)](https://github.com/frestifo "frestifo (1 commits)")[![riccardodallavia](https://avatars.githubusercontent.com/u/1372062?v=4)](https://github.com/riccardodallavia "riccardodallavia (1 commits)") --- Tags apilaravelphpremoterulesvalidationlaravelruleremotemaize-tech ### Code Quality TestsPHPUnit Static AnalysisPsalm Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/maize-tech-laravel-remote-rule/health.svg) ``` [![Health](https://phpackages.com/badges/maize-tech-laravel-remote-rule/health.svg)](https://phpackages.com/packages/maize-tech-laravel-remote-rule) ``` ### Alternatives [spatie/laravel-query-builder Easily build Eloquent queries from API requests 4.4k26.9M219](/packages/spatie-laravel-query-builder)[simplestats-io/laravel-client Client for SimpleStats! 4515.5k](/packages/simplestats-io-laravel-client)[essa/api-tool-kit set of tools to build an api with laravel 52680.5k](/packages/essa-api-tool-kit)[ryangjchandler/bearer Minimalistic token-based authentication for Laravel API endpoints. 8129.8k](/packages/ryangjchandler-bearer)[stechstudio/laravel-hubspot A Laravel SDK for the HubSpot CRM Api 2971.0k](/packages/stechstudio-laravel-hubspot)[api-platform/laravel API Platform support for Laravel 59126.4k6](/packages/api-platform-laravel) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)