Merge pull request #8 from ewarehousing-solutions/feature/pagination

Feature/pagination
ewarehousing-solutions · Jul 5, 2024 · f69b256 · f69b256
2 parents c10a4ea + 0c015ff
commit f69b256
Show file tree

Hide file tree

Showing 15 changed files with 237 additions and 133 deletions.
diff --git a/composer.json b/composer.json
@@ -28,7 +28,8 @@
     "require": {
         "php": ">=8.0",
         "saloonphp/saloon": "^3.0",
-        "saloonphp/rate-limit-plugin": "^2.0"
+        "saloonphp/rate-limit-plugin": "^2.0",
+        "saloonphp/pagination-plugin": "^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

diff --git a/composer.lock b/composer.lock
diff --git a/src/MiddlewareConnector.php b/src/MiddlewareConnector.php
@@ -48,14 +48,21 @@
 use Saloon\Contracts\Authenticator;
 use Saloon\Http\PendingRequest;
 use Saloon\Http\Connector;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Saloon\PaginationPlugin\Contracts\HasPagination;
+use Saloon\PaginationPlugin\OffsetPaginator;
+use Saloon\PaginationPlugin\PagedPaginator;
 use Saloon\RateLimitPlugin\Contracts\RateLimitStore;
 use Saloon\RateLimitPlugin\Limit;
 use Saloon\RateLimitPlugin\Stores\MemoryStore;
 use Saloon\RateLimitPlugin\Traits\HasRateLimits;
+use Saloon\Traits\Plugins\AlwaysThrowOnErrors;
 
-class MiddlewareConnector extends Connector
+class MiddlewareConnector extends Connector implements HasPagination
 {
     use HasRateLimits;
+    use AlwaysThrowOnErrors;
 
     public const BASE_URL_EU_DEV = 'https://eu-dev.middleware.ewarehousing-solutions.com';
     public const BASE_URL_EU = 'https://eu.middleware.ewarehousing-solutions.com';
@@ -198,4 +205,32 @@ protected function resolveRateLimitStore(): RateLimitStore
     {
         return new MemoryStore();
     }
+
+    public function paginate(Request $request): OffsetPaginator
+    {
+        return new class(connector: $this, request: $request) extends OffsetPaginator
+        {
+            protected ?int $perPageLimit = 100;
+
+            protected function isLastPage(Response $response): bool
+            {
+                return count($this->getPageItems($response, $this->request)) < $this->perPageLimit;
+            }
+
+            protected function getPageItems(Response $response, Request $request): array
+            {
+                return $response->json();
+            }
+
+            protected function applyPagination(Request $request): Request
+            {
+                $request->query()->merge([
+                    'page' => $this->getCurrentPage(),
+                    'limit' => $this->perPageLimit,
+                ]);
+
+                return $request;
+            }
+        };
+    }
 }
diff --git a/src/Requests/Article/GetArticleCollectionRequest.php b/src/Requests/Article/GetArticleCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetArticleCollectionRequest extends Request
+class GetArticleCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Batch/GetBatchCollectionRequest.php b/src/Requests/Batch/GetBatchCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetBatchCollectionRequest extends Request
+class GetBatchCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Customer/GetCustomerCollectionRequest.php b/src/Requests/Customer/GetCustomerCollectionRequest.php
@@ -4,8 +4,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetCustomerCollectionRequest extends Request
+class GetCustomerCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Inbound/GetInboundCollectionRequest.php b/src/Requests/Inbound/GetInboundCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetInboundCollectionRequest extends Request
+class GetInboundCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Logs/GetLogsCollectionRequest.php b/src/Requests/Logs/GetLogsCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetLogsCollectionRequest extends Request
+class GetLogsCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Order/GetOrderCollectionRequest.php b/src/Requests/Order/GetOrderCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetOrderCollectionRequest extends Request
+class GetOrderCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Order/GetOrderDocumentCollectionRequest.php b/src/Requests/Order/GetOrderDocumentCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetOrderDocumentCollectionRequest extends Request
+class GetOrderDocumentCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Shipment/GetShipmentCollectionRequest.php b/src/Requests/Shipment/GetShipmentCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetShipmentCollectionRequest extends Request
+class GetShipmentCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/ShippingMethod/GetShippingMethodCollectionRequest.php b/src/Requests/ShippingMethod/GetShippingMethodCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetShippingMethodCollectionRequest extends Request
+class GetShippingMethodCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/StockLevel/GetStockLevelCollectionRequest.php b/src/Requests/StockLevel/GetStockLevelCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetStockLevelCollectionRequest extends Request
+class GetStockLevelCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Variant/GetVariantCollectionRequest.php b/src/Requests/Variant/GetVariantCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetVariantCollectionRequest extends Request
+class GetVariantCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;
 

diff --git a/src/Requests/Webhook/GetWebhookCollectionRequest.php b/src/Requests/Webhook/GetWebhookCollectionRequest.php
@@ -10,8 +10,9 @@
 
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetWebhookCollectionRequest extends Request
+class GetWebhookCollectionRequest extends Request implements Paginatable
 {
     protected Method $method = Method::GET;