Release version 1.3.0

Author: the-csaba

.github/workflows/ci.yml

@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -86,13 +86,11 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup node
         if: matrix.test-type == 'integration'
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
+        uses: actions/setup-node@v3
 
       - name: Install and run @stoplight/prism
         if: matrix.test-type == 'integration'
@@ -141,12 +139,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
+        uses: actions/setup-node@v3
 
       - name: Install and run @stoplight/prism
         run: |

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.3.0 - 2022-12-21
+
+### Added
+- Use parameters defined outside endpoint methods.
+
+### Changed
+- Encourage the use of `php-http/mock-client` for testing and mocking API responses.
+- Remove the `Tests\MockHttpClient` class, and use the `php-http/mock-client` package instead.
+- Make Handler and Model class names more readable.
+
+### Fixed
+- Use correct model type for nested models.
+
 ## 1.2.0 - 2022-11-07
 
 ### Added

README.md

@@ -357,6 +357,16 @@ composer test:integration
 
 We do not recommend running integration tests against the live OpenAI API endpoints. This is because the tests will send example data to all endpoints, which can result in new data being created, or existing data being deleted.
 
+### Writing Your Own Tests
+
+If you are writing your own tests, you will likely need to mock the responses from the **OpenAI API**.
+
+One way of doing this is to install the `php-http/mock-client` package into your project, and then use the `\Http\Mock\Client` class (instead of a real PSR-18 client) when instantiating the **Tectalic OpenAI REST API Client**.
+
+This allows you to mock the responses from the **OpenAI API**, rather than performing real requests.
+
+Please see the [Mock Client documentation](https://docs.php-http.org/en/latest/clients/mock-client.html#mock-client) for details.
+
 ## Support
 
 If you have any questions or feedback, please use the [discussion board](https://github.com/tectalichq/public-openai-client-php/discussions).

composer.json

@@ -42,6 +42,7 @@
   "require-dev": {
     "league/openapi-psr7-validator": "^0.17.0",
     "mikey179/vfsstream": "^1.6.10",
+    "php-http/mock-client": "^1.5",
     "phpstan/phpstan": "^1.4",
     "phpunit/phpunit": "^8.5.14 || ^9.5",
     "squizlabs/php_codesniffer": "^3.6",
@@ -54,7 +55,10 @@
       "@test:unit",
       "@test:integration"
     ],
-    "test:coverage": "XDEBUG_MODE=coverage phpunit --verbose --coverage-html=coverage",
+    "test:coverage": [
+      "Composer\\Config::disableProcessTimeout",
+      "XDEBUG_MODE=coverage phpunit --verbose --coverage-html=coverage"
+    ],
     "test:integration": "phpunit --verbose --testsuite=integration",
     "test:phpcs": "phpcs -q -s",
     "test:phpstan": "phpstan analyse --memory-limit=1G",
@@ -67,5 +71,8 @@
     "test:phpstan": "Static test via phpstan.",
     "test:phpcs": "Style test via phpcs.",
     "test:unit": "Unit test via phpunit."
+  },
+  "suggest": {
+    "php-http/mock-client": "Simplify testing by using a mock HTTP client"
   }
 }

manifest.json

@@ -1,5 +1,5 @@
 {
-    "libraryVersion": "1.2.0",
+    "libraryVersion": "1.3.0",
     "apiVersion": "1.1.0",
-    "buildVersion": "1.1.5"
+    "buildVersion": "1.2.0"
 }

src/Client.php

@@ -12,6 +12,7 @@
 
 namespace Tectalic\OpenAi;
 
+use Http\Message\Authentication;
 use Http\Message\MultipartStream\MultipartStreamBuilder;
 use Nyholm\Psr7\Factory\Psr17Factory;
 use Psr\Http\Client\ClientExceptionInterface;
@@ -369,7 +370,7 @@ private function mergeRequestParts(
 
         $request = $request->withHeader(
             'User-Agent',
-            'Tectalic OpenAI REST API Client/1.2.0'
+            'Tectalic OpenAI REST API Client/1.3.0'
         );
 
         // Merge Headers.

src/Manager.php

@@ -12,6 +12,7 @@
 
 namespace Tectalic\OpenAi;
 
+use Http\Message\Authentication;
 use LogicException;
 use Psr\Http\Client\ClientInterface;
 

tests/MockHttpClient.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Copyright (c) 2022 Tectalic (https://tectalic.com)
+ *
+ * For copyright and license information, please view the LICENSE file that was distributed with this source code.
+ *
+ * Please see the README.md file for usage instructions.
+ */
+
+declare(strict_types=1);
+
+namespace Tests;
+
+use Http\Message\Authentication;
+use Psr\Http\Message\RequestInterface;
+
+final class NullAuth implements Authentication
+{
+    public function authenticate(RequestInterface $request): RequestInterface
+    {
+        return $request;
+    }
+}

tests/NullAuth.php

@@ -12,28 +12,28 @@
 
 namespace Tests\Unit;
 
+use Http\Mock\Client;
 use LogicException;
 use Nyholm\Psr7\Request;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
 use ReflectionClass;
 use ReflectionObject;
-use Tectalic\OpenAi\Authentication;
-use Tectalic\OpenAi\Client;
+use Tectalic\OpenAi\Client as OpenAiClient;
 use Tectalic\OpenAi\ClientException;
 use Tectalic\OpenAi\Manager;
 use Tectalic\OpenAi\Models\AbstractModel;
 use Tectalic\OpenAi\Models\AbstractModelCollection;
 use Tectalic\OpenAi\Models\UnstructuredModel;
-use Tests\MockHttpClient;
+use Tests\NullAuth;
 
 final class ClientTest extends TestCase
 {
     public function setUp(): void
     {
         Manager::build(
-            new MockHttpClient(),
-            new Authentication('token')
+            new Client(),
+            new NullAuth()
         );
     }
 
@@ -48,9 +48,9 @@ public function tearDown(): void
 
     public function testGlobal(): void
     {
-        $client = new Client(
-            new MockHttpClient(),
-            new Authentication('token'),
+        $client = new OpenAiClient(
+            new Client(),
+            new NullAuth(),
             Manager::BASE_URI
         );
         $this->assertEquals($client, Manager::access());
@@ -64,8 +64,8 @@ public function testDoubleBuild(): void
         $this->expectException(LogicException::class);
         $this->expectExceptionMessage('Client already built.');
         Manager::build(
-            new MockHttpClient(),
-            new Authentication('token')
+            new Client(),
+            new NullAuth()
         );
     }
 
@@ -385,15 +385,19 @@ public function invalidResponse(): array
 
     /**
      * @dataProvider invalidResponse
-     * @param class-string<\Throwable> $exception
+     * @param class-string<\Exception> $exception
      */
     public function testInvalidResponse(string $method, string $exception, string $message): void
     {
         $this->expectException(ClientException::class);
         $this->expectExceptionMessage($message);
-        $client = new Client(
-            new MockHttpClient(new $exception()),
-            new Authentication('token'),
+
+        $mockClient = new Client();
+        $mockClient->addException(new $exception());
+
+        $client = new OpenAiClient(
+            $mockClient,
+            new NullAuth(),
             Manager::BASE_URI
         );
         $client->sendRequest($client->$method('/'));