Add getByName to most resources (#24)

Author: LKaemmerling

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.8.0 (18.09.2019)
+ + Add ability to get `Datacenters`,`FloatingIPs`,`Images`,`Locations` and `ServerTypes` per name (`getByName`)
+ + Add `name` support to Floating IPs
+
 ## 1.7.1  (01.08.2019) 
  + Add missing `networks()` - method on `HetznerAPIClient`
 

src/HetznerAPIClient.php

@@ -24,7 +24,7 @@ class HetznerAPIClient
     /**
      * Version of the API Client
      */
-    const VERSION = "1.7.1";
+    const VERSION = "1.8.0";
 
     /**
      * @var string

src/Models/Datacenters/Datacenters.php

@@ -50,6 +50,21 @@ public function get(int $datacenterId): Datacenter
         }
     }
 
+    /**
+     * Returns a specific datacenter object by its name.
+     *
+     * @see https://docs.hetzner.cloud/#resources-datacenters-get-1
+     * @param int $datacenterId
+     * @return \LKDev\HetznerCloud\Models\Datacenters\Datacenter
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $name): Datacenter
+    {
+        $datacenters = $this->all($name);
+
+        return (count($datacenters) > 0) ? $datacenters[0] : null;
+    }
+
     /**
      * @param  $input
      * @return $this
@@ -71,4 +86,4 @@ public static function parse($input)
     {
         return (new self())->setAdditionalData($input);
     }
-}
+}

src/Models/FloatingIps/FloatingIPRequestOpts.php

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

src/Models/FloatingIps/FloatingIp.php

@@ -26,6 +26,11 @@ class FloatingIp extends Model
      */
     public $id;
 
+    /**
+     * @var string
+     */
+    public $name;
+
     /**
      * @var string
      */
@@ -69,7 +74,6 @@ class FloatingIp extends Model
      */
     public $protection;
 
-
     /**
      * @var array
      */
@@ -89,6 +93,7 @@ class FloatingIp extends Model
      * @param Protection $protection
      * @param array $labels
      * @param string $created
+     * @param string $name
      */
     public function __construct(
         int $id,
@@ -101,7 +106,8 @@ public function __construct(
         bool $blocked,
         Protection $protection,
         array $labels = [],
-        string $created = ''
+        string $created = '',
+        string $name = ''
     )
     {
         $this->id = $id;
@@ -115,6 +121,7 @@ public function __construct(
         $this->protection = $protection;
         $this->labels = $labels;
         $this->created = $created;
+        $this->name = $name;
         parent::__construct();
     }
 
@@ -259,7 +266,6 @@ public static function parse($input): FloatingIp
         if ($input == null) {
             return null;
         }
-
-        return new self($input->id, $input->description, $input->ip, $input->type, $input->server, $input->dns_ptr, Location::parse($input->home_location), $input->blocked, Protection::parse($input->protection));
+        return new self($input->id, $input->description, $input->ip, $input->type, $input->server, $input->dns_ptr, Location::parse($input->home_location), $input->blocked, Protection::parse($input->protection), get_object_vars($input->labels), $input->created, $input->name);
     }
 }

src/Models/FloatingIps/FloatingIps.php

@@ -25,14 +25,14 @@ class FloatingIps extends Model
      * Returns all floating ip objects.
      *
      * @see https://docs.hetzner.cloud/#resources-floating-ips-get
-     * @param RequestOpts|null $requestOpts
+     * @param FloatingIPRequestOpts|RequestOpts|null $requestOpts
      * @return array
      * @throws \LKDev\HetznerCloud\APIException
      */
-    public function all(RequestOpts $requestOpts = null): array
+    public function all(FloatingIPRequestOpts $requestOpts = null): array
     {
         if ($requestOpts == null) {
-            $requestOpts = new RequestOpts();
+            $requestOpts = new FloatingIPRequestOpts();
         }
         $response = $this->httpClient->get('floating_ips' . $requestOpts->buildQuery());
         if (!HetznerAPIClient::hasError($response)) {
@@ -56,6 +56,22 @@ public function get(int $floatingIpId): FloatingIp
         }
     }
 
+    /**
+     * Returns a specific Floating IP object by its name.
+     *
+     * @see https://docs.hetzner.cloud/#resources-floating-ips-get-1
+     * @param string $name
+     * @return \LKDev\HetznerCloud\Models\FloatingIps\FloatingIp
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $name)
+    {
+        $floatingIPs = $this->all(new FloatingIPRequestOpts($name));
+
+        return (count($floatingIPs) > 0) ? $floatingIPs[0] : null;
+    }
+
+
     /**
      * Creates a new Floating IP assigned to a server.
      *
@@ -64,21 +80,24 @@ public function get(int $floatingIpId): FloatingIp
      * @param string|null $description
      * @param \LKDev\HetznerCloud\Models\Locations\Location|null $location
      * @param \LKDev\HetznerCloud\Models\Servers\Server|null $server
+     * @param string|null $name
      * @return \LKDev\HetznerCloud\Models\FloatingIps\FloatingIp
      * @throws \LKDev\HetznerCloud\APIException
      */
     public function create(
         string $type,
         string $description = null,
         Location $location = null,
-        Server $server = null
+        Server $server = null,
+        string $name = null
     ): FloatingIp
     {
         $response = $this->httpClient->post('floating_ips', [
             'type' => $type,
             'description' => $description,
             'server' => $server ?: $server->id,
             'home_location' => $location ?: $location->name,
+            'name' => $name ?: $name,
         ]);
         if (!HetznerAPIClient::hasError($response)) {
             return FloatingIp::parse(json_decode((string)$response->getBody())->floating_ip);
@@ -106,4 +125,4 @@ public static function parse($input)
     {
         return (new self())->setAdditionalData($input);
     }
-}
+}

src/Models/Images/Images.php

@@ -50,6 +50,21 @@ public function get(int $imageId): Image
         }
     }
 
+    /**
+     * Returns a specific datacenter object by its name.
+     *
+     * @see https://docs.hetzner.cloud/#resources-datacenters-get-1
+     * @param int $datacenterId
+     * @return \LKDev\HetznerCloud\Models\Datacenters\Datacenter
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $name): Image
+    {
+        $images = $this->all($name);
+
+        return (count($images) > 0) ? $images[0] : null;
+    }
+
     /**
      * @param  $input
      * @return $this
@@ -71,4 +86,4 @@ public static function parse($input)
     {
         return (new self())->setAdditionalData($input);
     }
-}
+}

src/Models/Locations/Locations.php

@@ -53,6 +53,21 @@ public function get(int $locationId): Location
         }
     }
 
+    /**
+     * Returns a specific location object by its name.
+     *
+     * @see https://docs.hetzner.cloud/#resources-locations-get-1
+     * @param int $locationId
+     * @return \LKDev\HetznerCloud\Models\Locations\Location
+     * @throws \LKDev\HetznerCloud\APIException
+     */
+    public function getByName(string $name): Location
+    {
+        $locations = $this->all($name);
+
+        return (count($locations) > 0) ? $locations[0] : null;
+    }
+
     /**
      * @param  $input
      * @return $this

src/Models/Networks/Network.php

@@ -188,7 +188,7 @@ private function setAdditionalData($data)
 
 
         $this->labels = $data->labels;
-        //$this->created = $data->created;  //ToDo This should be uncomment, when the backend MR is done
+        $this->created = $data->created;
         return $this;
     }
 

src/Models/Servers/Servers.php

@@ -76,7 +76,6 @@ public function getByName(string $serverName)
         $servers = $this->all(new ServerRequestOpts($serverName));
 
         return (count($servers) > 0) ? $servers[0] : null;
-
     }
 
     /**