Source code for cyclone.jsonrpc

# coding: utf-8
#
# Copyright 2010 Alexandre Fiori
# based on the original Tornado by Facebook
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

"""Server-side implementation of the JSON-RPC protocol.

`JSON-RPC <http://json-rpc.org/wiki/specification>`_  is a lightweight remote
procedure call protocol, designed to be simple.

For more information, check out the `RPC demo
<https://github.com/fiorix/cyclone/tree/master/demos/rpc>`_.
"""

import types

import cyclone.escape
from cyclone.web import HTTPError, RequestHandler

from twisted.internet import defer
from twisted.python import log, failure


[docs]class JsonrpcRequestHandler(RequestHandler): """Subclass this class and define jsonrpc_* to make a handler. Example:: class MyRequestHandler(JsonrpcRequestHandler): def jsonrpc_echo(self, text): return text def jsonrpc_sort(self, items): return sorted(items) @defer.inlineCallbacks def jsonrpc_geoip_lookup(self, address): response = yield cyclone.httpclient.fetch( "http://freegeoip.net/json/%s" % address.encode("utf-8")) defer.returnValue(response.body) """ def post(self, *args): self._auto_finish = False try: req = cyclone.escape.json_decode(self.request.body) jsonid = req["id"] method = req["method"] assert isinstance(method, types.StringTypes), \ "Invalid method type: %s" % type(method) params = req.get("params", []) assert isinstance(params, (types.ListType, types.TupleType)), \ "Invalid params type: %s" % type(params) except Exception, e: log.msg("Bad Request: %s" % str(e)) raise HTTPError(400) function = getattr(self, "jsonrpc_%s" % method, None) if callable(function): args = list(args) + params d = defer.maybeDeferred(function, *args) d.addBoth(self._cbResult, jsonid) else: self._cbResult(AttributeError("method not found: %s" % method), jsonid) def _cbResult(self, result, jsonid): if isinstance(result, failure.Failure): error = {'code': 0, 'message': str(result.value)} result = None else: error = None data = {"result": result, "error": error, "id": jsonid} self.finish(cyclone.escape.json_encode(data))