Fix StringIO on py3. Add documentation and missing changelog

docs/source/users.rst

@@ -137,6 +137,23 @@ A successful response to a PATCH request will be indicated by a :term:`204 No Co
 
 Any user is able to update their own properties and password (if allowed) by using the same request.
 
+The user portrait/avatar can also be updated using the same serialization as the file one:
+
+..  http:example:: curl httpie python-requests
+    :request: ../../src/plone/restapi/tests/http-examples/users_update_portrait.req
+
+A successful response to a PATCH request will be indicated by a :term:`204 No Content` response.
+Then asking for the user the portrait URL should be on the response:
+
+.. literalinclude:: ../../src/plone/restapi/tests/http-examples/users_update_portrait_get.resp
+   :language: http
+
+Adding the portrait via the @user endpoint does not scale it since it's assumed that the frontend will take care of it (resizing/cropping).
+If you still want that Plone to take care of the scaling using the default Plone behavior for portraits, you have to add the ``scale`` attribute to the request:
+
+..  http:example:: curl httpie python-requests
+    :request: ../../src/plone/restapi/tests/http-examples/users_update_portrait_scale.req
+
 Delete User
 -----------
 

news/701.feature

@@ -0,0 +1,2 @@
+- Add support for add/update user portraits (@user endpoint)
+  [sneridagh]

src/plone/restapi/services/users/update.py

@@ -6,7 +6,6 @@
 from Products.CMFCore.utils import getToolByName
 from Products.CMFPlone.utils import set_own_login_name
 from Products.PlonePAS.utils import scale_image
-from StringIO import StringIO
 from zope.component import getAdapter
 from zope.component.hooks import getSite
 from zope.interface import alsoProvides
@@ -164,7 +163,7 @@ def set_member_portrait(self, user, portrait):
         if portrait.get('scale', False):
             # Only scale if the scale (default Plone behavior) boolean is set
             # This should be handled by the core in the future
-            scaled, mimetype = scale_image(StringIO(data))
+            scaled, mimetype = scale_image(six.StringIO(data))
         else:
             # Normally, the scale and cropping is going to be handled in the
             # frontend

src/plone/restapi/tests/http-examples/users_update_portrait.req

@@ -0,0 +1,13 @@
+PATCH /plone/@users/noam HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0
+Content-Type: application/json
+
+{
+    "portrait": {
+        "content-type": "image/png",
+        "data": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=",
+        "encoding": "base64",
+        "filename": "image.png"
+    }
+}

src/plone/restapi/tests/http-examples/users_update_portrait.resp

@@ -0,0 +1,2 @@
+HTTP/1.1 204 No Content
+

src/plone/restapi/tests/http-examples/users_update_portrait_get.req

@@ -0,0 +1,13 @@
+GET /plone/@users/noam HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0
+Content-Type: application/json
+
+{
+    "portrait": {
+        "content-type": "image/png",
+        "data": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=",
+        "encoding": "base64",
+        "filename": "image.png"
+    }
+}

src/plone/restapi/tests/http-examples/users_update_portrait_get.resp

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "@id": "http://localhost:55001/plone/@users/noam", 
+  "description": null, 
+  "email": "noam.chomsky@example.com", 
+  "fullname": null, 
+  "home_page": null, 
+  "id": "noam", 
+  "location": null, 
+  "portrait": "http://localhost:55001/plone/portal_memberdata/portraits/noam", 
+  "roles": [
+    "Member"
+  ], 
+  "username": "noam"
+}

src/plone/restapi/tests/http-examples/users_update_portrait_scale.req

@@ -0,0 +1,14 @@
+PATCH /plone/@users/noam HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0
+Content-Type: application/json
+
+{
+    "portrait": {
+        "content-type": "image/png",
+        "data": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=",
+        "encoding": "base64",
+        "filename": "image.png",
+        "scale": true
+    }
+}

src/plone/restapi/tests/http-examples/users_update_portrait_scale.resp

@@ -0,0 +1,2 @@
+HTTP/1.1 204 No Content
+

src/plone/restapi/tests/test_documentation.py

@@ -847,6 +847,49 @@ def test_documentation_users_update(self):
         )
         save_request_and_response_for_docs('users_update', response)
 
+    def test_documentation_users_update_portrait(self):
+        payload = {
+            'portrait': {
+                'filename': 'image.png',
+                'encoding': 'base64',
+                'data': 'R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=',
+                'content-type': 'image/png'
+            }
+        }
+        api.user.create(
+            email='noam.chomsky@example.com',
+            username='noam'
+        )
+        transaction.commit()
+        response = self.api_session.patch('/@users/noam', json=payload)
+        transaction.commit()
+
+        response_get = self.api_session.get('/@users/noam', json=payload)
+
+        save_request_and_response_for_docs('users_update_portrait', response)
+        save_request_and_response_for_docs(
+            'users_update_portrait_get', response_get)
+
+    def test_documentation_users_update_portrait_with_scale(self):
+        payload = {
+            'portrait': {
+                'filename': 'image.png',
+                'encoding': 'base64',
+                'data': 'R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=',
+                'content-type': 'image/png',
+                'scale': True
+            }
+        }
+        api.user.create(
+            email='noam.chomsky@example.com',
+            username='noam'
+        )
+        transaction.commit()
+        response = self.api_session.patch('/@users/noam', json=payload)
+
+        save_request_and_response_for_docs(
+            'users_update_portrait_scale', response)
+
     def test_documentation_users_delete(self):
         properties = {
             'email': 'noam.chomsky@example.com',