Client: handle pagination, default to 500 items per page, automatically paginate additional pages

Author: glaubinix

src/Api/AbstractApi.php

@@ -14,6 +14,8 @@
 
 abstract class AbstractApi
 {
+    const DEFAULT_LIMIT = 500;
+
     /** @var Client */
     protected $client;
     /** @var ResponseMediator */

src/Api/Credentials.php

@@ -21,7 +21,7 @@ class Credentials extends AbstractApi
 
     public function all()
     {
-        return $this->get('/credentials/');
+        return $this->get('/credentials/', ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function show($credentialId)

src/Api/Customers.php

@@ -16,7 +16,7 @@ class Customers extends AbstractApi
 {
     public function all()
     {
-        return $this->get('/customers/');
+        return $this->get('/customers/', ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function show($customerIdOrUrlName)
@@ -70,7 +70,7 @@ public function disable($customerIdOrUrlName)
 
     public function listPackages($customerIdOrUrlName)
     {
-        return $this->get(sprintf('/customers/%s/packages/', $customerIdOrUrlName));
+        return $this->get(sprintf('/customers/%s/packages/', $customerIdOrUrlName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function showPackage($customerIdOrUrlName, $packageIdOrName)

src/Api/Customers/MagentoLegacyKeys.php

@@ -15,7 +15,7 @@ class MagentoLegacyKeys extends AbstractApi
 {
     public function all($customerIdOrUrlName)
     {
-        return $this->get(sprintf('/api/customers/%s/magento-legacy-keys/', $customerIdOrUrlName));
+        return $this->get(sprintf('/api/customers/%s/magento-legacy-keys/', $customerIdOrUrlName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function create($customerIdOrUrlName, $publicKey, $privateKey)

src/Api/Customers/VendorBundles.php

@@ -15,7 +15,7 @@ class VendorBundles extends AbstractApi
 {
     public function listVendorBundles($customerIdOrUrlName)
     {
-        return $this->get(sprintf('/customers/%s/vendor-bundles/', $customerIdOrUrlName));
+        return $this->get(sprintf('/customers/%s/vendor-bundles/', $customerIdOrUrlName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     /**

src/Api/MirroredRepositories.php

@@ -13,7 +13,7 @@ class MirroredRepositories extends AbstractApi
 {
     public function all()
     {
-        return $this->get('/mirrored-repositories/');
+        return $this->get('/mirrored-repositories/', ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function create($name, $url, $mirroringBehavior, $credentials = null)
@@ -48,7 +48,7 @@ public function remove($mirroredRepositoryId)
 
     public function listPackages($mirroredRepositoryId)
     {
-        return $this->get(sprintf('/mirrored-repositories/%s/packages/', $mirroredRepositoryId));
+        return $this->get(sprintf('/mirrored-repositories/%s/packages/', $mirroredRepositoryId), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function addPackages($mirroredRepositoryId, array $packages)

src/Api/Packages.php

@@ -52,6 +52,8 @@ public function all(array $filters = [])
             throw new InvalidArgumentException('Filter "origin" has to be one of: "' . implode('", "', self::AVAILABLE_ORIGINS) . '".');
         }
 
+        $filters = array_merge(['limit' => self::DEFAULT_LIMIT], $filters);
+
         return $this->get('/packages/', $filters);
     }
 
@@ -127,16 +129,18 @@ public function remove($packageIdOrName)
 
     public function listCustomers($packageIdOrName)
     {
-        return $this->get(sprintf('/packages/%s/customers/', $packageIdOrName));
+        return $this->get(sprintf('/packages/%s/customers/', $packageIdOrName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function listDependents($packageName)
     {
-        return $this->get(sprintf('/packages/%s/dependents/', $packageName));
+        return $this->get(sprintf('/packages/%s/dependents/', $packageName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function listSecurityIssues($packageIdOrName, array $filters = [])
     {
+        $filters = array_merge(['limit' => self::DEFAULT_LIMIT], $filters);
+
         return $this->get(sprintf('/packages/%s/security-issues/', $packageIdOrName), $filters);
     }
 

src/Api/Packages/Artifacts.php

@@ -36,6 +36,6 @@ public function show($artifactId)
 
     public function showPackageArtifacts($packageIdOrName)
     {
-        return $this->get(sprintf('/packages/%s/artifacts/', $packageIdOrName));
+        return $this->get(sprintf('/packages/%s/artifacts/', $packageIdOrName), ['limit' => self::DEFAULT_LIMIT]);
     }
 }

src/Api/SecurityIssues.php

@@ -48,6 +48,8 @@ class SecurityIssues extends AbstractApi
 
     public function all(array $filters = [])
     {
+        $filters = array_merge(['limit' => self::DEFAULT_LIMIT], $filters);
+
         return $this->get('/security-issues/', $filters);
     }
 

src/Api/Suborganizations.php

@@ -15,7 +15,7 @@ class Suborganizations extends AbstractApi
 {
     public function all()
     {
-        return $this->get('/suborganizations/');
+        return $this->get('/suborganizations/', ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function show($suborganizationName)
@@ -35,7 +35,7 @@ public function remove($suborganizationName)
 
     public function listTeams($suborganizationName)
     {
-        return $this->get(sprintf('/suborganizations/%s/teams/', $suborganizationName));
+        return $this->get(sprintf('/suborganizations/%s/teams/', $suborganizationName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function addOrEditTeams($suborganizationName, array $teams)
@@ -60,7 +60,7 @@ public function removeTeam($suborganizationName, $teamId)
 
     public function listTokens($suborganizationName)
     {
-        return $this->get(sprintf('/suborganizations/%s/tokens/', $suborganizationName));
+        return $this->get(sprintf('/suborganizations/%s/tokens/', $suborganizationName), ['limit' => self::DEFAULT_LIMIT]);
     }
 
     public function createToken($suborganizationName, array $tokenData)