POC: strong typed requests and responses

Author: gehrisandro

src/Contracts/Request.php

@@ -4,7 +4,7 @@
 
 use OpenAI\Contracts\DataObject;
 
-final class ModerationResponse implements DataObject
+final class Moderation implements DataObject
 {
     /**
      * @param  array<array-key, ModerationResult>  $results

src/DataObjectFactories/Moderation/ModerationResponseFactory.php

@@ -2,9 +2,10 @@
 
 namespace OpenAI\DataObjects\Moderation;
 
+use OpenAI\Contracts\DataObject;
 use OpenAI\Enums\Moderation\Category;
 
-final class ModerationCategory
+final class ModerationCategory implements DataObject
 {
     public function __construct(
         public readonly Category $category,

src/DataObjects/Moderation/ModerationResponse.php renamed to src/DataObjects/Moderation/Moderation.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace OpenAI\DataObjectFactories\Moderation;
+namespace OpenAI\Factories\DataObjects\Moderation;
 
 use OpenAI\DataObjects\Moderation\ModerationCategory;
 use OpenAI\Enums\Moderation\Category;
@@ -33,8 +33,8 @@ public function make(array $attributes): ModerationCategory
     {
         return new ModerationCategory(
             category: Category::from((string) $attributes['category']),
-            violated: (bool) ($attributes['violated'] ?? false),
-            score: (float) ($attributes['score'] ?? 0),
+            violated: (bool) $attributes['violated'],
+            score: (float) $attributes['score'],
         );
     }
 }

src/DataObjects/Moderation/ModerationCategory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace OpenAI\Factories\DataObjects\Moderation;
+
+use OpenAI\DataObjects\Moderation\Moderation;
+
+final class ModerationFactory
+{
+    /**
+     * @param  array<string, array<array-key, array<string, array<string, bool|float>>>|string>  $attributes
+     */
+    public static function new(array $attributes): Moderation
+    {
+        return (new self)->make(
+            attributes: $attributes,
+        );
+    }
+
+    /**
+     * @param  array<string, array<array-key, array<string, array<string, bool|float>>>|string>  $attributes
+     */
+    public function make(array $attributes): Moderation
+    {
+        return new Moderation(
+            id: strval($attributes['id']),
+            model: strval($attributes['model']),
+            results: ModerationResultFactory::collection($attributes['results']), /** @phpstan-ignore-line */
+        );
+    }
+}

src/Enums/Moderation/ModerationModel.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace OpenAI\DataObjectFactories\Moderation;
+namespace OpenAI\Factories\DataObjects\Moderation;
 
 use OpenAI\DataObjects\Moderation\ModerationResult;
 use OpenAI\Enums\Moderation\Category;
@@ -13,7 +13,7 @@ final class ModerationResultFactory
      */
     public static function collection(array $results): array
     {
-        return array_map(fn ($result): \OpenAI\DataObjects\Moderation\ModerationResult => static::new($result), $results);
+        return array_map(fn ($result): ModerationResult => static::new($result), $results);
     }
 
     /**
@@ -33,13 +33,13 @@ public function make(array $attributes): ModerationResult
     {
         $categories = array_map(fn (Category $category): array => [
             'category' => $category->value,
-            'violated' => $attributes['categories'][$category->value] ?? false,
-            'score' => $attributes['category_scores'][$category->value] ?? 0,
+            'violated' => $attributes['categories'][$category->value],
+            'score' => $attributes['category_scores'][$category->value],
         ], Category::cases());
 
         return new ModerationResult(
             categories: ModerationCategoryFactory::collection($categories),
-            flagged: (bool) ($attributes['flagged'] ?? false),
+            flagged: (bool) ($attributes['flagged']),
         );
     }
 }

src/DataObjectFactories/Moderation/ModerationCategoryFactory.php renamed to src/Factories/DataObjects/Moderation/ModerationCategoryFactory.php

@@ -4,9 +4,8 @@
 
 namespace OpenAI\Resources;
 
-use OpenAI\DataObjectFactories\Moderation\ModerationResponseFactory;
-use OpenAI\DataObjects\Moderation\ModerationResponse;
-use OpenAI\Requests\Moderation\ModerationCreateRequest;
+use OpenAI\DataObjects\Moderation\Moderation;
+use OpenAI\Factories\DataObjects\Moderation\ModerationFactory;
 use OpenAI\ValueObjects\Transporter\Payload;
 
 final class Moderations
@@ -17,14 +16,16 @@ final class Moderations
      * Classifies if text violates OpenAI's Content Policy.
      *
      * @see https://beta.openai.com/docs/api-reference/moderations/create
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function create(ModerationCreateRequest $request): ModerationResponse
+    public function create(array $parameters): Moderation
     {
-        $payload = Payload::createFromRequest('moderations', $request);
+        $payload = Payload::create('moderations', $parameters);
 
-        /** @var array<string, mixed> $result */
+        /** @var array<string, array<array-key, array<string, array<string, bool|float>>>|string> $result */
         $result = $this->transporter->requestObject($payload);
 
-        return ModerationResponseFactory::new($result);
+        return ModerationFactory::new($result);
     }
 }

src/Factories/DataObjects/Moderation/ModerationFactory.php

@@ -80,18 +80,6 @@ public static function create(string $resource, array $parameters): self
         return new self($contentType, $method, $uri, $parameters);
     }
 
-    /**
-     * Creates a new Payload value object from the given parameters.
-     */
-    public static function createFromRequest(string $resource, Request $request): self
-    {
-        $contentType = ContentType::JSON;
-        $method = Method::POST;
-        $uri = ResourceUri::create($resource);
-
-        return new self($contentType, $method, $uri, $request->toArray());
-    }
-
     /**
      * Creates a new Payload value object from the given parameters.
      *

src/DataObjectFactories/Moderation/ModerationResultFactory.php renamed to src/Factories/DataObjects/Moderation/ModerationResultFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+use OpenAI\DataObjects\Moderation\Moderation;
+use OpenAI\DataObjects\Moderation\ModerationResult;
+use OpenAI\Factories\DataObjects\Moderation\ModerationFactory;
+
+test('build new moderation', function () {
+    $moderation = ModerationFactory::new(moderationResource());
+
+    expect($moderation)
+        ->toBeInstanceOf(Moderation::class)
+        ->id->toBe('modr-5MWoLO')
+        ->model->toBe('text-moderation-001')
+        ->results->toBeArray()->toHaveCount(1)
+        ->results->each->toBeInstanceOf(ModerationResult::class);
+});
+
+test('create array from moderation', function () {
+    $moderation = ModerationFactory::new(moderationResource());
+
+    expect($moderation->toArray())
+        ->toBeArray()
+        ->id->toBe('modr-5MWoLO')
+        ->model->toBe('text-moderation-001')
+        ->results->toBeArray()->toHaveCount(1)
+        ->results->each->toBeArray();
+});

src/RequestFactories/Moderation/ModerationCreateRequestFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+use OpenAI\Enums\Moderation\Category;
+use OpenAI\Factories\DataObjects\Moderation\ModerationCategoryFactory;
+
+test('build new moderation category', function () {
+    $category = ModerationCategoryFactory::new([
+        'category' => Category::Hate->value,
+        'violated' => true,
+        'score' => 0.1234,
+    ]);
+
+    expect($category)
+        ->category->toBe(Category::Hate)
+        ->violated->toBe(true)
+        ->score->toBe(0.1234);
+});
+
+test('create array from moderation category', function () {
+    $raw = [
+        'category' => Category::Hate->value,
+        'violated' => true,
+        'score' => 0.1234,
+    ];
+
+    $category = ModerationCategoryFactory::new($raw);
+
+    expect($category->toArray())
+        ->toBeArray()
+        ->toBe($raw);
+});

src/Requests/Moderation/ModerationCreateRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+use OpenAI\DataObjects\Moderation\ModerationCategory;
+use OpenAI\Factories\DataObjects\Moderation\ModerationResultFactory;
+
+test('build new moderation result', function () {
+    $result = ModerationResultFactory::new(moderationResource()['results'][0]);
+
+    expect($result)
+        ->flagged->toBeTrue()
+        ->categories->toHaveCount(7)
+        ->each->toBeInstanceOf(ModerationCategory::class);
+});
+
+test('create array from moderation result', function () {
+    $result = ModerationResultFactory::new(moderationResource()['results'][0]);
+
+    expect($result->toArray())
+        ->flagged->toBeTrue()
+        ->categories->toHaveCount(7)
+        ->each->toBeArray();
+});