From 5461088b0a5326c5fe524c92c75d3260bfd9a63a Mon Sep 17 00:00:00 2001 From: Harish Patel <31433208+harishpatel143@users.noreply.github.com> Date: Wed, 28 Dec 2022 16:18:29 +0530 Subject: [PATCH] FIX: Renamed all $apiToken variable and ApiToken class with $apiKey and ApiKey respectively --- src/OpenAI.php | 8 ++++---- src/ValueObjects/{ApiToken.php => ApiKey.php} | 10 +++++----- src/ValueObjects/Transporter/Headers.php | 6 +++--- tests/Pest.php | 4 ++-- tests/Transporters/HttpTransporter.php | 10 +++++----- tests/ValueObjects/ApiToken.php | 6 +++--- tests/ValueObjects/Transporter/Headers.php | 8 ++++---- tests/ValueObjects/Transporter/Payload.php | 12 ++++++------ 8 files changed, 32 insertions(+), 32 deletions(-) rename src/ValueObjects/{ApiToken.php => ApiKey.php} (57%) diff --git a/src/OpenAI.php b/src/OpenAI.php index 0bea2ffc..83e3357b 100644 --- a/src/OpenAI.php +++ b/src/OpenAI.php @@ -5,7 +5,7 @@ use GuzzleHttp\Client as GuzzleClient; use OpenAI\Client; use OpenAI\Transporters\HttpTransporter; -use OpenAI\ValueObjects\ApiToken; +use OpenAI\ValueObjects\ApiKey; use OpenAI\ValueObjects\Transporter\BaseUri; use OpenAI\ValueObjects\Transporter\Headers; @@ -14,13 +14,13 @@ final class OpenAI /** * Creates a new Open AI Client with the given API token. */ - public static function client(string $apiToken, string $organization = null): Client + public static function client(string $apiKey, string $organization = null): Client { - $apiToken = ApiToken::from($apiToken); + $apiKey = ApiKey::from($apiKey); $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization($apiToken); + $headers = Headers::withAuthorization($apiKey); if ($organization !== null) { $headers = $headers->withOrganization($organization); diff --git a/src/ValueObjects/ApiToken.php b/src/ValueObjects/ApiKey.php similarity index 57% rename from src/ValueObjects/ApiToken.php rename to src/ValueObjects/ApiKey.php index eb3e862b..15c4c366 100644 --- a/src/ValueObjects/ApiToken.php +++ b/src/ValueObjects/ApiKey.php @@ -9,19 +9,19 @@ /** * @internal */ -final class ApiToken implements Stringable +final class ApiKey implements Stringable { /** * Creates a new API token value object. */ - private function __construct(public readonly string $apiToken) + private function __construct(public readonly string $apiKey) { // .. } - public static function from(string $apiToken): self + public static function from(string $apiKey): self { - return new self($apiToken); + return new self($apiKey); } /** @@ -29,6 +29,6 @@ public static function from(string $apiToken): self */ public function toString(): string { - return $this->apiToken; + return $this->apiKey; } } diff --git a/src/ValueObjects/Transporter/Headers.php b/src/ValueObjects/Transporter/Headers.php index 93546588..6b9cfe44 100644 --- a/src/ValueObjects/Transporter/Headers.php +++ b/src/ValueObjects/Transporter/Headers.php @@ -5,7 +5,7 @@ namespace OpenAI\ValueObjects\Transporter; use OpenAI\Enums\Transporter\ContentType; -use OpenAI\ValueObjects\ApiToken; +use OpenAI\ValueObjects\ApiKey; /** * @internal @@ -25,10 +25,10 @@ private function __construct(private readonly array $headers) /** * Creates a new Headers value object with the given API token. */ - public static function withAuthorization(ApiToken $apiToken): self + public static function withAuthorization(ApiKey $apiKey): self { return new self([ - 'Authorization' => "Bearer {$apiToken->toString()}", + 'Authorization' => "Bearer {$apiKey->toString()}", ]); } diff --git a/tests/Pest.php b/tests/Pest.php index 72156a21..6c79b413 100644 --- a/tests/Pest.php +++ b/tests/Pest.php @@ -2,7 +2,7 @@ use OpenAI\Client; use OpenAI\Contracts\Transporter; -use OpenAI\ValueObjects\ApiToken; +use OpenAI\ValueObjects\ApiKey; use OpenAI\ValueObjects\Transporter\BaseUri; use OpenAI\ValueObjects\Transporter\Headers; use OpenAI\ValueObjects\Transporter\Payload; @@ -16,7 +16,7 @@ function mockClient(string $method, string $resource, array $params, array|strin ->once() ->withArgs(function (Payload $payload) use ($method, $resource) { $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization(ApiToken::from('foo')); + $headers = Headers::withAuthorization(ApiKey::from('foo')); $request = $payload->toRequest($baseUri, $headers); diff --git a/tests/Transporters/HttpTransporter.php b/tests/Transporters/HttpTransporter.php index b8806214..6f79dd17 100644 --- a/tests/Transporters/HttpTransporter.php +++ b/tests/Transporters/HttpTransporter.php @@ -8,7 +8,7 @@ use OpenAI\Exceptions\TransporterException; use OpenAI\Exceptions\UnserializableResponse; use OpenAI\Transporters\HttpTransporter; -use OpenAI\ValueObjects\ApiToken; +use OpenAI\ValueObjects\ApiKey; use OpenAI\ValueObjects\Transporter\BaseUri; use OpenAI\ValueObjects\Transporter\Headers; use OpenAI\ValueObjects\Transporter\Payload; @@ -17,12 +17,12 @@ beforeEach(function () { $this->client = Mockery::mock(ClientInterface::class); - $apiToken = ApiToken::from('foo'); + $apiKey = ApiKey::from('foo'); $this->http = new HttpTransporter( $this->client, BaseUri::from('api.openai.com/v1'), - Headers::withAuthorization($apiToken)->withContentType(ContentType::JSON), + Headers::withAuthorization($apiKey)->withContentType(ContentType::JSON), ); }); @@ -108,7 +108,7 @@ $payload = Payload::list('models'); $baseUri = BaseUri::from('api.openai.com'); - $headers = Headers::withAuthorization(ApiToken::from('foo')); + $headers = Headers::withAuthorization(ApiKey::from('foo')); $this->client ->shouldReceive('sendRequest') @@ -177,7 +177,7 @@ $payload = Payload::list('models'); $baseUri = BaseUri::from('api.openai.com'); - $headers = Headers::withAuthorization(ApiToken::from('foo')); + $headers = Headers::withAuthorization(ApiKey::from('foo')); $this->client ->shouldReceive('sendRequest') diff --git a/tests/ValueObjects/ApiToken.php b/tests/ValueObjects/ApiToken.php index 6bb46c46..5a4bed74 100644 --- a/tests/ValueObjects/ApiToken.php +++ b/tests/ValueObjects/ApiToken.php @@ -2,10 +2,10 @@ // Generate test for API token value object... -use OpenAI\ValueObjects\ApiToken; +use OpenAI\ValueObjects\ApiKey; it('can be created from a string', function () { - $apiToken = ApiToken::from('foo'); + $apiKey = ApiKey::from('foo'); - expect($apiToken->toString())->toBe('foo'); + expect($apiKey->toString())->toBe('foo'); }); diff --git a/tests/ValueObjects/Transporter/Headers.php b/tests/ValueObjects/Transporter/Headers.php index 5eecff16..2aad1d7d 100644 --- a/tests/ValueObjects/Transporter/Headers.php +++ b/tests/ValueObjects/Transporter/Headers.php @@ -1,11 +1,11 @@ toArray())->toBe([ 'Authorization' => 'Bearer foo', @@ -13,7 +13,7 @@ }); it('can have content/type', function () { - $headers = Headers::withAuthorization(ApiToken::from('foo')) + $headers = Headers::withAuthorization(ApiKey::from('foo')) ->withContentType(ContentType::JSON); expect($headers->toArray())->toBe([ @@ -23,7 +23,7 @@ }); it('can have organization', function () { - $headers = Headers::withAuthorization(ApiToken::from('foo')) + $headers = Headers::withAuthorization(ApiKey::from('foo')) ->withContentType(ContentType::JSON) ->withOrganization('nunomaduro'); diff --git a/tests/ValueObjects/Transporter/Payload.php b/tests/ValueObjects/Transporter/Payload.php index d06e73d6..21a65364 100644 --- a/tests/ValueObjects/Transporter/Payload.php +++ b/tests/ValueObjects/Transporter/Payload.php @@ -1,7 +1,7 @@ withContentType(ContentType::JSON); + $headers = Headers::withAuthorization(ApiKey::from('foo'))->withContentType(ContentType::JSON); expect($payload->toRequest($baseUri, $headers)->getMethod())->toBe('POST'); }); @@ -19,7 +19,7 @@ $payload = Payload::list('models'); $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization(ApiToken::from('foo'))->withContentType(ContentType::JSON); + $headers = Headers::withAuthorization(ApiKey::from('foo'))->withContentType(ContentType::JSON); $uri = $payload->toRequest($baseUri, $headers)->getUri(); @@ -32,7 +32,7 @@ $payload = Payload::list('models'); $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization(ApiToken::from('foo'))->withContentType(ContentType::JSON); + $headers = Headers::withAuthorization(ApiKey::from('foo'))->withContentType(ContentType::JSON); expect($payload->toRequest($baseUri, $headers)->getBody()->getContents())->toBe(''); }); @@ -43,7 +43,7 @@ ]); $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization(ApiToken::from('foo'))->withContentType(ContentType::JSON); + $headers = Headers::withAuthorization(ApiKey::from('foo'))->withContentType(ContentType::JSON); expect($payload->toRequest($baseUri, $headers)->getBody()->getContents())->toBe(json_encode([ 'name' => 'test', @@ -57,7 +57,7 @@ ]); $baseUri = BaseUri::from('api.openai.com/v1'); - $headers = Headers::withAuthorization(ApiToken::from('foo')); + $headers = Headers::withAuthorization(ApiKey::from('foo')); $request = $payload->toRequest($baseUri, $headers);