wip on casting to DTO

Author: Niek Brekelmans

composer.json

@@ -20,6 +20,7 @@
         "bensampo/laravel-enum": "^5.3",
         "illuminate/contracts": "^8.0|^9.0",
         "sammyjo20/saloon-laravel": "^1.4",
+        "spatie/data-transfer-object": "^3.8",
         "spatie/laravel-package-tools": "^1.9.2"
     },
     "require-dev": {

src/HetznerDnsClient.php

@@ -5,6 +5,10 @@
 use Sammyjo20\Saloon\Http\SaloonConnector;
 use Sammyjo20\Saloon\Traits\Plugins\AcceptsJson;
 
+/**
+ * @method RequestCollections\ZoneCollection zones()
+ * @method RequestCollections\RecordCollection records()
+ */
 class HetznerDnsClient extends SaloonConnector
 {
     use AcceptsJson;

src/Objects/Casters/CarbonCaster.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects\Casters;
+
+use Carbon\Carbon;
+use Spatie\DataTransferObject\Caster;
+
+class CarbonCaster implements Caster
+{
+    public function cast(mixed $value): ?Carbon
+    {
+        return empty($value) ? null : (new Carbon($value));
+    }
+}

src/Objects/Zone.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Carbon\Carbon;
+use Spatie\DataTransferObject\Attributes\DefaultCast;
+use Spatie\DataTransferObject\DataTransferObject;
+
+#[
+    DefaultCast(Carbon::class, Casters\CarbonCaster::class),
+]
+class Zone extends DataTransferObject
+{
+    public string $id;
+    public string $name;
+    public int $ttl;
+    public ?string $registrar;
+    public ?string $legacy_dns_host;
+    public ?array $legacy_ns;
+    public array $ns;
+    public Carbon $created;
+    public ?Carbon $verified;
+    public Carbon $modified;
+    public string $owner;
+    public string $permission;
+    public array $zone_type;
+    public string $status;
+    public bool $paused;
+    public bool $is_secondary_dns;
+    public array $txt_verification;
+    public int $records_count;
+}

src/Objects/ZoneCollection.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Carbon\Carbon;
+use Spatie\DataTransferObject\Attributes\CastWith;
+use Spatie\DataTransferObject\Attributes\DefaultCast;
+use Spatie\DataTransferObject\Casters\ArrayCaster;
+use Spatie\DataTransferObject\DataTransferObject;
+
+#[
+    DefaultCast(Carbon::class, Casters\CarbonCaster::class),
+]
+class ZoneCollection extends DataTransferObject
+{
+    /** @var Zone[] */
+    #[CastWith(ArrayCaster::class, itemType: Zone::class)]
+    public array $zones;
+}

src/RequestCollections/RecordCollection.php

@@ -15,36 +15,36 @@ class RecordCollection extends RequestCollection
 {
     public function all(...$arguments): array
     {
-        return $this->connector->request(new ListRecords(...$arguments))->send()->json();
+        return $this->connector->request(new ListRecords(...$arguments))->send()->throw()->json();
     }
 
     public function create(...$arguments): array
     {
-        return $this->connector->request(new CreateRecord(...$arguments))->send()->json();
+        return $this->connector->request(new CreateRecord(...$arguments))->send()->throw()->json();
     }
 
     public function get(...$arguments): array
     {
-        return $this->connector->request(new GetRecord(...$arguments))->send()->json();
+        return $this->connector->request(new GetRecord(...$arguments))->send()->throw()->json();
     }
 
     public function update(...$arguments): array
     {
-        return $this->connector->request(new UpdateRecord(...$arguments))->send()->json();
+        return $this->connector->request(new UpdateRecord(...$arguments))->send()->throw()->json();
     }
 
     public function delete(...$arguments): array
     {
-        return $this->connector->request(new DeleteRecord(...$arguments))->send()->json();
+        return $this->connector->request(new DeleteRecord(...$arguments))->send()->throw()->json();
     }
 
     public function bulkCreate(...$arguments): array
     {
-        return $this->connector->request(new BulkCreateRecords(...$arguments))->send()->json();
+        return $this->connector->request(new BulkCreateRecords(...$arguments))->send()->throw()->json();
     }
 
     public function bulkUpdate(...$arguments): array
     {
-        return $this->connector->request(new BulkUpdateRecords(...$arguments))->send()->json();
+        return $this->connector->request(new BulkUpdateRecords(...$arguments))->send()->throw()->json();
     }
 }

src/RequestCollections/ZoneCollection.php

@@ -2,6 +2,7 @@
 
 namespace DutchCodingCompany\HetznerDnsClient\RequestCollections;
 
+use DutchCodingCompany\HetznerDnsClient\Objects\Zone;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\CreateZone;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\DeleteZone;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\ExportZone;
@@ -14,31 +15,31 @@ class ZoneCollection extends RequestCollection
 {
     public function all(...$arguments): array
     {
-        return $this->connector->request(new ListZones(...$arguments))->send()->json();
+        return $this->connector->request(new ListZones(...$arguments))->send()->throw()->dto();
     }
 
     public function create(...$arguments): array
     {
-        return $this->connector->request(new CreateZone(...$arguments))->send()->json();
+        return $this->connector->request(new CreateZone(...$arguments))->send()->throw()->json();
     }
 
-    public function get(...$arguments): array
+    public function get(...$arguments): ?Zone
     {
-        return $this->connector->request(new GetZone(...$arguments))->send()->json();
+        return $this->connector->request(new GetZone(...$arguments))->send()->throw()->dto();
     }
 
     public function update(...$arguments): array
     {
-        return $this->connector->request(new UpdateZone(...$arguments))->send()->json();
+        return $this->connector->request(new UpdateZone(...$arguments))->send()->throw()->json();
     }
 
     public function delete(...$arguments): array
     {
-        return $this->connector->request(new DeleteZone(...$arguments))->send()->json();
+        return $this->connector->request(new DeleteZone(...$arguments))->send()->throw()->json();
     }
 
     public function export(...$arguments): array
     {
-        return $this->connector->request(new ExportZone(...$arguments))->send()->json();
+        return $this->connector->request(new ExportZone(...$arguments))->send()->throw()->json();
     }
 }

src/Requests/Zones/CreateZone.php

@@ -3,13 +3,16 @@
 namespace DutchCodingCompany\HetznerDnsClient\Requests\Zones;
 
 use DutchCodingCompany\HetznerDnsClient\HetznerDnsClient;
+use DutchCodingCompany\HetznerDnsClient\Objects\Zone;
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Http\SaloonResponse;
+use Sammyjo20\Saloon\Traits\Plugins\CastsToDto;
 use Sammyjo20\Saloon\Traits\Plugins\HasJsonBody;
 
 class CreateZone extends SaloonRequest
 {
-    use HasJsonBody;
+    use HasJsonBody, CastsToDto;
 
     public function __construct(
         protected string $name,
@@ -33,4 +36,9 @@ public function defaultData(): array
             'ttl' => $this->ttl,
         ]);
     }
+
+    protected function castToDto(SaloonResponse $response): Zone
+    {
+        dd($response->json());
+    }
 }

src/Requests/Zones/GetZone.php

@@ -3,12 +3,17 @@
 namespace DutchCodingCompany\HetznerDnsClient\Requests\Zones;
 
 use DutchCodingCompany\HetznerDnsClient\HetznerDnsClient;
+use DutchCodingCompany\HetznerDnsClient\Objects\Zone;
 use Illuminate\Support\Arr;
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Http\SaloonResponse;
+use Sammyjo20\Saloon\Traits\Plugins\CastsToDto;
 
 class GetZone extends SaloonRequest
 {
+    use CastsToDto;
+
     public function __construct(
         protected string $zone_id,
     )
@@ -22,4 +27,9 @@ public function defineEndpoint(): string
     {
         return '/zones/'.$this->zone_id;
     }
+
+    protected function castToDto(SaloonResponse $response): Zone
+    {
+        return new Zone($response->json('zone'));
+    }
 }

src/Requests/Zones/ListZones.php

@@ -3,12 +3,17 @@
 namespace DutchCodingCompany\HetznerDnsClient\Requests\Zones;
 
 use DutchCodingCompany\HetznerDnsClient\HetznerDnsClient;
+use DutchCodingCompany\HetznerDnsClient\Objects\ZoneCollection;
 use Illuminate\Support\Arr;
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Http\SaloonResponse;
+use Sammyjo20\Saloon\Traits\Plugins\CastsToDto;
 
 class ListZones extends SaloonRequest
 {
+    use CastsToDto;
+
     public function __construct(
         protected ?string $name = null,
         protected ?int $page = null,
@@ -35,4 +40,10 @@ public function defaultQuery(): array
             'search_name' => $this->search_name,
         ]);
     }
+
+    protected function castToDto(SaloonResponse $response): mixed
+    {
+
+         dd(new ZoneCollection($response->json()));
+    }
 }