Joesama\Webhook\Connectors\AbstractConnector

Complexity

Total Complexity

9

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

22.73%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	webHookSavingData()	0	2	1
A	setConnectorId()	0	3	1
A	__construct()	0	3	1
A	getConnectorId()	0	3	1
A	webHookContentType()	0	3	1
A	webHookException()	0	15	2
A	webHookResponse()	0	9	2

<?php

namespace Joesama\Webhook\Connectors;

use GuzzleHttp\Exception\BadResponseException;
use GuzzleHttp\Exception\TransferException;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

abstract class AbstractConnector
{
    /**
     * Web Hook connector id.
     *
     * @var string
     */
    private string $webHookConnectorId;

    /**
     * Initiate connector constructor
     */
    public function __construct()
    {
        $this->setConnectorId(strtolower(class_basename($this)));
    }

    /**
     * Define request content type.
     */
    public function webHookContentType(): string
    {
        return RequestOptions::JSON;
    }

    /**
     * Define additional handling HTTP request response.
     *
     * @return mixed
     */
    public function webHookResponse(ResponseInterface $response, RequestInterface $request)

The parameter $request is not used and could be removed.

    {
        $responseContent = $response->getBody()->getContents();

        if (($jsonResponse = json_decode($responseContent, true)) === null) {
            return $responseContent;
        }

        return $jsonResponse;
    }

    /**
     * Define additional handling for exceptions.
     *
     * @return mixed
     */
    public function webHookException(TransferException $exception, RequestInterface $request): mixed

The parameter $request is not used and could be removed.

    {
        if ($exception instanceof BadResponseException) {
            $response = new Response(
                $exception->getResponse()->getStatusCode(),
                $exception->getResponse()->getHeaders(),
                $exception->getResponse()->getBody()->getContents(),
                $exception->getResponse()->getProtocolVersion(),
                $exception->getResponse()->getReasonPhrase()
            );
        } else {
            $response = new Response(500, [], $exception->getMessage());
        }

        return $response;
    }

    /**
     * Save data to data storage.
     */
    public function webHookSavingData(array $logData): void

The parameter $logData is not used and could be removed.

    {
        //@TODO: Implement saving logic here..
    }

    /**
     * Set connector id.
     */
    public function setConnectorId(string $connectorId): void
    {
        $this->webHookConnectorId = $connectorId;
    }

    /**
     * Set connector id.
     */
    public function getConnectorId(): ?string
    {
        return $this->webHookConnectorId;
    }
}