Refactor to an abstract Resource

gehrisandro · gehrisandro · commit fc0e5b6e075e · 2023-12-06T08:28:23.000+01:00
diff --git a/src/Client.php b/src/Client.php
@@ -42,8 +42,7 @@ public function __construct(
      */
     public function completions(): Completions
     {
-        return (new Completions($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Completions($this->transporter, $this->events);
     }
 
     /**
@@ -53,8 +52,7 @@ public function completions(): Completions
      */
     public function chat(): Chat
     {
-        return (new Chat($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Chat($this->transporter, $this->events);
     }
 
     /**
@@ -64,8 +62,7 @@ public function chat(): Chat
      */
     public function embeddings(): Embeddings
     {
-        return (new Embeddings($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Embeddings($this->transporter, $this->events);
     }
 
     /**
@@ -75,8 +72,7 @@ public function embeddings(): Embeddings
      */
     public function audio(): Audio
     {
-        return (new Audio($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Audio($this->transporter, $this->events);
     }
 
     /**
@@ -86,8 +82,7 @@ public function audio(): Audio
      */
     public function edits(): Edits
     {
-        return (new Edits($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Edits($this->transporter, $this->events);
     }
 
     /**
@@ -97,8 +92,7 @@ public function edits(): Edits
      */
     public function files(): Files
     {
-        return (new Files($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Files($this->transporter, $this->events);
     }
 
     /**
@@ -108,8 +102,7 @@ public function files(): Files
      */
     public function models(): Models
     {
-        return (new Models($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Models($this->transporter, $this->events);
     }
 
     /**
@@ -119,8 +112,7 @@ public function models(): Models
      */
     public function fineTuning(): FineTuning
     {
-        return (new FineTuning($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new FineTuning($this->transporter, $this->events);
     }
 
     /**
@@ -132,8 +124,7 @@ public function fineTuning(): FineTuning
      */
     public function fineTunes(): FineTunes
     {
-        return (new FineTunes($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new FineTunes($this->transporter, $this->events);
     }
 
     /**
@@ -143,8 +134,7 @@ public function fineTunes(): FineTunes
      */
     public function moderations(): Moderations
     {
-        return (new Moderations($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Moderations($this->transporter, $this->events);
     }
 
     /**
@@ -154,8 +144,7 @@ public function moderations(): Moderations
      */
     public function images(): Images
     {
-        return (new Images($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Images($this->transporter, $this->events);
     }
 
     /**
@@ -165,8 +154,7 @@ public function images(): Images
      */
     public function assistants(): Assistants
     {
-        return (new Assistants($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Assistants($this->transporter, $this->events);
     }
 
     /**
@@ -176,7 +164,6 @@ public function assistants(): Assistants
      */
     public function threads(): ThreadsContract
     {
-        return (new Threads($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new Threads($this->transporter, $this->events);
     }
 }
diff --git a/src/Resources/Assistants.php b/src/Resources/Assistants.php
@@ -13,11 +13,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Assistants implements AssistantsContract
+final class Assistants extends Resource implements AssistantsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Create an assistant with a model and instructions.
      *
@@ -126,7 +123,6 @@ public function list(array $parameters = []): AssistantListResponse
      */
     public function files(): AssistantsFilesContract
     {
-        return (new AssistantsFiles($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new AssistantsFiles($this->transporter, $this->events);
     }
 }
diff --git a/src/Resources/AssistantsFiles.php b/src/Resources/AssistantsFiles.php
@@ -12,11 +12,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class AssistantsFiles implements AssistantsFilesContract
+final class AssistantsFiles extends Resource implements AssistantsFilesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Create an assistant file by attaching a File to an assistant.
      *
diff --git a/src/Resources/Audio.php b/src/Resources/Audio.php
@@ -12,11 +12,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Audio implements AudioContract
+final class Audio extends Resource implements AudioContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Generates audio from the input text.
      *
diff --git a/src/Resources/Chat.php b/src/Resources/Chat.php
@@ -12,11 +12,9 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Chat implements ChatContract
+final class Chat extends Resource implements ChatContract
 {
-    use Concerns\Dispatchable;
     use Concerns\Streamable;
-    use Concerns\Transportable;
 
     /**
      * Creates a completion for the chat message
diff --git a/src/Resources/Completions.php b/src/Resources/Completions.php
@@ -12,11 +12,9 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Completions implements CompletionsContract
+final class Completions extends Resource implements CompletionsContract
 {
-    use Concerns\Dispatchable;
     use Concerns\Streamable;
-    use Concerns\Transportable;
 
     /**
      * Creates a completion for the provided prompt and parameters
diff --git a/src/Resources/Edits.php b/src/Resources/Edits.php
@@ -10,11 +10,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Edits implements EditsContract
+final class Edits extends Resource implements EditsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Creates a new edit for the provided input, instruction, and parameters.
      *
diff --git a/src/Resources/Embeddings.php b/src/Resources/Embeddings.php
@@ -10,11 +10,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Embeddings implements EmbeddingsContract
+final class Embeddings extends Resource implements EmbeddingsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Creates an embedding vector representing the input text.
      *
diff --git a/src/Resources/Files.php b/src/Resources/Files.php
@@ -13,11 +13,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Files implements FilesContract
+final class Files extends Resource implements FilesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Returns a list of files that belong to the user's organization.
      *
diff --git a/src/Resources/FineTunes.php b/src/Resources/FineTunes.php
@@ -14,11 +14,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class FineTunes implements FineTunesContract
+final class FineTunes extends Resource implements FineTunesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Creates a job that fine-tunes a specified model from a given dataset.
      *
diff --git a/src/Resources/FineTuning.php b/src/Resources/FineTuning.php
@@ -12,11 +12,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class FineTuning implements FineTuningContract
+final class FineTuning extends Resource implements FineTuningContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Creates a job that fine-tunes a specified model from a given dataset.
      *
diff --git a/src/Resources/Images.php b/src/Resources/Images.php
@@ -12,11 +12,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Images implements ImagesContract
+final class Images extends Resource implements ImagesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Creates an image given a prompt.
      *
diff --git a/src/Resources/Models.php b/src/Resources/Models.php
@@ -12,11 +12,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Models implements ModelsContract
+final class Models extends Resource implements ModelsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Lists the currently available models, and provides basic information about each one such as the owner and availability.
      *
diff --git a/src/Resources/Moderations.php b/src/Resources/Moderations.php
@@ -10,11 +10,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Moderations implements ModerationsContract
+final class Moderations extends Resource implements ModerationsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Classifies if text violates OpenAI's Content Policy.
      *
diff --git a/src/Resources/Resource.php b/src/Resources/Resource.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace OpenAI\Resources;
+
+use OpenAI\Contracts\DispatcherContract;
+use OpenAI\Contracts\TransporterContract;
+
+abstract class Resource
+{
+    public function __construct(
+        protected readonly TransporterContract $transporter,
+        protected readonly DispatcherContract $events,
+    ) {
+        // ..
+    }
+
+    public function event(object $event): void
+    {
+        $this->events->dispatch($event);
+    }
+}
diff --git a/src/Resources/Threads.php b/src/Resources/Threads.php
@@ -14,11 +14,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class Threads implements ThreadsContract
+final class Threads extends Resource implements ThreadsContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Create a thread.
      *
@@ -127,8 +124,7 @@ public function delete(string $id): ThreadDeleteResponse
      */
     public function messages(): ThreadsMessagesContract
     {
-        return (new ThreadsMessages($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new ThreadsMessages($this->transporter, $this->events);
     }
 
     /**
@@ -138,7 +134,6 @@ public function messages(): ThreadsMessagesContract
      */
     public function runs(): ThreadsRunsContract
     {
-        return (new ThreadsRuns($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new ThreadsRuns($this->transporter, $this->events);
     }
 }
diff --git a/src/Resources/ThreadsMessages.php b/src/Resources/ThreadsMessages.php
@@ -13,11 +13,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class ThreadsMessages implements ThreadsMessagesContract
+final class ThreadsMessages extends Resource implements ThreadsMessagesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Create a message.
      *
@@ -126,7 +123,6 @@ public function list(string $threadId, array $parameters = []): ThreadMessageLis
      */
     public function files(): ThreadsMessagesFilesContract
     {
-        return (new ThreadsMessagesFiles($this->transporter))
-            ->setEventDispatcher($this->events);
+        return new ThreadsMessagesFiles($this->transporter, $this->events);
     }
 }
diff --git a/src/Resources/ThreadsMessagesFiles.php b/src/Resources/ThreadsMessagesFiles.php
@@ -11,11 +11,8 @@
 use OpenAI\ValueObjects\Transporter\Payload;
 use OpenAI\ValueObjects\Transporter\Response;
 
-final class ThreadsMessagesFiles implements ThreadsMessagesFilesContract
+final class ThreadsMessagesFiles extends Resource implements ThreadsMessagesFilesContract
 {
-    use Concerns\Dispatchable;
-    use Concerns\Transportable;
-
     /**
      * Retrieves a message file.
      *
diff --git a/src/Resources/ThreadsRuns.php b/src/Resources/ThreadsRuns.php
diff --git a/src/Resources/ThreadsRunsSteps.php b/src/Resources/ThreadsRunsSteps.php

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,7 @@ public function __construct(`
`42`	`42`	`*/`
`43`	`43`	`public function completions(): Completions`
`44`	`44`	`{`
`45`		`- return (new Completions($this->transporter))`
`46`		`- ->setEventDispatcher($this->events);`
	`45`	`+ return new Completions($this->transporter, $this->events);`
`47`	`46`	`}`
`48`	`47`
`49`	`48`	`/**`
`@@ -53,8 +52,7 @@ public function completions(): Completions`
`53`	`52`	`*/`
`54`	`53`	`public function chat(): Chat`
`55`	`54`	`{`
`56`		`- return (new Chat($this->transporter))`
`57`		`- ->setEventDispatcher($this->events);`
	`55`	`+ return new Chat($this->transporter, $this->events);`
`58`	`56`	`}`
`59`	`57`
`60`	`58`	`/**`
`@@ -64,8 +62,7 @@ public function chat(): Chat`
`64`	`62`	`*/`
`65`	`63`	`public function embeddings(): Embeddings`
`66`	`64`	`{`
`67`		`- return (new Embeddings($this->transporter))`
`68`		`- ->setEventDispatcher($this->events);`
	`65`	`+ return new Embeddings($this->transporter, $this->events);`
`69`	`66`	`}`
`70`	`67`
`71`	`68`	`/**`
`@@ -75,8 +72,7 @@ public function embeddings(): Embeddings`
`75`	`72`	`*/`
`76`	`73`	`public function audio(): Audio`
`77`	`74`	`{`
`78`		`- return (new Audio($this->transporter))`
`79`		`- ->setEventDispatcher($this->events);`
	`75`	`+ return new Audio($this->transporter, $this->events);`
`80`	`76`	`}`
`81`	`77`
`82`	`78`	`/**`
`@@ -86,8 +82,7 @@ public function audio(): Audio`
`86`	`82`	`*/`
`87`	`83`	`public function edits(): Edits`
`88`	`84`	`{`
`89`		`- return (new Edits($this->transporter))`
`90`		`- ->setEventDispatcher($this->events);`
	`85`	`+ return new Edits($this->transporter, $this->events);`
`91`	`86`	`}`
`92`	`87`
`93`	`88`	`/**`
`@@ -97,8 +92,7 @@ public function edits(): Edits`
`97`	`92`	`*/`
`98`	`93`	`public function files(): Files`
`99`	`94`	`{`
`100`		`- return (new Files($this->transporter))`
`101`		`- ->setEventDispatcher($this->events);`
	`95`	`+ return new Files($this->transporter, $this->events);`
`102`	`96`	`}`
`103`	`97`
`104`	`98`	`/**`
`@@ -108,8 +102,7 @@ public function files(): Files`
`108`	`102`	`*/`
`109`	`103`	`public function models(): Models`
`110`	`104`	`{`
`111`		`- return (new Models($this->transporter))`
`112`		`- ->setEventDispatcher($this->events);`
	`105`	`+ return new Models($this->transporter, $this->events);`
`113`	`106`	`}`
`114`	`107`
`115`	`108`	`/**`
`@@ -119,8 +112,7 @@ public function models(): Models`
`119`	`112`	`*/`
`120`	`113`	`public function fineTuning(): FineTuning`
`121`	`114`	`{`
`122`		`- return (new FineTuning($this->transporter))`
`123`		`- ->setEventDispatcher($this->events);`
	`115`	`+ return new FineTuning($this->transporter, $this->events);`
`124`	`116`	`}`
`125`	`117`
`126`	`118`	`/**`
`@@ -132,8 +124,7 @@ public function fineTuning(): FineTuning`
`132`	`124`	`*/`
`133`	`125`	`public function fineTunes(): FineTunes`
`134`	`126`	`{`
`135`		`- return (new FineTunes($this->transporter))`
`136`		`- ->setEventDispatcher($this->events);`
	`127`	`+ return new FineTunes($this->transporter, $this->events);`
`137`	`128`	`}`
`138`	`129`
`139`	`130`	`/**`
`@@ -143,8 +134,7 @@ public function fineTunes(): FineTunes`
`143`	`134`	`*/`
`144`	`135`	`public function moderations(): Moderations`
`145`	`136`	`{`
`146`		`- return (new Moderations($this->transporter))`
`147`		`- ->setEventDispatcher($this->events);`
	`137`	`+ return new Moderations($this->transporter, $this->events);`
`148`	`138`	`}`
`149`	`139`
`150`	`140`	`/**`
`@@ -154,8 +144,7 @@ public function moderations(): Moderations`
`154`	`144`	`*/`
`155`	`145`	`public function images(): Images`
`156`	`146`	`{`
`157`		`- return (new Images($this->transporter))`
`158`		`- ->setEventDispatcher($this->events);`
	`147`	`+ return new Images($this->transporter, $this->events);`
`159`	`148`	`}`
`160`	`149`
`161`	`150`	`/**`
`@@ -165,8 +154,7 @@ public function images(): Images`
`165`	`154`	`*/`
`166`	`155`	`public function assistants(): Assistants`
`167`	`156`	`{`
`168`		`- return (new Assistants($this->transporter))`
`169`		`- ->setEventDispatcher($this->events);`
	`157`	`+ return new Assistants($this->transporter, $this->events);`
`170`	`158`	`}`
`171`	`159`
`172`	`160`	`/**`
`@@ -176,7 +164,6 @@ public function assistants(): Assistants`
`176`	`164`	`*/`
`177`	`165`	`public function threads(): ThreadsContract`
`178`	`166`	`{`
`179`		`- return (new Threads($this->transporter))`
`180`		`- ->setEventDispatcher($this->events);`
	`167`	`+ return new Threads($this->transporter, $this->events);`
`181`	`168`	`}`
`182`	`169`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,8 @@`
`13`	`13`	`use OpenAI\ValueObjects\Transporter\Payload;`
`14`	`14`	`use OpenAI\ValueObjects\Transporter\Response;`
`15`	`15`
`16`		`-final class Assistants implements AssistantsContract`
	`16`	`+final class Assistants extends Resource implements AssistantsContract`
`17`	`17`	`{`
`18`		`- use Concerns\Dispatchable;`
`19`		`- use Concerns\Transportable;`
`20`		`-`
`21`	`18`	`/**`
`22`	`19`	`* Create an assistant with a model and instructions.`
`23`	`20`	`*`
`@@ -126,7 +123,6 @@ public function list(array $parameters = []): AssistantListResponse`
`126`	`123`	`*/`
`127`	`124`	`public function files(): AssistantsFilesContract`
`128`	`125`	`{`
`129`		`- return (new AssistantsFiles($this->transporter))`
`130`		`- ->setEventDispatcher($this->events);`
	`126`	`+ return new AssistantsFiles($this->transporter, $this->events);`
`131`	`127`	`}`
`132`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,8 @@`
`12`	`12`	`use OpenAI\ValueObjects\Transporter\Payload;`
`13`	`13`	`use OpenAI\ValueObjects\Transporter\Response;`
`14`	`14`
`15`		`-final class AssistantsFiles implements AssistantsFilesContract`
	`15`	`+final class AssistantsFiles extends Resource implements AssistantsFilesContract`
`16`	`16`	`{`
`17`		`- use Concerns\Dispatchable;`
`18`		`- use Concerns\Transportable;`
`19`		`-`
`20`	`17`	`/**`
`21`	`18`	`* Create an assistant file by attaching a File to an assistant.`
`22`	`19`	`*`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,8 @@`
`10`	`10`	`use OpenAI\ValueObjects\Transporter\Payload;`
`11`	`11`	`use OpenAI\ValueObjects\Transporter\Response;`
`12`	`12`
`13`		`-final class Edits implements EditsContract`
	`13`	`+final class Edits extends Resource implements EditsContract`
`14`	`14`	`{`
`15`		`- use Concerns\Dispatchable;`
`16`		`- use Concerns\Transportable;`
`17`		`-`
`18`	`15`	`/**`
`19`	`16`	`* Creates a new edit for the provided input, instruction, and parameters.`
`20`	`17`	`*`
Original file line number	Diff line number	Diff line change
`@@ -14,11 +14,8 @@`
`14`	`14`	`use OpenAI\ValueObjects\Transporter\Payload;`
`15`	`15`	`use OpenAI\ValueObjects\Transporter\Response;`
`16`	`16`
`17`		`-final class FineTunes implements FineTunesContract`
	`17`	`+final class FineTunes extends Resource implements FineTunesContract`
`18`	`18`	`{`
`19`		`- use Concerns\Dispatchable;`
`20`		`- use Concerns\Transportable;`
`21`		`-`
`22`	`19`	`/**`
`23`	`20`	`* Creates a job that fine-tunes a specified model from a given dataset.`
`24`	`21`	`*`