Add support for ordering a new Hypernode (POST /v2/app/order/)

Author: Jonathan Visser

src/Service/App.php

@@ -14,6 +14,7 @@ class App extends AbstractService
     public const V1_APP_FLOWS_URL = "/logbook/v1/logbooks/%s/flows/";
     public const V2_APP_BLOCK_ATTACK_DESCRIPTIONS_URL = "/v2/app/block_attack_descriptions/";
     public const V2_APP_EAV_DESCRIPTIONS_URL = "/v2/app/eav_descriptions/";
+    public const V2_APP_ORDER_URL = "/v2/app/order/";
 
     /**
      * @param array $params
@@ -81,4 +82,21 @@ public function getEavDescriptions(): array
 
         return $this->client->getJsonFromResponse($response);
     }
+
+    /**
+     * Order a new Hypernode under your account.
+     *
+     * @param array $data Order data, requires at least the keys
+     *  `product_code`, `app_name` and `initial_app_configuration`.
+     * @return void
+     * @throws \Http\Client\Exception
+     * @throws \Hypernode\Api\Exception\HypernodeApiClientException
+     * @throws \Hypernode\Api\Exception\HypernodeApiServerException
+     */
+    public function order(array $data): void
+    {
+        $response = $this->client->api->post(self::V2_APP_ORDER_URL, [], json_encode($data));
+
+        $this->client->maybeThrowApiExceptions($response);
+    }
 }

tests/unit/Service/AppTest.php

@@ -198,4 +198,48 @@ public function testGetEavDescriptionsRaisesServerExceptions()
 
         $this->client->app->getEavDescriptions();
     }
+
+    public function testOrder()
+    {
+        $this->responses->append(
+            new Response(201, [], null),
+        );
+
+        $orderData = [
+            'product_code' => 'FALCON_M_202203',
+            'app_name' => 'johndoe',
+            'initial_app_configuration' => 'magento_2',
+        ];
+        $this->client->app->order($orderData);
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('POST', $request->getMethod());
+        $this->assertEquals('/v2/app/order/', $request->getUri());
+        $this->assertJson((string)$request->getBody());
+        $this->assertEquals($orderData, json_decode((string)$request->getBody(), true));
+    }
+
+    public function testOrderRaisesClientExceptions()
+    {
+        $badRequestResponse = new Response(400, [], json_encode([
+            'non_field_errors' => ['Your request was invalid.']
+        ]));
+        $this->responses->append($badRequestResponse);
+
+        $this->expectExceptionObject(new HypernodeApiClientException($badRequestResponse));
+
+        $this->client->app->order(['product_code' => 'FALCON_M_202203']);
+    }
+
+    public function testOrderRaisesServerExceptions()
+    {
+        $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->app->order(['product_code' => 'FALCON_M_202203']);
+    }
 }