Zurbaev\ApiClient\Commands\ApiCommand

Complexity

Total Complexity

26

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	runnable()	0	3	1
A	requestUrl()	0	3	1
A	requestMethod()	0	3	1
A	description()	0	3	1
A	withPayload()	0	5	1
A	attachPayload()	0	9	2
A	on()	0	11	3
A	requestOptions()	0	8	2
A	executeOn()	0	9	2
B	hasPayloadData()	0	17	5
A	execute()	0	9	2
A	executeOnMulitpleResources()	0	9	2
A	getPayloadData()	0	7	2
A	from()	0	3	1

<?php

namespace Zurbaev\ApiClient\Commands;

use Psr\Http\Message\ResponseInterface;
use Zurbaev\ApiClient\Contracts\ApiResourceInterface;

abstract class ApiCommand
{
    /**
     * Command payload.
     *
     * @var array
     */
    protected $payload = [];

    /**
     * Command name.
     *
     * @return string
     */
    abstract public function command();

    /**
     * Command description.
     *
     * @return string
     */
    public function description()
    {
        return '';
    }

    /**
     * Determines if command can run.
     *
     * @return bool
     */
    public function runnable()
    {
        return true;
    }

    /**
     * HTTP request method.
     *
     * @return string
     */
    public function requestMethod()
    {
        return 'POST';
    }

    /**
     * HTTP request URL.
     *
     * @param ApiResourceInterface $owner
     *
     * @return string
     */
    public function requestUrl(ApiResourceInterface $owner)
    {
        return $owner->apiUrl();
    }

    /**
     * HTTP request options.
     *
     * @return array|null
     */
    public function requestOptions()
    {
        if (empty($this->payload)) {
            return null;
        }

        return [
            'json' => $this->payload,
        ];
    }

    /**
     * Set command payload.
     *
     * @param array $payload
     *
     * @return $this
     */
    public function withPayload(array $payload)
    {
        $this->payload = $payload;

        return $this;
    }

    /**
     * Set payload data.
     *
     * @param string|int $key
     * @param mixed      $value
     *
     * @return $this
     */
    public function attachPayload($key, $value)
    {
        if (is_null($this->payload)) {
            $this->payload = [];
        }

        $this->payload[$key] = $value;

        return $this;
    }

    /**
     * Return payload data.
     *
     * @param string|int $key
     * @param mixed      $default = null
     *
     * @return mixed|null
     */
    public function getPayloadData($key, $default = null)
    {
        if (is_null($this->payload)) {
            return null;
        }

        return $this->payload[$key] ?? $default;
    }

    /**
     * Determines if payload has requried keys.
     *
     * @param string|int|array $keys
     *
     * @return bool
     */
    public function hasPayloadData($keys): bool
    {
        if (is_null($this->payload)) {
            return false;
        }

        if (!is_array($keys)) {
            $keys = [$keys];
        }

        foreach ($keys as $key) {
            if (!isset($this->payload[$key])) {
                return false;
            }
        }

        return true;
    }

    /**
     * Execute command on single or multiple resources.
     *
     * @param array|ApiResourceInterface $resource
     *
     * @throws \InvalidArgumentException
     *
     * @return bool|array
     */
    public function on($resource)
    {
        if (!$this->runnable()) {
            throw new \InvalidArgumentException('Command execution is restricted.');
        }

        if (is_array($resource)) {
            return $this->executeOnMulitpleResources($resource);
        }

        return $this->executeOn($resource);
    }

    /**
     * Alias for "on" command.
     *
     * @param array|ApiResourceInterface $resource
     *
     * @throws \InvalidArgumentException
     *
     * @return bool|array
     */
    public function from($resource)
    {
        return $this->on($resource);
    }

    /**
     * Execute current command on given resource.
     *
     * @param ApiResourceInterface $resource
     *
     * @return bool|mixed
     */
    protected function executeOn(ApiResourceInterface $resource)
    {
        $response = $this->execute($resource);

        if (method_exists($this, 'handleResponse')) {
            return $this->handleResponse($response, $resource);
        }

        return true;
    }

    /**
     * Execute current command on multiple resources.
     *
     * @param array $resources
     *
     * @return array
     */
    protected function executeOnMulitpleResources(array $resources): array
    {
        $results = [];

        foreach ($resources as $resource) {
            $results[$resource->name()] = $this->executeOn($resource);
        }

        return $results;
    }

    /**
     * Execute current command.
     *
     * @param ApiResourceInterface $resource
     *
     * @return ResponseInterface
     */
    protected function execute(ApiResourceInterface $resource)
    {
        $client = $resource->getHttpClient();

        if (is_null($options = $this->requestOptions())) {
            return $client->request($this->requestMethod(), $this->requestUrl($resource));
        }

        return $client->request($this->requestMethod(), $this->requestUrl($resource), $options);
    }
}