Merge pull request #68 from vsham20/Issue_29

Rename the last_modified field to if_match (fixes #29)

Author: Natim

README.rst

@@ -204,7 +204,7 @@ Overwriting existing objects
 ----------------------------
 
 Most of the methods take a ``safe`` argument, which defaults to ``True``. If set
-to ``True`` and a ``last_modified`` field is present in the passed ``data``, then a
+to ``True`` and a ``if_match`` field is present in the passed ``data``, then a
 check will be added to the requests to ensure the record wasn't modified on
 the server side in the meantime.
 

kinto_client/__init__.py

@@ -118,12 +118,12 @@ def _paginated(self, endpoint, records=None, if_none_match=None, **kwargs):
                                        if_none_match=if_none_match)
         return records.values()
 
-    def _get_cache_headers(self, safe, data=None, last_modified=None):
+    def _get_cache_headers(self, safe, data=None, if_match=None):
         has_data = data is not None and data.get('last_modified')
-        if (last_modified is None and has_data):
-            last_modified = data['last_modified']
-        if safe and last_modified is not None:
-            return {'If-Match': utils.quote(last_modified)}
+        if (if_match is None and has_data):
+            if_match = data['last_modified']
+        if safe and if_match is not None:
+            return {'If-Match': utils.quote(if_match)}
         # else return None
 
     def _create_if_not_exists(self, resource, **kwargs):
@@ -165,9 +165,9 @@ def create_bucket(self, bucket=None, data=None, permissions=None,
         return resp
 
     def update_bucket(self, bucket=None, data=None, permissions=None,
-                      safe=True, last_modified=None, method='put'):
+                      safe=True, if_match=None, method='put'):
         endpoint = self._get_endpoint('bucket', bucket)
-        headers = self._get_cache_headers(safe, data, last_modified)
+        headers = self._get_cache_headers(safe, data, if_match)
         resp, _ = self.session.request(method, endpoint, data=data,
                                        permissions=permissions,
                                        headers=headers)
@@ -189,15 +189,15 @@ def get_bucket(self, bucket=None):
             raise BucketNotFound(bucket or self._bucket_name, e)
         return resp
 
-    def delete_bucket(self, bucket=None, safe=True, last_modified=None):
+    def delete_bucket(self, bucket=None, safe=True, if_match=None):
         endpoint = self._get_endpoint('bucket', bucket)
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 
-    def delete_buckets(self, safe=True, last_modified=None):
+    def delete_buckets(self, safe=True, if_match=None):
         endpoint = self._get_endpoint('buckets')
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 
@@ -226,9 +226,9 @@ def create_collection(self, collection=None, bucket=None,
 
     def update_collection(self, data=None, collection=None, bucket=None,
                           permissions=None, method='put',
-                          safe=True, last_modified=None):
+                          safe=True, if_match=None):
         endpoint = self._get_endpoint('collection', bucket, collection)
-        headers = self._get_cache_headers(safe, data, last_modified)
+        headers = self._get_cache_headers(safe, data, if_match)
         resp, _ = self.session.request(method, endpoint, data=data,
                                        permissions=permissions,
                                        headers=headers)
@@ -244,15 +244,15 @@ def get_collection(self, collection=None, bucket=None):
         return resp
 
     def delete_collection(self, collection=None, bucket=None,
-                          safe=True, last_modified=None):
+                          safe=True, if_match=None):
         endpoint = self._get_endpoint('collection', bucket, collection)
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 
-    def delete_collections(self, bucket=None, safe=True, last_modified=None):
+    def delete_collections(self, bucket=None, safe=True, if_match=None):
         endpoint = self._get_endpoint('collections', bucket)
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 
@@ -291,12 +291,12 @@ def create_record(self, data, id=None, collection=None, permissions=None,
 
     def update_record(self, data, id=None, collection=None, permissions=None,
                       bucket=None, safe=True, method='put',
-                      last_modified=None):
+                      if_match=None):
         id = id or data.get('id')
         if id is None:
             raise KeyError('Unable to update a record, need an id.')
         endpoint = self._get_endpoint('record', bucket, collection, id)
-        headers = self._get_cache_headers(safe, data, last_modified)
+        headers = self._get_cache_headers(safe, data, if_match)
         resp, _ = self.session.request(method, endpoint, data=data,
                                        headers=headers,
                                        permissions=permissions)
@@ -307,16 +307,16 @@ def patch_record(self, *args, **kwargs):
         return self.update_record(*args, **kwargs)
 
     def delete_record(self, id, collection=None, bucket=None,
-                      safe=True, last_modified=None):
+                      safe=True, if_match=None):
         endpoint = self._get_endpoint('record', bucket, collection, id)
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 
     def delete_records(self, collection=None, bucket=None,
-                       safe=True, last_modified=None):
+                       safe=True, if_match=None):
         endpoint = self._get_endpoint('records', bucket, collection)
-        headers = self._get_cache_headers(safe, last_modified=last_modified)
+        headers = self._get_cache_headers(safe, if_match=if_match)
         resp, _ = self.session.request('delete', endpoint, headers=headers)
         return resp['data']
 

kinto_client/tests/test_client.py

@@ -136,11 +136,11 @@ def test_patch_is_issued_on_patch(self):
             permissions={'read': ['natim']},
             headers=None)
 
-    def test_update_bucket_handles_last_modified(self):
+    def test_update_bucket_handles_if_match(self):
         self.client.update_bucket(
             'testbucket',
             data={'foo': 'bar'},
-            last_modified=1234)
+            if_match=1234)
         self.session.request.assert_called_with(
             'put',
             '/buckets/testbucket',
@@ -203,8 +203,8 @@ def test_delete_bucket_returns_the_contained_data(self):
         mock_response(self.session, data={'deleted': True})
         assert self.client.delete_bucket('bucket') == {'deleted': True}
 
-    def test_delete_bucket_handles_last_modified(self):
-        self.client.delete_bucket('mybucket', last_modified=1234)
+    def test_delete_bucket_handles_if_match(self):
+        self.client.delete_bucket('mybucket', if_match=1234)
         url = '/buckets/mybucket'
         headers = {'If-Match': '"1234"'}
         self.session.request.assert_called_with('delete', url, headers=headers)
@@ -282,11 +282,11 @@ def test_collection_update_issues_an_http_put(self):
             'put', url, data={'foo': 'bar'},
             permissions=mock.sentinel.permissions, headers=None)
 
-    def test_update_handles_last_modified(self):
+    def test_update_handles_if_match(self):
         self.client.update_collection(
             {'foo': 'bar'},
             collection='mycollection',
-            last_modified=1234)
+            if_match=1234)
 
         url = '/buckets/mybucket/collections/mycollection'
         headers = {'If-Match': '"1234"'}
@@ -317,11 +317,11 @@ def test_patch_collection_issues_an_http_patch(self):
             'patch', url, data={'key': 'secret'}, headers=None,
             permissions=None)
 
-    def test_patch_collection_handles_last_modified(self):
+    def test_patch_collection_handles_if_match(self):
         self.client.patch_collection(
             collection='mycollection',
             data={'key': 'secret'},
-            last_modified=1234)
+            if_match=1234)
 
         url = '/buckets/mybucket/collections/mycollection'
         headers = {'If-Match': '"1234"'}
@@ -366,7 +366,7 @@ def test_collection_delete_if_match(self):
         mock_response(self.session, data=data)
         deleted = self.client.delete_collection(
             'mycollection',
-            last_modified=1234)
+            if_match=1234)
         assert deleted == data
         url = '/buckets/mybucket/collections/mycollection'
         self.session.request.assert_called_with(
@@ -377,7 +377,7 @@ def test_collection_delete_if_match_not_included_if_not_safe(self):
         mock_response(self.session, data=data)
         deleted = self.client.delete_collection(
             'mycollection',
-            last_modified=1324,
+            if_match=1324,
             safe=False)
         assert deleted == data
         url = '/buckets/mybucket/collections/mycollection'
@@ -588,7 +588,7 @@ def test_record_delete_if_match(self):
             collection='mycollection',
             bucket='mybucket',
             id='1',
-            last_modified=1234)
+            if_match=1234)
         assert deleted == data
         url = '/buckets/mybucket/collections/mycollection/records/1'
         self.session.request.assert_called_with(
@@ -601,7 +601,7 @@ def test_record_delete_if_match_not_included_if_not_safe(self):
             collection='mycollection',
             bucket='mybucket',
             id='1',
-            last_modified=1234,
+            if_match=1234,
             safe=False)
         assert deleted == data
         url = '/buckets/mybucket/collections/mycollection/records/1'
@@ -618,11 +618,11 @@ def test_update_record_gets_the_id_from_data_if_exists(self):
             'put', '/buckets/mybucket/collections/mycollection/records/1',
             data={'id': 1, 'foo': 'bar'}, headers=None, permissions=None)
 
-    def test_update_record_handles_last_modified(self):
+    def test_update_record_handles_if_match(self):
         mock_response(self.session)
         self.client.update_record(
             bucket='mybucket', collection='mycollection',
-            data={'id': 1, 'foo': 'bar'}, last_modified=1234)
+            data={'id': 1, 'foo': 'bar'}, if_match=1234)
 
         headers = {'If-Match': '"1234"'}
         self.session.request.assert_called_with(