Merge pull request #157 from ToshY/feature/generator

Generator scripts for converting OpenAPI specs to models

Author: ToshY

.gitattributes

@@ -2,6 +2,7 @@
 /.githooks/ export-ignore
 /docs/ export-ignore
 /tests/ export-ignore
+/generator/ export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore
 /.php-cs-fixer.dist.php export-ignore

.github/workflows/generator.yml

@@ -0,0 +1,50 @@
+name: Generator
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 0'
+
+env:
+  API_SPEC_MANIFEST: https://toshy.github.io/bunnynet-openapi-specification/manifest.json
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v3
+
+      - name: Run map generator
+        run: php generator/Command/generate-maps.php
+
+      - name: Run model generator
+        run: php generator/Command/generate-models.php --log
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7.0.8
+        with:
+          commit-message: Updated API models
+          title: '[OpenAPI] Updated API models'
+          body: |
+            Added/Updated models according to OpenAPI specs.
+
+            Checklist:
+            - [x] Add/Update API models
+            - [ ] Add/Update API public methods for corresponding models
+            - [ ] Update documentation
+          branch: patch/models
+          branch-suffix: short-commit-hash
+          assignees: ToshY
+          reviewers: ToshY
+          labels: |
+            OpenAPI
+            automated

.github/workflows/phpstan.yml

@@ -32,4 +32,4 @@ jobs:
         uses: ramsey/composer-install@v3
 
       - name: PHPStan
-        run: php vendor/bin/phpstan analyse --error-format=github
+        run: php vendor/bin/phpstan analyse --error-format=github --memory-limit=256M

.php-cs-fixer.dist.php

@@ -2,7 +2,11 @@
 
 $finder = (new PhpCsFixer\Finder())
     ->exclude(__DIR__ . '/vendor')
-    ->in(__DIR__ . '/src')
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+        __DIR__ . '/generator',
+    ])
     ->name('*.php');
 
 return (new PhpCsFixer\Config())
@@ -14,6 +18,7 @@
         'array_syntax' => [
             'syntax' => 'short',
         ],
+        'array_indentation' => true,
         'trailing_comma_in_multiline' => [
             'elements' => [
                 'arguments',

Dockerfile

@@ -12,5 +12,3 @@ RUN apt-get update && apt-get install -y \
     && rm -rf /var/lib/apt/lists/*
 
 COPY --from=composer:2.5 /usr/bin/composer /usr/bin/composer
-
-COPY . .

Taskfile.yml

@@ -6,6 +6,7 @@ env:
   GID:
     sh: id -g
   TTY: ''
+  API_SPEC_MANIFEST: https://toshy.github.io/bunnynet-openapi-specification/manifest.json
 
 tasks:
   default:
@@ -63,6 +64,22 @@ tasks:
     cmds:
       - docker compose run --rm $TTY php composer update {{.PACKAGE}} {{.CLI_ARGS | default "--no-cache"}}
 
+  composer:audit:
+    desc: Composer audit
+    cmds:
+      - docker compose run --rm $TTY php composer audit
+
+  # Generator
+  specs:maps:
+    desc: Generate model mapping files from OpenAPI specs
+    cmds:
+      - docker compose run --rm $TTY php php /app/generator/Command/generate-maps.php
+
+  specs:models:
+    desc: Generate model from mapping file
+    cmds:
+      - docker compose run --rm $TTY php php /app/generator/Command/generate-models.php {{.CLI_ARGS | default "--log"}}
+
   # Git
   git:hooks:
     desc: Setup git hooks
@@ -112,7 +129,7 @@ tasks:
   phpstan:
     desc: PHPStan run
     cmds:
-      - docker compose run --rm $TTY php vendor/bin/phpstan analyse --error-format=table
+      - docker compose run --rm $TTY php vendor/bin/phpstan analyse --error-format=table --memory-limit=256M
 
   phpstan:baseline:
     desc: PHPStan update baseline

compose.yaml

@@ -4,5 +4,7 @@ services:
       context: .
       dockerfile: Dockerfile
     user: "${UID:-1000}:${GID:-1000}"
+    environment:
+      API_SPEC_MANIFEST: ${API_SPEC_MANIFEST:-}
     volumes:
-      - ./:/app
+      - ./:/app

composer.json

@@ -28,7 +28,8 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "ToshY\\BunnyNet\\Tests\\": "tests/"
+      "ToshY\\BunnyNet\\Tests\\": "tests/",
+      "ToshY\\BunnyNet\\Generator\\": "generator/"
     }
   },
   "require": {
@@ -42,7 +43,9 @@
     "phpmd/phpmd": "^2.15",
     "friendsofphp/php-cs-fixer": "^3.75",
     "phpstan/phpstan": "^2.1",
-    "phpunit/phpunit": "^10.0"
+    "phpunit/phpunit": "^10.0",
+    "nette/php-generator": "^4.1",
+    "cebe/php-openapi": "^1.8"
   },
   "config": {
   }

docs/stream-api.md

@@ -320,38 +320,10 @@ $streamApi->setThumbnail(
 );
 ```
 
-#### Set Thumbnail (by body)
-
-```php
-/*
- * File contents read into string from the local filesystem.
- */
-$content = file_get_contents('./thumbnail.jpg');
-
-/*
- * File contents handle from a `$filesystem` (Flysystem FtpAdapter).
- */
-$content = $filesystem->readStream('./thumbnail.jpg');
-
-// Set video thumbnail by body contents.
-$streamApi->setThumbnailByBody(
-    libraryId: 1,
-    videoId: 'e7e9b99a-ea2a-434a-b200-f6615e7b6abd',
-    body: $content,
-    headers: [
-        'Content-Type' => 'image/jpeg',
-    ],
-);
-```
-
 !!! note
 
     - This method allows for uploading a thumbnail based on body contents.
 
-!!! warning
-
-    - Adding a thumbnail by uploading body contents is not documented in the official Bunny.net API specification for the [Set Thumbnail](https://docs.bunny.net/reference/video_setthumbnail) endpoint.
-
 #### [Fetch Video](https://docs.bunny.net/reference/video_fetchnewvideo)
 
 ```php

generator/Command/generate-maps.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+use ToshY\BunnyNet\Generator\Generator\MapGenerator;
+use ToshY\BunnyNet\Generator\Utils\FileUtils;
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+$apiSpecManifest = getenv('API_SPEC_MANIFEST');
+$modelInputDirectory = __DIR__ . '/../../src/Model/API';
+$outputDirectory = __DIR__ . '/../Map';
+
+$file = FileUtils::getFile($apiSpecManifest);
+if ($file === false) {
+    throw new RuntimeException(
+        sprintf(
+            'Unable to load API spec file `%s`.',
+            $apiSpecManifest,
+        ),
+    );
+}
+$manifests = FileUtils::jsonDecode($file);
+
+$data = [];
+foreach ($manifests as $file) {
+    $description = $file['sourceDescription'];
+    $key = match (true) {
+        str_contains($description, 'bunny.net API') => 'Base',
+        str_contains($description, 'Edge Scripting API') => 'EdgeScripting',
+        str_contains($description, 'Edge Storage API') => 'EdgeStorage',
+        str_contains($description, 'Stream API') => 'Stream',
+        str_contains($description, 'Shield API') => 'Shield',
+        default => throw new RuntimeException(
+            sprintf(
+                'Unknown API type with description: `%s`',
+                $description,
+            ),
+        ),
+    };
+
+    $ignoreEndpoints = match ($key) {
+        'Base' => [
+            /* Changed to EdgeScripting */
+            '/compute/script',
+            '/compute/script/{id}',
+            '/compute/script/{id}/code',
+            '/compute/script/{id}/releases',
+            '/compute/script/{id}/publish',
+            '/compute/script/{id}/publish/{uuid}',
+            '/compute/script/{id}/variables/add',
+            '/compute/script/{id}/variables/{variableId}',
+        ],
+        default => [],
+    };
+
+    $data[$key] = [
+        'apiSpecPath' => $file['fileUrl'],
+        'modelDirectory' => $modelInputDirectory . '/' . $key,
+        'mappingClassName' => $key,
+        'outputDirectory' => $outputDirectory,
+        'ignoreEndpoints' => $ignoreEndpoints,
+    ];
+}
+
+foreach ($data as $namespace => $config) {
+    $generator = new MapGenerator(
+        $config['apiSpecPath'],
+        $config['outputDirectory'],
+        $config['mappingClassName'],
+        $config['modelDirectory'],
+        $config['ignoreEndpoints'],
+    );
+    $generator->generate();
+
+    echo "[$namespace] Mapping class generated successfully" . PHP_EOL;
+}
+
+// Autofix with php-cs-fixer
+shell_exec('php vendor/bin/php-cs-fixer --quiet fix ' . realpath($outputDirectory));