Address PR review feedback - rename methods, consolidate export logic, update docs and version to 0.28.0

Author: soniafrancisNS1

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.28.0 (TBD)
+
+ENHANCEMENTS:
+* Add zone export functionality to export zones in BIND format for backup/migration
+
 ## 0.27.1 (December 3rd, 2025)
 
 FIXED:

examples/zone-export.py

@@ -15,11 +15,21 @@
 # to load an alternate configuration file:
 # api = NS1(configFile='/etc/ns1/api.json')
 
-# export a zone to BIND format
+# Export a zone to BIND format
+# The export() method will:
+# 1. Initiate the export job
+# 2. Poll the status until complete or failed
+# 3. Download and return the zone file content
 zone = api.loadZone("example.com")
+
+print("Exporting zone example.com...")
 zone_file = zone.export()
+print("Export complete!")
 print(zone_file)
 
-# save to a file
-with open("example.com.zone", "w") as f:
+# Save to a file
+with open("example.com.txt", "w") as f:
     f.write(zone_file)
+print("Zone file saved to example.com.txt")
+
+# Made with Bob

ns1/__init__.py

@@ -5,7 +5,7 @@
 #
 from .config import Config
 
-version = "0.27.1"
+version = "0.28.0"
 
 
 class NS1:

ns1/rest/zones.py

@@ -188,45 +188,45 @@ def delete_version(self, zone, version_id, callback=None, errback=None):
             errback=errback,
         )
 
-    def export(self, zone, callback=None, errback=None):
+    def initiate_zonefile_export(self, zone, callback=None, errback=None):
         """
-        Export zone as BIND-compatible zone file.
+        Initiate zone export job.
 
         :param str zone: zone name
-        :return: zone file content as string
+        :return: export status response
         """
         return self._make_request(
-            "GET",
-            f"{self.ROOT}/{zone}/export",
+            "PUT",
+            f"export/zonefile/{zone}",
+            body={},
             callback=callback,
             errback=errback,
         )
 
-    def initiate_export(self, zone, callback=None, errback=None):
+    def status_zonefile_export(self, zone, callback=None, errback=None):
         """
-        Initiate zone export job.
+        Check zone export status.
 
         :param str zone: zone name
         :return: export status response
         """
         return self._make_request(
-            "PUT",
-            f"export/zonefile/{zone}",
-            body={},
+            "GET",
+            f"export/zonefile/{zone}/status",
             callback=callback,
             errback=errback,
         )
 
-    def export_status(self, zone, callback=None, errback=None):
+    def get_zonefile_export(self, zone, callback=None, errback=None):
         """
-        Check zone export status.
+        Download the exported zone file in BIND-compatible format.
 
         :param str zone: zone name
-        :return: export status response
+        :return: zone file content as string
         """
         return self._make_request(
             "GET",
-            f"export/zonefile/{zone}/status",
+            f"{self.ROOT}/{zone}/export",
             callback=callback,
             errback=errback,
         )

ns1/zones.py

@@ -288,36 +288,49 @@ def usage(self, callback=None, errback=None, **kwargs):
             zone=self.zone, callback=callback, errback=errback, **kwargs
         )
 
-    def export(self, callback=None, errback=None):
+    def export(self, callback=None, errback=None, timeout=300, poll_interval=2):
         """
         Export zone as a BIND-compatible zone file.
+        
+        This method initiates the export, polls the status until complete or failed,
+        and downloads the zone file.
 
         :param callback: optional callback
         :param errback: optional error callback
+        :param int timeout: maximum time to wait for export completion in seconds (default: 300)
+        :param int poll_interval: time between status checks in seconds (default: 2)
         :return: zone file content as string
+        :raises ZoneException: if export fails or times out
         """
-        return self._rest.export(self.zone, callback=callback, errback=errback)
+        import time
 
-    def initiate_export(self, callback=None, errback=None):
-        """
-        Initiate zone export job.
+        # Initiate the export
+        self._rest.initiate_zonefile_export(self.zone)
 
-        :param callback: optional callback
-        :param errback: optional error callback
-        :return: export status response
-        """
-        return self._rest.initiate_export(
-            self.zone, callback=callback, errback=errback
-        )
+        # Poll the status until complete or failed
+        start_time = time.time()
+        while True:
+            if time.time() - start_time > timeout:
+                raise ZoneException(
+                    f"Zone export timed out after {timeout} seconds"
+                )
 
-    def export_status(self, callback=None, errback=None):
-        """
-        Check zone export status.
+            status_response = self._rest.status_zonefile_export(self.zone)
+            status = status_response.get("status")
 
-        :param callback: optional callback
-        :param errback: optional error callback
-        :return: export status response
-        """
-        return self._rest.export_status(
+            if status == "COMPLETE":
+                break
+            elif status == "FAILED":
+                error_msg = status_response.get("message", "Unknown error")
+                raise ZoneException(f"Zone export failed: {error_msg}")
+
+            time.sleep(poll_interval)
+
+        # Download the zone file
+        zone_file = self._rest.get_zonefile_export(
             self.zone, callback=callback, errback=errback
         )
+        
+        if callback:
+            return callback(zone_file)
+        return zone_file