Merge branch 'hetzner-dns' into 'master'

V1 of Client

See merge request dcc-public-packages/laravel-hetzner-dns-client!1

Author: dododedodonl

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

README.md

@@ -1,22 +1,17 @@
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)
-
 # An unofficial PHP SDK for the Hetzner DNS API.
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/dutchcodingcompany/laravel-hetzner-dns-api.svg?style=flat-square)](https://packagist.org/packages/dutchcodingcompany/laravel-hetzner-dns-api)
 [![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/dutchcodingcompany/laravel-hetzner-dns-api/run-tests?label=tests)](https://github.com/dutchcodingcompany/laravel-hetzner-dns-api/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/dutchcodingcompany/laravel-hetzner-dns-api/Check%20&%20fix%20styling?label=code%20style)](https://github.com/dutchcodingcompany/laravel-hetzner-dns-api/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/dutchcodingcompany/laravel-hetzner-dns-api.svg?style=flat-square)](https://packagist.org/packages/dutchcodingcompany/laravel-hetzner-dns-api)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
+This PHP/Laravel client around the [Hetzner DNS API](https://dns.hetzner.com/api-docs) support:
+- Zones
+- Records
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-hetzner-dns-api.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-hetzner-dns-api)
+This SDK is based on [Saloon](https://docs.saloon.dev/), a Laravel / PHP package that helps write API integrations and SDKs.
 
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
 
 ## Installation
 
@@ -26,13 +21,6 @@ You can install the package via composer:
 composer require dutchcodingcompany/laravel-hetzner-dns-api
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="laravel-hetzner-dns-api-migrations"
-php artisan migrate
-```
-
 You can publish the config file with:
 
 ```bash
@@ -43,44 +31,52 @@ This is the contents of the published config file:
 
 ```php
 return [
+    'api_token' => env('HETZNER_DNS_API_TOKEN')
 ];
 ```
 
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="laravel-hetzner-dns-api-views"
+If you would like to store the API Token outside of the config (e.g. encrypted in the database), you can override the resolver in the `boot` method of the `AppServiceProvider`
+```php
+use DutchCodingCompany\HetznerDnsClient\HetznerDnsClient;
+HetznerDnsClient::resolveApiTokenUsing(fn () => 'your-token');
 ```
 
 ## Usage
 
 ```php
-$hetznerDnsClient = new DutchCodingCompany\HetznerDnsClient();
-echo $hetznerDnsClient->echoPhrase('Hello, DutchCodingCompany!');
+$records = HetznerDnsClient::records()->all();
+// resolves to a Records DTO
 ```
 
-## Testing
+## ToDo
+- Caching
+- ...
 
-```bash
-composer test
-```
+[//]: # (## Testing)
+
+[//]: # ()
+[//]: # (```bash)
+
+[//]: # (composer test)
+
+[//]: # (```)
 
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Contributing
 
-Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities
 
 Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
 
 ## Credits
 
-- [Niek Brekelmans](https://github.com/niek)
-- [All Contributors](../../contributors)
+- [Niek Brekelmans](https://github.com/niekbr)
+- [All Contributors](../../graphs/hetzner-dns)
 
 ## License
 

composer.json

@@ -17,8 +17,10 @@
     ],
     "require": {
         "php": "^8.0",
+        "bensampo/laravel-enum": "^4.2|^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": {

config/hetzner-dns.php

@@ -1,5 +1,6 @@
 <?php
 // config for DutchCodingCompany/HetznerDnsClient
 return [
-    'api_token' => env('HETZNER_DNS_API_TOKEN')
+    'api_token' => env('HETZNER_DNS_API_TOKEN'),
+    'default_ttl' => env('HETZNER_DNS_DEFAULT_TTL', 300),
 ];

src/Enums/RecordType.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace DutchCodingCompany\HetznerDnsClient\Enums;
+
+use BenSampo\Enum\Enum;
+
+/**
+ * @method static static A()
+ * @method static static AAAA()
+ * @method static static NS()
+ * @method static static MX()
+ * @method static static CNAME()
+ * @method static static RP()
+ * @method static static TXT()
+ * @method static static SOA()
+ * @method static static HINFO()
+ * @method static static SRV()
+ * @method static static DANE()
+ * @method static static TLSA()
+ * @method static static DS()
+ * @method static static CAA()
+ */
+final class RecordType extends Enum
+{
+    public const A = 'A';
+    public const AAAA = 'AAAA';
+    public const NS = 'NS';
+    public const MX = 'MX';
+    public const CNAME = 'CNAME';
+    public const RP = 'RP';
+    public const TXT = 'TXT';
+    public const SOA = 'SOA';
+    public const HINFO = 'HINFO';
+    public const SRV = 'SRV';
+    public const DANE = 'DANE';
+    public const TLSA = 'TLSA';
+    public const DS = 'DS';
+    public const CAA = 'CAA';
+}

src/HetznerDnsClient.php

@@ -2,6 +2,43 @@
 
 namespace DutchCodingCompany\HetznerDnsClient;
 
-class HetznerDnsClient
+use DutchCodingCompany\HetznerDnsClient\Traits\ThrowsOnErrorsExceptNotFound;
+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, ThrowsOnErrorsExceptNotFound;
+    use Traits\ResolvesApiToken;
+
+    protected array $requests = [
+        'zones' => RequestCollections\ZoneCollection::class,
+        'records' => RequestCollections\RecordCollection::class,
+    ];
+
+    /**
+     * The Base URL of the API.
+     *
+     * @return string
+     */
+    public function defineBaseUrl(): string
+    {
+        return 'https://dns.hetzner.com/api/v1';
+    }
+
+    /**
+     * The headers that will be applied to every request.
+     *
+     * @return string[]
+     */
+    public function defaultHeaders(): array
+    {
+        return [
+            'Auth-API-Token' => self::getApiToken(),
+        ];
+    }
 }

src/HetznerDnsClientServiceProvider.php

@@ -4,10 +4,16 @@
 
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
-use DutchCodingCompany\HetznerDnsClient\Commands\HetznerDnsClientCommand;
+use Illuminate\Contracts\Container\Container;
 
 class HetznerDnsClientServiceProvider extends PackageServiceProvider
 {
+    public function packageRegistered()
+    {
+        $this->app->singleton(HetznerDnsClient::class);
+        $this->app->alias(HetznerDnsClient::class, 'hetnzer-dns-client');
+    }
+
     public function configurePackage(Package $package): void
     {
         /*
@@ -17,9 +23,6 @@ public function configurePackage(Package $package): void
          */
         $package
             ->name('laravel-hetzner-dns-api')
-            ->hasConfigFile()
-            ->hasViews()
-            ->hasMigration('create_laravel-hetzner-dns-api_table')
-            ->hasCommand(HetznerDnsClientCommand::class);
+            ->hasConfigFile('hetzner-dns');
     }
 }

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;
+}