Merge lp:~pedronis/u1db/rest-all-docs into lp:u1db

[Samuele Pedroni]

support get_all_docs over the rest api, returning the current with a x-u1db-genertion header is optional

support get_all_docs but without returning the cur gen over the rest api, instead return -1 from http_database for that

[lp:~pedronis/u1db/rest-all-docs]

430. By Samuele Pedroni on 2012-10-12

support returning gen in rest all-docs with a header but its absence is ok and we fallback to -1

[Lucio Torre (lucio.torre)]

review: Approve

[Stuart Langridge (sil)]

review: Approve

[Eric Casteleijn (thisfred)]

review: Approve

=== modified file 'u1db/remote/http_app.py'
--- u1db/remote/http_app.py	2012-10-02 16:10:27 +0000
+++ u1db/remote/http_app.py	2012-10-12 14:02:18 +0000
@@ -273,6 +273,34 @@
 
 
 @url_to_resource.register
+class AllDocsResource(object):
+    """All Documents resource."""
+
+    url_pattern = "/{dbname}/all-docs"
+
+    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'
+        # returning a x-u1db-generation header is optional
+        # HTTPDatabase will fallback to return -1 if it's missing
+        self.responder.start_response(200,
+                                      headers={'x-u1db-generation': str(gen)})
+        self.responder.start_stream(),
+        for doc in docs:
+            entry = dict(
+                doc_id=doc.doc_id, doc_rev=doc.rev, content=doc.get_json(),
+                has_conflicts=doc.has_conflicts)
+            self.responder.stream_entry(entry)
+        self.responder.end_stream()
+        self.responder.finish_response()
+
+
+@url_to_resource.register
 class DocResource(object):
     """Document resource."""
 

=== modified file 'u1db/remote/http_database.py'
--- u1db/remote/http_database.py	2012-10-10 14:54:25 +0000
+++ u1db/remote/http_database.py	2012-10-12 14:02:18 +0000
@@ -105,20 +105,31 @@
         doc.has_conflicts = has_conflicts
         return doc
 
+    def _build_docs(self, res):
+        for doc_dict in json.loads(res):
+            doc = self._factory(
+                doc_dict['doc_id'], doc_dict['doc_rev'], doc_dict['content'])
+            doc.has_conflicts = doc_dict['has_conflicts']
+            yield doc
+
     def get_docs(self, doc_ids, check_for_conflicts=True,
                  include_deleted=False):
         if not doc_ids:
-            return
+            return []
         doc_ids = ','.join(doc_ids)
         res, headers = self._request(
             'GET', ['docs'], {
                 "doc_ids": doc_ids, "include_deleted": include_deleted,
                 "check_for_conflicts": check_for_conflicts})
-        for doc_dict in json.loads(res):
-            doc = self._factory(
-                doc_dict['doc_id'], doc_dict['doc_rev'], doc_dict['content'])
-            doc.has_conflicts = doc_dict['has_conflicts']
-            yield doc
+        return self._build_docs(res)
+
+    def get_all_docs(self, include_deleted=False):
+        res, headers = self._request(
+            'GET', ['all-docs'], {"include_deleted": include_deleted})
+        gen = -1
+        if 'x-u1db-generation' in headers:
+            gen = int(headers['x-u1db-generation'])
+        return gen, list(self._build_docs(res))
 
     def _allocate_doc_id(self):
         return 'D-%s' % (uuid.uuid4().hex,)

=== modified file 'u1db/tests/test_backends.py'
--- u1db/tests/test_backends.py	2012-10-11 20:48:58 +0000
+++ u1db/tests/test_backends.py	2012-10-12 14:02:18 +0000
@@ -276,6 +276,29 @@
     def test_get_docs_empty_list(self):
         self.assertEqual([], list(self.db.get_docs([])))
 
+    def test_get_all_docs_empty(self):
+        self.assertEqual([], list(self.db.get_all_docs()[1]))
+
+    def test_get_all_docs(self):
+        doc1 = self.db.create_doc_from_json(simple_doc)
+        doc2 = self.db.create_doc_from_json(nested_doc)
+        self.assertEqual(
+            sorted([doc1, doc2]), sorted(list(self.db.get_all_docs()[1])))
+
+    def test_get_all_docs_exclude_deleted(self):
+        doc1 = self.db.create_doc_from_json(simple_doc)
+        doc2 = self.db.create_doc_from_json(nested_doc)
+        self.db.delete_doc(doc2)
+        self.assertEqual([doc1], list(self.db.get_all_docs()[1]))
+
+    def test_get_all_docs_include_deleted(self):
+        doc1 = self.db.create_doc_from_json(simple_doc)
+        doc2 = self.db.create_doc_from_json(nested_doc)
+        self.db.delete_doc(doc2)
+        self.assertEqual(
+            sorted([doc1, doc2]),
+            sorted(list(self.db.get_all_docs(include_deleted=True)[1])))
+
     def test_handles_nested_content(self):
         doc = self.db.create_doc_from_json(nested_doc)
         self.assertGetDoc(self.db, doc.doc_id, doc.rev, nested_doc, False)
@@ -408,29 +431,6 @@
         doc = self.make_document('/a', None, simple_doc)
         self.assertRaises(errors.InvalidDocId, self.db.put_doc, doc)
 
-    def test_get_all_docs_empty(self):
-        self.assertEqual([], list(self.db.get_all_docs()[1]))
-
-    def test_get_all_docs(self):
-        doc1 = self.db.create_doc_from_json(simple_doc)
-        doc2 = self.db.create_doc_from_json(nested_doc)
-        self.assertEqual(
-            sorted([doc1, doc2]), sorted(list(self.db.get_all_docs()[1])))
-
-    def test_get_all_docs_exclude_deleted(self):
-        doc1 = self.db.create_doc_from_json(simple_doc)
-        doc2 = self.db.create_doc_from_json(nested_doc)
-        self.db.delete_doc(doc2)
-        self.assertEqual([doc1], list(self.db.get_all_docs()[1]))
-
-    def test_get_all_docs_include_deleted(self):
-        doc1 = self.db.create_doc_from_json(simple_doc)
-        doc2 = self.db.create_doc_from_json(nested_doc)
-        self.db.delete_doc(doc2)
-        self.assertEqual(
-            sorted([doc1, doc2]),
-            sorted(list(self.db.get_all_docs(include_deleted=True)[1])))
-
     def test_get_all_docs_generation(self):
         self.db.create_doc_from_json(simple_doc)
         self.db.create_doc_from_json(nested_doc)

=== modified file 'u1db/tests/test_http_app.py'
--- u1db/tests/test_http_app.py	2012-10-02 16:10:27 +0000
+++ u1db/tests/test_http_app.py	2012-10-12 14:02:18 +0000
@@ -780,6 +780,21 @@
              "has_conflicts": False}]
         self.assertEqual(expected, json.loads(resp.body))
 
+    def test_get_all_docs(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/all-docs')
+        self.assertEqual(200, resp.status)
+        self.assertEqual(
+            'application/json', resp.header('content-type'))
+        def doc_to_dic(doc):
+            return dict(doc_id=doc.doc_id, doc_rev=doc.rev,
+                        content=doc.get_json(),
+                        has_conflicts=doc.has_conflicts)
+        expected = sorted([doc_to_dic(doc1), doc_to_dic(doc2)])
+        self.assertEqual(expected, sorted(json.loads(resp.body)))
+        self.assertEqual(2, int(resp.header('x-u1db-generation')))
+
     def test_get_sync_info(self):
         self.db0._set_replica_gen_and_trans_id('other-id', 1, 'T-transid')
         resp = self.app.get('/db0/sync-from/other-id')

=== modified file 'u1db/tests/test_http_database.py'
--- u1db/tests/test_http_database.py	2012-10-10 14:54:25 +0000
+++ u1db/tests/test_http_database.py	2012-10-12 14:02:18 +0000
@@ -148,6 +148,27 @@
         self.assertRaises(errors.HTTPError,
                           self.db.get_doc, 'something-something')
 
+    def test_get_all_docs_gen_included(self):
+        self.response_val = ('[{"doc_id": "doc", "doc_rev": "db:1",'
+                             ' "content": "{}", "has_conflicts": false}]',
+                             {'x-u1db-generation': 2})
+        gen, docs = self.db.get_all_docs(include_deleted=True)
+        self.assertEqual(2, gen)
+        self.assertEqual(1, len(docs))
+        self.assertEqual(
+            ('GET', ['all-docs'], {'include_deleted': True}, None, None),
+            self.got)
+
+    def test_get_all_docs_gen_absent(self):
+        self.response_val = ('[{"doc_id": "doc", "doc_rev": "db:1",'
+                             ' "content": "{}", "has_conflicts": false}]', {})
+        gen, docs = self.db.get_all_docs()
+        self.assertEqual(-1, gen)
+        self.assertEqual(1, len(docs))
+        self.assertEqual(
+            ('GET', ['all-docs'], {'include_deleted': False}, None, None),
+            self.got)
+
     def test_create_doc_from_json_with_id(self):
         self.response_val = {'rev': 'doc-rev'}, {}
         new_doc = self.db.create_doc_from_json('{"v": 1}', doc_id='doc-id')