Laravel\Forge\Servers\Providers\Provider

Complexity

Total Complexity

33

Size/Duplication

Total Lines	371
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	initProvider()	0	4	1
A	provider()	0	4	1
A	regions()	0	4	1
A	sizes()	0	4	1
A	phpVersions()	0	4	1
A	validate()	0	4	1
A	regionAvailable()	0	4	1
A	memoryAvailable()	0	4	1
A	resourceAvailable()	0	4	1
A	hasPayload()	0	4	1
A	usingCredential()	0	6	1
A	identifiedAs()	0	6	1
A	withMemoryOf()	0	10	2
A	at()	0	10	2
A	runningPhp()	0	12	2
A	withMariaDb()	0	7	1
A	withMysql()	0	7	1
A	asLoadBalancer()	0	4	1
A	asNodeBalancer()	0	4	1
A	connectedTo()	0	6	1
A	usingPublicIp()	0	6	1
A	usingPrivateIp()	0	6	1
A	save()	0	16	2
A	sortPayload()	0	8	1
A	togglePayload()	0	10	4

<?php

namespace Laravel\Forge\Servers\Providers;

use Laravel\Forge\Server;
use InvalidArgumentException;
use Laravel\Forge\ApiProvider;

abstract class Provider
{
    /**
     * @var \Laravel\Forge\ApiProvider
     */
    protected $api;

    /**
     * @var array
     */
    protected $payload = [];

    /**
     * Create new server provider instance.
     *
     * @param \Laravel\Forge\ApiProvider $api
     */
    public function __construct(ApiProvider $api)
    {
        $this->api = $api;
        $this->initProvider();
    }

    /**
     * Initializes server provider.
     */
    protected function initProvider()
    {
        $this->payload['provider'] = $this->provider();
    }

    /**
     * Server provider name.
     *
     * @return string
     */
    public function provider()
    {
        return 'abstract';
    }

    /**
     * Server provider regions list.
     *
     * @return array
     */
    public function regions()
    {
        return [];
    }

    /**
     * Server provider server sizes.
     *
     * @return array
     */
    public function sizes()
    {
        return [];
    }

    /**
     * Available PHP versions.
     *
     * @return array
     */
    public function phpVersions()
    {
        return [56, 70, 71];
    }

    /**
     * Validates payload before sending to Forge API.
     *
     * @return bool|array
     */
    public function validate()
    {
        return true;
    }

    /**
     * Determines if given region is available at current provider.
     *
     * @param string $region
     *
     * @return bool
     */
    public function regionAvailable(string $region)
    {
        return $this->resourceAvailable($this->regions(), $region);
    }

    /**
     * Determines if given memory size is available at current provider.
     *
     * @param string|int $memory
     *
     * @return bool
     */
    public function memoryAvailable($memory)
    {
        return $this->resourceAvailable($this->sizes(), $memory);
    }

    /**
     * Determines if given resource exists in resources list.
     *
     * @param array $resources
     * @param mixed $resource
     *
     * @return bool
     */
    protected function resourceAvailable(array $resources, $resource)
    {
        return isset($resources[$resource]);
    }

    /**
     * Determines if given key exists in current payload.
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasPayload(string $key): bool
    {
        return !empty($this->payload[$key]);
    }

    /**
     * Set credential ID to create server with.
     *
     * @param int $credentialId
     *
     * @return static
     */
    public function usingCredential(int $credentialId)
    {
        $this->payload['credential_id'] = $credentialId;

        return $this;
    }

    /**
     * Set new server name.
     *
     * @param string $name
     *
     * @return static
     */
    public function identifiedAs(string $name)
    {
        $this->payload['name'] = $name;

        return $this;
    }

    /**
     * Set memory / server size.
     *
     * @param int|string $memory
     *
     * @return static
     */
    public function withMemoryOf($memory)
    {
        if (!$this->memoryAvailable($memory)) {
            throw new InvalidArgumentException('Given memory value is not supported by '.$this->provider().' provider.');
        }

        $this->payload['size'] = $memory;

        return $this;
    }

    /**
     * Set server region.
     *
     * @param string $region
     *
     * @return static
     */
    public function at(string $region)
    {
        if (!$this->regionAvailable($region)) {
            throw new InvalidArgumentException('Given region is not supported by '.$this->provider().' provider.');
        }

        $this->payload['region'] = $region;

        return $this;
    }

    /**
     * Set PHP version.
     *
     * @param int|string $version
     *
     * @return static
     */
    public function runningPhp($version)
    {
        $phpVersion = intval(str_replace(['php', '.'], '', $version));

        if (!in_array($phpVersion, $this->phpVersions())) {
            throw new InvalidArgumentException('PHP version "php'.$phpVersion.'" is not supported.');
        }

        $this->payload['php_version'] = 'php'.$phpVersion;

        return $this;
    }

    /**
     * Indicates that server should be provisioned with MariaDB instead of MySQL.
     *
     * @param string $database = 'forge'
     *
     * @return static
     */
    public function withMariaDb(string $database = 'forge')
    {
        $this->payload['maria'] = 1;
        $this->payload['database'] = $database;

        return $this;
    }

    /**
     * Indicates that server should be provisioned with MySQL.
     *
     * @param string $database = 'forge'
     *
     * @return static
     */
    public function withMysql(string $database = 'forge')
    {
        $this->payload['maria'] = 0;
        $this->payload['database'] = $database;

        return $this;
    }

    /**
     * Indicates that server should be provisioned as load balancer.
     *
     * @param bool $install = true
     *
     * @deprecated since 1.3.1
     * @see Provider::asNodeBalancer()
     *
     * @return static
     */
    public function asLoadBalancer(bool $install = true)
    {
        return $this->asNodeBalancer($install);
    }

    /**
     * Indicates that server should be provisioned as load balancer.
     *
     * @param bool $install = true
     *
     * @return static
     */
    public function asNodeBalancer(bool $install = true)
    {
        return $this->togglePayload('node_balancer', $install);
    }

    /**
     * Servers ID that the new server should be connected to.
     *
     * @param array $servers
     *
     * @return static
     */
    public function connectedTo(array $servers)
    {
        $this->payload['network'] = $servers;

        return $this;
    }

    /**
     * Public IP address.
     *
     * @param string $ip
     *
     * @return static
     */
    public function usingPublicIp(string $ip)
    {
        $this->payload['ip_address'] = $ip;

        return $this;
    }

    /**
     * Private IP address.
     *
     * @param string $ip
     *
     * @return static
     */
    public function usingPrivateIp(string $ip)
    {
        $this->payload['private_ip_address'] = $ip;

        return $this;
    }

    /**
     * Create new server.
     *
     * @throws \GuzzleHttp\Exception\RequestException
     * @throws \InvalidArgumentException
     *
     * @return \Laravel\Forge\Server
     */
    public function save()
    {
        $validationResult = $this->validate();

        if ($validationResult !== true) {
            throw new InvalidArgumentException(
                'Some required parameters are missing: '.implode(', ', $validationResult)
            );
        }

        $response = $this->api->getClient()->request('POST', 'servers', [
            'json' => $this->sortPayload(),
        ]);

        return Server::createFromResponse($response, $this->api);
    }

    /**
     * Sort payload data by key name.
     *
     * @return array
     */
    protected function sortPayload(): array
    {
        $payload = $this->payload;

        ksort($payload);

        return $payload;
    }

    /**
     * Toggle boolean payload key.
     *
     * @param string $key
     * @param bool   $install
     *
     * @return static
     */
    protected function togglePayload(string $key, bool $install)
    {
        if ($install === false && isset($this->payload[$key])) {
            unset($this->payload[$key]);
        } elseif ($install === true) {
            $this->payload[$key] = 1;
        }

        return $this;
    }
}