Add support for listing whitelist entries (GET /v2/whitelist/{app}/)

Author: Jonathan Visser

src/HypernodeClient.php

@@ -16,6 +16,7 @@
 use Hypernode\Api\Service\Logbook;
 use Hypernode\Api\Service\Product;
 use Hypernode\Api\Service\Settings;
+use Hypernode\Api\Service\Whitelist;
 use Psr\Http\Message\ResponseInterface;
 
 class HypernodeClient
@@ -30,6 +31,7 @@ class HypernodeClient
     public Product $product;
     public Settings $settings;
     public Logbook $logbook;
+    public Whitelist $whitelist;
 
     public function __construct(HttpMethodsClientInterface $apiClient)
     {
@@ -43,6 +45,7 @@ public function __construct(HttpMethodsClientInterface $apiClient)
         $this->product = new Product($this);
         $this->settings = new Settings($this);
         $this->logbook = new Logbook($this);
+        $this->whitelist = new Whitelist($this);
     }
 
     public function getJsonFromResponse(ResponseInterface $response)

src/Service/Whitelist.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypernode\Api\Service;
+
+use Hypernode\Api\Exception\HypernodeApiClientException;
+use Hypernode\Api\Exception\HypernodeApiServerException;
+
+class Whitelist extends AbstractService
+{
+    public const V2_WHITELIST_URL = "/v2/whitelist/%s/";
+
+    /**
+     * Get all whitelist entries for the Hypernode.
+     *
+     * @param string $app Name of the Hypernode
+     * @param array $params Query parameters to filter the results, e.g. ['type' => 'waf']
+     * @return array List of whitelist entries
+     * @throws HypernodeApiClientException
+     * @throws HypernodeApiServerException
+     */
+    public function getList(string $app, array $params = []): array
+    {
+        $url = sprintf(self::V2_WHITELIST_URL, $app);
+        if ($params) {
+            $url .= '?' . http_build_query($params);
+        }
+
+        $response = $this->client->api->get($url);
+
+        $this->client->maybeThrowApiExceptions($response);
+
+        return $this->client->getJsonFromResponse($response);
+    }
+}

tests/unit/Service/WhitelistTest.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypernode\Api\Service;
+
+use GuzzleHttp\Psr7\Response;
+use Hypernode\Api\Exception\HypernodeApiClientException;
+use Hypernode\Api\Exception\HypernodeApiServerException;
+use Hypernode\Api\HypernodeClientTestCase;
+
+class WhitelistTest extends HypernodeClientTestCase
+{
+    public function testGetList()
+    {
+        $entries = [
+            [
+                'id' => 1234,
+                'created' => '2026-07-14T14:49:06Z',
+                'type' => 'waf',
+                'description' => 'Office IP',
+                'ip' => '1.2.3.4',
+                'app' => 'johndoe',
+            ],
+        ];
+        $this->responses->append(
+            new Response(200, [], json_encode($entries)),
+        );
+
+        $result = $this->client->whitelist->getList('johndoe');
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('GET', $request->getMethod());
+        $this->assertEquals('/v2/whitelist/johndoe/', $request->getUri());
+        $this->assertEquals($entries, $result);
+    }
+
+    public function testGetListAcceptsParams()
+    {
+        $this->responses->append(
+            new Response(200, [], json_encode([])),
+        );
+
+        $result = $this->client->whitelist->getList('johndoe', ['type' => 'waf']);
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('GET', $request->getMethod());
+        $this->assertEquals('/v2/whitelist/johndoe/?type=waf', $request->getUri());
+        $this->assertEquals([], $result);
+    }
+
+    public function testGetListRaisesClientExceptions()
+    {
+        $badRequestResponse = new Response(400, [], json_encode([
+            'non_field_errors' => ['Your request was invalid.']
+        ]));
+        $this->responses->append($badRequestResponse);
+
+        $this->expectExceptionObject(new HypernodeApiClientException($badRequestResponse));
+
+        $this->client->whitelist->getList('johndoe');
+    }
+
+    public function testGetListRaisesServerExceptions()
+    {
+        $badRequestResponse = new Response(500, [], json_encode([
+            'non_field_errors' => ['Something went wrong processing your request.']
+        ]));
+        $this->responses->append($badRequestResponse);
+
+        $this->expectExceptionObject(new HypernodeApiServerException($badRequestResponse));
+
+        $this->client->whitelist->getList('johndoe');
+    }
+}