Rename abstract classes and use union types (#399)

VerifiedJoseph · Aug 1, 2024 · 62f2bcb · 62f2bcb
1 parent 49940d6
commit 62f2bcb
Show file tree

Hide file tree

Showing 24 changed files with 57 additions and 58 deletions.
diff --git a/docs/endpoints.md b/docs/endpoints.md
@@ -14,7 +14,7 @@ Jump to:
 ## Application
 
 ```PHP
-Gotify\Endpoint\Application(Server $server, ?Auth $auth)
+Gotify\Endpoint\Application(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [Application](../src/Endpoint/Application.php)
@@ -60,7 +60,7 @@ uploadImage(int $id, string $image): stdClass
 ## ApplicationMessage
 
 ```PHP
-Gotify\Endpoint\ApplicationMessage(Server $server, ?Auth $auth)
+Gotify\Endpoint\ApplicationMessage(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [ApplicationMessage](../src/Endpoint/ApplicationMessage.php)
@@ -84,7 +84,7 @@ deleteAll(int $id): boolean
 ## Message
 
 ```PHP
-Gotify\Endpoint\Message(Server $server, ?Auth $auth)
+Gotify\Endpoint\Message(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [Message](../src/Endpoint/Message.php)
@@ -151,7 +151,7 @@ deleteAll(): boolean
 ## Client
 
 ```PHP
-Gotify\Endpoint\Client(Server $server, ?Auth $auth)
+Gotify\Endpoint\Client(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [Client](../src/Endpoint/Client.php)
@@ -191,7 +191,7 @@ delete(int $id): boolean
 ## User
 
 ```PHP
-Gotify\Endpoint\User(Server $server, ?Auth $auth)
+Gotify\Endpoint\User(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [User](../src/Endpoint/User.php)
@@ -266,7 +266,7 @@ get(): stdClass
 ## Plugin
 
 ```PHP
-Gotify\Endpoint\Plugin(Server $server, ?Auth $auth)
+Gotify\Endpoint\Plugin(Server $server, Auth\User|Auth\Token $auth)
 ```
 
 Class: [Plugin](../src/Endpoint/Plugin.php)

diff --git a/src/Auth.php → src/Auth/AbstractAuth.php b/src/Auth.php → src/Auth/AbstractAuth.php
@@ -1,11 +1,11 @@
 <?php
 
-namespace Gotify;
+namespace Gotify\Auth;
 
 /**
  * Class for setting and validating authentication
  */
-abstract class Auth
+abstract class AbstractAuth
 {
     /** @var string $method Authentication method */
     protected string $method = '';

diff --git a/src/Auth/Token.php b/src/Auth/Token.php
@@ -2,12 +2,10 @@
 
 namespace Gotify\Auth;
 
-use Gotify\Auth;
-
 /**
  * Class for setting and validating an authentication token
  */
-class Token extends Auth
+class Token extends AbstractAuth
 {
     /** @var string $method Authentication method */
     protected string $method = 'token';

diff --git a/src/Auth/User.php b/src/Auth/User.php
@@ -2,12 +2,10 @@
 
 namespace Gotify\Auth;
 
-use Gotify\Auth;
-
 /**
  * Class for setting and validating username and password authentication
  */
-class User extends Auth
+class User extends AbstractAuth
 {
     /** @var string $method Authentication method */
     protected string $method = 'user';

diff --git a/src/Api.php → src/Endpoint/AbstractEndpoint.php b/src/Api.php → src/Endpoint/AbstractEndpoint.php
@@ -1,25 +1,25 @@
 <?php
 
-namespace Gotify;
+namespace Gotify\Endpoint;
 
 use Gotify\Server;
 use Gotify\Guzzle;
+use Gotify\Auth\User;
+use Gotify\Auth\Token;
 
 /**
  * Class for interacting with the Gotify API using Guzzle
  */
-abstract class Api
+abstract class AbstractEndpoint
 {
     /** @var Guzzle $guzzle Guzzle class instance */
     protected Guzzle $guzzle;
 
     /**
-     * Create Guzzle instance
-     *
      * @param Server $server Server URI
-     * @param ?Auth $auth Authentication
+     * @param null|User|Token $auth Authentication class instance
      */
-    final public function __construct(Server $server, ?Auth $auth = null)
+    final public function __construct(Server $server, null|User|Token $auth = null)
     {
         $this->guzzle = new Guzzle($server->get(), $auth);
     }

diff --git a/src/Endpoint/Application.php b/src/Endpoint/Application.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
   * @see https://gotify.net/api-docs#/application API docs for message endpoint
  */
-class Application extends Api
+class Application extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'application';

diff --git a/src/Endpoint/ApplicationMessage.php b/src/Endpoint/ApplicationMessage.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/message API docs for message endpoint
  */
-class ApplicationMessage extends Api
+class ApplicationMessage extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'application';

diff --git a/src/Endpoint/Client.php b/src/Endpoint/Client.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
   * @see https://gotify.net/api-docs#/client API docs for client endpoint
  */
-class Client extends Api
+class Client extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'client';

diff --git a/src/Endpoint/Health.php b/src/Endpoint/Health.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/health API docs for the health endpoint
  */
-class Health extends Api
+class Health extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'health';

diff --git a/src/Endpoint/Message.php b/src/Endpoint/Message.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/message API docs for message endpoint
  */
-class Message extends Api
+class Message extends AbstractEndpoint
 {
     /**
      * High message priority

diff --git a/src/Endpoint/Plugin.php b/src/Endpoint/Plugin.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/plugin API docs for the user endpoint
  */
-class Plugin extends Api
+class Plugin extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'plugin';

diff --git a/src/Endpoint/User.php b/src/Endpoint/User.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/user API docs for the user endpoint
  */
-class User extends Api
+class User extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'user';

diff --git a/src/Endpoint/Version.php b/src/Endpoint/Version.php
@@ -2,7 +2,6 @@
 
 namespace Gotify\Endpoint;
 
-use Gotify\Api;
 use Gotify\Json;
 use stdClass;
 
@@ -11,7 +10,7 @@
  *
  * @see https://gotify.net/api-docs#/version API docs for the version endpoint
  */
-class Version extends Api
+class Version extends AbstractEndpoint
 {
     /** @var string $endpoint API endpoint */
     private string $endpoint = 'version';

diff --git a/src/Guzzle.php b/src/Guzzle.php
@@ -2,6 +2,8 @@
 
 namespace Gotify;
 
+use Gotify\Auth\User;
+use Gotify\Auth\Token;
 use GuzzleHttp\Psr7;
 use GuzzleHttp\Client;
 use GuzzleHttp\RequestOptions;
@@ -26,12 +28,11 @@ class Guzzle
     private int $timeout = 10;
 
     /**
-     *
      * @param string $uri Server URI
-     * @param Auth $auth Authentication
+     * @param null|User|Token $auth Authentication class instance
      * @param ?HandlerStack $handlerStack Guzzle handler stack
      */
-    public function __construct(string $uri, ?Auth $auth, ?HandlerStack $handlerStack = null)
+    public function __construct(string $uri, null|User|Token $auth = null, ?HandlerStack $handlerStack = null)
     {
         $config = $this->getConfig($uri, $auth, $handlerStack);
 
@@ -185,11 +186,11 @@ protected function request(string $method, string $endpoint, array $options = []
      *
      * @param string $uri Server URI
      * @param ?HandlerStack $handlerStack Guzzle handler stack
-     * @param ?Auth $auth Authentication
+     * @param User|Token $auth Authentication class instance
      *
      * @return array<string, mixed> Returns client config array
      */
-    private function getConfig(string $uri, ?Auth $auth, ?HandlerStack $handlerStack): array
+    private function getConfig(string $uri, null|User|Token $auth = null, ?HandlerStack $handlerStack): array
     {
         $config = [
             'base_uri' => $uri,
@@ -213,11 +214,11 @@ private function getConfig(string $uri, ?Auth $auth, ?HandlerStack $handlerStack
     /**
      * Get authentication config
      *
-     * @param ?Auth $auth Authentication
+     * @param User|Token $auth Authentication class instance
      *
      * @return array<string, array<int|string, string>>
      */
-    private function getAuthConfig(?Auth $auth): array
+    private function getAuthConfig(null|User|Token $auth = null): array
     {
         $config = [];
 

diff --git a/tests/Auth/TokenTest.php b/tests/Auth/TokenTest.php
@@ -5,9 +5,10 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\AbstractTestCase;
 use Gotify\Auth\Token;
+use Gotify\Auth\AbstractAuth;
 
 #[CoversClass(Token::class)]
-#[CoversClass(\Gotify\Auth::class)]
+#[CoversClass(AbstractAuth::class)]
 class TokenTest extends AbstractTestCase
 {
     protected string $method = 'token';

diff --git a/tests/Auth/UserTest.php b/tests/Auth/UserTest.php
@@ -5,9 +5,10 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\AbstractTestCase;
 use Gotify\Auth\User;
+use Gotify\Auth\AbstractAuth;
 
 #[CoversClass(User::class)]
-#[CoversClass(\Gotify\Auth::class)]
+#[CoversClass(AbstractAuth::class)]
 class UserTest extends AbstractTestCase
 {
     private string $method = 'user';

diff --git a/tests/Endpoints/ApplicationMessageTest.php b/tests/Endpoints/ApplicationMessageTest.php
@@ -7,15 +7,16 @@
 use Tests\AbstractTestCase;
 use Gotify\Endpoint\Application;
 use Gotify\Endpoint\ApplicationMessage;
+use Gotify\Endpoint\AbstractEndpoint;
 
 #[CoversClass(ApplicationMessage::class)]
 #[UsesClass(Application::class)]
-#[UsesClass(\Gotify\Api::class)]
+#[UsesClass(AbstractEndpoint::class)]
 #[UsesClass(\Gotify\Guzzle::class)]
 #[UsesClass(\Gotify\Json::class)]
 #[UsesClass(\Gotify\Server::class)]
-#[UsesClass(\Gotify\Auth::class)]
 #[UsesClass(\Gotify\Auth\User::class)]
+#[UsesClass(\Gotify\Auth\AbstractAuth::class)]
 class ApplicationMessageTest extends AbstractTestCase
 {
     private static ApplicationMessage $applicationMessage;

diff --git a/tests/Endpoints/ApplicationTest.php b/tests/Endpoints/ApplicationTest.php
@@ -7,14 +7,15 @@
 use PHPUnit\Framework\Attributes\Depends;
 use Tests\AbstractTestCase;
 use Gotify\Endpoint\Application;
+use Gotify\Endpoint\AbstractEndpoint;
 
 #[CoversClass(Application::class)]
-#[UsesClass(\Gotify\Api::class)]
+#[UsesClass(AbstractEndpoint::class)]
 #[UsesClass(\Gotify\Guzzle::class)]
 #[UsesClass(\Gotify\Json::class)]
 #[UsesClass(\Gotify\Server::class)]
-#[UsesClass(\Gotify\Auth::class)]
 #[UsesClass(\Gotify\Auth\User::class)]
+#[UsesClass(\Gotify\Auth\AbstractAuth::class)]
 class ApplicationTest extends AbstractTestCase
 {
     private static Application $application;

diff --git a/tests/Endpoints/ClientTest.php b/tests/Endpoints/ClientTest.php
@@ -7,14 +7,15 @@
 use PHPUnit\Framework\Attributes\Depends;
 use Tests\AbstractTestCase;
 use Gotify\Endpoint\Client;
+use Gotify\Endpoint\AbstractEndpoint;
 
 #[CoversClass(Client::class)]
-#[UsesClass(\Gotify\Api::class)]
+#[UsesClass(AbstractEndpoint::class)]
 #[UsesClass(\Gotify\Guzzle::class)]
 #[UsesClass(\Gotify\Json::class)]
 #[UsesClass(\Gotify\Server::class)]
-#[UsesClass(\Gotify\Auth::class)]
 #[UsesClass(\Gotify\Auth\User::class)]
+#[UsesClass(\Gotify\Auth\AbstractAuth::class)]
 class ClientTest extends AbstractTestCase
 {
     private static Client $client;