Add flavors extra-specs

src/Common/Api/Parameter.php

@@ -151,7 +151,7 @@ private function stockItemSchema(array $data)
     private function stockProperties(array $data)
     {
         if (isset($data['properties'])) {
-            if ($this->name && stripos($this->name, 'metadata') !== false) {
+            if ($this->name && (stripos($this->name, 'metadata') !== false || stripos($this->name, 'extraSpecs') !== false)) {
                 $this->properties = new Parameter($data['properties']);
             } else {
                 foreach ($data['properties'] as $name => $property) {
@@ -247,7 +247,7 @@ private function validateObject($userValues)
      */
     private function getNestedProperty($key): Parameter
     {
-        if ($this->name && stripos($this->name, 'metadata') !== false && $this->properties instanceof Parameter) {
+        if ($this->name && (stripos($this->name, 'metadata') !== false || stripos($this->name, 'extraSpecs') !== false) && $this->properties instanceof Parameter) {
             return $this->properties;
         } elseif (isset($this->properties[$key])) {
             return $this->properties[$key];

src/Common/Resource/HasExtraSpecs.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace OpenStack\Common\Resource;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface HasExtraSpecs
+{
+    /**
+     * Retrieves extra specs for the resource in the form of an associative array or hash. Each key represents the
+     * extra specs item's name, and each value represents extra specs item's remote value.
+     *
+     * @return array
+     */
+    public function getExtraSpecs(): array;
+
+    /**
+     * Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if
+     * the resource has this extra specs already set:
+     *
+     *  Foo: val1
+     *  Bar: val2
+     *
+     * and mergeExtraSpecs(['Foo' => 'val3', 'Baz' => 'val4']); is called, then the resource will have the following
+     * extra specs:
+     *
+     *  Foo: val3
+     *  Bar: val2
+     *  Baz: val4
+     *
+     * You will notice that any extra specs items which are not specified in the call are preserved.
+     *
+     * @param array $extra specs The new extra specs items
+     *
+     * @return void
+     */
+    public function mergeExtraSpecs(array $extraSpecs);
+
+    /**
+     * Deletes an extra spec, by key, for a flavor, by ID.
+     *
+     * @param string $extra specs key
+     *
+     * @return void
+     */
+    public function deleteExtraSpec($extraSpecs);
+
+    /**
+     * Extracts extra specs from a response object and returns it in the form of an associative array.
+     *
+     * @param ResponseInterface $response
+     *
+     * @return array
+     */
+    public function parseExtraSpecs(ResponseInterface $response): array;
+}

src/Compute/v2/Api.php

@@ -84,6 +84,39 @@ public function deleteFlavor(): array
         ];
     }
 
+    public function getFlavorExtraSpecs(): array
+    {
+        return [
+            'method' => 'GET',
+            'path'   => 'flavors/{id}/os-extra_specs',
+            'params' => ['id' => $this->params->urlId('flavor')]
+        ];
+    }
+
+    public function postFlavorExtraSpecs(): array
+    {
+        return [
+            'method' => 'POST',
+            'path'   => 'flavors/{id}/os-extra_specs',
+            'params' => [
+                'id'       => $this->params->urlId('flavor'),
+                'extraSpecs' => $this->params->extraSpecs()
+            ]
+        ];
+    }
+
+    public function deleteFlavorExtraSpecKey(): array
+    {
+        return [
+            'method' => 'DELETE',
+            'path'   => 'flavors/{id}/os-extra_specs/{key}',
+            'params' => [
+                'id'  => $this->params->urlId('flavor'),
+                'key' => $this->params->key(),
+            ]
+        ];
+    }
+
     public function getImages(): array
     {
         return [

src/Compute/v2/Models/Flavor.php

@@ -4,16 +4,19 @@
 
 use OpenStack\Common\Resource\Creatable;
 use OpenStack\Common\Resource\Deletable;
+use OpenStack\Common\Resource\HasExtraSpecs;
 use OpenStack\Common\Resource\OperatorResource;
 use OpenStack\Common\Resource\Listable;
 use OpenStack\Common\Resource\Retrievable;
+use OpenStack\Common\Transport\Utils;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Represents a Compute v2 Flavor.
  *
  * @property \OpenStack\Compute\v2\Api $api
  */
-class Flavor extends OperatorResource implements Listable, Retrievable, Creatable, Deletable
+class Flavor extends OperatorResource implements Listable, Retrievable, Creatable, Deletable, HasExtraSpecs
 {
     /** @var int */
     public $disk;
@@ -36,15 +39,25 @@ class Flavor extends OperatorResource implements Listable, Retrievable, Creatabl
     /** @var array */
     public $links;
 
+    /** @var array */
+    public $extraSpecs = [];
+
     protected $resourceKey = 'flavor';
     protected $resourcesKey = 'flavors';
 
+    public function populateFromResponse(ResponseInterface $response): self
+    {
+        parent::populateFromResponse($response);
+        $this->extraSpecs = $this->parseExtraSpecs($response);
+        return $this;
+    }
+
     /**
      * {@inheritDoc}
      */
     public function retrieve()
     {
-        $response = $this->execute($this->api->getFlavor(), ['id' => (string) $this->id]);
+        $response = $this->execute($this->api->getFlavor(), ['id' => (string)$this->id]);
         $this->populateFromResponse($response);
     }
 
@@ -62,6 +75,29 @@ public function create(array $userOptions): Creatable
      */
     public function delete()
     {
-        $this->execute($this->api->deleteFlavor(), ['id' => (string) $this->id]);
+        $this->execute($this->api->deleteFlavor(), ['id' => (string)$this->id]);
+    }
+
+    public function getExtraSpecs(): array
+    {
+        $response = $this->executeWithState($this->api->getFlavorExtraSpecs());
+        $this->extraSpecs = $this->parseExtraSpecs($response);
+        return $this->extraSpecs;
+    }
+
+    public function mergeExtraSpecs(array $extraSpecs)
+    {
+        $this->execute($this->api->postFlavorExtraSpecs(), ['id' => $this->id, 'extraSpecs' => $extraSpecs]);
+    }
+
+    public function deleteExtraSpec($key)
+    {
+        $this->execute($this->api->deleteFlavorExtraSpecKey(), ['id' => $this->id, 'key' => $key]);
+    }
+
+    public function parseExtraSpecs(ResponseInterface $response): array
+    {
+        $json = Utils::jsonDecode($response);
+        return isset($json['extra_specs']) ? $json['extra_specs'] : [];
     }
 }

src/Compute/v2/Params.php

@@ -146,6 +146,23 @@ public function metadata(): array
         ];
     }
 
+    public function extraSpecs(): array
+    {
+        return [
+            'type'        => self::OBJECT_TYPE,
+            'sentAs'      => 'extra_specs',
+            'location'    => self::JSON,
+            'required'    => true,
+            'description' => 'An arbitrary key/value pairing that will be used for extra specs.',
+            'properties'  => [
+                'type'        => self::STRING_TYPE,
+                'description' => <<<TYPEOTHER
+The value being set for your key. Bear in mind that "key" is just an example, you can name it anything.
+TYPEOTHER
+            ]
+        ];
+    }
+
     public function personality(): array
     {
         return [