Commit 515e4d6

authored

Merge pull request #3 from harlev/meta

Support metadata read URL

2 parents af9b8b1 + 5f9646f commit 515e4d6Copy full SHA for 515e4d6

File tree

+39

-13

lines changed

+39

-13

lines changed

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -14,11 +14,10 @@ Python wrapper for https://jsonbox.io (with support for V2 features)`
`14`	`14`
`15`	`15`	`## Usage`
`16`	`16`	```python
`17`		`-import uuid`
`18`	`17`	`from jsonbox import JsonBox`
`19`	`18`
`20`	`19`	`# generate unique box id`
`21`		`-MY_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
	`20`	`+MY_BOX_ID = JsonBox.get_new_box_id()`
`22`	`21`
`23`	`22`	`# create instance`
`24`	`23`	`jb = JsonBox()`
`@@ -37,6 +36,9 @@ print(jb.read(MY_BOX_ID, record_ids[0]))`
`37`	`36`	`# read all records in box`
`38`	`37`	`print(jb.read(MY_BOX_ID))`
`39`	`38`
	`39`	`+# get metadata for box`
	`40`	`+print(jb.get_meta(MY_BOX_ID))`
	`41`	`+`
`40`	`42`	`# read all records in box with sort`
`41`	`43`	`print(jb.read(MY_BOX_ID, sort_by="age"))`
`42`	`44`
`@@ -65,7 +67,7 @@ print(jb.delete(MY_BOX_ID, query="age:=23"))`
`65`	`67`	`jb.delete(MY_BOX_ID, record_ids[1])`
`66`	`68`
`67`	`69`	`# write to a private box`
`68`		`-MY_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
	`70`	`+MY_PRIVATE_BOX_ID = JsonBox.get_new_box_id()`
`69`	`71`	`api_key = jb.get_new_api_key()`
`70`	`72`	`result = jb.write(data, MY_PRIVATE_BOX_ID, api_key=api_key)`
`71`	`73`	`record_id = jb.get_record_id(result)`

Lines changed: 5 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,7 @@`
`1`		`-import uuid`
`2`	`1`	`from jsonbox import JsonBox`
`3`	`2`
`4`	`3`	`# generate unique box id`
`5`		`-MY_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
	`4`	`+MY_BOX_ID = JsonBox.get_new_box_id()`
`6`	`5`
`7`	`6`	`# create instance`
`8`	`7`	`jb = JsonBox()`
`@@ -21,6 +20,9 @@`
`21`	`20`	`# read all records in box`
`22`	`21`	`print(jb.read(MY_BOX_ID))`
`23`	`22`
	`23`	`+# get metadata for box`
	`24`	`+print(jb.get_meta(MY_BOX_ID))`
	`25`	`+`
`24`	`26`	`# read all records in box with sort`
`25`	`27`	`print(jb.read(MY_BOX_ID, sort_by="age"))`
`26`	`28`
`@@ -49,7 +51,7 @@`
`49`	`51`	`jb.delete(MY_BOX_ID, record_ids[1])`
`50`	`52`
`51`	`53`	`# write to a private box`
`52`		`-MY_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
	`54`	`+MY_PRIVATE_BOX_ID = JsonBox.get_new_box_id()`
`53`	`55`	`api_key = jb.get_new_api_key()`
`54`	`56`	`result = jb.write(data, MY_PRIVATE_BOX_ID, api_key=api_key)`
`55`	`57`	`record_id = jb.get_record_id(result)`
`@@ -60,5 +62,3 @@`
`60`	`62`
`61`	`63`	`# delete a private box`
`62`	`64`	`jb.delete(MY_PRIVATE_BOX_ID, record_id, api_key=api_key)`
`63`		`-`
`64`		`-`

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,11 @@ def _get_url(self,`
`40`	`40`
`41`	`41`	`return url`
`42`	`42`
	`43`	`+ def _get_meta_url(self, box_id):`
	`44`	`+ url = "{0}/_meta/{1}".format(self.service_host, box_id)`
	`45`	`+`
	`46`	`+ return url`
	`47`	`+`
`43`	`48`	`def get_record_id(self, data):`
`44`	`49`	`if isinstance(data, list):`
`45`	`50`	`return [item[self.RECORD_ID_KEY] for item in data]`
`@@ -50,6 +55,10 @@ def get_record_id(self, data):`
`50`	`55`	`def get_new_api_key():`
`51`	`56`	`return str(uuid.uuid4())`
`52`	`57`
	`58`	`+ @staticmethod`
	`59`	`+ def get_new_box_id():`
	`60`	`+ return str(uuid.uuid4()).replace("-", "_")`
	`61`	`+`
`53`	`62`	`def read(self,`
`54`	`63`	`box_id,`
`55`	`64`	`collection_or_record=None,`
`@@ -62,6 +71,12 @@ def read(self,`
`62`	`71`	`response = requests.get(url)`
`63`	`72`	`return self._check_response(response)`
`64`	`73`
	`74`	`+ def get_meta(self, box_id):`
	`75`	`+ url = self._get_meta_url(box_id)`
	`76`	`+`
	`77`	`+ response = requests.get(url)`
	`78`	`+ return self._check_response(response)`
	`79`	`+`
`65`	`80`	`def write(self, data, box_id, collection=None, api_key=None):`
`66`	`81`	`url = self._get_url(box_id, collection)`
`67`	`82`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`url='https://github.com/harlev/jsonbox-python',`
`7`	`7`	`author="Ron Harlev",`
`8`	`8`	`author_email="harlev@gmail.com",`
`9`		`- version='1.1.0',`
	`9`	`+ version='1.2.1',`
`10`	`10`	`packages=['.'],`
`11`	`11`	`license='MIT',`
`12`	`12`	`long_description=open('README.md').read(),`

Lines changed: 13 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,9 @@`
`1`	`1`	`import unittest`
`2`		`-import uuid`
`3`	`2`	`from jsonbox import JsonBox`
`4`	`3`
`5`		`-TEST_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
`6`		`-TEST_PRIVATE_BOX_ID = str(uuid.uuid4()).replace("-", "_")`
`7`		`-TEST_PRIVATE_BOX_ID_FAIL = str(uuid.uuid4()).replace("-", "_")`
	`4`	`+TEST_BOX_ID = JsonBox.get_new_box_id()`
	`5`	`+TEST_PRIVATE_BOX_ID = JsonBox.get_new_box_id()`
	`6`	`+TEST_PRIVATE_BOX_ID_FAIL = JsonBox.get_new_box_id()`
`8`	`7`	`TEST_COLLECTION_ID = "collection_427453"`
`9`	`8`	`TEST_RECORD_ID = "test_sjdgfygsf2347623564twfgyu"`
`10`	`9`	`TEST_DATA_KEY_1 = "gjsfdjghdjs"`
`@@ -47,6 +46,16 @@ def test_read_box(self):`
`47`	`46`	`self.assertIsNotNone(json_data)`
`48`	`47`	`self.assertTrue(isinstance(json_data, list))`
`49`	`48`
	`49`	`+ def test_get_meta(self):`
	`50`	`+ data = [{"name": "first", "age": "25"}, {"name": "second", "age": "19"}]`
	`51`	`+ box_id = TEST_BOX_ID + "_meta"`
	`52`	`+ result = self.jb.write(data, box_id)`
	`53`	`+`
	`54`	`+ json_data = self.jb.get_meta(box_id)`
	`55`	`+ self.assertIsNotNone(json_data)`
	`56`	`+ self.assertEqual(json_data["_count"], 2)`
	`57`	`+ self.assertIsNotNone(json_data["_createdOn"])`
	`58`	`+`
`50`	`59`	`def test_read_sort(self):`
`51`	`60`	`data = [{"name": "first", "age": "25"}, {"name": "second", "age": "19"}]`
`52`	`61`	`box_id = TEST_BOX_ID + "_sort"`

Comments

(0)