Merge pull request #490 from thedac/thedac/ip-ranges-available-ips

Enable available_ips for ip_ranges

Author: arthanson

pynetbox/models/ipam.py

@@ -22,6 +22,42 @@ def __str__(self):
         return str(self.address)
 
 
+class IpRanges(Record):
+    def __str__(self):
+        return str(self.display)
+
+    @property
+    def available_ips(self):
+        """Represents the ``available-ips`` detail endpoint.
+
+        Returns a DetailEndpoint object that is the interface for
+        viewing and creating IP addresses inside an ip range .
+
+        :returns: :py:class:`.DetailEndpoint`
+
+        :Examples:
+
+        >>> ip_range = nb.ipam.ip_ranges.get(24)
+        >>> ip_range.available_ips.list()
+        [10.0.0.1/24, 10.0.0.2/24, 10.0.0.3/24, 10.0.0.4/24, 10.0.0.5/24, ...]
+
+        To create a single IP:
+
+        >>> ip_range = nb.ipam.ip_ranges.get(24)
+        >>> ip_range.available_ips.create()
+        10.0.0.1/24
+
+
+        To create multiple IPs:
+
+        >>> ip_range = nb.ipam.ip_ranges.get(24)
+        >>> create = ip_range.available_ips.create([{} for i in range(2)])
+        >>> create
+        [10.0.0.2/24, 10.0.0.3/24]
+        """
+        return DetailEndpoint(self, "available-ips", custom_return=IpAddresses)
+
+
 class Prefixes(Record):
     def __str__(self):
         return str(self.prefix)

tests/unit/test_detailendpoint.py

@@ -9,6 +9,7 @@
 
 class DetailEndpointTestCase(unittest.TestCase):
     def test_detail_endpoint_create_single(self):
+        # Prefixes
         with patch(
             "pynetbox.core.query.Request._make_call",
             return_value={"id": 123, "prefix": "1.2.3.0/24"},
@@ -21,8 +22,22 @@ def test_detail_endpoint_create_single(self):
         ):
             ip_obj = prefix_obj.available_ips.create()
             self.assertEqual(ip_obj.address, "1.2.3.1/24")
+        # IP Ranges
+        with patch(
+            "pynetbox.core.query.Request._make_call",
+            return_value={"id": 321, "display": "1.2.4.1-254/24"},
+        ):
+            ip_range_obj = nb.ipam.ip_ranges.get(321)
+            self.assertEqual(ip_range_obj.display, "1.2.4.1-254/24")
+        with patch(
+            "pynetbox.core.query.Request._make_call",
+            return_value={"address": "1.2.4.2/24"},
+        ):
+            ip_obj = ip_range_obj.available_ips.create()
+            self.assertEqual(ip_obj.address, "1.2.4.2/24")
 
     def test_detail_endpoint_create_list(self):
+        # Prefixes
         with patch(
             "pynetbox.core.query.Request._make_call",
             return_value={"id": 123, "prefix": "1.2.3.0/24"},
@@ -36,3 +51,17 @@ def test_detail_endpoint_create_list(self):
             ip_list = prefix_obj.available_ips.create([{} for _ in range(2)])
             self.assertTrue(isinstance(ip_list, list))
             self.assertEqual(len(ip_list), 2)
+        # IP Ranges
+        with patch(
+            "pynetbox.core.query.Request._make_call",
+            return_value={"id": 321, "display": "1.2.4.1-254/24"},
+        ):
+            ip_range_obj = nb.ipam.ip_ranges.get(321)
+            self.assertEqual(ip_range_obj.display, "1.2.4.1-254/24")
+        with patch(
+            "pynetbox.core.query.Request._make_call",
+            return_value=[{"address": "1.2.4.2/24"}, {"address": "1.2.4.3/24"}],
+        ):
+            ip_list = ip_range_obj.available_ips.create([{} for _ in range(2)])
+            self.assertTrue(isinstance(ip_list, list))
+            self.assertEqual(len(ip_list), 2)