Dev/3.3 (#3)

* Added chunk() functionality in JsonApiFetcher

* Added `getDataCollection` method & definition

* Added `chunk` method & definition

* Updated JsonApiFetcher to inject Collection to Closure in chunk()

Collection is making on the fly, from data key from PaginatedData DTO (which contain full API response)

* Updated CHANGELOG.md

Author: grixu

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to `api-client` will be documented in this file
 
+## 3.3.0 - 2021-05-21
+
+- Added `chunk()` method in `JsonApiFetcher`
+- Added `getDataCollection` in `PaginatedData`
+- Added definition of `getDataCollection` in `FetchedData`
+- Make method `parseElement` public in `StraightKeyParser`
+- Added definition of `praseElement` in `ResponseParser` interface
+
+
 ## 3.2.1 - 2021-05-04
 
 - Bug fixed in `StraightKeyParser`

src/Contracts/FetchedData.php

@@ -2,8 +2,11 @@
 
 namespace Grixu\ApiClient\Contracts;
 
+use Illuminate\Support\Collection;
+
 interface FetchedData
 {
     public function getData(): array;
+    public function getDataCollection(): Collection;
     public function isMoreToLoad(): bool;
 }

src/Contracts/ResponseParser.php

@@ -3,8 +3,10 @@
 namespace Grixu\ApiClient\Contracts;
 
 use Illuminate\Support\Collection;
+use Spatie\DataTransferObject\DataTransferObject;
 
 interface ResponseParser
 {
     public function parse(Collection $inputData): Collection;
+    public function parseElement(array $input): DataTransferObject;
 }

src/Data/PaginatedData.php

@@ -5,6 +5,7 @@
 use Grixu\ApiClient\Contracts\FetchedData;
 use Grixu\ApiClient\Exceptions\DamagedResponse;
 use Illuminate\Http\Client\Response;
+use Illuminate\Support\Collection;
 
 class PaginatedData implements FetchedData
 {
@@ -35,7 +36,7 @@ protected function validateResponse(Response $response): void
 
     protected function validateResponseData(array $responseData): void
     {
-        if (!isset($responseData['data']) || empty($responseData['data'])) {
+        if (!isset($responseData['data'])) {
             throw new DamagedResponse();
         }
 
@@ -49,6 +50,11 @@ public function getData(): array
         return $this->data;
     }
 
+    public function getDataCollection(): Collection
+    {
+        return collect($this->data);
+    }
+
     public function getCurrentPage(): int
     {
         return $this->currentPage;

src/Data/StraightKeyParser.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Str;
 use ReflectionClass;
 use ReflectionProperty;
+use Spatie\DataTransferObject\DataTransferObject;
 
 class StraightKeyParser implements ResponseParser
 {
@@ -27,31 +28,30 @@ public function parse(Collection $inputCollection): Collection
                 continue;
             }
 
-            $preparedData = $this->parseElement($inputData);
-            $dto = new $this->dtoClass($preparedData);
+            $dto = $this->parseElement($inputData);
 
             $parsed->push($dto);
         }
 
         return $parsed;
     }
 
-    protected function parseElement(array $input): array
+    public function parseElement(array $input): DataTransferObject
     {
         $data = [];
 
         foreach ($this->fields as $field) {
             $dtoFieldName = $field->getName();
             $arrayFieldName = Str::snake($dtoFieldName);
 
-            if ($dtoFieldName === 'relationships' && isset($input[$arrayFieldName])) {
+            if ($dtoFieldName === 'relations' && isset($input[$arrayFieldName])) {
                 $data[$dtoFieldName] = $this->parseRelationship($input[$arrayFieldName]);
             } else {
                 $data[$dtoFieldName] = $input[$arrayFieldName] ?? null;
             }
         }
 
-        return $data;
+        return (new $this->dtoClass($data));
     }
 
     protected function parseRelationship(array $inputRelationships): array

src/JsonApiFetcher.php

@@ -46,4 +46,23 @@ public function fetch(?Closure $before = null)
             $this->fetch($before);
         }
     }
+
+    public function chunk(Closure $loop)
+    {
+        $dataFetcher = new DataFetcher(
+            $this->urlComposer->get(),
+            $this->config->getResponseDataClass(),
+            $this->token
+        );
+
+        $dataFetcher->fetch();
+        $results = $dataFetcher->get();
+
+        $loop($results->getDataCollection());
+
+        if ($results->isMoreToLoad() && $this->loadAll) {
+            $this->urlComposer->nextPage();
+            $this->chunk($loop);
+        }
+    }
 }

tests/Data/StraightKeyParserTest.php

@@ -78,7 +78,6 @@ public function it_replaces_datetime_to_carbon()
         );
 
 
-
         $returnedData = $this->basicAssertions($inputData);
 
         $this->assertEquals($date->timestamp, $returnedData->first()->date->timestamp);
@@ -133,4 +132,25 @@ public function it_replaces_enums()
 
         $this->basicAssertions($inputData);
     }
+
+    /** @test */
+    public function it_parsing_collection_of_arrays_with_relations_data_to_collection_of_dtos()
+    {
+        $inputData = collect(
+            [
+                [
+                    'first' => 'first entry',
+                    'second' => 'second entry',
+                    'third' => 'third entry',
+                    'relations' => [
+                        [
+                            'test' => 'another_thing'
+                        ]
+                    ]
+                ]
+            ]
+        );
+
+        $this->basicAssertions($inputData);
+    }
 }

tests/Helpers/ExampleDto.php

@@ -19,4 +19,6 @@ class ExampleDto extends DataTransferObject
     public FakeEnum|null $enum;
 
     public int|null $id;
+
+    public array|null $relations;
 }

tests/JsonApiFetcherTest.php

@@ -9,6 +9,7 @@
 use Grixu\ApiClient\Tests\Helpers\HttpMocksTrait;
 use Grixu\ApiClient\UrlCompose;
 use Illuminate\Support\Facades\Cache;
+use Mockery\Mock;
 use Orchestra\Testbench\TestCase;
 
 class JsonApiFetcherTest extends TestCase
@@ -118,4 +119,16 @@ public function it_give_access_to_underlying_url_compose()
 
         $this->assertEquals(UrlCompose::class, $returnedValue::class);
     }
+
+    /** @test */
+    public function it_chunk_load()
+    {
+        Cache::flush();
+        $this->mockHttpMultiplePagesDataResponseSequence();
+        $this->makeObj(true);
+
+        $closure = \Mockery::mock(fn () => true);
+        $this->obj->chunk(fn () => $closure());
+        $closure->shouldHaveBeenCalled();
+    }
 }