Add support for listing products (GET /v2/product/)

Author: Jonathan Visser

src/HypernodeClient.php

@@ -14,6 +14,7 @@
 use Hypernode\Api\Service\Configuration;
 use Hypernode\Api\Service\InsightsAnnotation;
 use Hypernode\Api\Service\Logbook;
+use Hypernode\Api\Service\Product;
 use Hypernode\Api\Service\Settings;
 use Psr\Http\Message\ResponseInterface;
 
@@ -26,6 +27,7 @@ class HypernodeClient
     public BrancherApp $brancherApp;
     public Configuration $configuration;
     public InsightsAnnotation $insightsAnnotation;
+    public Product $product;
     public Settings $settings;
     public Logbook $logbook;
 
@@ -38,6 +40,7 @@ public function __construct(HttpMethodsClientInterface $apiClient)
         $this->brancherApp = new BrancherApp($this);
         $this->configuration = new Configuration($this);
         $this->insightsAnnotation = new InsightsAnnotation($this);
+        $this->product = new Product($this);
         $this->settings = new Settings($this);
         $this->logbook = new Logbook($this);
     }

src/Service/Product.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypernode\Api\Service;
+
+use Hypernode\Api\Exception\HypernodeApiClientException;
+use Hypernode\Api\Exception\HypernodeApiServerException;
+
+class Product extends AbstractService
+{
+    public const V2_PRODUCT_LIST_URL = "/v2/product/";
+
+    /**
+     * Show all Hypernode products.
+     *
+     * @return array List of products
+     * @throws HypernodeApiClientException
+     * @throws HypernodeApiServerException
+     */
+    public function getList(): array
+    {
+        $response = $this->client->api->get(self::V2_PRODUCT_LIST_URL);
+
+        $this->client->maybeThrowApiExceptions($response);
+
+        return $this->client->getJsonFromResponse($response);
+    }
+}

tests/unit/Service/ProductTest.php

@@ -0,0 +1,73 @@
+<?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 ProductTest extends HypernodeClientTestCase
+{
+    public function testGetList()
+    {
+        $products = [
+            [
+                'code' => 'FALCON_XS_202203',
+                'name' => 'Falcon XS',
+                'backups_enabled' => true,
+                'is_development' => false,
+                'varnish_supported' => false,
+                'supports_sla' => true,
+                'price' => 1234,
+                'currency' => 'EUR',
+            ],
+            [
+                'code' => 'FALCON_M_202203',
+                'name' => 'Falcon M',
+                'backups_enabled' => true,
+                'is_development' => false,
+                'varnish_supported' => true,
+                'supports_sla' => true,
+                'price' => 2345,
+                'currency' => 'EUR',
+            ],
+        ];
+        $this->responses->append(
+            new Response(200, [], json_encode($products)),
+        );
+
+        $result = $this->client->product->getList();
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('GET', $request->getMethod());
+        $this->assertEquals('/v2/product/', $request->getUri());
+        $this->assertEquals($products, $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->product->getList();
+    }
+
+    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->product->getList();
+    }
+}