RealPage\JsonApi\MediaTypeGuard

Complexity

Total Complexity

15

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	hasCorrectHeadersForData()	0	7	3
A	__construct()	0	5	1
A	getContentType()	0	4	1
A	getAcceptHeaderPolicy()	0	4	1
A	validateExistingContentType()	0	4	2
A	clientRequestMustHaveContentTypeHeader()	0	5	2
A	contentTypeIsValid()	0	4	1
A	hasCorrectlySetAcceptHeader()	0	17	4

<?php

namespace RealPage\JsonApi;

use Illuminate\Http\Request;

class MediaTypeGuard
{
    protected $contentType;

    public function __construct(string $contentType, string $acceptHeaderPolicy)
    {
        $this->contentType = $contentType;
        $this->acceptHeaderPolicy = $acceptHeaderPolicy;

The property acceptHeaderPolicy does not exist. Did you maybe forget to declare it?

    }

    public function getContentType(): string
    {
        return $this->contentType;
    }

    public function getAcceptHeaderPolicy(): string
    {
        return $this->acceptHeaderPolicy;
    }

    public function validateExistingContentType(Request $request): bool
    {
        return str_is($this->getContentType(), $request->header('Accept')) || str_is('', $request->header('Accept'));

It seems like $request->header('Accept') targeting Illuminate\Http\Concerns\InteractsWithInput::header() can also be of type array; however, str_is() does only seem to accept string, maybe add an additional type check?

    }

    public function clientRequestMustHaveContentTypeHeader(Request $request)
    {
        $method = $request->method();
        return $method === 'POST' || $method === 'PATCH';
    }

    public function contentTypeIsValid(string $contentType): bool
    {
        return str_is($this->getContentType(), $contentType);
    }

    public function hasCorrectHeadersForData(Request $request): bool
    {
        if ($this->clientRequestMustHaveContentTypeHeader($request)) {
            return $request->hasHeader('Content-Type') && $this->contentTypeIsValid($request->header('Content-Type'));

It seems like $request->header('Content-Type') targeting Illuminate\Http\Concerns\InteractsWithInput::header() can also be of type array; however, RealPage\JsonApi\MediaTypeGuard::contentTypeIsValid() does only seem to accept string, maybe add an additional type check?

        }
        return true;
    }

    public function hasCorrectlySetAcceptHeader(Request $request): bool
    {
        if ($this->acceptHeaderPolicy === 'ignore') {
            return true;
        }

        $accept = $request->header('Accept');
        if (empty($accept)) {
            return $this->acceptHeaderPolicy !== 'require';
        }

        if ('*/*' === $accept) {
            return true;
        }

        return substr_count($accept, $this->getContentType()) > substr_count($accept, $this->getContentType() . ';');
    }
}