Fix pagination handling

Author: danmichaelo

spec/TaskLists/LendingRequestsSpec.php

@@ -19,12 +19,11 @@ function it_provides_filtering_options(AlmaClient $client, Library $library)
         ]);
 
         $client->getJSON('/task-lists/rs/lending-requests?printed=N&status=REQUEST_CREATED_LEND&library=SOME_LIBRARY')
-            ->shouldBeCalled()
+            ->shouldBeCalledTimes(1)
             ->willReturn(SpecHelper::getDummyData('lending_requests_created.json'));
 
-        $result = $this->all();
-        $result->shouldBeArray();
-        $result->shouldHaveCount(3);
-        $result[0]->shouldBeAnInstanceOf(ResourceSharingRequest::class);
+        $this->all()->shouldBeArray();
+        $this->all()->shouldHaveCount(3);
+        $this->all()[0]->shouldBeAnInstanceOf(ResourceSharingRequest::class);
     }
 }

src/Analytics/Report.php

@@ -146,6 +146,14 @@ protected function fetchBatch($attempt = 1, $chunkSize = null)
         }
     }
 
+    protected function fetchData()
+    {
+        do {
+            $this->fetchBatch();
+        } while (!$this->isFinished);
+        return null;
+    }
+
     /**
      * Read column headers from response, and check that we got the right number of columns back.
      *

src/Model/LazyResource.php

@@ -71,7 +71,7 @@ public function init($data = null)
             $data = $this->fetchData();
         }
 
-        if (!is_null($data) && $this->isInitialized($data)) {
+        if ($this->isInitialized($data)) {
             $this->initialized = true;
         }
 
@@ -84,15 +84,16 @@ public function init($data = null)
     }
 
     /**
-     * Get the model data.
+     * Get and return the model data.
+     * @return object
      */
     protected function fetchData()
     {
         return $this->client->getJSON($this->url());
     }
 
     /**
-     * Called when data is available to be processed.
+     * Called when data is available on the object.
      * The resource classes can use this method to process the data.
      *
      * @param mixed $data

src/Model/LazyResourceList.php

@@ -6,10 +6,13 @@
 
 /**
  * The LazyResourceList extends the LazyResource class with functionality for
- * working with lists of resources, such as holdings, items, loans, etc.
+ * working with non-paginated lists of resources, such as holdings, items, loans, etc.
  */
 abstract class LazyResourceList extends LazyResource implements \Countable
 {
+    /* @var integer */
+    protected $totalRecordCount = null;
+
     /* @var array */
     protected $resources = [];
 
@@ -41,18 +44,24 @@ public function __construct(Client $client, $responseKey)
     abstract protected function convertToResource($data);
 
     /**
-     * Called when data is available to be processed.
+     * Called when data is available on the object.
+     * The resource classes can use this method to process the data.
      *
-     * @param mixed $data
+     * @param $data
      */
-    public function onData($data)
+    protected function onData($data)
     {
-        $this->resources = ($data->total_record_count === 0) ? [] : array_map(
-            function (\stdClass $res) {
-                return $this->convertToResource($res);
-            },
-            $data->{$this->responseKey}
-        );
+        if (is_null($this->totalRecordCount)) {
+            $this->totalRecordCount = $data->total_record_count;
+        }
+
+        if (!isset($data->{$this->responseKey})) {
+            return;
+        }
+
+        foreach ($data->{$this->responseKey} as $result) {
+            $this->resources[] = $this->convertToResource($result);
+        }
     }
 
     /**

src/Model/PaginatedList.php

@@ -7,14 +7,6 @@ trait PaginatedList
     /* @var integer */
     protected $position = 0;
 
-    /**
-     * Fetch all the data.
-     */
-    protected function fetchData()
-    {
-        return iterator_to_array($this);
-    }
-
     /**
      * Rewind the Iterator to the first element.
      *

src/Model/SimplePaginatedList.php

@@ -20,8 +20,6 @@ abstract class SimplePaginatedList extends LazyResourceList
     /* @var integer */
     protected $limit = 10;
 
-    /* @var integer */
-    protected $totalRecordCount = null;
 
     protected function fetchBatch()
     {
@@ -33,24 +31,21 @@ protected function fetchBatch()
             'offset' => $this->offset,
             'limit' => $this->limit,
         ]));
+        return $this->onData($response);
+    }
 
-        if (is_null($this->totalRecordCount)) {
-            $this->totalRecordCount = $response->total_record_count;
-        }
-
-        if ($this->totalRecordCount === 0) {
-            return;
-        }
-
-        foreach ($response->{$this->responseKey} as $res) {
-            $this->resources[] = $this->convertToResource($res);
-        }
-        $this->offset = count($this->resources);
+    protected function fetchData()
+    {
+        do {
+            $this->fetchBatch();
+        } while (!$this->isInitialized($this->resources));
+        return null;
     }
 
-    public function fetchData()
+    protected function onData($data)
     {
-        $this->all();
+        parent::onData($data);
+        $this->offset = count($this->resources);
     }
 
     /**