assurdeal/laravel-orias

Work with the ORIAS web service in Laravel

v0.2.1 2024-07-12 07:45 UTC

This package is auto-updated.

Last update: 2024-10-12 08:15:10 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package allows you to integrate the ORIAS webservice into your Laravel application. You can use it to validate an ORIAS number, or to retrieve information about a Broker.

Installation

You can install the package via composer:

composer require assurdeal/laravel-orias

Add your ORIAS webservice API key to your .env file

ORIAS_KEY=your-api-key

Usage

use Assurdeal\LaravelOrias\Requests\ShowBrokerRequest;

$response = ShowBrokerRequest::make('123456789')->send();

/** @var \Assurdeal\LaravelOrias\Data\Intermediary $dto */
$dto = $response->dto();

Usage as validator

use Assurdeal\LaravelOrias\Rules\RegisteredIntermediary;
use Assurdeal\LaravelOrias\Enums\RegistrationCategory;

Validator::make($data, [
    'orias' => ['required', new RegisteredIntermediary()],
]);

Validator::make($data, [
    'orias' => [
        'required', 
        (new RegisteredIntermediary())->withAllOfCategories(
            RegistrationCategory::COA,
            RegistrationCategory::AGA
        )
    ],
]);

Validator::make($data, [
    'orias' => [
        'required', 
        (new RegisteredIntermediary())->withAnyOfCategories(
            RegistrationCategory::COA,
            RegistrationCategory::AGA
        )
    ],
]);

Translations

Add the following lines to your lang/xx.json files where xx represents the locale you want to translate in.

Example for resources/fr.json

{
  "The :attribute is not of a valid length.": "Le :attribute n'est pas d'une longueur valide.",
  "The :attribute is not a registered intermediary.": "Le :attribute n'est pas un intermédiaire enregistré.",
  "The :attribute was not found in the registry of intermediaries.": "Le :attribute n'a pas été trouvé dans le registre des intermédiaires.",
  "The :attribute is not registered for any of the valid categories.": "Le :attribute n'est pas enregistré pour aucune des catégories valides.",
  "The :attribute is not registered for all of the valid categories.": "Le :attribute n'est pas enregistré pour toutes les catégories valides."
}

Testing

composer test

Credits

License

The MIT License (MIT). Please see License File for more information.