Add support for deleting whitelist entries (DELETE /v2/whitelist/{app}/)

Author: Jonathan Visser

src/Service/Whitelist.php

@@ -55,4 +55,23 @@ public function create(string $app, array $data): array
 
         return $this->client->getJsonFromResponse($response);
     }
+
+    /**
+     * Remove a whitelist entry for the Hypernode.
+     *
+     * @param string $app Name of the Hypernode
+     * @param array $data Data identifying the entry to remove, e.g.
+     *  ['ip' => '1.2.3.4', 'type' => 'waf']
+     * @return void
+     * @throws HypernodeApiClientException
+     * @throws HypernodeApiServerException
+     */
+    public function delete(string $app, array $data): void
+    {
+        $url = sprintf(self::V2_WHITELIST_URL, $app);
+
+        $response = $this->client->api->delete($url, [], json_encode($data));
+
+        $this->client->maybeThrowApiExceptions($response);
+    }
 }

tests/unit/Service/WhitelistTest.php

@@ -122,4 +122,44 @@ public function testCreateRaisesServerExceptions()
 
         $this->client->whitelist->create('johndoe', ['ip' => '1.2.3.4']);
     }
+
+    public function testDelete()
+    {
+        $this->responses->append(
+            new Response(204, [], null),
+        );
+
+        $entryData = ['ip' => '1.2.3.4', 'type' => 'waf'];
+        $this->client->whitelist->delete('johndoe', $entryData);
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('DELETE', $request->getMethod());
+        $this->assertEquals('/v2/whitelist/johndoe/', $request->getUri());
+        $this->assertJson((string)$request->getBody());
+        $this->assertEquals($entryData, json_decode((string)$request->getBody(), true));
+    }
+
+    public function testDeleteRaisesClientExceptions()
+    {
+        $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->delete('johndoe', ['ip' => '1.2.3.4']);
+    }
+
+    public function testDeleteRaisesServerExceptions()
+    {
+        $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->delete('johndoe', ['ip' => '1.2.3.4']);
+    }
 }