riverwaysoft/api-tools

Api tools

0.2.9.6 2023-08-22 10:12 UTC

Requires

• php: ^8.0|^8.1
• ext-intl: *
• giggsey/libphonenumber-for-php: ^8.11
• moneyphp/money: ^3
• myclabs/php-enum: ^1.7
• phpdocumentor/reflection-docblock: ^5.2
• symfony/intl: ^5.3|^6.0|^6.2
• symfony/polyfill-uuid: ^1.23
• symfony/serializer: ^5.3|6.0.1|^6.2

Requires (Dev)

• api-platform/core: ^2.6
• doctrine/orm: ^2.9
• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5
• spatie/phpunit-snapshot-assertions: ^4.2
• symfony/messenger: ^5.3|^6.0|^6.2
• symfony/validator: ^5.3|^6.0|^6.2

Suggests

• api-platform/core: ^2.6
• doctrine/orm: ^2.9
• symfony/messenger: ^5.3|^6.0|^6.2

proprietary

• mitalcoi

README

Installation

composer req riverwaysoft/api-tools

What's inside?

TelephoneObject

Wrapper around libphonenumber + PhoneNumberType for DoctrineType. Configuration:

doctrine:
    dbal:
        types:
            phone_number: Riverwaysoft\ApiTools\Telephone\Doctrine\DBAL\Types\TelephoneObjectType

ApiPlatform extra

Extra serializers (Enum, TelephoneObject, Money)

Configuration:

$services
    ->load('Riverwaysoft\\ApiTools\\ApiPlatform\\Serializer\\', __DIR__ . '/../vendor/riverwaysoft/api-tools/src/Lib/ApiPlatform/Serializer');

Extra filters (look riveradmin ;))

• RiverAdminEnumSearchFilter
• RiverAdminSearchFilter
• RiverAdminBooleanFilter
• AbstractFullTextSearchFilter

Domain Events

Usage:

class UserRegisteredMessage {
    public function __construct(public string $username) {}
}

use Riverwaysoft\ApiTools\DomainEvents\EventSourceCollector;
class User extends EventSourceCollector {
    
    public function signUp(string $username){
        $this->rememberMessage(new UserRegisteredMessage($username));
    }
    
}

# After that message can be consumed with:

$user = new User();
$messages = $user->popMessages();

Or it can be done automatically with doctrine adapter:

Configuration:

    $services->set(Riverwaysoft\ApiTools\DomainEvents\Doctrine\DoctrineDomainEventsCollector::class)->public()
        ->tag('doctrine.event_listener', ['event' => "postPersist"])
        ->tag('doctrine.event_listener', ['event' => "postUpdate"])
        ->tag('doctrine.event_listener', ['event' => "postFlush"])
        ->tag('doctrine.event_listener', ['event' => "postLoad"]);

InputValueResolver

A set of automatic serializers of HTTP POST body and GET query into typed objects.

#[Query] attribute usage:

class UserFilter
{
    public function __construct(
        public int $ageGreaterThan,
        public string $name,
    ) {
    }
}

class CreateUserInput {
    public function __construct(
        public int $age,
        public string $name,
    ) {
    } 
}

use Riverwaysoft\ApiTools\InputValueResolver\Query;
use Riverwaysoft\ApiTools\InputValueResolver\Input;

class UserController
{
    #[Route('/api/users', methods: ['GET'])]
    public function getUsers(#[Query] UserFilter $userFilter)
    {
        // Use $userFilter for requests like
        // /api/users?ageGreaterThan=18&name=test
    }
    
    #[Route('/api/users', methods: ['POST'])]
    public function createUser(#[Input] CreateUserInput $input)
    {
        // variable $input will be automatically created
        // from the request body   
    }
}

Configuration in services.yml:

  Riverwaysoft\ApiTools\InputValueResolver\:
    resource: '../vendor/riverwaysoft/api-tools/src/InputValueResolver'

UnicodeIgnoreOrderJsonDriver

A driver for the phpunit-snapshot-assertions library. This driver is responsible for 3 main things:

1. Show unicode characters unescaped in json, so you'll see "£" instead of "\u00a3"
2. Ignore property order. Example equal json {a: 1, b: 2} and {b: 2, a: 1}
3. Ignore order of array elements in json. Example equal json arrays [{a: 1}, {b: 2}] and [{b: 2}, {a: 1}]

How to use

Add the following trait to all your tests:

use Riverwaysoft\ApiTools\Testing\UnicodeIgnoreOrderJsonDriver;

//

public function assertMatchesJsonUnicodeSnapshot(mixed $actual): void
{
    $this->assertMatchesSnapshot($actual, new UnicodeIgnoreOrderJsonDriver());
}

Use assertMatchesJsonUnicodeSnapshot instead of the assertMatchesJsonSnapshot.