throw exception or cast response to DTO

Author: Niek Brekelmans

src/Objects/BaseRecord.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Carbon\Carbon;
+use DutchCodingCompany\HetznerDnsClient\Enums\RecordType;
+use Spatie\DataTransferObject\Attributes\DefaultCast;
+use Spatie\DataTransferObject\DataTransferObject;
+
+#[
+    DefaultCast(Carbon::class, Casters\CarbonCaster::class),
+    DefaultCast(RecordType::class, Casters\RecordTypeCaster::class),
+]
+class BaseRecord extends DataTransferObject
+{
+    public RecordType $type;
+    public string $name;
+    public string $value;
+    public string $zone_id;
+}

src/Objects/BulkCreatedRecords.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Spatie\DataTransferObject\Attributes\CastWith;
+use Spatie\DataTransferObject\Casters\ArrayCaster;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class BulkCreatedRecords extends DataTransferObject
+{
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: BaseRecord::class)]
+    public array $invalid_records;
+
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: Record::class)]
+    public array $records;
+
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: BaseRecord::class)]
+    public array $valid_records;
+}

src/Objects/BulkUpdatedRecords.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Spatie\DataTransferObject\Attributes\CastWith;
+use Spatie\DataTransferObject\Casters\ArrayCaster;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class BulkUpdatedRecords extends DataTransferObject
+{
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: BaseRecord::class)]
+    public array $failed_records;
+
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: Record::class)]
+    public array $records;
+}

src/Objects/Casters/RecordTypeCaster.php

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

src/Objects/Record.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Carbon\Carbon;
+use DutchCodingCompany\HetznerDnsClient\Enums\RecordType;
+use Spatie\DataTransferObject\Attributes\DefaultCast;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class Record extends BaseRecord
+{
+    public string $id;
+    public Carbon $created;
+    public Carbon $modified;
+}

src/Objects/Records.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Objects;
+
+use Spatie\DataTransferObject\Attributes\CastWith;
+use Spatie\DataTransferObject\Casters\ArrayCaster;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class Records extends DataTransferObject
+{
+    /** @var Record[] */
+    #[CastWith(ArrayCaster::class, itemType: Record::class)]
+    public array $records;
+}

src/Objects/ZoneCollection.php renamed to src/Objects/Zones.php

@@ -2,16 +2,11 @@
 
 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
+class Zones extends DataTransferObject
 {
     /** @var Zone[] */
     #[CastWith(ArrayCaster::class, itemType: Zone::class)]

src/RequestCollections/RecordCollection.php

@@ -2,6 +2,11 @@
 
 namespace DutchCodingCompany\HetznerDnsClient\RequestCollections;
 
+use DutchCodingCompany\HetznerDnsClient\Enums\RecordType;
+use DutchCodingCompany\HetznerDnsClient\Objects\BulkCreatedRecords;
+use DutchCodingCompany\HetznerDnsClient\Objects\BulkUpdatedRecords;
+use DutchCodingCompany\HetznerDnsClient\Objects\Record;
+use DutchCodingCompany\HetznerDnsClient\Objects\Records;
 use DutchCodingCompany\HetznerDnsClient\Requests\Records\BulkCreateRecords;
 use DutchCodingCompany\HetznerDnsClient\Requests\Records\BulkUpdateRecords;
 use DutchCodingCompany\HetznerDnsClient\Requests\Records\CreateRecord;
@@ -13,38 +18,38 @@
 
 class RecordCollection extends RequestCollection
 {
-    public function all(...$arguments): array
+    public function all(?int $page = null, ?int $per_page = null, ?string $zone_id = null): Records
     {
-        return $this->connector->request(new ListRecords(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new ListRecords(page: $page, per_page: $per_page, zone_id: $zone_id))->send()->throw()->dto();
     }
 
-    public function create(...$arguments): array
+    public function create(string $zone_id, RecordType $type, string $name, string $value, ?int $ttl = null): Record
     {
-        return $this->connector->request(new CreateRecord(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new CreateRecord(zone_id: $zone_id, type: $type, name: $name, value: $value, ttl: $ttl))->send()->throw()->dto();
     }
 
-    public function get(...$arguments): array
+    public function get(string $record_id): Record
     {
-        return $this->connector->request(new GetRecord(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new GetRecord(record_id: $record_id))->send()->throw()->dto();
     }
 
-    public function update(...$arguments): array
+    public function update(string $record_id, string $zone_id, RecordType $type, string $name, string $value, ?int $ttl = null): Record
     {
-        return $this->connector->request(new UpdateRecord(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new UpdateRecord(record_id: $record_id, zone_id: $zone_id, type: $type, name: $name, value: $value, ttl: $ttl))->send()->throw()->dto();
     }
 
-    public function delete(...$arguments): array
+    public function delete(string $record_id): void
     {
-        return $this->connector->request(new DeleteRecord(...$arguments))->send()->throw()->json();
+        $this->connector->request(new DeleteRecord($record_id))->send()->throw();
     }
 
-    public function bulkCreate(...$arguments): array
+    public function bulkCreate(array $records): BulkCreatedRecords
     {
-        return $this->connector->request(new BulkCreateRecords(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new BulkCreateRecords($records))->send()->throw()->dto();
     }
 
-    public function bulkUpdate(...$arguments): array
+    public function bulkUpdate(array $records): BulkUpdatedRecords
     {
-        return $this->connector->request(new BulkUpdateRecords(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new BulkUpdateRecords($records))->send()->throw()->dto();
     }
 }

src/RequestCollections/ZoneCollection.php

@@ -3,6 +3,7 @@
 namespace DutchCodingCompany\HetznerDnsClient\RequestCollections;
 
 use DutchCodingCompany\HetznerDnsClient\Objects\Zone;
+use DutchCodingCompany\HetznerDnsClient\Objects\Zones;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\CreateZone;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\DeleteZone;
 use DutchCodingCompany\HetznerDnsClient\Requests\Zones\ExportZone;
@@ -13,33 +14,33 @@
 
 class ZoneCollection extends RequestCollection
 {
-    public function all(...$arguments): array
+    public function all(string $name = null,?int $per_page = null, ?string $search_name = null): Zones
     {
-        return $this->connector->request(new ListZones(...$arguments))->send()->throw()->dto();
+        return $this->connector->request(new ListZones(name: $name, per_page: $per_page, search_name: $search_name))->send()->throw()->dto();
     }
 
-    public function create(...$arguments): array
+    public function create(string $name, ?int $ttl = null): Zone
     {
-        return $this->connector->request(new CreateZone(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new CreateZone(name: $name, ttl: $ttl))->send()->throw()->dto();
     }
 
-    public function get(...$arguments): ?Zone
+    public function get(string $zone_id): Zone
     {
-        return $this->connector->request(new GetZone(...$arguments))->send()->throw()->dto();
+        return $this->connector->request(new GetZone(zone_id: $zone_id))->send()->throw()->dto();
     }
 
-    public function update(...$arguments): array
+    public function update(string $zone_id, string $name, ?int $ttl = null): Zone
     {
-        return $this->connector->request(new UpdateZone(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new UpdateZone(zone_id: $zone_id, name: $name, ttl: $ttl))->send()->throw()->dto();
     }
 
-    public function delete(...$arguments): array
+    public function delete(string $zone_id): void
     {
-        return $this->connector->request(new DeleteZone(...$arguments))->send()->throw()->json();
+        $this->connector->request(new DeleteZone(zone_id: $zone_id))->send()->throw();
     }
 
-    public function export(...$arguments): array
+    public function export(string $zone_id): string
     {
-        return $this->connector->request(new ExportZone(...$arguments))->send()->throw()->json();
+        return $this->connector->request(new ExportZone(zone_id: $zone_id))->send()->throw()->body();
     }
 }

src/Requests/Records/BulkCreateRecords.php

@@ -4,13 +4,16 @@
 
 use DutchCodingCompany\HetznerDnsClient\Enums\RecordType;
 use DutchCodingCompany\HetznerDnsClient\HetznerDnsClient;
+use DutchCodingCompany\HetznerDnsClient\Objects\BulkCreatedRecords;
 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 BulkCreateRecords extends SaloonRequest
 {
-    use HasJsonBody;
+    use HasJsonBody, CastsToDto;
 
     protected array $records;
 
@@ -37,4 +40,9 @@ public function defaultData(): array
             'records' => $this->records,
         ]);
     }
+
+    protected function castToDto(SaloonResponse $response): BulkCreatedRecords
+    {
+        return new BulkCreatedRecords($response->json());
+    }
 }