Merge pull request #163 from ToshY/feature/162

Feature/162 - Library overhaul with public API models using BunnyHttpClient

Author: ToshY

.github/workflows/generator.yml

@@ -3,7 +3,7 @@ name: Generator
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 0'
+    - cron: '0 0 * * *'
 
 permissions:
   contents: write
@@ -45,8 +45,7 @@ jobs:
 
             Checklist:
             - [x] Add/Update API models
-            - [ ] Add/Update API public methods for corresponding models
-            - [ ] Update documentation
+            - [ ] Add/Update documentation examples (when needed)
           branch: patch/automated-models
           branch-suffix: short-commit-hash
           maintainer-can-modify: true

README.md

@@ -27,7 +27,7 @@ edge storage, video streaming, image optimizers and much more!
 ## 🧰 Install
 
 ```bash
-composer require toshy/bunnynet-php:^6.0
+composer require toshy/bunnynet-php:^7.0
 ```
 
 ## 📜 Documentation
@@ -63,12 +63,11 @@ task git:hooks
 This repository has a workflow run (see [generator](.github/workflows/generator.yml)) that creates or updates existing [models](src/Model/API) based on the latest OpenAPI specifications and subsequently
 creates a (draft) PR for these changes. You can identify these automated PRs with the labels `OpenAPI` and `automated`.
 
-The automated PRs contain 3 tasks:
+The automated PRs contain two tasks:
 - [x] Add/Update API models
-- [ ] Add/Update API public methods for corresponding models
-- [ ] Update documentation
+- [ ] Add/Update documentation examples (when needed)
 
-The first task is already done by the generator, but if you want to fix the other two tasks, please use the following way of working.
+The first task is already done by the generator, but if you want to fix the other task, please use the following way of working.
 
 1. Fork the repository and make sure to copy all branches (not just `master`).
 2. Create a branch based on the automated PR branch.

UPGRADE.md

@@ -1,3 +1,123 @@
+## 7.x
+
+This release comes with breaking changes for the usability of the library.
+
+Back in release [`6.0`](https://github.com/ToshY/BunnyNet-PHP/releases/tag/6.0.0) I introduced compatibility with OpenAPI specifications. After further research and consideration, I realised that the models that were generated should be enough for the end user to create a request with, making the existing API classes (`BaseAPI`, `EdgeScriptingAPI`, `EdgeStorageAPI`, `LoggingAPI`, `ShieldAPI` and `StreamAPI`) obsolete if the users have a single entrypoint that could be used instead, which eventually became the `BunnyHttpClient`.
+
+> [!CAUTION]  
+> Due to the nature of this release, I cannot guarantee this list of breaking changes is complete. Thank you for your understanding.
+
+### ‼️ Breaking changes
+
+#### `BunnyHttpClient`
+
+All requests will now have to be made using the `ToshY\BunnyNet\BunnyHttpClient` (previously `ToshY\BunnyNet\Client\BunnyClient`), which now requires the `apiKey` and
+`baseUrl` to be set when constructing.
+
+**Example**
+```php
+<?php
+
+require 'vendor/autoload.php';
+
+use ToshY\BunnyNet\BunnyHttpClient;
+use ToshY\BunnyNet\Enum\Endpoint;
+
+$bunnyHttpClient = new BunnyHttpClient(
+    client: new \Symfony\Component\HttpClient\Psr18Client(),
+    // Provide the account API key.
+    apiKey: '2cebf4f8-4bff-429f-86f6-bce2c2163d7e89fb0a86-a1b2-463c-a142-11eba8811989',
+    baseUrl: Endpoint::BASE
+);
+```
+
+| **6.x**                             | **7.x**                          | **7.x signature notes**                   |
+|-------------------------------------|----------------------------------|-------------------------------------------|
+| `ToshY\BunnyNet\Client\BunnyClient` | `ToshY\BunnyNet\BunnyHttpClient` | Requires `apiKey` and `baseUrl` to be set |
+
+#### Models
+
+The `BunnyHttpClient` now has a public `request` method that accepts any model implementing `ModelInterface`.
+
+**Example**
+```php
+$bunnyHttpClient->request(
+    new \ToshY\BunnyNet\Model\Api\Base\AbuseCase\ListAbuseCases(
+        query: [
+            'page' => 1,
+            'perPage' => 1000,
+        ],
+    )
+)
+```
+
+All publicly usable models can be found under the [`\ToshY\BunnyNet\Model\Api`](https://github.com/ToshY/BunnyNet-PHP/blob/master/src/Model/Api) namespace.
+
+> [!NOTE]  
+> Examples have been updated in the [documentation](https://toshy.github.io/BunnyNet-PHP/).
+
+#### `ImageProcessor` & `TokenAuthenitcation`
+
+The `ImageProcessor` and `TokenAuthentication` have been renamed by prefixing it with `Bunny`.
+
+| **6.x**                              | **7.x**                              | **7.x signature notes**     |
+|--------------------------------------|--------------------------------------|-----------------------------|
+| `ToshY\BunnyNet\ImageProcessor`      | `ToshY\BunnyNet\BunnyImageProcessor` | `generate` method is static |
+| `ToshY\BunnyNet\TokenAuthentication` | `ToshY\BunnyNet\BunnyTokenAuthentication` |                             |
+
+#### `BunnyValidator`
+
+The `BunnyValidator` was introduced in [`6.1`](https://github.com/ToshY/BunnyNet-PHP/releases/tag/6.1.0) as an initial way of making validation optional and/or more flexible. Up until now, the validator was always used by the API classes.
+
+With this release, the `BunnyValidator` has become optional, no longer is used by default and separated from the formerly known API classes.
+
+**Example**
+```php
+$bunnyValidator = new BunnyValidator();
+
+// Construct the payload
+$payload = new TranscribeVideo(
+    libraryId: 1,
+    videoId: 'e7e9b99a-ea2a-434a-b200-f6615e7b6abd',
+    query: [
+        'language' => 'fi',
+        'force' => true,
+    ],
+    body: [
+        'targetLanguages' => [
+            'fi',
+            'jp'
+        ],
+        'generateTitle' => true,
+        'generateDescription' => true,
+        'sourceLanguage' => 'en',
+    ],   
+);
+
+// Perform validation and catch if necessary
+try {
+    $bunnyValidator->query($payload);
+    $bunnyValidator->body($payload);
+} catch (BunnyValidatorExceptionInterface) {
+    // ...
+}
+```
+
+| **6.x**                                    | **7.x**                         |
+|--------------------------------------------|---------------------------------|
+| `ToshY\BunnyNet\Validation\BunnyValidator` | `ToshY\BunnyNet\BunnyValidator` |
+
+
+> [!NOTE]  
+> Usage examples for the `BunnyValidator` have been added to the [documentation](https://toshy.github.io/BunnyNet-PHP/validation/).
+
+#### Naming coding standards
+
+All classes (and namespaces) have been updated according to the latest [coding standards](https://github.com/php/policies/blob/06ef24434942f3b09241ccbde124b83ca8a18042/coding-standards-and-naming.rst?plain=1#L26), where abbreviations/acronyms/initialisms have been renamed to be treated like regular words (camelcasing).
+
+> [!IMPORTANT]  
+> The `6.x` branch will now no longer be maintained.
+
 ## 6.x
 
 This release comes with minor breaking changes for public methods that have been removed to ensure OpenAPI specifications compatibility.
@@ -48,6 +168,8 @@ The following bugs were discovered after the generator scripts recreated the mod
 | Stream API         | UPDATE     | [`getOEmbed`](https://toshy.github.io/BunnyNet-PHP/stream-api/#get-oembed)                                    | Query parameter `url` not required                                                                                                                                                                                                                                        |
 
 
+The `5.x` branch will now no longer be maintained.
+
 ### 🚀 Enhancements
 
 | **Endpoint** | **Action** | **Method**                                                                                      | **Notes** |