Server::getApi() - Code Metrics - Inspection of "Fix Linode datacenters list. Add more getters to S..." - tzurbaev/laravel-forge-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0ac51f...eeaba4 )

by Timur

created 2017-03-13 11:37 UTC

Server::getApi() A

↳ Parent: Server

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Laravel\Forge;

use ArrayAccess;
use Psr\Http\Message\ResponseInterface;
use Laravel\Forge\Traits\ArrayAccessTrait;
use Laravel\Forge\Exceptions\Servers\PublicKeyWasNotFound;
use Laravel\Forge\Exceptions\Servers\ServerWasNotFoundException;

class Server implements ArrayAccess
{
    use ArrayAccessTrait;

    /**
     * API provider.
     *
     * @var \Laravel\Forge\ApiProvider
     */
    protected $api;

    /**
     * Server data.
     *
     * @var array
     */
    protected $data;

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

    /**
     * Create new server instance from HTTP response.
     *
     * @param \Psr\Http\Message\ResponseInterface $response
     * @param \Laravel\Forge\ApiProvider          $api      = null
     *
     * @throws \Laravel\Forge\Exceptions\Servers\ServerWasNotFoundException
     *
     * @return static
     */
    public static function createFromResponse(ResponseInterface $response, ApiProvider $api = null)
    {
        $json = json_decode((string) $response->getBody(), true);

        if (empty($json['server'])) {
            throw new ServerWasNotFoundException('Given response is not a server response.');
        }

        return new static($api, $json['server']);
    }

    /**
     * Server data.
     *
     * @param string $key     = null
     * @param mixed  $default = null
     *
     * @return mixed|array|null
     */
    protected function serverData(string $key = null, $default = null)
    {
        if (is_null($key)) {
            return $this->data;
        }

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

    /**
     * API provider.
     *
     * @return \Laravel\Forge\ApiProvider
     */
    public function getApi(): ApiProvider
    {
        return $this->api;
    }

    /**
     * Server ID.
     *
     * @return int
     */
    public function id(): int
    {
        return intval($this->serverData('id'));
    }

    /**
     * Credential ID.
     *
     * @return int
     */
    public function credentialId(): int
    {
        return intval($this->serverData('credential_id'));
    }

    /**
     * Server name.
     *
     * @return string|null
     */
    public function name()
    {
        return $this->serverData('name');
    }

    /**
     * Human readable server size.
     *
     * @return string|null
     */
    public function size()
    {
        return $this->serverData('size');
    }

    /**
     * Server region.
     *
     * @return string|null
     */
    public function region()
    {
        return $this->serverData('region');
    }

    /**
     * Server's PHP version.
     *
     * @return string|null
     */
    public function phpVersion()
    {
        return $this->serverData('php_version');
    }

    /**
     * Server public IP address.
     *
     * @return string|null
     */
    public function ip()
    {
        return $this->serverData('ip_address');
    }

    /**
     * Server private IP address.
     */
    public function privateIp()
    {
        return $this->serverData('private_ip_address');
    }

    /**
     * Blackfire service status.
     *
     * @return string|null
     */
    public function blackfireStatus()
    {
        return $this->serverData('blackfire_status');
    }

    /**
     * Papertrail service status.
     *
     * @return string
     */
    public function parerTrailStatus()
    {
        return $this->serverData('papertrail_status');
    }

    /**
     * Determines if server access was revoked from Forge.
     *
     * @return bool
     */
    public function isRevoked(): bool
    {
        return intval($this->serverData('revoked')) === 1;
    }

    /**
     * Determines if server was provisioned and ready to use.
     *
     * @return bool
     */
    public function isReady(): bool
    {
        return intval($this->serverData('is_ready')) === 1;
    }

    /**
     * Network status.
     *
     * @return array|null
     */
    public function network()
    {
        return $this->serverData('network');
    }

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

        return 'servers/'.$this->id().$path;
    }

    /**
     * Update server data.
     *
     * @param array $payload
     *
     * @return bool
     */
    public function update(array $payload): bool
    {
        ksort($payload);

        $response = $this->api->getClient()->request('PUT', $this->apiUrl(), [
            'form_params' => $payload,
        ]);

        $json = json_decode((string) $response->getBody(), true);

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

        $this->data = $json['server'];

        return true;
    }

    /**
     * Reboot the server.
     *
     * @return bool
     */
    public function reboot(): bool
    {
        $this->api->getClient()->request('POST', $this->apiUrl('reboot'));

        return true;
    }

    /**
     * Revoke Forge access to server.
     *
     * @return bool
     **/
    public function revokeAccess(): bool
    {
        $this->api->getClient()->request('POST', $this->apiUrl('/revoke'));

        return true;
    }

    /**
     * Reconnect revoked server.
     *
     * @return string Public SSH key.
     */
    public function reconnect(): string
    {
        $response = $this->api->getClient()->request('POST', $this->apiUrl('/reconnect'));
        $json = json_decode((string) $response->getBody(), true);

        if (empty($json['public_key'])) {
            throw new PublicKeyWasNotFound(
                'Public key was not found after reconnecting revoked server (ID: '.$this->id().').',
                404
            );
        }

        return $json['public_key'];
    }

    /**
     * Reactivate revoked server. Make sure you've installed public SSH key
     * before calling this method.
     *
     * @return bool
     */
    public function reactivate(): bool
    {
        $this->api->getClient()->request('POST', $this->apiUrl('/reactivate'));

        return true;
    }

    /**
     * Delete the server.
     *
     * @return bool
     */
    public function delete(): bool
    {
        $this->api->getClient()->request('DELETE', $this->apiUrl());

        return true;
    }
}


1			<?php
2
3			namespace Laravel\Forge;
4
5			use ArrayAccess;
6			use Psr\Http\Message\ResponseInterface;
7			use Laravel\Forge\Traits\ArrayAccessTrait;
8			use Laravel\Forge\Exceptions\Servers\PublicKeyWasNotFound;
9			use Laravel\Forge\Exceptions\Servers\ServerWasNotFoundException;
10
11			class Server implements ArrayAccess
12			{
13			use ArrayAccessTrait;
14
15			/**
16			* API provider.
17			*
18			* @var \Laravel\Forge\ApiProvider
19			*/
20			protected $api;
21
22			/**
23			* Server data.
24			*
25			* @var array
26			*/
27			protected $data;
28
29			/**
30			* Create new server instance.
31			*
32			* @param \Laravel\Forge\ApiProvider $api = null
33			* @param array $data = []
34			*/
35			public function __construct(ApiProvider $api = null, array $data = [])
36			{
37			$this->api = $api;
38			$this->data = $data;
39			}
40
41			/**
42			* Create new server instance from HTTP response.
43			*
44			* @param \Psr\Http\Message\ResponseInterface $response
45			* @param \Laravel\Forge\ApiProvider $api = null
46			*
47			* @throws \Laravel\Forge\Exceptions\Servers\ServerWasNotFoundException
48			*
49			* @return static
50			*/
51			public static function createFromResponse(ResponseInterface $response, ApiProvider $api = null)
52			{
53			$json = json_decode((string) $response->getBody(), true);
54
55			if (empty($json['server'])) {
56			throw new ServerWasNotFoundException('Given response is not a server response.');
57			}
58
59			return new static($api, $json['server']);
60			}
61
62			/**
63			* Server data.
64			*
65			* @param string $key = null
66			* @param mixed $default = null
67			*
68			* @return mixed\|array\|null
69			*/
70			protected function serverData(string $key = null, $default = null)
71			{
72			if (is_null($key)) {
73			return $this->data;
74			}
75
76			return $this->data[$key] ?? $default;
77			}
78
79			/**
80			* API provider.
81			*
82			* @return \Laravel\Forge\ApiProvider
83			*/
84			public function getApi(): ApiProvider
85			{
86			return $this->api;
87			}
88
89			/**
90			* Server ID.
91			*
92			* @return int
93			*/
94			public function id(): int
95			{
96			return intval($this->serverData('id'));
97			}
98
99			/**
100			* Credential ID.
101			*
102			* @return int
103			*/
104			public function credentialId(): int
105			{
106			return intval($this->serverData('credential_id'));
107			}
108
109			/**
110			* Server name.
111			*
112			* @return string\|null
113			*/
114			public function name()
115			{
116			return $this->serverData('name');
117			}
118
119			/**
120			* Human readable server size.
121			*
122			* @return string\|null
123			*/
124			public function size()
125			{
126			return $this->serverData('size');
127			}
128
129			/**
130			* Server region.
131			*
132			* @return string\|null
133			*/
134			public function region()
135			{
136			return $this->serverData('region');
137			}
138
139			/**
140			* Server's PHP version.
141			*
142			* @return string\|null
143			*/
144			public function phpVersion()
145			{
146			return $this->serverData('php_version');
147			}
148
149			/**
150			* Server public IP address.
151			*
152			* @return string\|null
153			*/
154			public function ip()
155			{
156			return $this->serverData('ip_address');
157			}
158
159			/**
160			* Server private IP address.
161			*/
162			public function privateIp()
163			{
164			return $this->serverData('private_ip_address');
165			}
166
167			/**
168			* Blackfire service status.
169			*
170			* @return string\|null
171			*/
172			public function blackfireStatus()
173			{
174			return $this->serverData('blackfire_status');
175			}
176
177			/**
178			* Papertrail service status.
179			*
180			* @return string
181			*/
182			public function parerTrailStatus()
183			{
184			return $this->serverData('papertrail_status');
185			}
186
187			/**
188			* Determines if server access was revoked from Forge.
189			*
190			* @return bool
191			*/
192			public function isRevoked(): bool
193			{
194			return intval($this->serverData('revoked')) === 1;
195			}
196
197			/**
198			* Determines if server was provisioned and ready to use.
199			*
200			* @return bool
201			*/
202			public function isReady(): bool
203			{
204			return intval($this->serverData('is_ready')) === 1;
205			}
206
207			/**
208			* Network status.
209			*
210			* @return array\|null
211			*/
212			public function network()
213			{
214			return $this->serverData('network');
215			}
216
217			/**
218			* Server's API URL.
219			*
220			* @param string $path = ''
221			*
222			* @return string
223			*/
224			public function apiUrl(string $path = ''): string
225			{
226			$path = ($path ? '/'.ltrim($path, '/') : '');
227
228			return 'servers/'.$this->id().$path;
229			}
230
231			/**
232			* Update server data.
233			*
234			* @param array $payload
235			*
236			* @return bool
237			*/
238			public function update(array $payload): bool
239			{
240			ksort($payload);
241
242			$response = $this->api->getClient()->request('PUT', $this->apiUrl(), [
243			'form_params' => $payload,
244			]);
245
246			$json = json_decode((string) $response->getBody(), true);
247
248			if (empty($json['server'])) {
249			return false;
250			}
251
252			$this->data = $json['server'];
253
254			return true;
255			}
256
257			/**
258			* Reboot the server.
259			*
260			* @return bool
261			*/
262			public function reboot(): bool
263			{
264			$this->api->getClient()->request('POST', $this->apiUrl('reboot'));
265
266			return true;
267			}
268
269			/**
270			* Revoke Forge access to server.
271			*
272			* @return bool
273			**/
274			public function revokeAccess(): bool
275			{
276			$this->api->getClient()->request('POST', $this->apiUrl('/revoke'));
277
278			return true;
279			}
280
281			/**
282			* Reconnect revoked server.
283			*
284			* @return string Public SSH key.
285			*/
286			public function reconnect(): string
287			{
288			$response = $this->api->getClient()->request('POST', $this->apiUrl('/reconnect'));
289			$json = json_decode((string) $response->getBody(), true);
290
291			if (empty($json['public_key'])) {
292			throw new PublicKeyWasNotFound(
293			'Public key was not found after reconnecting revoked server (ID: '.$this->id().').',
294			404
295			);
296			}
297
298			return $json['public_key'];
299			}
300
301			/**
302			* Reactivate revoked server. Make sure you've installed public SSH key
303			* before calling this method.
304			*
305			* @return bool
306			*/
307			public function reactivate(): bool
308			{
309			$this->api->getClient()->request('POST', $this->apiUrl('/reactivate'));
310
311			return true;
312			}
313
314			/**
315			* Delete the server.
316			*
317			* @return bool
318			*/
319			public function delete(): bool
320			{
321			$this->api->getClient()->request('DELETE', $this->apiUrl());
322
323			return true;
324			}
325			}
326

tzurbaev / laravel-forge-api

Push — master ( 0ac51f...eeaba4 )

Server::getApi() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like