Add ability to retrieve avatar for user (#403)

Author: Cary Cheng

boxsdk/object/user.py

@@ -177,6 +177,20 @@ def get_group_memberships(self, limit=None, offset=None, fields=None):
             return_full_pages=False,
         )
 
+    @api_call
+    def get_avatar(self):
+        """
+        Get the avatar for the User.
+
+        :returns:
+            Avatar content as bytes.
+        :rtype:
+            `bytes`
+        """
+        url = self.get_url('avatar')
+        response = self._session.get(url, expect_json_response=False)
+        return response.content
+
     @api_call
     def delete(self, notify=True, force=False):
         # pylint: disable=arguments-differ

docs/usage/user.md

@@ -10,6 +10,7 @@ Users represent an individual's account on Box.
 - [Get User Information](#get-user-information)
 - [Get the Current User's Information](#get-the-current-users-information)
 - [Create An Enterprise User](#create-an-enterprise-user)
+- [Get the Avatar for a User](#get-the-avatar-for-a-user)
 - [Create An App User](#create-an-app-user)
 - [Update User](#update-user)
 - [Delete User](#delete-user)
@@ -70,6 +71,18 @@ new_user = client.create_user('Dummy User', '[email protected]')
 
 [create_user]: https://box-python-sdk.readthedocs.io/en/latest/boxsdk.client.html#boxsdk.client.client.Client.create_user
 
+Get the Avatar for a User
+-------------------------
+
+To get the avatar for a user call the [`user.get_avatar()`][get_avatar] method with the [`User`][user_class] 
+object for the user you wish to retrieve an avatar for. This will return the user avatar to you in bytes.
+
+```python
+avatar = client.user('33333').get_avatar()
+```
+
+[get_avatar]: https://box-python-sdk.readthedocs.io/en/latest/boxsdk.user.html#boxsdk.user.User.get_avatar
+
 Create An App User
 ------------------
 

test/unit/object/test_user.py

@@ -200,3 +200,14 @@ def test_get_group_memberships(
         # pylint:disable=protected-access
         assert membership._session == mock_box_session
     mock_box_session.get.assert_called_once_with(expected_url, params={'offset': None})
+
+
+def test_get_user_avatar(mock_user, mock_box_session, mock_content_response):
+    expected_url = mock_user.get_url('avatar')
+    mock_box_session.get.return_value = mock_content_response
+    avatar_content = mock_user.get_avatar()
+    assert avatar_content == mock_content_response.content
+    mock_box_session.get.assert_called_once_with(
+        expected_url,
+        expect_json_response=False,
+    )