Add fetch endpoints with Saloon

composer.json

@@ -17,8 +17,9 @@
     ],
     "require": {
         "php": "^8.3",
-        "spatie/laravel-package-tools": "^1.16",
-        "illuminate/contracts": "^11.0"
+        "illuminate/contracts": "^11.0",
+        "saloonphp/laravel-plugin": "^3.0",
+        "spatie/laravel-package-tools": "^1.16"
     },
     "require-dev": {
         "laravel/pint": "^1.14",

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - config

src/FloatClient.php

@@ -2,30 +2,50 @@
 
 namespace Spatie\FloatSdk;
 
-use GuzzleHttp\Client;
-use Spatie\FloatSdk\Tests\Fake\FakeFloatClient;
+use Saloon\Http\Auth\TokenAuthenticator;
+use Saloon\Http\Connector;
+use Spatie\FloatSdk\Groups\ProjectsGroup;
+use Spatie\FloatSdk\Groups\TasksGroup;
+use Spatie\FloatSdk\Groups\UsersGroup;
 
-class FloatClient
+class FloatClient extends Connector
 {
-    protected Client $client;
-
     public function __construct(
-        private readonly string $apiKey,
-        private readonly string $userAgent,
-    ) {
-        $this->client = new Client([
-            'base_uri' => 'https://api.float.com/v3',
-            'headers' => [
-                'Authorization' => 'Bearer '.$this->apiKey,
-                'Accept' => 'application/json',
-                'User-Agent' => $this->userAgent,
-            ],
-        ]);
+        private string $apiKey,
+        private string $userAgent,
+    ) {}
+
+    public function resolveBaseUrl(): string
+    {
+        return 'https://api.float.com/v3';
+    }
+
+    protected function defaultHeaders(): array
+    {
+        return [
+            'Accept' => 'application/json',
+            'Content-Type' => 'application/json',
+            'User-Agent' => $this->userAgent,
+        ];
+    }
+
+    protected function defaultAuth(): TokenAuthenticator
+    {
+        return new TokenAuthenticator($this->apiKey);
+    }
+
+    public function users(): UsersGroup
+    {
+        return new UsersGroup($this);
+    }
+
+    public function projects(): ProjectsGroup
+    {
+        return new ProjectsGroup($this);
     }
 
-    /** @internal for testing purposes only */
-    public static function fake(): void
+    public function tasks(): TasksGroup
     {
-        app()->instance(self::class, new FakeFloatClient);
+        return new TasksGroup($this);
     }
 }

src/Groups/ProjectsGroup.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\FloatSdk\Groups;
+
+use Saloon\Http\BaseResource;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Requests\GetProjects;
+
+class ProjectsGroup extends BaseResource
+{
+    public function all(): Response
+    {
+        return $this->connector->send(new GetProjects);
+    }
+}

src/Groups/TasksGroup.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\FloatSdk\Groups;
+
+use Saloon\Http\BaseResource;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Requests\GetTasks;
+
+class TasksGroup extends BaseResource
+{
+    public function all(): Response
+    {
+        return $this->connector->send(new GetTasks);
+    }
+}

src/Groups/UsersGroup.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\FloatSdk\Groups;
+
+use Saloon\Http\BaseResource;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Requests\GetUsers;
+
+class UsersGroup extends BaseResource
+{
+    public function all(): Response
+    {
+        return $this->connector->send(new GetUsers);
+    }
+}

src/Requests/GetProjects.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\FloatSdk\Requests;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Resources\ProjectResource;
+
+class GetProjects extends Request
+{
+    protected Method $method = Method::GET;
+
+    public function resolveEndpoint(): string
+    {
+        return '/projects';
+    }
+
+    /** @return array<ProjectResource> */
+    public function createDtoFromResponse(Response $response): array
+    {
+        return array_map(function (array $object) {
+            return ProjectResource::createFromResponse($object);
+        }, $response->json());
+    }
+}

src/Requests/GetTasks.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\FloatSdk\Requests;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Resources\TaskResource;
+
+class GetTasks extends Request
+{
+    protected Method $method = Method::GET;
+
+    public function resolveEndpoint(): string
+    {
+        return '/project-tasks';
+    }
+
+    /** @return array<TaskResource> */
+    public function createDtoFromResponse(Response $response): array
+    {
+        return array_map(function (array $object) {
+            return TaskResource::createFromResponse($object);
+        }, $response->json());
+    }
+}

src/Requests/GetUsers.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\FloatSdk\Requests;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Spatie\FloatSdk\Resources\UserResource;
+
+class GetUsers extends Request
+{
+    protected Method $method = Method::GET;
+
+    public function resolveEndpoint(): string
+    {
+        return '/people';
+    }
+
+    /** @return array<UserResource> */
+    public function createDtoFromResponse(Response $response): array
+    {
+        return array_map(function (array $object) {
+            return UserResource::createFromResponse($object);
+        }, $response->json());
+    }
+}

src/Resources/ProjectResource.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Spatie\FloatSdk\Resources;
+
+class ProjectResource
+{
+    public function __construct(
+        public int $id,
+        public string $name,
+        public string $code,
+        public string $clientId,
+    ) {}
+
+    /** @param array<mixed> $response */
+    public static function createFromResponse(array $response): self
+    {
+        return new self(
+            id: $response['project_id'],
+            name: $response['name'],
+            code: $response['code'],
+            clientId: $response['client_id'],
+        );
+    }
+}

src/Resources/TaskResource.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spatie\FloatSdk\Resources;
+
+class TaskResource
+{
+    public function __construct(
+        public int $id,
+        public string $name,
+        public string $projectId,
+    ) {}
+
+    /** @param array<mixed> $response */
+    public static function createFromResponse(array $response): self
+    {
+        return new self(
+            id: $response['task_meta_id'],
+            name: $response['task_name'],
+            projectId: $response['project_id'],
+        );
+    }
+}

src/Resources/UserResource.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\FloatSdk\Resources;
+
+class UserResource
+{
+    public function __construct(
+        public int $id,
+        public string $name,
+        public string $email,
+        public string $jobTitle,
+        public bool $active
+    ) {}
+
+    /** @param array<mixed> $response */
+    public static function createFromResponse(array $response): self
+    {
+        return new self(
+            id: $response['people_id'],
+            name: $response['name'],
+            email: $response['email'],
+            jobTitle: $response['job_title'],
+            active: $response['active'],
+        );
+    }
+}

tests/FloatServiceProviderTest.php

@@ -4,7 +4,6 @@
 
 use Spatie\FloatSdk\FloatClient;
 use Spatie\FloatSdk\FloatServiceProvider;
-use Spatie\FloatSdk\Tests\Fake\FakeFloatClient;
 
 beforeEach(function () {
     $this->provider = new FloatServiceProvider($this->app);
@@ -44,16 +43,3 @@
 
     app(FloatClient::class);
 })->throws('Float requires a User-Agent header in the format: `YourAppName (your-email@example.com)`. Please set the `FLOAT_USER_AGENT` environment variable accordingly.');
-
-it('can create a fake', function () {
-    config()->set('float-sdk', [
-        'api_token' => 'fake-token',
-        'user_agent' => null,
-    ]);
-
-    FloatClient::fake();
-
-    $client = app(FloatClient::class);
-
-    expect($client)->toBeInstanceOf(FakeFloatClient::class);
-});

tests/Requests/GetUsersTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Spatie\FloatSdk\Tests\Requests;
+
+use Saloon\Http\Faking\MockClient;
+use Saloon\Http\Faking\MockResponse;
+use Spatie\FloatSdk\FloatClient;
+use Spatie\FloatSdk\Requests\GetUsers;
+
+beforeEach(function () {
+    $people = [
+        ['id' => 00000001, 'name' => 'Wouter', 'email' => 'wouter@spatie.com', 'job_title' => 'Project manager', 'active' => 0],
+        ['id' => 00000002, 'name' => 'Séba', 'email' => 'sebastien@spatie.com', 'job_title' => 'Frontend developer', 'active' => 1],
+        ['id' => 00000003, 'name' => 'Jimi', 'email' => 'jimi@spatie.com', 'job_title' => 'Digital designer', 'active' => 1],
+        ['id' => 00000004, 'name' => 'Tim', 'email' => 'tim@spatie.com', 'job_title' => 'Backend developer', 'active' => 1],
+        ['id' => 00000005, 'name' => 'Niels', 'email' => 'niels@spatie.com', 'job_title' => 'Backend developer', 'active' => 1],
+        ['id' => 00000006, 'name' => 'Willem', 'email' => 'willem@spatie.com', 'job_title' => 'Frontend developer', 'active' => 0],
+        ['id' => 00000007, 'name' => 'Sebastian', 'email' => 'sebastian@spatie.com', 'job_title' => 'Frontend developer', 'active' => 1],
+        ['id' => 00000010, 'name' => 'Ruben', 'email' => 'ruben@spatie.com', 'job_title' => 'Backend developer', 'active' => 1],
+        ['id' => 00000011, 'name' => 'Rias', 'email' => 'rias@spatie.com', 'job_title' => 'Backend developer', 'active' => 1],
+        ['id' => 00000012, 'name' => 'Freek', 'email' => 'freek@spatie.com', 'job_title' => 'Backend developer', 'active' => 1],
+        ['id' => 00000013, 'name' => 'Alex', 'email' => 'alex@spatie.com', 'job_title' => 'Backend developer', 'active' => 0],
+    ];
+
+    $this->mockClient = new MockClient([
+        GetUsers::class => MockResponse::make(body: $people),
+    ]);
+
+    $this->client = new FloatClient('fake-api-key', 'fake-user_agent');
+});
+
+it('can fetch all the users of an organisation', function () {
+    $response = $this->client
+        ->withMockClient($this->mockClient)
+        ->send(new GetUsers);
+
+    expect($response->json())
+        ->toBeArray()
+        ->toHaveCount(11);
+
+    $firstUser = $response->json()[0];
+
+    expect($firstUser)
+        ->toHaveKeys(['id', 'name', 'email', 'job_title', 'active']);
+});
+
+it('can fetch the users with a specific method', function () {
+    $response = $this->client
+        ->withMockClient($this->mockClient)
+        ->users()->all();
+
+    expect($response->json())
+        ->toBeArray()
+        ->toHaveCount(11);
+
+    $firstUser = $response->json()[0];
+
+    expect($firstUser)
+        ->toHaveKeys(['id', 'name', 'email', 'job_title', 'active']);
+});