fix: send headers with requests (#2)

Author: patrickhoogkamer

phpstan-baseline.neon

@@ -78,7 +78,7 @@ public function whereIn(string $property, array $values): static
 
     public function find(mixed $id): Model|null
     {
-        $response = Http::get($this->model->baseUrl().$this->toQuery($id))->throwUnlessStatus(404);
+        $response = Http::withHeaders($this->model->headers())->get($this->model->baseUrl().$this->toQuery($id))->throwUnlessStatus(404);
 
         if ($response->failed()) {
             return null;
@@ -183,7 +183,7 @@ public function toQuery(string|int|null $id = null): string
 
     public function performCollectionQuery(): Response
     {
-        return Http::get($this->model->baseUrl().$this->toQuery());
+        return Http::withHeaders($this->model->headers())->get($this->model->baseUrl().$this->toQuery());
     }
 
     /**

src/QueryBuilder.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Http\Client\Request;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Http;
 use Intermax\EloquentJsonApiClient\Tests\Team;
@@ -11,8 +12,7 @@
 uses(TestCase::class);
 
 it('fetches and hydrates a team', function () {
-    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamFindResponse.json'))
-    );
+    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamFindResponse.json')));
 
     $team = Team::find(1);
 
@@ -24,17 +24,27 @@
 });
 
 it('fetches and hydrates a team with its relations', function () {
-    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamFindRelationResponse.json'))
-    );
+    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamFindRelationResponse.json')));
 
     $team = Team::query()->with(['members'])->find(1);
 
     assert($team instanceof Team);
 
-    Http::assertSent(fn (Request $request) => str_contains($request->url(), 'teams/1') && str_contains($request->url(), 'include=members')
+    Http::assertSent(
+        fn (Request $request) => str_contains($request->url(), 'teams/1') && str_contains($request->url(), 'include=members')
     );
 
     expect($team)->toBeInstanceOf(Team::class)
         ->and($team->members)->toBeInstanceOf(Collection::class)
         ->and($team->members->first()->id)->toBe('5');
 });
+
+it('sends headers with the request', function () {
+    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamFindResponse.json')));
+
+    Team::find(1);
+
+    Http::assertSent(
+        fn (Request $request) => Arr::first($request->header('api-key')) === 'test'
+    );
+});

tests/FindTest.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Http\Client\Request;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Http;
 use Intermax\EloquentJsonApiClient\Tests\Team;
@@ -11,8 +12,7 @@
 uses(TestCase::class);
 
 it('fetches teams', function () {
-    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamGetResponse.json'))
-    );
+    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamGetResponse.json')));
 
     $teams = Team::query()->get();
 
@@ -22,3 +22,13 @@
         ->and($teams->count())->toBe(4)
         ->and($teams->first())->toBeInstanceOf(Team::class);
 });
+
+it('sends headers with the request', function () {
+    Http::fake(fn () => Http::response(file_get_contents(__DIR__.'/Utilities/TeamGetResponse.json')));
+
+    Team::query()->get();
+
+    Http::assertSent(
+        fn (Request $request) => Arr::first($request->header('api-key')) === 'test'
+    );
+});

tests/GetTest.php

@@ -38,4 +38,9 @@ public function baseUrl(): string
     {
         return 'https://localhost';
     }
+
+    public function headers(): array
+    {
+        return ['api-key' => 'test'];
+    }
 }