Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onursimsek/precondition
Precondition request for Laravel
https://github.com/onursimsek/precondition
laravel-package lost-update precondition precondition-validator
Last synced: 2 months ago
JSON representation
Precondition request for Laravel
- Host: GitHub
- URL: https://github.com/onursimsek/precondition
- Owner: onursimsek
- License: mit
- Created: 2024-01-30T14:18:16.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-07-08T08:29:20.000Z (7 months ago)
- Last Synced: 2024-07-08T10:44:20.743Z (7 months ago)
- Topics: laravel-package, lost-update, precondition, precondition-validator
- Language: PHP
- Homepage:
- Size: 46.9 KB
- Stars: 37
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-tr.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# HTTP Precondition for Laravel
[](https://packagist.org/packages/onursimsek/precondition)
[](LICENSE.md)
[](https://github.com/onursimsek/precondition/actions)
[](https://packagist.org/packages/onursimsek/precondition)
## Kurulum
Kurulum icin projenizde asagidaki komutu calistirin:
```shell
composer require onursimsek/precondition
```
## Kullanim
Bir istemci sizden bir kaynagi istemis (GET), bir sure sonra kaynakta guncelleme yapip size geri gondermek (PUT) ister.
O sirada baska bir istemci de ayni kaynagi almis (GET) ve ilk istemciden once guncellemistir (PUT). Bu durumda ilk
istemcinin yapmis oldugu guncelleme yanlis bir kopya uzerinden olacaktir ve ikinci istemcinin yaptigi guncellemeleri
gormezden gelecektir. Buna **[kayip guncelleme problemi](https://www.rfc-editor.org/rfc/rfc6585.txt)** denir.
Boyle bir durumda ilk istemciye **[428 Precondition Required](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428)** donusunde
bulunarak, kaynagi tekrar cekmesini isteyebilirsiniz.
Bu paket bu islemi kolayca yapmanizi saglar. Tek yapmaniz gereken bir **Validator class**'i olusturmak ve ilgili
controller metoduna **attribute** olarak eklemek.
```php
use Illuminate\Http\Request;
use OnurSimsek\Precondition\Validators\PreconditionValidator;
class LostUpdateValidator extends PreconditionValidator
{
public function parameter(Request $request)
{
return $request->header('If-Unmodified-Since');
}
public function __invoke(Request $request): bool
{
return $this->parameter($request) == $request->route('article')->updated_at;
}
}
```
```php
use App\Models\Article;
use App\Http\Requests\UpdateArticleRequest;
use OnurSimsek\Precondition\Attributes\Precondition;
class ArticleController
{
#[Precondition(LostUpdateValidator::class)]
public function update(Article $article, UpdateArticleRequest $request)
{
$article->fill($request->validated())
$article->save();
return response()->json();
}
}
```
Son olarak kullanmak istediginiz **route**'a **precondition** middleware'ini eklemeniz gerekiyor.
```php
Route::put('/articles/{:article}', [ArticleController::class, 'update'])
->middleware(['precondition']);
```
Bunun disinda bir istegin gerceklestirilmesi icin herhangi bir sartiniz varsa yine bu paketi kullanabilirsiniz. Iste
bazi ornekler;
### Github Ornegi
Bir repo silinmeden once repo adinin tekrar yazilmasi istenir.
```php
use Illuminate\Http\Request;
use OnurSimsek\Precondition\Validators\PreconditionValidator;
class DeleteRepositoryValidator extends PreconditionValidator
{
public function parameter(Request $request)
{
return $request->input('repository_name');
}
public function __invoke(Request $request): bool
{
return $this->parameter($request) == $request->route('repository')->name;
}
}
```
**Not:** Repo adi dogru degilse, cevap
**[412 Precondition Failed](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412)** durum kodu ile doner.
### SMS ile Dogrulama
Odeme islemi yapilmadan once sms dogrulamasi yapilmak istenir.
```php
use Illuminate\Http\Request;
use OnurSimsek\Precondition\Validators\PreconditionValidator;
class SmsValidator extends PreconditionValidator
{
public function preProcess(): void
{
cache()->set('sms', '123456');
}
public function parameter(Request $request)
{
return $request->input('sms_code');
}
public function __invoke(Request $request): bool
{
return $this->parameter($request) == cache()->get('sms');
}
}
```
### Opsiyonel Dogrulama
Dogrulamayi duruma gore yapmak istiyorsaniz asagidaki gibi **when** method'unu kullanabilirsiniz.
```php
use Illuminate\Http\Request;
use OnurSimsek\Precondition\Validators\PreconditionValidator;
class PrivateArticleValidator extends PreconditionValidator
{
public function when(Request $request)
{
return $request->route('article')->is_private;
}
public function parameter(Request $request)
{
return $request->header('X-Article-Secret-Code');
}
public function __invoke(Request $request): bool
{
return $this->parameter($request) == $request->route('article')->secret_code;
}
}
```
Hata mesajlarini ozellestirmek icin validator class'inda **messages()** metodunu kullanabilirsiniz.
```php
public function messages(): array
{
return [
'required' => 'Telefonunuza gelen sms kodunu giriniz.',
'failed' => 'Sms kodunu dogru girmediniz!',
];
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Onur Simsek](https://github.com/onursimsek)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.