Merge pull request #2 from miroslaws8/create_model_endpoints

Feature: add model endpoints

Author: miroslaws8

src/Services/AIModels/General.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\AIModels;
+
+use GuzzleHttp\Exception\GuzzleException;
+use Itsimiro\OpenAI\Services\API\ApiService;
+use Itsimiro\OpenAI\Services\API\Results\ModelResult;
+use Itsimiro\OpenAI\Services\API\Results\ModelsResult;
+use Itsimiro\OpenAI\Services\API\UrlService;
+
+class General
+{
+    public function __construct(private readonly ApiService $apiService, private readonly UrlService $urlService)
+    {}
+
+    /**
+     * @throws GuzzleException
+     */
+    public function getModels(): ModelsResult
+    {
+        return $this->apiService->getResult(
+            $this->apiService->sendRequest('GET', $this->urlService->models()),
+            ModelsResult::class
+        );
+    }
+
+    /**
+     * @throws GuzzleException
+     */
+    public function retrieveModel(string $modelId): ModelResult
+    {
+        return $this->apiService->getResult(
+            $this->apiService->sendRequest('POST', $this->urlService->models().'/'.$modelId),
+            ModelResult::class
+        );
+    }
+}

src/Services/API/Results/BodyParameters.php

@@ -10,4 +10,6 @@ class BodyParameters
     public const MODEL = 'model';
     public const CHOICES = 'choices';
     public const USAGE = 'usage';
+    public const OWNER_BY = 'owned_by';
+    public const PERMISSIONS = 'permissions';
 }

src/Services/API/Results/ModelResult.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\API\Results;
+
+use Illuminate\Support\Arr;
+use Spatie\LaravelData\Data;
+
+class ModelResult extends Data implements ResultInterface
+{
+    public function __construct(public array $result)
+    {}
+
+    public function getId(): string
+    {
+        return Arr::get($this->result, BodyParameters::ID, '');
+    }
+
+    public function getObject(): string
+    {
+        return Arr::get($this->result, BodyParameters::OBJECT, '');
+    }
+
+    public function getOwner(): string
+    {
+        return Arr::get($this->result, BodyParameters::OWNER_BY, '');
+    }
+
+    public function getPermissions(): array
+    {
+        return Arr::get($this->result, BodyParameters::PERMISSIONS, []);
+    }
+}

src/Services/API/Results/ModelsResult.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\API\Results;
+
+use Spatie\LaravelData\Data;
+use Spatie\LaravelData\DataCollection;
+
+class ModelsResult extends Data implements ResultInterface
+{
+    public function __construct(public array $result)
+    {}
+
+    public function getModels(): DataCollection
+    {
+        return ModelResult::collection($this->result['data']);
+    }
+}

src/Services/API/UrlService.php

@@ -34,7 +34,7 @@ public function fineTune(): string
         return $this->buildUrl('/fine-tunes');
     }
 
-    public function fineTuneModel(): string
+    public function models(): string
     {
         return $this->buildUrl('/models');
     }

src/Services/OpenAI.php

@@ -6,6 +6,7 @@
 use Illuminate\Contracts\Container\Container;
 use Itsimiro\OpenAI\Services\AIModels\Dalle;
 use Itsimiro\OpenAI\Services\AIModels\Davinci;
+use Itsimiro\OpenAI\Services\AIModels\General;
 use Itsimiro\OpenAI\Services\AIModels\Whisper;
 
 class OpenAI
@@ -36,4 +37,12 @@ public function getWhisper(): Whisper
     {
         return $this->container->make(Whisper::class);
     }
+
+    /**
+     * @throws BindingResolutionException
+     */
+    public function getGeneral(): General
+    {
+        return $this->container->make(General::class);
+    }
 }

tests/Unit/AIModels/GeneralTest.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Unit\AIModels;
+
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Itsimiro\OpenAI\Services\AIModels\General;
+use Itsimiro\OpenAI\Services\API\ApiService;
+use Itsimiro\OpenAI\Services\API\Results\ModelResult;
+use Itsimiro\OpenAI\Services\API\Results\ModelsResult;
+use Itsimiro\OpenAI\Services\API\UrlService;
+use PHPUnit\Framework\MockObject\Exception;
+use PHPUnit\Framework\TestCase;
+use Spatie\LaravelData\DataCollection;
+
+class GeneralTest extends TestCase
+{
+    /**
+     * @throws Exception
+     * @throws BindingResolutionException
+     */
+    public function testGetModels(): void
+    {
+        $app = app();
+
+        $expectedModel = $this->getMockModel();
+
+        $dataCollection = $this->getMockBuilder(DataCollection::class)
+            ->setConstructorArgs([
+                'dataClass' => ModelResult::class,
+                'items' => []
+            ])->getMock();
+
+        $dataCollection->method('first')->willReturn(new ModelResult($expectedModel));
+
+        $resultObject = $this->createMock(ModelsResult::class);
+        $resultObject->method('getModels')->willReturn($dataCollection);
+
+        $apiService = $this->createMock(ApiService::class);
+        $app->bind(ApiService::class, fn() => $apiService);
+        $apiService->expects($this->once())->method('getResult')->willReturn($resultObject);
+
+        $app->bind(UrlService::class, fn() => $this->createMock(UrlService::class));
+
+        $model = $app->make(General::class);
+
+        $result = $model->getModels();
+
+        $this->assertEquals($expectedModel['id'], $result->getModels()->first()->getId());
+    }
+
+    /**
+     * @throws Exception
+     * @throws BindingResolutionException
+     */
+    public function testRetrieveModel(): void
+    {
+        $app = app();
+
+        $modelId = 'testModel';
+
+        $resultObject = $this->createMock(ModelResult::class);
+        $resultObject->method('getId')->willReturn($modelId);
+
+        $apiService = $this->createMock(ApiService::class);
+        $app->bind(ApiService::class, fn() => $apiService);
+        $apiService->expects($this->once())->method('getResult')->willReturn($resultObject);
+
+        $app->bind(UrlService::class, fn() => $this->createMock(UrlService::class));
+
+        $model = $app->make(General::class);
+
+        $result = $model->retrieveModel($modelId);
+
+        $this->assertEquals($modelId, $result->getId());
+    }
+
+    private function getMockModel(): array
+    {
+        return [
+            'id' => 'text-davinci-003',
+            'object' => 'model',
+            'owned_by'=> 'openai',
+            'permission' => []
+        ];
+    }
+}