revise storage passwords create() and docstrings

Author: Shakeel Mohamed

splunklib/client.py

@@ -1673,7 +1673,6 @@ def __len__(self):
 
 class StoragePassword(Entity):
     """This class contains a storage password.
-
     """
     def __init__(self, service, path, **kwargs):
         state = kwargs.get('state', None)
@@ -1701,7 +1700,6 @@ def username(self):
 class StoragePasswords(Collection):
     """This class provides access to the storage passwords from this Splunk
     instance. Retrieve this collection using :meth:`Service.storage_passwords`.
-
     """
     def __init__(self, service):
         if service.namespace.owner == '-' or service.namespace.app == '-':
@@ -1711,13 +1709,12 @@ def __init__(self, service):
     def create(self, password, username, realm=None):
         """ Creates a storage password.
 
-        The identifier can be passed in through the username parameter as
-        <username> or <realm>:<username>, but the preferred way is by
-        passing in the username and realm parameters.
+        A `StoragePassword` can be identified by <username>, or by <realm>:<username> if the
+        optional realm parameter is also provided.
 
         :param password: The password for the credentials - this is the only part of the credentials that will be stored securely.
         :type name: ``string``
-        :param username: The username for the credentials, or <realm>:<username> if the realm parameter is omitted.
+        :param username: The username for the credentials.
         :type name: ``string``
         :param realm: The credential realm. (optional)
         :type name: ``string``
@@ -1727,7 +1724,10 @@ def create(self, password, username, realm=None):
         if not isinstance(username, basestring):
             raise ValueError("Invalid name: %s" % repr(username))
 
-        response = self.post(password=password, realm=realm, name=username)
+        if realm is None:
+            response = self.post(password=password, name=username)
+        else:
+            response = self.post(password=password, realm=realm, name=username)
 
         if response.status != 201:
             raise ValueError("Unexpected status code %s returned from creating a stanza" % response.status)
@@ -1737,8 +1737,9 @@ def create(self, password, username, realm=None):
         storage_password = StoragePassword(self.service, self._entity_path(state), state=state, skip_refresh=True)
 
         return storage_password
-
-    """Delete a storage password by username and/or realm.
+    
+    def delete(self, username, realm=None):
+        """Delete a storage password by username and/or realm.
 
         The identifier can be passed in through the username parameter as
         <username> or <realm>:<username>, but the preferred way is by
@@ -1748,9 +1749,9 @@ def create(self, password, username, realm=None):
         :type name: ``string``
         :param realm: The credential realm. (optional)
         :type name: ``string``
-
-    """
-    def delete(self, username, realm=None):
+        :return: The `StoragePassword` collection.
+        :rtype: ``self``
+        """
         if realm is None:
             # This case makes the username optional, so
             # the full name can be passed in as realm.

tests/test_storage_passwords.py

@@ -49,7 +49,7 @@ def test_create_norealm(self):
         start_count = len(self.storage_passwords)
         username = testlib.tmpname()
 
-        p = self.storage_passwords.create("changeme", username, "")
+        p = self.storage_passwords.create("changeme", username)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, None)
         self.assertEqual(p.username, username)
@@ -106,7 +106,7 @@ def test_read(self):
         start_count = len(self.storage_passwords)
         username = testlib.tmpname()
 
-        p = self.storage_passwords.create("changeme", username, "")
+        p = self.storage_passwords.create("changeme", username)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
 
         for sp in self.storage_passwords: