Implement Access endpoints (#21)

src/ControlD.php

@@ -5,6 +5,7 @@
 namespace Rapkis\Controld;
 
 use Illuminate\Http\Client\PendingRequest;
+use Rapkis\Controld\Resources\Access;
 use Rapkis\Controld\Resources\Devices;
 use Rapkis\Controld\Resources\Profiles;
 
@@ -23,4 +24,9 @@ public function devices(): Devices
     {
         return app(Devices::class, ['client' => $this->request]);
     }
+
+    public function access(): Access
+    {
+        return app(Access::class, ['client' => $this->request]);
+    }
 }

src/Entities/LearnedIp.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Entities;
+
+class LearnedIp
+{
+    public function __construct(
+        public readonly string $ip,
+        public readonly int $timestamp,
+        public readonly string $isp,
+        public readonly ?string $country,
+        public readonly ?string $city,
+    ) {
+    }
+}

src/Factories/LearnedIpFactory.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Factories;
+
+use Rapkis\Controld\Contracts\Factories\Factory;
+use Rapkis\Controld\Entities\LearnedIp;
+
+class LearnedIpFactory implements Factory
+{
+    public function make(array $data): LearnedIp
+    {
+        return new LearnedIp(
+            ip: $data['ip'],
+            timestamp: (int) $data['ts'],
+            isp: $data['isp'],
+            country: $data['country'] ?? null,
+            city: $data['city'] ?? null,
+        );
+    }
+}

src/Resources/Access.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Resources;
+
+use Illuminate\Http\Client\PendingRequest;
+use Rapkis\Controld\Factories\LearnedIpFactory;
+use Rapkis\Controld\Responses\LearnedIps;
+
+class Access
+{
+    public function __construct(private readonly PendingRequest $client, private readonly LearnedIpFactory $learnedIp)
+    {
+    }
+
+    public function list(string $devicePk): LearnedIps
+    {
+        $response = $this->client->get('access', ['device_id' => $devicePk])->json('body.ips');
+
+        $result = new LearnedIps();
+
+        foreach ($response as $learnedIp) {
+            $learnedIp = $this->learnedIp->make($learnedIp);
+            $result->put($learnedIp->ip, $learnedIp);
+        }
+
+        return $result;
+    }
+
+    public function learn(string $devicePk, array $ips): bool
+    {
+        $this->client->post('access', [
+            'device_id' => $devicePk,
+            'ips' => $ips,
+        ]);
+
+        return true;
+    }
+
+    public function delete(string $devicePk, array $ips): bool
+    {
+        $this->client->delete('access', [
+            'device_id' => $devicePk,
+            'ips' => $ips,
+        ]);
+
+        return true;
+    }
+}

src/Responses/LearnedIps.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Responses;
+
+use Illuminate\Support\Collection;
+
+class LearnedIps extends Collection
+{
+}

tests/ControlDTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Http\Client\PendingRequest;
 use Rapkis\Controld\ControlD;
+use Rapkis\Controld\Resources\Access;
 use Rapkis\Controld\Resources\Devices;
 use Rapkis\Controld\Resources\Profiles;
 
@@ -16,3 +17,8 @@
     $client = new ControlD($this->createStub(PendingRequest::class));
     expect($client->devices())->toBeInstanceOf(Devices::class);
 });
+
+it('accesses access resource', function () {
+    $client = new ControlD($this->createStub(PendingRequest::class));
+    expect($client->access())->toBeInstanceOf(Access::class);
+});

tests/Factories/LearnedIpFactoryTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Rapkis\Controld\Entities\LearnedIp;
+use Rapkis\Controld\Factories\LearnedIpFactory;
+
+it('builds an action', function (array $data, LearnedIp $expected) {
+    expect((new LearnedIpFactory())->make($data))->toEqual($expected);
+})->with([
+    [
+        [
+            'ip' => '127.0.0.1',
+            'ts' => 111111111,
+            'country' => null,
+            'city' => null,
+            'isp' => 'Cloudflare',
+        ],
+        new LearnedIp(
+            ip: '127.0.0.1',
+            timestamp: 111111111,
+            isp: 'Cloudflare',
+            country: null,
+            city: null,
+        ),
+    ],
+    [
+        [
+            'ip' => '2606:1a40::2',
+            'ts' => 111111111,
+            'country' => 'US',
+            'city' => 'New York',
+            'isp' => 'Cloudflare',
+        ],
+        new LearnedIp(
+            ip: '2606:1a40::2',
+            timestamp: 111111111,
+            isp: 'Cloudflare',
+            country: 'US',
+            city: 'New York',
+        ),
+    ],
+]);

tests/Mocks/Endpoints/access-delete.json

@@ -0,0 +1,5 @@
+{
+    "body": {},
+    "success": true,
+    "message": "1 IPs deleted"
+}

tests/Mocks/Endpoints/access-learn.json

@@ -0,0 +1,5 @@
+{
+    "body": {},
+    "success": true,
+    "message": "1 IPs added"
+}

tests/Mocks/Endpoints/access-list.json

@@ -0,0 +1,28 @@
+{
+    "body": {
+        "ips": [
+            {
+                "ip": "2606:1a40::2",
+                "ts": 1694584816,
+                "country": "US",
+                "city": null,
+                "isp": "Cloudflare"
+            },
+            {
+                "ip": "22606:1a40:1::2",
+                "ts": 1694584816,
+                "country": "US",
+                "city": null,
+                "isp": "Cloudflare"
+            },
+            {
+                "ip": "127.0.0.1",
+                "ts": 1694443821,
+                "country": "NL",
+                "city": "Amsterdam",
+                "isp": "Cloudflare"
+            }
+        ]
+    },
+    "success": true
+}

tests/Resources/AccessTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Support\Facades\Http;
+use Rapkis\Controld\Factories\LearnedIpFactory;
+use Rapkis\Controld\Resources\Access;
+use Rapkis\Controld\Responses\LearnedIps;
+
+beforeEach(function () {
+    Http::preventStrayRequests();
+});
+
+it('lists known ips', function () {
+    $request = Http::fake([
+        'access?device_id=device_pk' => Http::response(mockJsonEndpoint('access-list')),
+    ])->asJson();
+
+    $resource = new Access(
+        $request,
+        app(LearnedIpFactory::class),
+    );
+
+    $result = $resource->list('device_pk');
+
+    expect($result)->toBeInstanceOf(LearnedIps::class)
+        ->and($result)->toHaveCount(3);
+});
+
+it('learns a new ip', function () {
+    $request = Http::fake([
+        'access' => Http::response(mockJsonEndpoint('access-learn')),
+    ])->asJson();
+
+    $resource = new Access(
+        $request,
+        $this->createStub(LearnedIpFactory::class),
+    );
+
+    $result = $resource->learn('device_pk', ['0.0.0.0']);
+
+    expect($result)->toBeTrue();
+});
+
+it('deletes an IP', function () {
+    $request = Http::fake([
+        'access' => Http::response(mockJsonEndpoint('access-delete')),
+    ])->asJson();
+
+    $resource = new Access(
+        $request,
+        $this->createStub(LearnedIpFactory::class),
+    );
+
+    $result = $resource->delete('device_pk', ['0.0.0.0']);
+
+    expect($result)->toBeTrue();
+});