VGirol\JsonApiAssert\Laravel\Asserts\Response\AssertCreated

Complexity

Total Complexity

3

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	assertIsCreatedResponse()	0	38	3

<?php

namespace VGirol\JsonApiAssert\Laravel\Asserts\Response;

use Illuminate\Testing\TestResponse;
use PHPUnit\Framework\Assert as PHPUnit;
use VGirol\JsonApiAssert\Laravel\HttpHeader;
use VGirol\JsonApiAssert\Laravel\Messages;
use VGirol\JsonApiConstant\Members;

/**
 * This trait adds the ability to test response returned after resource creation.
 */
trait AssertCreated
{
    /**
     * Asserts that a response object is a valid "201 Created" response following a creation request.
     *
     * @param TestResponse $response
     * @param array        $expected The expected newly created resource object
     * @param boolean      $strict   If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsCreatedResponse(
        TestResponse $response,
        $expected,
        bool $strict
    ) {
        $response->assertStatus(201);
        $response->assertHeader(
            HttpHeader::HEADER_NAME,
            HttpHeader::MEDIA_TYPE
        );

        // Decode JSON response
        $json = $response->json();

        // Checks response structure
        static::assertHasValidStructure(
            $json,
            $strict
        );

        // Checks data member
        static::assertHasData($json);
        $data = $json[Members::DATA];

        static::assertIsNotArrayOfObjects($data);

        static::assertResourceObjectEquals(
            $expected,
            $data
        );

        // Checks Location header
        $header = $response->headers->get('Location');
        if (($header !== null) && isset($data[Members::LINKS][Members::LINK_SELF])) {
            PHPUnit::assertEquals(
                $header,
                $data[Members::LINKS][Members::LINK_SELF],
                Messages::LOCATION_HEADER_IS_NOT_AS_EXPECTED
            );
        }
    }
}