Merge lp:~pedronis/u1db/naming-in-sync-doc-json-envelope into lp:u1db

[Samuele Pedroni]

use the more consistent naming 'content' not 'doc' for the main data field in the json object entries exchanged by sync for each document, right now we pass documents as strings (because is the natural thing with the current layering of things, and the current Document interface)

[John A Meinel (jameinel)]

Thanks. There are still a few places in the code where it would be good to do this. (Eg. u1db.tests.simple_doc)

I like sending the content as strings, so that we don't change the actual content. It would be nice to preserve:
PUT_DOC(id, content)
sha1(content) == sha1(GET_DOC(id))

review: Approve

=== modified file 'u1db/remote/http_app.py'
--- u1db/remote/http_app.py	2011-12-01 14:20:34 +0000
+++ u1db/remote/http_app.py	2011-12-01 21:57:23 +0000
@@ -289,13 +289,13 @@
         self.sync_exch = self.target.get_sync_exchange()
 
     @http_method(content_as_args=True)
-    def post_stream_entry(self, id, rev, doc):
-        doc = Document(id, rev, doc)
+    def post_stream_entry(self, id, rev, content):
+        doc = Document(id, rev, content)
         self.sync_exch.insert_doc_from_source(doc)
 
     def post_end(self):
         def send_doc(doc):
-            entry = dict(id=doc.doc_id, rev=doc.rev, doc=doc.content)
+            entry = dict(id=doc.doc_id, rev=doc.rev, content=doc.content)
             self.responder.stream_entry(entry)
         new_gen = self.sync_exch.find_docs_to_return(self.last_known_generation)
         self.responder.content_type = 'application/x-u1db-multi-json'

=== modified file 'u1db/remote/http_target.py'
--- u1db/remote/http_target.py	2011-11-21 14:32:17 +0000
+++ u1db/remote/http_target.py	2011-12-01 21:57:23 +0000
@@ -60,7 +60,7 @@
         size += prepare(last_known_generation=last_known_generation,
                         from_replica_generation=from_replica_generation)
         for doc in docs:
-            size += prepare(id=doc.doc_id, rev=doc.rev, doc=doc.content)
+            size += prepare(id=doc.doc_id, rev=doc.rev, content=doc.content)
         self._conn.putheader('content-length', str(size))
         self._conn.endheaders()
         for entry in entries:
@@ -71,7 +71,7 @@
         res = simplejson.loads(data[0])
         for entry in data[1:]:
             entry = simplejson.loads(entry)
-            doc = Document(entry['id'], entry['rev'], entry['doc'])
+            doc = Document(entry['id'], entry['rev'], entry['content'])
             return_doc_cb(doc)
         data = None
         return res['new_generation']

=== modified file 'u1db/tests/test_http_app.py'
--- u1db/tests/test_http_app.py	2011-12-01 14:20:34 +0000
+++ u1db/tests/test_http_app.py	2011-12-01 21:57:23 +0000
@@ -551,7 +551,7 @@
         self.assertEqual(self.db0.get_sync_generation('other-id'), 2)
 
     def test_sync_exchange_send(self):
-        entry = {'id': 'doc-here', 'rev': 'replica:1', 'doc':
+        entry = {'id': 'doc-here', 'rev': 'replica:1', 'content':
                  '{"value": "here"}'}
         args = dict(from_replica_generation=10, last_known_generation=0)
         body = ("%s\r\n" % simplejson.dumps(args) +
@@ -581,7 +581,7 @@
         parts = resp.body.splitlines()
         self.assertEqual(2, len(parts))
         self.assertEqual({'new_generation': 1}, simplejson.loads(parts[0]))
-        self.assertEqual({'doc': '{"value": "there"}',
+        self.assertEqual({'content': '{"value": "there"}',
                           'rev': doc.rev, 'id': doc.doc_id},
                          simplejson.loads(parts[1]))