Implemented wp.getUser, wp.getUsers, wp.getProfile, and wp.editProfile.

maxcutler · maxcutler · commit bb5d5012067f · 2012-12-02T21:35:42.000Z
diff --git a/docs/ref/methods.rst b/docs/ref/methods.rst
@@ -56,8 +56,11 @@ methods.users
 -------------
 
 .. automodule:: wordpress_xmlrpc.methods.users
-	
-	.. autoclass:: GetUserInfo()
+
+	.. autoclass:: GetUser(user_id[, fields])
+	.. autoclass:: GetUsers([filter, fields])
+	.. autoclass:: GetProfile()
+	.. autoclass:: EditProfile(user)
 	.. autoclass:: GetUsersBlogs()
 	.. autoclass:: GetAuthors()
 
diff --git a/docs/ref/wordpress.rst b/docs/ref/wordpress.rst
@@ -121,10 +121,18 @@ WordPressUser
 	Basic representation of a WordPress user.
 
 		* id
+		* username
+		* password
+		* roles
 		* nickname
 		* url
 		* first_name
 		* last_name
+		* registered
+		* bio
+		* email
+		* nicename
+		* display_name
 
 WordPressComment
 ----------------
diff --git a/tests/test_users.py b/tests/test_users.py
@@ -9,10 +9,45 @@
 class TestUsers(WordPressTestCase):
 
     @attr('users')
-    def test_get_user_info(self):
-        user = self.client.call(users.GetUserInfo())
+    def test_get_user(self):
+        user = self.client.call(users.GetUser(self.userid))
         self.assertTrue(isinstance(user, WordPressUser))
-        self.assertEqual(user.nickname, self.username)
+        self.assertEqual(user.username, self.username)
+
+    @attr('users')
+    def test_get_users(self):
+        user_list = self.client.call(users.GetUsers())
+        self.assert_list_of_classes(user_list, WordPressUser)
+        found = False
+        for user in user_list:
+            if user.id == self.userid:
+                found = True
+                break
+        self.assertTrue(found)
+
+    @attr('users')
+    def test_get_profile(self):
+        user = self.client.call(users.GetProfile())
+        self.assertTrue(isinstance(user, WordPressUser))
+        self.assertEqual(user.username, self.username)
+
+    @attr('users')
+    def test_edit_profile(self):
+        user = self.client.call(users.GetProfile())
+        self.assertTrue(isinstance(user, WordPressUser))
+        old_first_name = user.first_name
+        new_first_name = 'Foo bar'
+        user.first_name = new_first_name
+        result = self.client.call(users.EditProfile(user))
+        self.assertTrue(result)
+
+        # check that the value changed
+        user2 = self.client.call(users.GetProfile())
+        self.assertEqual(new_first_name, user2.first_name)
+
+        # cleanup
+        user.first_name = old_first_name
+        self.client.call(users.EditProfile(user))
 
     @attr('users')
     def test_get_user_blogs(self):
diff --git a/wordpress_xmlrpc/methods/users.py b/wordpress_xmlrpc/methods/users.py
@@ -2,7 +2,42 @@
 from wordpress_xmlrpc.wordpress import WordPressBlog, WordPressAuthor, WordPressUser
 
 
-class GetUserInfo(AuthenticatedMethod):
+class GetUsers(AuthenticatedMethod):
+    """
+    Retrieve list of users in the blog.
+
+    Parameters:
+        `filter`: optional `dict` of filters:
+            * `number`
+            * `offset`
+            * `role`
+
+        `fields`: optional `list` of fields to return. Specific fields, or groups 'basic' or 'all'.
+
+    Returns: `list` of :class:`WordPressUser` instances.
+    """
+    method_name = 'wp.getUsers'
+    optional_args = ('filter', 'fields')
+    results_class = WordPressUser
+
+
+class GetUser(AuthenticatedMethod):
+    """
+    Retrieve an individual user.
+
+    Parameters:
+        `user_id`: ID of the user
+        `fields`: (optional) `list` of fields to return. Specific fields, or groups 'basic' or 'all'.
+
+    Returns: :class:`WordPressUser` instance.
+    """
+    method_name = 'wp.getUser'
+    method_args = ('user_id',)
+    optional_args = ('fields',)
+    results_class = WordPressUser
+
+
+class GetProfile(AuthenticatedMethod):
     """
     Retrieve information about the connected user.
 
@@ -11,10 +46,28 @@ class GetUserInfo(AuthenticatedMethod):
 
     Returns: instance of :class:`WordPressUser` representing the user whose credentials are being used with the XML-RPC API.
     """
-    method_name = 'blogger.getUserInfo'
+    method_name = 'wp.getProfile'
     results_class = WordPressUser
 
 
+class EditProfile(AuthenticatedMethod):
+    """
+    Edit profile fields of the connected user.
+
+    Parameters:
+        `user`: `WordPressUser` instance.
+
+    Returns: `True` on successful edit.
+    """
+    method_name = 'wp.editProfile'
+    method_args = ('user',)
+
+
+class GetUserInfo(GetProfile):
+    """Alias for GetProfile for backwards compatibility"""
+    pass
+
+
 class GetUsersBlogs(AuthenticatedMethod):
     """
     Retrieve list of blogs that this user belongs to.
diff --git a/wordpress_xmlrpc/wordpress.py b/wordpress_xmlrpc/wordpress.py
@@ -170,11 +170,18 @@ def __str__(self):
 
 class WordPressUser(WordPressBase):
     definition = {
-        'id': 'userid',
-        'nickname': FieldMap('nickname', default=''),
+        'id': 'user_id',
+        'username': 'username',
+        'roles': 'roles',
+        'nickname': 'nickname',
         'url': 'url',
-        'first_name': 'firstname',
-        'last_name': 'lastname',
+        'first_name': 'first_name',
+        'last_name': 'last_name',
+        'registered': DateTimeFieldMap('registered'),
+        'bio': 'bio',
+        'email': 'email',
+        'nicename': 'nicename',
+        'display_name': 'display_name',
     }
 
     def __str__(self):
