X-Git-Url: http://gitweb.michael.orlitzky.com/?p=untangle-https-backup.git;a=blobdiff_plain;f=src%2Funtangle%2Funtangle.py;fp=src%2Funtangle%2Funtangle.py;h=6a972804f0fe0a1afe0523a108b2c4ecce009b7e;hp=09c5723c9c11a08a98dc250973716ec081ecdd3a;hb=b76e936f471c7c0c31652056fde8555ab3b913f2;hpb=1b7c4afc84bf55acef350fdc5479e7213c78eaa4

diff --git a/src/untangle/untangle.py b/src/untangle/untangle.py
index 09c5723..6a97280 100644
--- a/src/untangle/untangle.py
+++ b/src/untangle/untangle.py
@@ -5,7 +5,11 @@ import urllib.parse
 import urllib.request
 
 class Untangle:
-
+    """
+    This class wraps one instance of Untangle. It gets initialized with
+    some configuration information, and then provides the methods to
+    retreive a backup.
+    """
     def __init__(self, s):
         """
         Initialize this Untangle object with a ConfigParser section.
@@ -57,6 +61,10 @@ class Untangle:
 
 
     def login(self):
+        """
+        Perform the HTTPS request to log in to the Untangle web admin
+        UI. The resulting session cookie is stored by our ``self.opener``.
+        """
         login_path = 'auth/login?url=/setup/welcome.do&realm=Administrator'
         url = self.base_url + login_path
         post_vars = {'username': self.username, 'password': self.password }
@@ -65,6 +73,10 @@ class Untangle:
 
 
     def get_backup(self):
+        """
+        Version-agnostic get-me-a-backup method. Dispatches to the
+        actual implementation based on ``self.version``.
+        """
         if self.version == 9:
             return self.get_backup_v9()
         elif self.version == 11:
@@ -72,6 +84,13 @@ class Untangle:
 
 
     def get_backup_v9(self):
+        """
+        Retrieve a backup from Untangle version 9. This requires two
+        requests; the first just hits the page, and the second actually
+        retrieves the backup file.
+
+        Returns the binary HTTPS response (i.e. the file).
+        """
         url = self.base_url + '/webui/backup'
         post_vars = {'action': 'requestBackup'}
         post_data = urllib.parse.urlencode(post_vars).encode('ascii')
@@ -83,6 +102,11 @@ class Untangle:
 
 
     def get_backup_v11(self):
+        """
+        Retrieve a backup from Untangle version 11.
+
+        Returns the binary HTTPS response (i.e. the file).
+        """
         url = self.base_url + '/webui/download?type=backup'
         post_vars = {'type': 'backup'}
         post_data = urllib.parse.urlencode(post_vars).encode('ascii')