Implement basic DNS Zones client

Author: LKaemmerling

src/HetznerAPIClient.php

@@ -21,6 +21,7 @@
 use LKDev\HetznerCloud\Models\Servers\Types\ServerTypes;
 use LKDev\HetznerCloud\Models\SSHKeys\SSHKeys;
 use LKDev\HetznerCloud\Models\Volumes\Volumes;
+use LKDev\HetznerCloud\Models\Zones\Zones;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -63,9 +64,9 @@ class HetznerAPIClient
     protected GuzzleClient $httpClient;
 
     /**
-     * @param  string  $apiToken
-     * @param  string  $baseUrl
-     * @param  string  $userAgent
+     * @param string $apiToken
+     * @param string $baseUrl
+     * @param string $userAgent
      */
     public function __construct(string $apiToken, $baseUrl = 'https://api.hetzner.cloud/v1/', $userAgent = '')
     {
@@ -101,7 +102,7 @@ public function getBaseUrl(): string
     }
 
     /**
-     * @param  string  $userAgent
+     * @param string $userAgent
      * @return HetznerAPIClient
      */
     public function setUserAgent(string $userAgent): self
@@ -112,7 +113,7 @@ public function setUserAgent(string $userAgent): self
     }
 
     /**
-     * @param  string  $baseUrl
+     * @param string $baseUrl
      * @return HetznerAPIClient
      */
     public function setBaseUrl(string $baseUrl): self
@@ -141,13 +142,13 @@ public function setHttpClient(GuzzleClient $client): self
     }
 
     /**
-     * @param  \Psr\Http\Message\ResponseInterface  $response
+     * @param \Psr\Http\Message\ResponseInterface $response
      *
      * @throws \LKDev\HetznerCloud\APIException
      */
     public static function throwError(ResponseInterface $response)
     {
-        $body = (string) $response->getBody();
+        $body = (string)$response->getBody();
         if (strlen($body) > 0) {
             $error = \GuzzleHttp\json_decode($body);
             throw new APIException(APIResponse::create([
@@ -160,15 +161,15 @@ public static function throwError(ResponseInterface $response)
     }
 
     /**
-     * @param  \Psr\Http\Message\ResponseInterface  $response
+     * @param \Psr\Http\Message\ResponseInterface $response
      * @return bool
      *
      * @throws \LKDev\HetznerCloud\APIException
      */
     public static function hasError(ResponseInterface $response)
     {
-        $responseDecoded = json_decode((string) $response->getBody());
-        if (strlen((string) $response->getBody()) > 0) {
+        $responseDecoded = json_decode((string)$response->getBody());
+        if (strlen((string)$response->getBody()) > 0) {
             if (property_exists($responseDecoded, 'error')) {
                 self::throwError($response);
 
@@ -327,6 +328,12 @@ public function loadBalancerTypes()
         return new LoadBalancerTypes($this->httpClient);
     }
 
+
+    public function zones()
+    {
+        return new Zones($this->httpClient);
+    }
+
     /**
      * @return GuzzleClient
      */

src/Models/Zones/AuthoritativeNameservers.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace LKDev\HetznerCloud\Models\Zones;
+
+class AuthoritativeNameservers
+{
+    public array $assigned;
+    public array $delegated;
+    public string $delegation_last_check;
+    public string $delegation_status;
+
+    /**
+     * @param array $assigned
+     * @param array $delegated
+     * @param string $delegation_last_check
+     * @param string $delegation_status
+     */
+    public function __construct(array $assigned, array $delegated, string $delegation_last_check, string $delegation_status)
+    {
+        $this->assigned = $assigned;
+        $this->delegated = $delegated;
+        $this->delegation_last_check = $delegation_last_check;
+        $this->delegation_status = $delegation_status;
+    }
+
+    public static function fromResponse(array $response): AuthoritativeNameservers
+    {
+        return new self($response['assigned'], $response['delegated'], $response['delegation_last_check'], $response['delegation_status']);
+    }
+}

src/Models/Zones/PrimaryNameserver.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace LKDev\HetznerCloud\Models\Zones;
+
+class PrimaryNameserver
+{
+    public string $address;
+    public int $port;
+
+    /**
+     * @param string $address
+     * @param int $port
+     */
+    public function __construct(string $address, int $port)
+    {
+        $this->port = $port;
+        $this->address = $address;
+    }
+
+
+    public static function fromResponse(array $response): PrimaryNameserver
+    {
+        return new self($response['address'], $response['port']);
+    }
+}

src/Models/Zones/RRSet.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace LKDev\HetznerCloud\Models\Zones;
+
+use LKDev\HetznerCloud\Models\Protection;
+
+class RRSet
+{
+    public string $id;
+    public string $name;
+    public string $type;
+    public int $ttl;
+    public array $records;
+    public array $labels;
+    public RRSetProtection $protection;
+
+    /**
+     * @param string $id
+     * @param string $name
+     * @param string $type
+     * @param int $ttl
+     * @param array $records
+     * @param array|null $labels
+     * @param RRSetProtection|null $protection
+     */
+    public function __construct(string $id, string $name, string $type, int $ttl, array $records, ?array $labels, ?RRSetProtection $protection)
+    {
+        $this->id = $id;
+        $this->name = $name;
+        $this->type = $type;
+        $this->ttl = $ttl;
+        $this->records = $records;
+        $this->labels = $labels;
+        $this->protection = $protection;
+    }
+
+    public static function fromResponse(array $data): RRSet
+    {
+        return new self($data['id'], $data['name'], $data['type'], $data['ttl'], $data['records'], $data['labels'], RRSetProtection::parse($data['protection']));
+    }
+
+    public function __toRequest(): array
+    {
+        $r = [
+            "name" => $this->name,
+            'type' => $this->type,
+            'ttl' => $this->ttl,
+            'records' => $this->records,
+        ];
+        if (!empty($this->labels)) {
+            $r['labels'] = $this->labels;
+        }
+        return $r;
+    }
+}
+
+
+class Record
+{
+    public string $value;
+    public string $comment;
+
+
+    public function __construct(string $value, string $comment)
+    {
+        $this->value = $value;
+        $this->comment = $comment;
+    }
+}

src/Models/Zones/RRSetProtection.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Created by PhpStorm.
+ * User: lukaskammerling
+ * Date: 01.04.18
+ * Time: 19:02.
+ */
+
+namespace LKDev\HetznerCloud\Models\Zones;
+
+// This is a read only model, that does not have any logic. Just a stupid dataholder.
+use LKDev\HetznerCloud\Models\Model;
+
+class RRSetProtection extends Model
+{
+    /**
+     * @var bool
+     */
+    public $change;
+
+
+    /**
+     * Protection constructor.
+     *
+     * @param bool $delete
+     */
+    public function __construct(bool $delete)
+    {
+        $this->change = $delete;
+        // Force getting the default http client
+        parent::__construct(null);
+    }
+
+    /**
+     * @param array $input
+     * @return ?RRSetProtection
+     */
+    public static function parse($input)
+    {
+        if ($input == null) {
+            return null;
+        }
+        if (!is_array($input)) {
+            return null;
+        }
+        return new self($input['change'] ?? false);
+    }
+}