Merge pull request #172 from Kinto/171-fix-batch-patch

Fix patch methods in batch requests (fixes #171)

Author: leplatrem

CHANGELOG.rst

@@ -7,8 +7,9 @@ This document describes changes between each past release.
 9.2.0 (unreleased)
 ==================
 
-- Nothing changed yet.
+**Bug fixes**
 
+- Fix patch methods in batch requests (fixes #171)
 
 9.1.0 (2018-02-05)
 ==================

Makefile

@@ -1,4 +1,4 @@
-VIRTUALENV = virtualenv
+VIRTUALENV = virtualenv --python=python3.6
 VENV := $(shell echo $${VIRTUAL_ENV-.venv})
 PYTHON = $(VENV)/bin/python
 DEV_STAMP = $(VENV)/.dev_env_installed.stamp

kinto_http/batch.py

@@ -19,10 +19,16 @@ def __init__(self, client, batch_max_requests=0):
         self._results = []
 
     def request(self, method, endpoint, data=None, permissions=None,
-                headers=None):
+                payload=None, headers=None):
         # Store all the requests in a dict, to be read later when .send()
         # is called.
-        self.requests.append((method, endpoint, data, permissions, headers))
+        payload = payload or {}
+        if data is not None:
+            payload['data'] = data
+        if permissions is not None:
+            payload['permissions'] = permissions
+
+        self.requests.append((method, endpoint, payload, headers))
         # This is the signature of the session request.
         return defaultdict(dict), defaultdict(dict)
 
@@ -32,17 +38,13 @@ def reset(self):
 
     def _build_requests(self):
         requests = []
-        for (method, url, data, permissions, headers) in self.requests:
+        for (method, url, payload, headers) in self.requests:
             # Strip the prefix in batch requests.
             request = {
                 'method': method.upper(),
                 'path': url.replace('v1/', '')}
 
-            request['body'] = {}
-            if data is not None:
-                request['body']['data'] = data
-            if permissions is not None:
-                request['body']['permissions'] = permissions
+            request['body'] = payload
             if headers is not None:
                 request['headers'] = headers
             requests.append(request)

kinto_http/tests/test_client.py

@@ -25,6 +25,9 @@ def test_context_manager_works_as_expected(self):
         with self.client.batch(bucket='mozilla', collection='test') as batch:
             batch.create_record(id=1234, data={'foo': 'bar'})
             batch.create_record(id=5678, data={'bar': 'baz'})
+            batch.patch_record(id=5678, data={'bar': 'biz'})
+            changes = JSONPatch([{'op': 'add', 'location': 'foo', 'value': 'bar'}])
+            batch.patch_record(id=5678, changes=changes)
 
         self.session.request.assert_called_with(
             method='POST',
@@ -37,7 +40,15 @@ def test_context_manager_works_as_expected(self):
                 {'body': {'data': {'bar': 'baz'}},
                  'path': '/buckets/mozilla/collections/test/records/5678',
                  'method': 'PUT',
-                 'headers': {'If-None-Match': '*'}}]})
+                 'headers': {'If-None-Match': '*'}},
+                {'body': {'data': {'bar': 'biz'}},
+                 'path': '/buckets/mozilla/collections/test/records/5678',
+                 'method': 'PATCH',
+                 'headers': {'Content-Type': 'application/json'}},
+                {'body': [{'op': 'add', 'location': 'foo', 'value': 'bar'}],
+                 'path': '/buckets/mozilla/collections/test/records/5678',
+                 'method': 'PATCH',
+                 'headers': {'Content-Type': 'application/json-patch+json'}}]})
 
     def test_batch_raises_exception(self):
         # Make the next call to sess.request raise a 403.