Prepeare Release 1.5

Author: LKaemmerling

CHANGELOG.md

@@ -1,7 +1,13 @@
 # Changelog
 
+## 1.5.0 (28.03.2019)
++ Implement `getByName` method on `LKDev\HetznerCloud\Models\Servers\Servers` and `LKDev\HetznerCloud\Models\Volumes\Volumes`.
++ Implement `waitUntilCompleted`  method on `LKDev\HetznerCloud\Models\Actions\Action`
++ Add `LKDev\HetznerCloud\Models\Servers\ServerRequestOpts` for better control over the `all`-Method on `LKDev\HetznerCloud\Models\Servers\Servers`
++ Add `LKDev\HetznerCloud\Models\Volumes\VolumeRequestOpts` for better control over the `all`-Method on `LKDev\HetznerCloud\Models\Volumes\Volumes`
+
 ## 1.4.0 (27.02.2019)
-+ Implement `metrics` method on `LKDev\HetznerCloud\Models\Server\Server` (@paulus7, https://github.com/LKDevelopment/hetzner-cloud-php-sdk/pull/10)
++ Implement `metrics` method on `LKDev\HetznerCloud\Models\Servers\Server` (@paulus7, https://github.com/LKDevelopment/hetzner-cloud-php-sdk/pull/10)
 
 ## 1.3.1 (20.02.2019)
 + Fix a error on the update methods.

src/Models/Actions/Action.php

@@ -92,7 +92,7 @@ public function __construct(
      */
     public function getById($actionId): Action
     {
-        $response = $this->httpClient->get( 'actions/' . $actionId);
+        $response = $this->httpClient->get('actions/' . $actionId);
         if (!HetznerAPIClient::hasError($response)) {
             return Action::parse(json_decode((string)$response->getBody())->action);
         }
@@ -107,6 +107,17 @@ public function refresh(): Action
         return $this->getById($this->id);
     }
 
+    /**
+     * Wait for an action to complete.
+     * @param float $pollingInterval seconds
+     * @return bool
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function waitUntilCompleted($pollingInterval = 0.5)
+    {
+        return Actions::waitActionCompleted($this, $pollingInterval);
+    }
+
     /**
      * @param $input
      * @return \LKDev\HetznerCloud\Models\Actions\Action|static
@@ -119,4 +130,4 @@ public static function parse($input)
 
         return new self($input->id, $input->command, $input->progress, $input->status, $input->started, $input->finished, $input->resources, $input->error);
     }
-}
+}

src/Models/Images/Image.php

@@ -230,4 +230,4 @@ public static function parse($input)
 
         return new self($input->id, $input->type, (property_exists($input, 'status') ? $input->status : null), $input->name, $input->description, $input->image_size, $input->disk_size, $input->created, $input->created_from, $input->bound_to, $input->os_flavor, $input->os_version, $input->rapid_deploy, Protection::parse($input->protection));
     }
-}
+}

src/Models/Servers/ServerRequestOpts.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LKDev\HetznerCloud\Models\Servers;
+
+
+use LKDev\HetznerCloud\RequestOpts;
+
+/**
+ * Class ServerRequestOpts
+ * @package LKDev\HetznerCloud\Models\Servers
+ */
+class ServerRequestOpts extends RequestOpts
+{
+    /**
+     * @var string
+     */
+    public $name;
+
+    /**
+     * @var string
+     */
+    public $status;
+
+    /**
+     * RequestOpts constructor.
+     *
+     * @param $name
+     * @param $perPage
+     * @param $page
+     * @param $labelSelector
+     */
+    public function __construct(string $name = null, string $status = null, int $perPage = null, int $page = null, string $labelSelector = null)
+    {
+        parent::__construct($perPage, $page, $labelSelector);
+        $this->name = $name;
+        $this->status = $status;
+    }
+}

src/Models/Servers/Servers.php

@@ -39,7 +39,7 @@ class Servers extends Model
     public function all(RequestOpts $requestOpts = null): array
     {
         if ($requestOpts == null) {
-            $requestOpts = new RequestOpts();
+            $requestOpts = new ServerRequestOpts();
         }
         $response = $this->httpClient->get('servers' . $requestOpts->buildQuery());
         if (!HetznerAPIClient::hasError($response)) {
@@ -63,6 +63,22 @@ public function get(int $serverId): Server
         }
     }
 
+    /**
+     * Returns a specific server object by its name. The server must exist inside the project.
+     *
+     * @see https://docs.hetzner.cloud/#resources-servers-get
+     * @param string $serverName
+     * @return \LKDev\HetznerCloud\Models\Servers\Server|null
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $serverName): Server
+    {
+        $servers = $this->all(new ServerRequestOpts($serverName));
+
+        return (count($servers) > 0) ? $servers[0] : null;
+
+    }
+
     /**
      * Creates a new server in a datacenter instead of in a location. Returns preliminary information about the server as well as an action that covers progress of creation
      *
@@ -178,4 +194,4 @@ public static function parse($input)
 
         return (new self())->setAdditionalData($input);
     }
-}
+}

src/Models/Volumes/VolumeRequestOpts.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: lukaskammerling
+ * Date: 2019-03-28
+ * Time: 13:51
+ */
+
+namespace LKDev\HetznerCloud\Models\Volumes;
+
+
+use LKDev\HetznerCloud\RequestOpts;
+
+class VolumeRequestOpts extends RequestOpts
+{
+    /**
+     * @var string
+     */
+    public $name;
+
+    /**
+     * @var string
+     */
+    public $status;
+
+    /**
+     * RequestOpts constructor.
+     *
+     * @param $name
+     * @param $perPage
+     * @param $page
+     * @param $labelSelector
+     */
+    public function __construct(string $name = null, string $status = null, int $perPage = null, int $page = null, string $labelSelector = null)
+    {
+        parent::__construct($perPage, $page, $labelSelector);
+        $this->name = $name;
+        $this->status = $status;
+    }
+}

src/Models/Volumes/Volumes.php

@@ -47,6 +47,22 @@ public function all(RequestOpts $requestOpts = null): array
         }
     }
 
+    /**
+     * Returns a specific server object by its name. The server must exist inside the project.
+     *
+     * @see https://docs.hetzner.cloud/#resources-volumes-get
+     * @param string $volumeName
+     * @return \LKDev\HetznerCloud\Models\Volumes\Volume|null
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $volumeName): Server
+    {
+        $volumes = $this->all(new VolumeRequestOpts($volumeName));
+
+        return (count($volumes) > 0) ? $volumes[0] : null;
+
+    }
+
     /**
      * Returns a specific volume object. The server must exist inside the project.
      *
@@ -120,4 +136,4 @@ public static function parse($input)
 
         return (new self())->setAdditionalData($input);
     }
-}
+}

tests/Unit/Servers/ServersTest.php

@@ -40,7 +40,16 @@ public function testGet()
         $this->assertEquals($server->name, 'my-server');
         $this->assertEquals($server->status, 'running');
     }
-
+    /**
+     *
+     */
+    public function testGetByName()
+    {
+        $server = $this->servers->getByName('my-server');
+        $this->assertEquals($server->id, 42);
+        $this->assertEquals($server->name, 'my-server');
+        $this->assertEquals($server->status, 'running');
+    }
     /**
      *
      */