Merge pull request #108 from ptmcnally/iops-client

Iops client

Author: gavtaylor

src/eCloud/Client.php

@@ -72,4 +72,12 @@ public function virtualMachines()
     {
         return (new VirtualMachineClient($this->httpClient))->auth($this->token);
     }
+
+    /**
+     * @return BaseClient
+     */
+    public function iops()
+    {
+        return (new IopsClient($this->httpClient))->auth($this->token);
+    }
 }

src/eCloud/Entities/Iops.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace UKFast\SDK\eCloud\Entities;
+
+use UKFast\SDK\Entities\Entity;
+
+class Iops extends Entity
+{
+    /**
+     * @var string IOPS tier UUID
+     */
+    public $id;
+
+    /**
+     * @var string IOPS tier name
+     */
+    public $name;
+
+    /**
+     * @var int IOPS limit to apply to a datastore
+     */
+    public $limit;
+}

src/eCloud/IopsClient.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace UKFast\SDK\eCloud;
+
+use UKFast\SDK\Entities\ClientEntityInterface;
+use UKFast\SDK\Page;
+
+use UKFast\SDK\eCloud\Entities\Iops;
+
+class IopsClient extends Client implements ClientEntityInterface
+{
+    /**
+     * Gets a paginated response of Iops
+     * @param int $page Page number
+     * @param int $perPage Number of items to return per page
+     * @param array $filters Filter to apply
+     * @return int|Page
+     */
+    public function getPage($page = 1, $perPage = 15, $filters = [])
+    {
+        $page = $this->paginatedRequest("v1/iops", $page, $perPage, $filters);
+        $page->serializeWith(function ($item) {
+            return $this->loadEntity($item);
+        });
+
+        return $page;
+    }
+
+    /**
+     * Gets an individual Iops entity
+     *
+     * @param string $id UUID for required IOPS record
+     * @return Iops
+     */
+    public function getById($id)
+    {
+        $response = $this->get("v1/iops/$id");
+        $body = $this->decodeJson($response->getBody()->getContents());
+        return $this->loadEntity($body->data);
+    }
+
+
+    /**
+     * Load an instance of Iops from API data
+     * @param $data API response data
+     * @return Iops
+     */
+    public function loadEntity($data)
+    {
+        return new Iops(
+            [
+                'id' => $data->id,
+                'name' => $data->name,
+                'limit' => $data->limit,
+            ]
+        );
+    }
+}

tests/eCloud/IopsTest.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Tests\eCloud;
+
+use GuzzleHttp\Client as Guzzle;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+use UKFast\SDK\Account\Entities\Iops;
+
+class IopsTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function get_page_of_iops()
+    {
+        $mock = new MockHandler([
+            new Response(200, [], json_encode([
+                'data' => [
+                    [
+                        'id' => '22891f55-cd6b-11e9-89fb-005056a64a16',
+                        'name' => 'Gold',
+                        'limit' => 1500
+                    ],
+                    [
+                        'id' => '3d12186c-cd6b-11e9-89fb-005056a64a16',
+                        'name' => 'Platinum',
+                        'limit' => 2000
+                    ]
+                ],
+                "meta" => [
+                    "pagination" => [
+                        "total" => 2,
+                        "count" => 2,
+                        "per_page" => 100,
+                        "current_page" => 1,
+                        "total_pages" => 1,
+                        "links" => []
+                    ]
+                ]
+            ])),
+        ]);
+
+        $handler = HandlerStack::create($mock);
+        $guzzle = new Guzzle(['handler' => $handler]);
+
+        $client = new \UKFast\SDK\eCloud\Client($guzzle);
+        $page = $client->iops()->getPage();
+
+        $this->assertTrue($page instanceof \UKFast\SDK\Page);
+        $request = $page->getItems()[0];
+
+        $this->assertTrue($request instanceof \UKFast\SDK\eCloud\Entities\Iops);
+        $this->assertEquals('22891f55-cd6b-11e9-89fb-005056a64a16', $request->id);
+        $this->assertEquals('Gold', $request->name);
+        $this->assertEquals(1500, $request->limit);
+    }
+
+    /**
+     * @test
+     */
+    public function get_iops_by_id()
+    {
+        $mock = new MockHandler([
+            new Response(200, [], json_encode([
+                'data' => [
+                    'id' => '22891f55-cd6b-11e9-89fb-005056a64a16',
+                    'name' => 'Gold',
+                    'limit' => 1500
+                ],
+                "meta" => []
+            ])),
+        ]);
+
+        $handler = HandlerStack::create($mock);
+        $guzzle = new Guzzle(['handler' => $handler]);
+
+        $id = '22891f55-cd6b-11e9-89fb-005056a64a16';
+
+        $client = new \UKFast\SDK\eCloud\Client($guzzle);
+        $iopsRecord = $client->iops()->getById($id);
+
+        $this->assertTrue($iopsRecord instanceof \UKFast\SDK\eCloud\Entities\Iops);
+        $this->assertEquals($id, $iopsRecord->id);
+        $this->assertEquals('Gold', $iopsRecord->name);
+        $this->assertEquals(1500, $iopsRecord->limit);
+    }
+}