Laravel\Forge\ServerResources\ServerResource

Complexity

Total Complexity

12

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
	resourceType()	0	1	?
	resourcePath()	0	1	?
A	createFromResponse()	0	11	2
A	getServer()	0	4	1
A	getHttpClient()	0	4	1
A	getData()	0	4	1
A	apiUrl()	0	8	2
A	id()	0	4	1
A	update()	0	17	2
A	delete()	0	6	1

<?php

namespace Laravel\Forge\ServerResources;

use ArrayAccess;
use Laravel\Forge\Server;
use InvalidArgumentException;
use GuzzleHttp\ClientInterface;
use Psr\Http\Message\ResponseInterface;
use Laravel\Forge\Traits\ArrayAccessTrait;

abstract class ServerResource implements ArrayAccess
{
    use ArrayAccessTrait;

    /**
     * Associated server.
     *
     * @var \Laravel\Forge\Server
     */
    protected $server;

    /**
     * Resource data.
     *
     * @var array
     */
    protected $data = [];

    /**
     * Create new resource instance.
     *
     * @param \Laravel\Forge\Server $server
     * @param array                 $data   = []
     */
    public function __construct(Server $server, array $data = [])
    {
        $this->server = $server;
        $this->data = $data;
    }

    /**
     * Resource type.
     *
     * @return string
     */
    abstract public static function resourceType();

    /**
     * Resource path (relative to Server URL).
     *
     * @return string
     */
    abstract public function resourcePath();

    /**
     * Create new resource instance from HTTP response.
     *
     * @param \Psr\Http\Message\ResponseInterface $response
     * @param \Laravel\Forge\Server               $server
     */
    public static function createFromResponse(ResponseInterface $response, Server $server)
    {
        $data = json_decode((string) $response->getBody(), true);
        $resource = static::resourceType();

        if (empty($data[$resource])) {
            throw new InvalidArgumentException('Given response is not a '.$resource.' response.');
        }

        return new static($server, $data[$resource]);
    }

    /**
     * Associated server.
     *
     * @return \Laravel\Forge\Server
     */
    public function getServer()
    {
        return $this->server;
    }

    /**
     * HTTP Client from API provider.
     *
     * @return \GuzzleHttp\ClientInterface
     */
    public function getHttpClient(): ClientInterface
    {
        return $this->getServer()->getApi()->getClient();
    }

    /**
     * Get resource data.
     *
     * @param string|int $key
     * @param mixed      $default = null
     *
     * @return mixed|null
     */
    public function getData($key, $default = null)
    {
        return $this->data[$key] ?? $default;
    }

    /**
     * Resource API URL.
     *
     * @return string
     */
    public function apiUrl($path = '')
    {
        $path = ($path ? '/'.ltrim($path, '/') : '');

        return $this->server->apiUrl(
            $this->resourcePath().'/'.$this->id().$path
        );
    }

    /**
     * Resource ID.
     *
     * @return int
     */
    public function id(): int
    {
        return intval($this->getData('id', 0));
    }

    /**
     * Update resource data.
     *
     * @return bool
     */
    public function update(array $payload): bool
    {
        $response = $this->getHttpClient()->request('PUT', $this->apiUrl(), [
            'form_params' => $payload,
        ]);

        $json = json_decode((string) $response->getBody(), true);
        $resource = static::resourceType();

        if (empty($json[$resource])) {
            return false;
        }

        $this->data = $json[$resource];

        return true;
    }

    /**
     * Delete current resource.
     *
     * @return bool
     */
    public function delete()
    {
        $this->getHttpClient()->request('DELETE', $this->apiUrl());

        return true;
    }
}