[server] Server cmd: ddoc updates

Author:     Alexander Shorin <[email protected]>
Patched by: Iblis Lin <[email protected]>

Reference: djc#268
See Also:  djc#276

Author: kxepal

couchdb/server/__init__.py

@@ -337,6 +337,7 @@ def __init__(self, *args, **kwargs):
             ddoc_commands = {}
             ddoc_commands['shows'] = render.ddoc_show
             ddoc_commands['lists'] = render.ddoc_list
+            ddoc_commands['updates'] = render.ddoc_update
 
         if self.version >= (1, 1, 0):
             self.commands['add_lib'] = state.add_lib
@@ -705,6 +706,30 @@ def ddoc_list(self, ddoc_id, func_path, rows, head=None, req=None):
         self._receive, self._respond = _input, _output
         return result
 
+    def ddoc_update(self, ddoc_id, func_path, doc=None, req=None):
+        """Runs ``ddoc`` ``updates`` command.
+        Requires teached ddoc by :meth:`add_ddoc`.
+
+        :param ddoc_id: DDoc id.
+        :type ddoc_id: str
+
+        :param func_path: List of keys which holds filter function within ddoc.
+        :type func_path: list
+
+        :param doc: Document object.
+        :type doc: dict
+
+        :param req: Request object.
+        :type req: dict
+
+        :return: Three-element list with ``up`` token, new document object
+                 and response object.
+
+        .. versionadded:: 0.11.0
+        """
+        args = [doc or {}, req or {}]
+        return self.ddoc_cmd(ddoc_id, 'updates', func_path, args)
+
     @property
     def ddocs(self):
         """Returns dict with registered ddocs"""

couchdb/server/render.py

@@ -349,6 +349,36 @@ def update(server, funsrc, doc, req):
     return run_update(server, server.compile(funsrc), doc, req)
 
 
+def ddoc_update(server, func, doc, req):
+    """Implementation of ddoc `updates` commands.
+
+    :command: updates
+
+    :param server: Query server instance.
+    :type server: :class:`~couchdb.server.BaseQueryServer`
+
+    :param func: Update function object.
+    :type func: function
+
+    :param doc: Document object.
+    :type doc: dict
+
+    :param req: Request info.
+    :type req: dict
+
+    :return: Three element list: ["up", doc, response]
+    :rtype: list
+
+    :raises:
+        - :exc:`~couchdb.server.exceptions.Error`
+          If request method was GET.
+          If response was not dict object or basestring.
+
+    .. versionadded:: 0.11.0
+    """
+    return run_update(server, func, doc, req)
+
+
 ################################################################################
 # Old render used only for 0.9.x
 #

couchdb/tests/server/qs.py

@@ -533,6 +533,19 @@ def func(head, req):
         self.assertEqual(rows[2], ['chunks', ['baz']])
         self.assertEqual(tail, ['end', ['early']])
 
+    def test_ddoc_update(self):
+        def func(doc, req):
+            doc['world'] = 'hello'
+            return [doc, 'hello, doc']
+
+        server = self.server((0, 11, 0))
+        server.add_ddoc(wrap_func_to_ddoc('foo', ['updates', 'hello'], func))
+        result = server.ddoc_update('foo', ['hello'], {'_id': 'foo'})
+        self.assertEqual(
+            result,
+            ['up', {'_id': 'foo', 'world': 'hello'}, {'body': 'hello, doc'}]
+        )
+
 
 def suite():
     suite = unittest.TestSuite()