Merge lp:~jvalenzuela1977/txjsonrpc/devel into lp:txjsonrpc

[Jason Valenzuela]

Unmerged revisions

77. By Jason Valenzuela on 2010-08-07

Added decorator class allowing published methods to receive request objects.

=== modified file 'txjsonrpc/web/jsonrpc.py'
--- txjsonrpc/web/jsonrpc.py	2009-11-09 06:31:56 +0000
+++ txjsonrpc/web/jsonrpc.py	2010-08-08 13:37:43 +0000
@@ -63,6 +63,37 @@
         self.result.errback(NotImplementedError("Implement run() in subclasses"))
 
 
+class IncludeRequest(object):
+    """
+    A decorator which can be used to inform the JSONRPC resource that
+    the decorated method call wants access to the request object which
+    dispatched the RPC. To illustrate usage, consider the following published
+    method which accepts three arguments:
+
+    jsonrpc_spam(self, x, y, z)
+
+    Decorated with this class or derived subclass, the method will now
+    receive the request object followed by the arguments provided by the
+    caller.
+
+    @IncludeRequest
+    jsonrpc_spam(self, request, x, y, z)
+    """
+
+    def __init__(self, method):
+        self.method = method
+
+    def __call__(self, *args, **kw):
+        """Dispatches the RPC with the included request object.
+
+        args -- Normal arguments supplied by the caller.
+
+        kw -- Dictionary containing the request object under key value 'req'.
+
+        """
+        return self.method(self, kw['req'], *args)
+
+
 class JSONRPC(resource.Resource, BaseSubhandler):
     """
     A resource that implements JSON-RPC.
@@ -107,7 +138,10 @@
             self._cbRender(f, request, id, version)
         else:
             request.setHeader("content-type", "text/json")
-            d = defer.maybeDeferred(function, *args)
+            if isinstance(function, IncludeRequest):
+                d = defer.maybeDeferred(function, *args, req=request)
+            else:
+                d = defer.maybeDeferred(function, *args)
             d.addErrback(self._ebRender, id)
             d.addCallback(self._cbRender, request, id, version)
         return server.NOT_DONE_YET

=== modified file 'txjsonrpc/web/test/test_jsonrpc.py'
--- txjsonrpc/web/test/test_jsonrpc.py	2009-11-09 06:10:20 +0000
+++ txjsonrpc/web/test/test_jsonrpc.py	2010-08-08 13:37:43 +0000
@@ -74,6 +74,10 @@
     def jsonrpc_none(self):
         return "null"
 
+    @jsonrpc.IncludeRequest
+    def jsonrpc_request(self, request, arg):
+        return isinstance(request, server.Request) and arg
+
     def _getFunction(self, functionPath):
         try:
             return jsonrpc.JSONRPC._getFunction(self, functionPath)
@@ -124,7 +128,8 @@
             1,
             ["a", 1],
             "null",
-            {"a": ["b", "c", 12, []], "D": "foo"}]
+            {"a": ["b", "c", 12, []], "D": "foo"},
+            True]
 
     def testResults(self):
         input = [
@@ -133,7 +138,8 @@
             ("dict", ({"a": 1}, "a")),
             ("pair", ("a", 1)),
             ("none", ()),
-            ("complex", ())]
+            ("complex", ()),
+            ("request", (True,))]
 
         dl = []
         for methodAndArgs, output in zip(input, self.getExpectedOutput()):