Feature paginate (#128)

Author: RhysLees

README.md

@@ -141,7 +141,7 @@ $document = $connector->send(new GetDocumentRequest($fileCabinetId, $documentId)
 /**
  * Return all documents for a file cabinet.
  */
-$documents = $connector->send(new GetDocumentRequest($fileCabinetId))->dto();
+$documents = $connector->send(new GetDocumentsRequest($fileCabinetId))->dto();
 
 /**
  * Return image preview of a document.

src/Requests/Document/GetDocumentsRequest.php

@@ -2,8 +2,8 @@
 
 namespace CodebarAg\DocuWare\Requests\Document;
 
+use CodebarAg\DocuWare\DTO\DocumentPaginator;
 use CodebarAg\DocuWare\Responses\Document\GetDocumentsResponse;
-use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use Saloon\CachePlugin\Contracts\Cacheable;
 use Saloon\CachePlugin\Drivers\LaravelCacheDriver;
@@ -20,9 +20,19 @@ class GetDocumentsRequest extends Request implements Cacheable
 
     public function __construct(
         protected readonly string $fileCabinetId,
+        protected readonly int $page = 1,
+        protected readonly int $perPage = 50,
     ) {
     }
 
+    public function defaultQuery(): array
+    {
+        return [
+            'count' => $this->perPage,
+            'start' => ($this->page - 1) * $this->perPage,
+        ];
+    }
+
     public function resolveEndpoint(): string
     {
         return '/FileCabinets/'.$this->fileCabinetId.'/Documents';
@@ -38,8 +48,8 @@ public function cacheExpiryInSeconds(): int
         return config('laravel-docuware.configurations.cache.lifetime_in_seconds', 3600);
     }
 
-    public function createDtoFromResponse(Response $response): Collection
+    public function createDtoFromResponse(Response $response): DocumentPaginator
     {
-        return GetDocumentsResponse::fromResponse($response);
+        return GetDocumentsResponse::fromResponse($response, $this->page, $this->perPage);
     }
 }

src/Responses/Document/GetDocumentsResponse.php

@@ -2,22 +2,30 @@
 
 namespace CodebarAg\DocuWare\Responses\Document;
 
-use CodebarAg\DocuWare\DTO\Document;
+use CodebarAg\DocuWare\DTO\DocumentPaginator;
 use CodebarAg\DocuWare\Events\DocuWareResponseLog;
 use CodebarAg\DocuWare\Support\EnsureValidResponse;
-use Illuminate\Support\Collection;
+use Exception;
 use Saloon\Http\Response;
 
 final class GetDocumentsResponse
 {
-    public static function fromResponse(Response $response): Collection
+    public static function fromResponse(Response $response, $page, $perPage): DocumentPaginator
     {
         event(new DocuWareResponseLog($response));
 
-        EnsureValidResponse::from($response);
+        try {
+            EnsureValidResponse::from($response);
 
-        $items = $response->throw()->json('Items');
+            $data = $response->throw()->json();
+        } catch (Exception $e) {
+            return DocumentPaginator::fromFailed($e);
+        }
 
-        return collect($items)->map(fn (array $item) => Document::fromJson($item));
+        return DocumentPaginator::fromJson(
+            $data,
+            $page,
+            $perPage,
+        );
     }
 }

tests/Pest.php

@@ -41,12 +41,12 @@ function clearFiles(): void
 {
     $connector = getConnector();
 
-    $documents = $connector->send(new GetDocumentsRequest(
+    $paginator = $connector->send(new GetDocumentsRequest(
         config('laravel-docuware.tests.file_cabinet_id')
     ))->dto();
 
-    foreach ($documents as $document) {
-        $delete = $connector->send(new DeleteDocumentRequest(
+    foreach ($paginator->documents as $document) {
+        $connector->send(new DeleteDocumentRequest(
             config('laravel-docuware.tests.file_cabinet_id'),
             $document->id,
         ))->dto();