Merge lp:~sil/u1db/http-all-docs into lp:u1db

[Stuart Langridge]

Add /docs/all-ids HTTP endpoint which returns a list of all docids (filtered by include_deleted)

[lp:~sil/u1db/http-all-docs]

395. By Stuart Langridge on 2012-09-04

declare only the correct parameter in the http decorator

[Eric Casteleijn (thisfred)]

I would think we'd want a non-http version of this as well, which the http version can then call? That way it can be optimized in backends that have ways of getting the ids directly.

[Stuart Langridge (sil)]

but then it has to be implemented by backends rather than building on the existing backend API.

[Eric Casteleijn (thisfred)]

Well yes, but they can always implement it using the 3 lines shown here. For python, we could add that to the reference implementation even, and backends could override it. I am not 100% sure about this, though, so maybe adding the http implementation only for now is the way to go, since we know we need that, and for the general API we don't yet.

[Eric Casteleijn (thisfred)]

review: Approve

[Samuele Pedroni (pedronis)]

superseded

Unmerged revisions

395. By Stuart Langridge on 2012-09-04

declare only the correct parameter in the http decorator

394. By Stuart Langridge on 2012-09-04

Add /docs/all-ids HTTP endpoint which returns a list of all docids (filtered by include_deleted)

=== modified file 'u1db/remote/http_app.py'
--- u1db/remote/http_app.py	2012-08-20 21:29:46 +0000
+++ u1db/remote/http_app.py	2012-09-04 09:29:22 +0000
@@ -244,6 +244,29 @@
 
 
 @url_to_resource.register
+class AllDocsIdsResource(object):
+    """All document IDs resource."""
+
+    url_pattern = "/{dbname}/docs/all-ids"
+
+    def __init__(self, dbname, state, responder):
+        self.responder = responder
+        self.db = state.open_database(dbname)
+
+    @http_method(include_deleted=parse_bool)
+    def get(self, include_deleted=False):
+        gen, docs = self.db.get_all_docs(include_deleted=include_deleted)
+        self.responder.content_type = 'application/json'
+        self.responder.start_response(200)
+        self.responder.start_stream(),
+        for doc in docs:
+            entry = doc.doc_id
+            self.responder.stream_entry(entry)
+        self.responder.end_stream()
+        self.responder.finish_response()
+
+
+@url_to_resource.register
 class DocsResource(object):
     """Documents resource."""
 

=== modified file 'u1db/tests/test_http_app.py'
--- u1db/tests/test_http_app.py	2012-08-20 21:29:46 +0000
+++ u1db/tests/test_http_app.py	2012-09-04 09:29:22 +0000
@@ -738,6 +738,47 @@
              "has_conflicts": False}]
         self.assertEqual(expected, json.loads(resp.body))
 
+    def test_get_docs_all(self):
+        doc1 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc1')
+        doc2 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc2')
+        resp = self.app.get('/db0/docs/all-ids')
+        self.assertEqual(200, resp.status)
+        self.assertEqual(
+            'application/json', resp.header('content-type'))
+        expected = sorted([doc1.doc_id, doc2.doc_id])
+        self.assertEqual(expected, sorted(json.loads(resp.body)))
+
+    def test_get_docs_all_empty(self):
+        resp = self.app.get('/db0/docs/all-ids')
+        self.assertEqual(200, resp.status)
+        self.assertEqual(
+            'application/json', resp.header('content-type'))
+        self.assertEqual([], json.loads(resp.body))
+
+    def test_get_docs_all_exclude_deleted(self):
+        doc1 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc1')
+        doc2 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc2')
+        doc3 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc3')
+        self.db0.delete_doc(doc1)
+        resp = self.app.get('/db0/docs/all-ids')
+        self.assertEqual(200, resp.status)
+        self.assertEqual(
+            'application/json', resp.header('content-type'))
+        expected = sorted([doc2.doc_id, doc3.doc_id])
+        self.assertEqual(expected, sorted(json.loads(resp.body)))
+
+    def test_get_docs_all_include_deleted(self):
+        doc1 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc1')
+        doc2 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc2')
+        doc3 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc3')
+        self.db0.delete_doc(doc1)
+        resp = self.app.get('/db0/docs/all-ids?include_deleted=true')
+        self.assertEqual(200, resp.status)
+        self.assertEqual(
+            'application/json', resp.header('content-type'))
+        expected = sorted([doc1.doc_id, doc2.doc_id, doc3.doc_id])
+        self.assertEqual(expected, sorted(json.loads(resp.body)))
+
     def test_get_docs_include_deleted(self):
         doc1 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc1')
         doc2 = self.db0.create_doc_from_json('{"x": 1}', doc_id='doc2')