Merge pull request #2 from harlev/api_key

WIP: Add support for api_key in V2

Author: harlev

README.md

@@ -63,8 +63,26 @@ print(jb.delete(MY_BOX_ID, query="age:=23"))
 
 # delete records
 jb.delete(MY_BOX_ID, record_ids[1])
+
+# write to a private box
+MY_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")
+api_key = jb.get_new_api_key()
+result = jb.write(data, MY_PRIVATE_BOX_ID, api_key=api_key)
+record_id = jb.get_record_id(result)
+
+# update a private box
+data = {"name": "David", "age": 35}
+jb.update(data, MY_PRIVATE_BOX_ID, record_id, api_key=api_key)
+
+# delete a private box
+jb.delete(MY_PRIVATE_BOX_ID, record_id, api_key=api_key)
 ```
 
+## Private Box
+Add `api_key` to write/update/delete as shown above.  
+read is always accessible, even with out an `api_key`.  
+A valid and unique `api_key` can be generated using `get_new_api_key()`
+
 ## Query Params
 As supported (and documented) by https://github.com/vasanthv/jsonbox
 

examples/example.py

@@ -48,4 +48,17 @@
 # delete records
 jb.delete(MY_BOX_ID, record_ids[1])
 
+# write to a private box
+MY_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")
+api_key = jb.get_new_api_key()
+result = jb.write(data, MY_PRIVATE_BOX_ID, api_key=api_key)
+record_id = jb.get_record_id(result)
+
+# update a private box
+data = {"name": "David", "age": 35}
+jb.update(data, MY_PRIVATE_BOX_ID, record_id, api_key=api_key)
+
+# delete a private box
+jb.delete(MY_PRIVATE_BOX_ID, record_id, api_key=api_key)
+
 

jsonbox.py

@@ -1,4 +1,5 @@
 import requests
+import uuid
 from six.moves.urllib import parse
 
 
@@ -45,6 +46,10 @@ def get_record_id(self, data):
         else:
             return data[self.RECORD_ID_KEY]
 
+    @staticmethod
+    def get_new_api_key():
+        return str(uuid.uuid4())
+
     def read(self,
              box_id,
              collection_or_record=None,
@@ -57,40 +62,51 @@ def read(self,
         response = requests.get(url)
         return self._check_response(response)
 
-    def write(self, data, box_id, collection=None):
+    def write(self, data, box_id, collection=None, api_key=None):
         url = self._get_url(box_id, collection)
 
-        response = requests.post(url, json=data)
+        headers = self._get_headers(api_key)
+
+        response = requests.post(url, json=data, headers=headers)
         return self._check_response(response)
 
-    def update(self, data, box_id, record_id):
+    def _get_headers(self, api_key):
+        headers = None
+        if api_key:
+            headers = {"x-api-key": api_key}
+        return headers
+
+    def update(self, data, box_id, record_id, api_key=None):
         url = self._get_url(box_id, record_id)
+        headers = self._get_headers(api_key)
 
-        response = requests.put(url, json=data)
+        response = requests.put(url, json=data, headers=headers)
         return self._check_response(response)
 
-    def delete(self, box_id, record_ids=None, query=None):
+    def delete(self, box_id, record_ids=None, query=None, api_key=None):
         if record_ids:
             if isinstance(record_ids, list):
                 result = []
                 for record_id in record_ids:
                     result.append(self._delete_one(box_id, record_id))
                 return result
             else:
-                return self._delete_one(box_id, record_ids)
+                return self._delete_one(box_id, record_ids, api_key=api_key)
         elif query:
-            return self._delete_query(box_id, query)
+            return self._delete_query(box_id, query, api_key=api_key)
 
-    def _delete_query(self, box_id, query):
+    def _delete_query(self, box_id, query, api_key=None):
         url = self._get_url(box_id, query=query)
+        headers = self._get_headers(api_key)
 
-        response = requests.delete(url)
+        response = requests.delete(url, headers=headers)
         return self._check_response(response)
 
-    def _delete_one(self, box_id, record_id):
+    def _delete_one(self, box_id, record_id, api_key=None):
         url = self._get_url(box_id, record_id)
+        headers = self._get_headers(api_key)
 
-        response = requests.delete(url)
+        response = requests.delete(url, headers=headers)
         return self._check_response(response)
 
     def _check_response(self, response):

tests/test_jsonbin.py

@@ -3,6 +3,8 @@
 from jsonbox import JsonBox
 
 TEST_BOX_ID = str(uuid.uuid4()).replace("-", "_")
+TEST_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")
+TEST_PRIVATE_BOX_ID_FAIL = str(uuid.uuid4()).replace("-", "_")
 TEST_COLLECTION_ID = "collection_427453"
 TEST_RECORD_ID = "test_sjdgfygsf2347623564twfgyu"
 TEST_DATA_KEY_1 = "gjsfdjghdjs"
@@ -105,6 +107,58 @@ def test_write_box(self):
         self.assertIsNotNone(json_data)
         self.assertEqual(json_data[TEST_DATA_KEY_1], TEST_DATA_VALUE_1)
 
+    def test_write_box_api_key(self):
+        data = {
+            TEST_DATA_KEY_1: TEST_DATA_VALUE_1
+        }
+        api_key = self.jb.get_new_api_key()
+        json_data = self.jb.write(data, TEST_PRIVATE_BOX_ID, api_key=api_key)
+        self.assertIsNotNone(json_data)
+        self.assertEqual(json_data[TEST_DATA_KEY_1], TEST_DATA_VALUE_1)
+
+        record_id = self.jb.get_record_id(json_data)
+
+        json_data = self.jb.read(TEST_PRIVATE_BOX_ID, record_id)
+        self.assertIsNotNone(json_data)
+        self.assertEqual(json_data[TEST_DATA_KEY_1], TEST_DATA_VALUE_1)
+
+        data = {
+            TEST_DATA_KEY_2: TEST_DATA_VALUE_2
+        }
+        self.jb.update(data, TEST_PRIVATE_BOX_ID, record_id, api_key=api_key)
+
+        json_data = self.jb.read(TEST_PRIVATE_BOX_ID, record_id)
+        self.assertIsNotNone(json_data)
+        self.assertEqual(json_data[TEST_DATA_KEY_2], TEST_DATA_VALUE_2)
+
+        json_data = self.jb.delete(TEST_PRIVATE_BOX_ID, record_id, api_key=api_key)
+        self.assertIsNotNone(json_data)
+
+        self.assertRaises(ValueError, self.jb.read, TEST_PRIVATE_BOX_ID, record_id)
+
+    def test_write_box_api_key_fail(self):
+        data = {
+            TEST_DATA_KEY_1: TEST_DATA_VALUE_1
+        }
+        api_key = self.jb.get_new_api_key()
+        json_data = self.jb.write(data, TEST_PRIVATE_BOX_ID_FAIL, api_key=api_key)
+        self.assertIsNotNone(json_data)
+        self.assertEqual(json_data[TEST_DATA_KEY_1], TEST_DATA_VALUE_1)
+
+        record_id = self.jb.get_record_id(json_data)
+
+        json_data = self.jb.read(TEST_PRIVATE_BOX_ID_FAIL, record_id)
+        self.assertIsNotNone(json_data)
+        self.assertEqual(json_data[TEST_DATA_KEY_1], TEST_DATA_VALUE_1)
+
+        data = {
+            TEST_DATA_KEY_2: TEST_DATA_VALUE_2
+        }
+        self.assertRaises(ValueError, self.jb.update, data, TEST_PRIVATE_BOX_ID_FAIL, record_id)
+
+        self.assertRaises(ValueError, self.jb.delete, TEST_PRIVATE_BOX_ID_FAIL, record_id)
+
+
     def test_write_box_collection(self):
         data = {
             TEST_DATA_KEY_1: TEST_DATA_VALUE_1