Orbjson 0.0.3 → 0.0.4

data/examples/webrick/script/jsonrpc.js

@@ -1,7 +1,7 @@
 /*
  * JSON-RPC JavaScript client
  *
- * $Id: jsonrpc.js,v 1.1.1.1 2005/02/28 03:06:29 jamesgbritt Exp $
+ * $Id: jsonrpc.js,v 1.2 2005/03/15 02:29:22 jamesgbritt Exp $
  *
  * Copyright (c) 2003-2004 Jan-Klaas Kollhof
  * Copyright (c) 2005 Michael Clark, Metaparadigm Pte Ltd

data/examples/webrick/script/jsonrpc_async.js

@@ -0,0 +1,262 @@
+/*
+ * JSON-RPC JavaScript client
+ *
+ * $Id: jsonrpc_async.js,v 1.2 2005/03/15 02:29:22 jamesgbritt Exp $
+ *
+ * Copyright (c) 2003-2004 Jan-Klaas Kollhof
+ * Copyright (c) 2005 Michael Clark, Metaparadigm Pte Ltd
+ * Copyright (c) 2005 James Britt, Neurogami, LLC
+ *
+ * This code is based on Michael Clark's' version of Jan-Klaas' jsonrpc.js
+ * file fom the JavaScript o lait library (jsolait).
+ 
+ * The Clark version seemed easier to use the original Module-based
+ * code, but did not do asyncronous requests.  The current version
+ * is essentialy the same code, but with the async requests and callback 
+ * hooks
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public (LGPL)
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details: http://www.gnu.org/
+ *
+ */
+
+// TODO: Add async
+// TODO: Add HTTP auth (user, password)
+
+Object.prototype.toJSON = function Object_toJSON() {
+    var v = [];
+    for(attr in this) {
+      if(this[attr] == null) v.push("\"" + attr + "\": null");
+      else if(typeof this[attr] == "function"); // skip
+      else v.push("\"" + attr + "\": " + this[attr].toJSON());
+    }
+    return "{" + v.join(", ") + "}";
+  }
+
+String.prototype.toJSON = function String_toJSON()  {
+    return "\"" + this.replace(/([\"\\])/g, "\\$1") + "\"";
+}
+
+Number.prototype.toJSON = function Number_toJSON() {
+    return this.toString();
+}
+
+Boolean.prototype.toJSON = function Boolean_toJSON() {
+    return this.toString();
+}
+
+Date.prototype.toJSON = function Date_toJSON() {
+    this.valueOf().toString();
+}
+
+Array.prototype.toJSON = function Array_toJSON() {
+    var v = [];
+    for(var i=0; i<this.length; i++) {
+      if(this[i] == null) v.push("null");
+      else v.push(this[i].toJSON());
+    }
+    return "[" + v.join(", ") + "]";
+}
+
+
+/*******************************************************************
+ ******************************************************************/
+JSONRpcAsyncClient = function JSONRpcAsyncClient_ctor( serverURL, objectID ) {
+    this.serverURL = serverURL;
+    this.objectID = objectID;
+    if( !JSONRpcAsyncClient.http )
+      JSONRpcAsyncClient.http = JSONRpcAsyncClient.getHTTPRequest();
+    this.addAsyncMethods( ["system.listMethods"] );
+    var m = this.sendRequest( "system.listMethods", [] );
+    this.addAsyncMethods( m );    
+
+}
+
+/*******************************************************************
+ ******************************************************************/
+JSONRpcAsyncClient.Exception = function JSONRpcAsyncClient_Exception_ctor(code, msg) {
+    this.code = code;
+    this.msg = msg;
+}
+
+/*******************************************************************
+ ******************************************************************/
+JSONRpcAsyncClient.Exception.prototype.toString =
+function JSONRpcAsyncClient_Exception_toString(code, msg)  {
+    return "JSONRpcAsyncClientException: " + this.msg;
+}
+
+
+
+
+JSONRpcAsyncClient.AsyncMethod =
+function JSONRpcAsyncClient_Method_ctor( client, methodName ) {
+  
+    var fn=function()  {
+      var args = [];
+      var callback = arguments[0]
+      for(var i=1; i< arguments.length;i++) {
+          args.push(arguments[i]);
+      }
+      return fn.client.sendAsyncRequest.call( fn.client, fn.methodName, callback, args);
+    }
+    
+    fn.client = client;
+    fn.methodName = methodName;
+    return fn;
+}
+
+ JSONRpcAsyncClient.prototype.addAsyncMethods =
+function JSONRpcAsyncClient_addAsyncMethods(methodNames) {
+    for(var i=0; i<methodNames.length; i++) {
+    var obj = this;
+    var names = methodNames[i].split(".");
+    for(var n=0; n<names.length-1; n++){
+      var name = names[n];
+      if(obj[name]){
+        obj = obj[name];
+      } 
+      else {
+        obj[name]  = new Object();
+        obj = obj[name];
+      }
+  }
+  var name = names[names.length-1];
+  if(!obj[name]){
+      var method = new JSONRpcAsyncClient.AsyncMethod(this, methodNames[i]);
+      obj[name] = method;
+   }
+  }
+}
+
+
+/*******************************************************************
+ ******************************************************************/
+// Async JSON-RPC call.  The tricky part may be catching the
+// state change when the call is complete, and unmarshalling the
+// response.
+// Possibility: Have the user pass in a caqllback method; this method
+// assumes it will get called with the unnarshalled response.
+// When the reqadyState goes to 4, grab the JSON response, unmarshal,
+// and invokve the callback
+
+JSONRpcAsyncClient.prototype.sendAsyncRequest =
+function JSONRpcAsyncClient_sendAsyncRequest( methodName, call_back, args ) {
+    var obj = {"method" : methodName, "params" : args };
+    if (this.objectID) obj.objectID = this.objectID;
+    
+    var req_data = obj.toJSON();
+    
+    var http = JSONRpcAsyncClient.getHTTPRequest();
+
+    http.open("POST", this.serverURL, true); //  async
+
+    try {
+      http.setRequestHeader( "Content-type", "text/plain" );
+    } 
+    catch(e) {}
+
+
+    http.onreadystatechange = function() {
+      if ( http.readyState == 4 && http.status == 200) {
+        try {
+          s  = "var obj = " + http.responseText 
+          eval( s );
+        }
+        catch( e ) {
+          var e_msg = "onreadystatechange Error: " + e + "\nresponseText: " + http.responseText  
+          obj.err = e.toString()
+        }
+        if( obj.error ) {
+          throw new JSONRpcAsyncClient.Exception( obj.error.code, obj.error.msg );
+        }
+        return call_back( obj.result );
+      }
+      else {
+          window.status =  "http.status  '" + http.status    + "' "        
+        }
+    }
+
+    http.send( req_data );
+
+}
+
+
+/*******************************************************************
+ ******************************************************************/
+JSONRpcAsyncClient.prototype.sendRequest =
+
+ function JSONRpcAsyncClient_sendRequest(methodName, args) {
+    // Make request object
+    var obj = {"method" : methodName, "params" : args};
+    if (this.objectID) obj.objectID = this.objectID;
+
+    // Marshall the request object to a JSON string
+    var req_data = obj.toJSON();
+
+    // Send the request
+    JSONRpcAsyncClient.http.open("POST", this.serverURL, false); // no async
+    // setRequestHeader is missing in Opera 8 Beta
+    try {
+      JSONRpcAsyncClient.http.setRequestHeader("Content-type", "text/plain");
+    } 
+    catch(e) {}
+    JSONRpcAsyncClient.http.send(req_data);
+
+    // Unmarshall the response
+
+    try {
+      eval("var obj = " + JSONRpcAsyncClient.http.responseText);
+    }
+    catch(e) {
+      alert( "sendRequest error: " + e + "\nresponseText: " + JSONRpcAsyncClient.http.responseText )            
+      obj.err = e.toString()
+    }
+    if( obj.error) {
+      alert( JSONRpcAsyncClient.http.responseText )      
+      throw new JSONRpcAsyncClient.Exception(obj.error.code, obj.error.msg);
+     }
+      var res = obj.result;
+
+    // Handle CallableProxy
+    if(res && res.objectID && res.JSONRPCType == "CallableReference")
+      return new JSONRpcAsyncClient(this.serverURL, res.objectID);
+
+    return res;
+}
+
+/*******************************************************************
+ ******************************************************************/
+JSONRpcAsyncClient.getHTTPRequest = function JSONRpcAsyncClient_getHTTPRequest() {
+
+    try { // to get the mozilla httprequest object
+      return new XMLHttpRequest();
+    } 
+    catch(e) {}
+
+    try { // to get MS HTTP request object
+      return new ActiveXObject("Msxml2.XMLHTTP.4.0");
+    } 
+    catch(e) {}
+
+    try { // to get MS HTTP request object
+      return new ActiveXObject("Msxml2.XMLHTTP");
+    } 
+    catch(e) {}
+
+    try {// to get the old MS HTTP request object
+      return new ActiveXObject("microsoft.XMLHTTP"); 
+    } 
+    catch(e) {}
+
+    throw new JSONRpcAsyncClient.Exception( 0, "Can't create XMLHttpRequest object");
+}
+
+

data/examples/webrick/server.rb

@@ -1,6 +1,6 @@
 #!/usr/local/bin/ruby
 require 'webrick'
-
+require 'rubygems'
 require "orbjson"
 include WEBrick
 

data/lib/orbjson.rb

@@ -1,4 +1,5 @@
 require 'rubygems' 
+require 'utils'
 require 'logger'
 require 'json/objects'
 require 'json/lexer'
@@ -6,84 +7,105 @@ require 'yaml'
 require 'needle'
 require 'webrick'
 
-class CGI
-  def raw_post
-    self.params.keys[0]
-  end
-end
 
 include WEBrick
 
-def new_from_name( classname, *args)
-  cname = String.new( classname.untaint )
-  obj = nil
-  begin
-    obj = Object.const_get( cname ).new( *args )
-  rescue Exception
-    begin
-      require cname
-      obj = Object.const_get( cname ).new( *args )
-    rescue Exception
-      raise "Cannot create object #{cname}: #{$!}" unless obj
-    end
-  end
-  obj
-end
-
-
 
 
 module Orbjson
+
   
   $roy_logger = Logger.new( "Orbjson.log" )
   $roy_logger.level = Logger::DEBUG
 
-  Version = "0.1.1"
+  Version = "0.0.4"
+  STDERR.puts( "Orbjson: version #{Version }")
   LibPath = File.dirname(__FILE__)  
+   
   
+  # The System class holds the core broker methods. It is reponsible for 
+  # registering server-side classes, sending a list of available services
+  # to the client, and connecting JSON-RPC requests with registered services
+  #
+  # The System object is initialized by calling +init+ and passing in a
+  # mapping of files and classes implementing services.
   class System
     @@registry = Needle::Registry.new() 
-    
+   
+    # Returns an object stored in the registry
     def self.get_object( klass, *args )
       return @@registry[ klass.intern ] 
     end
     
+    # Adds an object to the registry
     def self.put_object( klass, instance )
       @@registry.register( klass ) { instance }
-      # @@cache[ klass ] = instance 
     end
     
+    # Returns a list of registered service classes. 
     def self.registered_classses
-      @@registry.keys.map{ |k| k.to_s.capitalize }
+      @@registry.keys.map{ |k| 
+       $roy_logger.debug( "[#{__LINE__}] self.registered_classses  has @@registry[k].to_s   #{@@registry[k].to_s}" ) 
+        cls = @@registry[k].class.to_s 
+        ( cls  =~ /Needle::/ || cls  =~ /^Hash$/ || cls  =~ /^[a-z]/ )  ?  nil : @@registry[k].class.to_s
+      }.compact
+
     end
-    
+   
+    # Returns a list of registerd services.  Wraps a call to System.list_methods.
+    # The format of each listed service name is className.method
+    # It was added as a conveience for client code that uses the archaic
+    # camelCase method naming convention found in 2oth C. programming languages
     def listMethods
       System.list_methods
     end
     
+      # Returns a list of registerd services.  
+      # The format of each listed service name is +className.method+    
     def self.list_methods
       mlist = []
       
       System.registered_classses.each  do |cls|
-        name = cls.to_s.downcase
+        name = String.new( cls )
+        name[0]  = name[0].chr.downcase
         begin 
-          klass = eval(cls )
+          $roy_logger.debug( "[#{__LINE__}] System#list_methods has cls   #{cls}" )
+          klass = eval( cls )
           ( klass.public_instance_methods  - 
             Object.methods ).sort.each { |m| 
+            $roy_logger.debug( "[#{__LINE__}] System#list_methods adding  #{name}.#{m}" )
               mlist << "#{name}.#{m}" 
            }  
          rescue Exception
-           STDERR.puts( "System#list_methods error #{$!}" )
-           $roy_logger.error( "System#list_methods error #{$!}" )
+           STDERR.puts( "[#{__LINE__}] System#list_methods error #{$!}" )
+           $roy_logger.error( "[#{__LINE__}] System#list_methods error #{$!}" )
          end
       end
+     $roy_logger.debug( "[#{__LINE__}] System#list_methods returning #{mlist.inspect}" )      
       mlist 
     end
 
-
-       # You configure the services list by passing in either a hash of file
-       # paths mapped to class names, or a YMAL string encoding the same, or
-       # the path to YAML file 
+      # You can configure the Orbjson services list in a few ways, passing
+      # detials into the init method.  
+      #
+      # Well, three, really:
+      #  1. Pass in a path to a local YAML file; the path must begin with
+      #   'file://'
+      #     For example: cfg = 'file://config.yaml'
+      #     System.init( cfg )
+      #     
+      #  2. Pass in some YAML:   
+      #    cfg = 'services/sample: 
+      #            - Details'
+      #    System.init( cfg )
+      #            
+      #  3. Pass in some an actual Hash object:   
+      #    cfg = { 'services/sample' => ['Details'] }
+      #    System.init( cfg )
+      #
+      #  The hash (however you express it) consists of 'require' paths mapped
+      #  to arrays of classes to instantiate.
+      #
     def self.init( cfg, flush = true )
       
       @@registry = Needle::Registry.new() if flush 
@@ -113,11 +135,15 @@ module Orbjson
 
       @@registry.register( :System ) { System.new }
       @@registry.register( :system ) { System.new }  
-      $roy_logger.debug(  "Regist now has \n" + @@registry.keys.inspect )
+      $roy_logger.debug(  "@@registry now has \n" + @@registry.keys.inspect )
     end
   end
 
+    # Assorted method used by both CGI and WEBrick Orbjson classes
   module Common
+
+      # Takes the result of some method, plus the id of the originating
+      # JSON-RP call, and creates the JSON-RPC reponse
     def format_repsonse( result, error, id )
       id.class == String ? quote = '"' : quote = ''
       '{ "result" : ' + result.to_json + ', "error":"' + 
@@ -125,6 +151,9 @@ module Orbjson
        quote + ' }'
     end
 
+      # Takes a JSON-RPC message, figures out what it means in Ruby,
+      # invokes the request method on the correspnding service, and returns
+      # the results
     def process( json )
       json   = "#{json}"
       null=nil;  
@@ -134,23 +163,18 @@ module Orbjson
       receiver = System.get_object( klass.capitalize )
       begin
         if ( jsonobj[ 'params'] && jsonobj[ 'params'] != 'nil' )
-          $roy_logger.debug( __LINE__ )
           if jsonobj[ 'params'].size < 1
-            $roy_logger.debug( __LINE__ )          
             result = receiver.send( method  )                  
           else
-            $roy_logger.debug( __LINE__ )          
             result = receiver.send( method , *jsonobj[ 'params']   )
           end
         else
-          $roy_logger.debug( __LINE__ )
           result = receiver.send( method  )        
         end
         error = null
       rescue
         result = null
         error = $!.to_s
-        $roy_logger.error( "#{_LINE__}: #{$!}"  )      
       end
       format_repsonse( result, error, jsonobj['id'] || 'default' )
     end
@@ -162,7 +186,9 @@ module Orbjson
   class WEBrick_JSON_RPC < HTTPServlet::AbstractServlet
     
     include  Common
-    
+   
+      # This initiats the actual message processing.  Calls into the Common
+      # menthod 'process'
     def process_request( req, res, json )
       res.body = process( json )
       res['Content-Type'] = "text/javascript"    
@@ -187,10 +213,13 @@ module Orbjson
     
     include  Common
 
+      # Passes the configuration off to System.init
     def initialize(  cfg  )
        System.init( cfg  )
     end
-    
+   
+      # Takes the raw post data, grabs the JSON-RPC message, and starts
+      # the processing
     def process_request( )
       cgi =  CGI.new
       json   = cgi.raw_post