Merge pull request #201 from ArabCoders/dev

Remove old Server classes

Author: arabcoders

FAQ.md

@@ -1,5 +1,7 @@
 # FAQ
 
+**All commands have help document attached to them. So, please read them.**
+
 ### Q: How to sync play state to a new backend without overwriting current play state?
 
 Add the backend and when asked, answer `no` for `Enable Importing metadata and play state from this backend?`. when you

config/config.php

@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
+use App\Backends\Emby\EmbyClient;
+use App\Backends\Jellyfin\JellyfinClient;
+use App\Backends\Plex\PlexClient;
 use App\Commands\State\BackupCommand;
 use App\Commands\State\ExportCommand;
 use App\Commands\State\ImportCommand;
 use App\Commands\State\PushCommand;
 use App\Commands\System\IndexCommand;
 use App\Commands\System\PruneCommand;
 use App\Libs\Mappers\Import\MemoryMapper;
-use App\Libs\Servers\EmbyServer;
-use App\Libs\Servers\JellyfinServer;
-use App\Libs\Servers\PlexServer;
 use Monolog\Logger;
 
 return (function () {
@@ -140,9 +140,9 @@
     ];
 
     $config['supported'] = [
-        'plex' => PlexServer::class,
-        'emby' => EmbyServer::class,
-        'jellyfin' => JellyfinServer::class,
+        'plex' => PlexClient::class,
+        'emby' => EmbyClient::class,
+        'jellyfin' => JellyfinClient::class,
     ];
 
     $config['servers'] = [];

src/Libs/Servers/ServerInterface.php renamed to src/Backends/Common/ClientInterface.php

@@ -2,42 +2,36 @@
 
 declare(strict_types=1);
 
-namespace App\Libs\Servers;
+namespace App\Backends\Common;
 
 use App\Libs\Entity\StateInterface;
 use App\Libs\Mappers\ImportInterface as iImport;
 use App\Libs\QueueRequests;
 use DateTimeInterface as iDate;
 use JsonException;
 use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
 use SplFileObject;
 use Symfony\Contracts\HttpClient\Exception\ExceptionInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-interface ServerInterface
+interface ClientInterface
 {
     /**
-     * Initiate server. It should return **NEW OBJECT**
+     * Initiate Client with context. It **MUST** return new instance.
      *
-     * @param string $name Server name
-     * @param UriInterface $url Server url
-     * @param null|int|string $token Server Token
-     * @param null|int|string $userId Server user Id
-     * @param string|int|null $uuid
-     * @param array $options array of options.
+     * @param Context $context
      *
-     * @return self
+     * @return ClientInterface
      */
-    public function setUp(
-        string $name,
-        UriInterface $url,
-        null|string|int $token = null,
-        null|string|int $userId = null,
-        null|string|int $uuid = null,
-        array $options = []
-    ): self;
+    public function withContext(Context $context): ClientInterface;
+
+    /**
+     * Return client context.
+     *
+     * @return Context
+     */
+    public function getContext(): Context;
 
     /**
      * Get Backend name.
@@ -51,9 +45,9 @@ public function getName(): string;
      *
      * @param LoggerInterface $logger
      *
-     * @return ServerInterface
+     * @return ClientInterface
      */
-    public function setLogger(LoggerInterface $logger): ServerInterface;
+    public function setLogger(LoggerInterface $logger): ClientInterface;
 
     /**
      * Process The request For attributes extraction.
@@ -66,15 +60,15 @@ public function setLogger(LoggerInterface $logger): ServerInterface;
     public function processRequest(ServerRequestInterface $request, array $opts = []): ServerRequestInterface;
 
     /**
-     * Parse server specific webhook event. for play/un-played event.
+     * Parse backend webhook event.
      *
      * @param ServerRequestInterface $request
      * @return StateInterface
      */
     public function parseWebhook(ServerRequestInterface $request): StateInterface;
 
     /**
-     * Import watch state.
+     * Import metadata & play state.
      *
      * @param iImport $mapper
      * @param iDate|null $after
@@ -84,16 +78,18 @@ public function parseWebhook(ServerRequestInterface $request): StateInterface;
     public function pull(iImport $mapper, iDate|null $after = null): array;
 
     /**
-     * Backup watch state.
+     * Backup play state.
      *
      * @param iImport $mapper
+     * @param SplFileObject|null $writer
+     * @param array $opts
      *
      * @return array<array-key,ResponseInterface>
      */
-    public function backup(iImport $mapper, SplFileObject $writer, array $opts = []): array;
+    public function backup(iImport $mapper, SplFileObject|null $writer = null, array $opts = []): array;
 
     /**
-     * Export watch state to server.
+     * Compare play state and export.
      *
      * @param iImport $mapper
      * @param QueueRequests $queue
@@ -104,7 +100,7 @@ public function backup(iImport $mapper, SplFileObject $writer, array $opts = [])
     public function export(iImport $mapper, QueueRequests $queue, iDate|null $after = null): array;
 
     /**
-     * Push webhook queued states.
+     * Compare webhook queued events and push.
      *
      * @param array<StateInterface> $entities
      * @param QueueRequests $queue
@@ -115,7 +111,7 @@ public function export(iImport $mapper, QueueRequests $queue, iDate|null $after
     public function push(array $entities, QueueRequests $queue, iDate|null $after = null): array;
 
     /**
-     * Search server libraries.
+     * Search backend libraries.
      *
      * @param string $query
      * @param int $limit
@@ -126,7 +122,7 @@ public function push(array $entities, QueueRequests $queue, iDate|null $after =
     public function search(string $query, int $limit = 25, array $opts = []): array;
 
     /**
-     * Server Backend id.
+     * Search backend for item id.
      *
      * @param string|int $id
      * @param array $opts
@@ -156,19 +152,16 @@ public function getMetadata(string|int $id, array $opts = []): array;
     public function getLibrary(string|int $id, array $opts = []): array;
 
     /**
-     * Get Server Unique ID.
+     * Get backend unique id.
      *
-     * @param bool $forceRefresh force read uuid from server.
+     * @param bool $forceRefresh force reload from backend.
      *
      * @return int|string|null
-     *
-     * @throws JsonException May throw if json decoding fails.
-     * @throws ExceptionInterface May be thrown if there is HTTP request errors.
      */
-    public function getServerUUID(bool $forceRefresh = false): int|string|null;
+    public function getIdentifier(bool $forceRefresh = false): int|string|null;
 
     /**
-     * Return List of users from server.
+     * Return list of backend users.
      *
      * @param array $opts
      *
@@ -180,7 +173,7 @@ public function getServerUUID(bool $forceRefresh = false): int|string|null;
     public function getUsersList(array $opts = []): array;
 
     /**
-     * Return list of server libraries.
+     * Return list of backend libraries.
      *
      * @param array $opts
      *

src/Backends/Emby/Action/Backup.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Backends\Emby\Action;
+
+class Backup extends \App\Backends\Jellyfin\Action\Backup
+{
+}

src/Backends/Emby/EmbyActionTrait.php

@@ -4,6 +4,9 @@
 
 namespace App\Backends\Emby;
 
+use App\Backends\Jellyfin\JellyfinActionTrait;
+
 trait EmbyActionTrait
 {
+    use JellyfinActionTrait;
 }