DataObjectWrapperTest.php

<?php

declare(strict_types=1);

use Saloon\Http\Faking\MockClient;
use Saloon\Http\Faking\MockResponse;
use Saloon\Tests\Fixtures\Data\User;
use Saloon\Contracts\DataObjects\WithResponse;
use Saloon\Tests\Fixtures\Requests\DTORequest;
use Saloon\Tests\Fixtures\Requests\UserRequest;
use Saloon\Tests\Fixtures\Data\UserWithResponse;
use Saloon\Tests\Fixtures\Requests\DTOWithResponseRequest;

test('if a dto does not implement the WithResponse interface and HasResponse trait Saloon will not add the original response', function () {
    $mockClient = new MockClient([
        new MockResponse(['name' => 'Sammyjo20', 'actual_name' => 'Sam', 'twitter' => '@carre_sam']),
    ]);

    $response = connector()->send(new DTORequest, $mockClient);

    $dto = $response->dto(User::class);

    expect($dto)->toBeInstanceOf(User::class);
    expect($dto)->not->toBeInstanceOf(WithResponse::class);
});

test('if a dto implements the WithResponse interface and HasResponse trait Saloon will add the original response', function () {
    $mockClient = new MockClient([
        new MockResponse(['name' => 'Sammyjo20', 'actual_name' => 'Sam', 'twitter' => '@carre_sam']),
    ]);

    $request = new DTOWithResponseRequest();
    $response = connector()->send($request, $mockClient);

    /** @var UserWithResponse $dto */
    $dto = $response->dto();

    expect($dto)->toBeInstanceOf(UserWithResponse::class);
    expect($dto)->toBeInstanceOf(WithResponse::class);
    expect($dto->getResponse())->toBe($response);
});

test('if a dto type is provided and the class does not support a dto null is still returned', function () {
    $mockClient = new MockClient([
        new MockResponse(['name' => 'Sammyjo20', 'actual_name' => 'Sam', 'twitter' => '@carre_sam']),
    ]);

    $response = connector()->send(new UserRequest, $mockClient);

    $dto = $response->dto(User::class);

    expect($dto)->toBeNull();
});

test('if a dto type is provided and the class returned doesnt match an exception is thrown', function () {
    $mockClient = new MockClient([
        new MockResponse(['name' => 'Sammyjo20', 'actual_name' => 'Sam', 'twitter' => '@carre_sam']),
    ]);

    $response = connector()->send(new DTORequest, $mockClient);

    $this->expectException(InvalidArgumentException::class);
    $this->expectExceptionMessage('The class-string provided [Saloon\Tests\Fixtures\Data\UserWithResponse] must match the class-string returned by the connector/request [Saloon\Tests\Fixtures\Data\User].');

    $response->dto(UserWithResponse::class);
});