digitonic / api-test-suite

src/Concerns/InteractsWithApi.php

<?php

namespace Digitonic\ApiTestSuite\Concerns;

use Illuminate\Foundation\Testing\TestResponse;

trait InteractsWithApi
{
    public $user;

    /**
     * @param null $data

Are you sure the doc-type for parameter $data is correct as it would always require null to be passed?

     * @param array $params
     * @param array $headers
     * @return TestResponse
     */
    protected function doAuthenticatedRequest($data, array $params = [], $headers = [])
    {
        return $this->actingAs($this->user, 'api')->doRequest($data, $params, $headers);

It seems like actingAs() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param array $data
     * @param array $params
     * @param array $headers
     * @return TestResponse
     */
    protected function doRequest($data, array $params = [], $headers = [])
    {
        return $this->call(

It seems like call() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->httpAction(),

It seems like httpAction() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            route($this->routeName(), $params),

It seems like routeName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $data,
            [],
            [],
            empty($headers) ? $this->defaultHeaders() : $headers
        );
    }

    protected function defaultHeaders()
    {
        return config('digitonic.api-test-suite.default_headers');
    }

    /**
     * @param TestResponse $response
     * @return array
     */
    protected function getResponseData(TestResponse $response)
    {
        $data = json_decode($response->getContent(), true);

        if (!isset($data['data'])) {
            $this->fail('The response data is empty. Content: '. $response->getContent());

It seems like fail() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $data['data'];
    }
}