Merge pull request #8 from joomla-projects/update-resposne-class

Update Response class to implement PSR7s ResponseInterface

Author: charvimehradu

.gitignore

@@ -15,3 +15,4 @@ phpunit.*.xml
 .idea/
 /.phpunit.result.cache
 /.phpunit.cache/
+config.json

src/AbstractProvider.php

@@ -58,7 +58,7 @@ abstract class AbstractProvider implements ProviderInterface
      * @throws  \InvalidArgumentException
      * @since  ___DEPLOY_VERSION___
      */
-    public function __construct(array $options = [], ?HttpFactory $httpFactory = null)
+    public function __construct($options = [], ?HttpFactory $httpFactory = null)
     {
         // Validate provider is suported
         if (!\is_array($options) && !($options instanceof \ArrayAccess)) {
@@ -340,9 +340,9 @@ protected function getExtensionFromMimeType(string $mimeType): string
     }
 
     /**
-     * Get audio MIME type from file path.
+     * Get audio MIME type from the input.
      *
-     * @param   string  $filepath  The file path
+     * @param   string  $input
      *
      * @return  string  The MIME type
      * @since   __DEPLOY_VERSION__

src/Exception/QuotaExceededException.php

@@ -20,14 +20,11 @@ class QuotaExceededException extends AIException
      * Constructor.
      *
      * @param   string        $provider          The AI provider name
-     * @param   string        $message           The error message
-     * @param   array         $context           Additional context data
      * @param   int|null      $httpStatusCode    The actual HTTP status code from response
-     * @param   string|null   $providerErrorCode The provider-specific error code
      *
      * @since   __DEPLOY_VERSION__
      */
-    public function __construct(string $provider, array $errorData, int $httpStatusCode)
+    public function __construct(string $provider, array $errorData, $httpStatusCode)
     {
         $context = ['error_data' => $errorData];
         $providerErrorCode = $errorData['code'] ?? $errorData['error']['code'] ?? null;

src/Exception/RateLimitException.php

@@ -20,14 +20,12 @@ class RateLimitException extends AIException
      * Constructor.
      *
      * @param   string        $provider          The AI provider name
-     * @param   string        $message           The error message
-     * @param   array         $context           Additional context data
+     * @param   array         $errorData         Additional error data
      * @param   int|null      $httpStatusCode    The actual HTTP status code from response
-     * @param   string|null   $providerErrorCode The provider-specific error code
      *
      * @since   __DEPLOY_VERSION__
      */
-    public function __construct(string $provider, array $errorData, int $httpStatusCode)
+    public function __construct(string $provider, array $errorData, $httpStatusCode)
     {
         $context = ['error_data' => $errorData];
         $providerErrorCode = $errorData['code'] ?? $errorData['error']['code'] ?? null;

src/Interface/AudioInterface.php

@@ -22,8 +22,6 @@ interface AudioInterface
      * Generate speech audio from text input.
      *
      * @param   string  $text     The text to convert to speech
-     * @param   string  $model    The TTS model to use for speech generation
-     * @param   string  $voice    The voice to use for speech generation
      * @param   array   $options  Additional options for speech generation
      *
      * @return  Response
@@ -59,7 +57,6 @@ public function getSupportedAudioFormats(): array;
      * Transcribe audio to text.
      *
      * @param   string  $audioFile  Path to the audio file to transcribe
-     * @param   string  $model      The transcription model to use
      * @param   array   $options    Additional options for transcription
      *
      * @return  Response
@@ -71,7 +68,6 @@ public function transcribe(string $audioFile, array $options = []): Response;
      * Translate audio to English text.
      *
      * @param   string  $audioFile  Path to audio file to translate
-     * @param   string  $model      Model to use for translation
      * @param   array   $options    Additional options
      *
      * @return  Response

src/Provider/AnthropicProvider.php

@@ -42,7 +42,7 @@ class AnthropicProvider extends AbstractProvider implements ProviderInterface, C
      *
      * @since  __DEPLOY_VERSION__
      */
-    public function __construct(array $options = [], ?HttpFactory $httpFactory = null)
+    public function __construct($options = [], ?HttpFactory $httpFactory = null)
     {
         parent::__construct($options, $httpFactory);
 
@@ -143,9 +143,7 @@ private function getModelsEndpoint(): string
     /**
      * List available models from Anthropic.
      *
-     * @param   array  $options  Optional parameters for the request
-     *
-     * @return  Response  The response containing model list
+     * @return  array
      * @since  __DEPLOY_VERSION__
      */
     public function getAvailableModels(): array

src/Provider/OllamaProvider.php

@@ -32,7 +32,7 @@ class OllamaProvider extends AbstractProvider
      *
      * @since  __DEPLOY_VERSION__
      */
-    public function __construct(array $options = [], ?HttpFactory $httpFactory = null)
+    public function __construct($options = [], ?HttpFactory $httpFactory = null)
     {
         parent::__construct($options, $httpFactory);
 
@@ -165,7 +165,6 @@ public function getAvailableModels(): array
     /**
      * List models currently loaded into memory (running) and echo their names.
      *
-     * @return array Array of running model info
      * @throws ProviderException If the request fails
      * @since __DEPLOY_VERSION__
      */
@@ -319,7 +318,6 @@ public function deleteModel(string $modelName): bool
      * @param   bool    $stream     Whether to stream the response (for progress updates)
      * @param   bool    $insecure   Allow insecure connections to the library
      *
-     * @return  bool    True if model was pulled successfully
      * @throws  InvalidArgumentException  If model doesn't exist in Ollama library
      * @throws  ProviderException        If pull fails for other reasons
      * @since   __DEPLOY_VERSION__
@@ -626,7 +624,7 @@ public function buildGenerateRequestPayload(string $prompt, array $options = [])
      *
      * @param   string    $prompt    The prompt to generate a response for
      * @param   array     $options   Additional options
-     * @param   callable  $callback  Optional callback function for streaming responses
+     *
      * @return  Response  The AI response
      * @throws  ProviderException  If the request fails
      * @since   __DEPLOY_VERSION__

src/Provider/OpenAIProvider.php

@@ -124,7 +124,7 @@ class OpenAIProvider extends AbstractProvider implements ChatInterface, ModelInt
      *
      * @since  __DEPLOY_VERSION__
      */
-    public function __construct(array $options = [], ?HttpFactory $httpFactory = null)
+    public function __construct($options = [], ?HttpFactory $httpFactory = null)
     {
         parent::__construct($options, $httpFactory);
 
@@ -573,8 +573,6 @@ public function editImage($images, string $prompt, array $options = []): Respons
      * Generate speech audio from text input.
      *
      * @param   string  $text     The text to convert to speech
-     * @param   string  $model    The model to use for speech synthesis
-     * @param   string  $voice    The voice to use for speech synthesis
      * @param   array   $options  Additional options for speech generation
      *
      * @return  Response
@@ -602,7 +600,6 @@ public function speech(string $text, array $options = []): Response
      * Transcribe audio into text.
      *
      * @param   string  $audioFile  Path to audio file
-     * @param   string  $model      The transcription model to use
      * @param   array   $options    Additional options for transcription
      *
      * @return  Response  The AI response containing transcribed text
@@ -627,7 +624,6 @@ public function transcribe(string $audioFile, array $options = []): Response
      * Translate audio to English text.
      *
      * @param   string  $audioFile  Path to audio file
-     * @param   string  $model      Model to use for translation
      * @param   array   $options    Additional options
      *
      * @return  Response  Translation response
@@ -722,7 +718,6 @@ public function moderate($input, array $options = []): array
      * @param   array  $moderationResult  Result from moderate() method
      *
      * @return  bool
-     * @throws  \InvalidArgumentException
      * @since   __DEPLOY_VERSION__
      */
     public function isContentFlagged(array $moderationResult): bool
@@ -909,7 +904,6 @@ private function buildVisionRequestPayload(string $message, string $image, strin
      *
      * @param   string  $prompt      The image generation prompt.
      * @param   array   $options     Additional options for the request.
-     * @param   string  $capability  Required capability.
      *
      * @return  array  The request payload.
      * @since   __DEPLOY_VERSION__
@@ -1194,8 +1188,6 @@ private function buildImageEditPayload($images, string $prompt, array $options):
      * Build payload for text-to-speech request.
      *
      * @param   string  $text     The text to convert to speech
-     * @param   string  $model    The model to use for speech synthesis
-     * @param   string  $voice    The voice to use for speech synthesis
      * @param   array   $options  Additional options for speech generation
      *
      * @return  array  The request payload.
@@ -1268,7 +1260,6 @@ private function buildSpeechPayload(string $text, array $options): array
      * Build payload for transcription request.
      *
      * @param   string  $audioFile  The audio file
-     * @param   string  $model      The transcription model
      * @param   array   $options    Additional options
      *
      * @return  array   Form data for multipart request
@@ -1378,7 +1369,6 @@ private function buildTranscriptionPayload(string $audioFile, array $options): a
      * Build payload for translation request.
      *
      * @param   string  $audioFile  Path to the audio file
-     * @param   string  $model      The translation model to use
      * @param   array   $options    Additional options for translation
      *
      * @return  array   Form data for multipart request

src/Response/Response.php

@@ -12,45 +12,30 @@
 use Joomla\Filesystem\File;
 use Joomla\Filesystem\Folder;
 use Joomla\Filesystem\Path;
+use Joomla\Http\Response as HttpResponse;
 
 /**
  * AI response data object class.
  *
  * @since  __DEPLOY_VERSION__
  */
-class Response
+class Response extends HttpResponse
 {
     /**
-     * The content of the response.
+     * The provider of the response.
      *
      * @var string
      * @since  __DEPLOY_VERSION__
      */
-    private $content;
-
-    /**
-     * The status code of the response.
-     *
-     * @var int
-     * @since  __DEPLOY_VERSION__
-     */
-    private $statusCode;
+    private string $provider;
 
     /**
      * The metadata of the response.
      *
      * @var array
      * @since  __DEPLOY_VERSION__
      */
-    private $metadata;
-
-    /**
-     * The provider of the response.
-     *
-     * @var string
-     * @since  __DEPLOY_VERSION__
-     */
-    private $provider;
+    private array $metadata;
 
     /**
      * Constructor.
@@ -64,21 +49,25 @@ class Response
      */
     public function __construct(string $content, string $provider, array $metadata = [], int $status = 200)
     {
-        $this->content = $content;
+        parent::__construct('php://memory', $status);
+
+        $body = $this->getBody();
+        $body->write($content);
+        $body->rewind();
+
         $this->provider = $provider;
         $this->metadata = $metadata;
-        $this->statusCode = $status;
     }
 
     /**
      * Get the content of the response.
      *
-     * @return  string  The content of the response.
+     * @return string
      * @since  __DEPLOY_VERSION__
      */
     public function getContent(): string
     {
-        return $this->content;
+        return (string) $this->getBody();
     }
 
     /**
@@ -191,55 +180,4 @@ public function getProvider(): string
     {
         return $this->provider;
     }
-
-    /**
-     * Get the status code of the response.
-     *
-     * @return  int  The status code of the response.
-     * @since  __DEPLOY_VERSION__
-     */
-    public function getStatusCode(): int
-    {
-        return $this->statusCode;
-    }
-
-    /**
-     * Magic method to access properties of the response object.
-     *
-     * @param   string  $name  The name of the property to get.
-     *
-     * @return  mixed  The value of the property.
-     * @since  __DEPLOY_VERSION__
-     */
-    public function __get($name)
-    {
-        switch (strtolower($name)) {
-            case 'content':
-                return $this->getContent();
-
-            case 'metadata':
-                return $this->getMetadata();
-
-            case 'provider':
-                return $this->getProvider();
-
-            case 'statuscode':
-                return $this->getStatusCode();
-
-            default:
-                $trace = debug_backtrace();
-
-                trigger_error(
-                    sprintf(
-                        'Undefined property via __get(): %s in %s on line %s',
-                        $name,
-                        $trace[0]['file'],
-                        $trace[0]['line']
-                    ),
-                    E_USER_NOTICE
-                );
-
-                break;
-        }
-    }
 }