Stubbing out net IP availability integration

clwells · Aug 30, 2017 · Aug 30, 2017 · Aug 30, 2017 · Aug 31, 2017 · Sep 3, 2017
commit 929fead1167271e15cb3607a5962c3417bc20a42
diff --git a/src/Networking/v2/Api.php b/src/Networking/v2/Api.php
@@ -700,4 +700,25 @@ public function deleteLoadBalancerHealthMonitor() : array
             ]
         ];
     }
+
+    public function getNetworkIpAvailability() : array
+    {
+        return [
+            'method' => 'GET',
+            'path'   => $this->pathPrefix . '/network-ip-availability/{id}',
+            'params' => ['id' => $this->params->idPath()],
+        ];
+    }
+
+    public function getNetworkIpAvailabilities(): array
+    {
+        return [
+            'method' => 'GET',
+            'path'   => $this->pathPrefix . '/network-ip-availabilities',
+            'params' => [
+                'tenantId' => $this->params->queryTenantId()
+            ],
+        ];
+    }
+
 }
diff --git a/src/Networking/v2/Models/NetworkIpAvailability.php b/src/Networking/v2/Models/NetworkIpAvailability.php
@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace OpenStack\Networking\v2\Models;
+
+use OpenStack\Common\Resource\OperatorResource;
+use OpenStack\Common\Resource\HasWaiterTrait;
+use OpenStack\Common\Resource\Listable;
+use OpenStack\Common\Resource\Retrievable;
+
+/**
+ * Represents a Networking v2 Network.
+ *
+ * @property \OpenStack\Networking\v2\Api $api
+ */
+class NetworkIpAvailability extends OperatorResource implements Listable, Retrievable
+{
+    use HasWaiterTrait;
+
+    /** @var string */
+    public $networkId;
+
+    /** @var string */
+    public $networkName;
+
+    /** @var string */
+    public $tenantId;
+
+    /** @var string */
+    public $projectId;
+
+    /** @var int */
+    public $totalIps;
+
+    /** @var int */
+    public $usedIps;
+
+    /** @var array */
+    public $subnetIpAvailability;
+
+    protected $aliases = [
+        'network_id'             => 'networkId',
+        'network_name'           => 'networkName',
+        'tenant_id'              => 'tenantId',
+        'project_id'             => 'projectId',
+        'total_ips'              => 'totalIps',
+        'used_ips'               => 'usedIps',
+        'subnet_ip_availability' => 'subnetIpAvailability'
+    ];
+
+    protected $resourceKey = 'network_ip_availability';
+    protected $resourcesKey = 'network_ip_availabilities';
+    protected $markerKey = 'network_id';
+
+    /**
+     * {@inheritDoc}
+     */
+    public function retrieve()
+    {
+        $response = $this->execute($this->api->getNetworkIpAvailability(), ['newtork_id' => (string)$this->networkId]);
+        $this->populateFromResponse($response);
+    }
+}
diff --git a/src/Networking/v2/Service.php b/src/Networking/v2/Service.php
@@ -9,6 +9,7 @@
 use OpenStack\Networking\v2\Models\LoadBalancerMember;
 use OpenStack\Networking\v2\Models\LoadBalancerPool;
 use OpenStack\Networking\v2\Models\Network;
+use OpenStack\Networking\v2\Models\NetworkIpAvailability;
 use OpenStack\Networking\v2\Models\Pool;
 use OpenStack\Networking\v2\Models\Port;
 use OpenStack\Networking\v2\Models\Quota;
@@ -383,4 +384,31 @@ public function createLoadBalancerHealthMonitor(array $options): LoadBalancerHea
     {
         return $this->model(LoadBalancerHealthMonitor::class)->create($options);
     }
+
+    /**
+     * Retrieve a network IP availability object without calling the remote API. Any values provided in the array will populate the
+     * empty object, allowing you greater control without the expense of network transactions. To call the remote API
+     * and have the response populate the object, call {@see NetworkIpAvailabilities::retrieve}.
+     *
+     * @param string $network_id
+     *
+     * @return NetworkIpAvailability
+     */
+    public function getNetworkIpAvailability(string $network_id): NetworkIpAvailability
+    {
+        return $this->model(NetworkIpAvailability::class, ['network_id' => $network_id]);
+    }
+
+    /**
+     * List network IP availability(es)
+     *
+     * @param array $options {@see \OpenStack\Networking\v2\Api::getNetworkIpAvailabilities()
+     *
+     * @return \Generator
+     */
+    public function listNetworkIpAvailabilities(array $options = []): \Generator
+    {
+        return $this->model(NetworkIpAvailability::class)->enumerate($this->api->getNetworkIpAvailabilities(), $options);
+    }
+
 }