Orbjson 0.0.3 → 0.0.4

data/lib/skeleton/script/jsonrpc.js

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

data/lib/skeleton/script/jsonrpc_async.js

@@ -0,0 +1,261 @@
+/*
+ * JSON-RPC JavaScript client
+ *
+ * $Id: jsonrpc_async.js,v 1.4 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 {
+        }
+    }
+
+    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/lib/skeleton/webrick/config.yml

@@ -1,2 +1,3 @@
-services/sample: 
-   - Details
+path/to/file/name: 
+   - ClassToRegister
+   - OtherClassToRegister

data/lib/utils.rb

@@ -0,0 +1,29 @@
+ 
+
+# Helper method to make it easier to grab the raw POST data,
+# which where the JSON-RPC request is transported
+class CGI
+  def raw_post
+    self.params.keys[0]
+  end
+end
+
+
+
+# Helper method that instatiates an object given a class name
+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
+ 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.6
 specification_version: 1
 name: Orbjson
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2005-02-28
+  version: 0.0.4
+date: 2005-03-14
 summary: Lib for creating JSON-RPC server applications.
 require_paths: 
   - lib
@@ -28,56 +28,41 @@ authors:
   - James Britt
 files: 
   - README
-  - docs/todo.txt
+  - docs/getting_started_with_orbjson_short_version.pdf
+  - docs/tutorial_code.tgz
   - bin/orbjson
   - lib/skeleton
+  - lib/utils.rb
   - lib/orbjson.rb
   - lib/skeleton/cgi
   - lib/skeleton/script
   - lib/skeleton/webrick
-  - lib/skeleton/cgi/json-rpc.rb,bak
   - lib/skeleton/cgi/json-rpc.rb
-  - lib/skeleton/script/jsonrpc.js,bak
+  - lib/skeleton/script/jsonrpc_async.js
   - lib/skeleton/script/jsonrpc.js
-  - lib/skeleton/webrick/config.yml
-  - lib/skeleton/webrick/server.rb,bak
   - lib/skeleton/webrick/server.rb
+  - lib/skeleton/webrick/config.yml
   - examples/cgi
   - examples/webrick
-  - examples/cgi/Orbjson.log
   - examples/cgi/httpd.conf
-  - examples/cgi/orbjson_cgi.log
   - examples/cgi/yellow_crossfade_01.gif
   - examples/cgi/script
   - examples/cgi/services
-  - examples/cgi/json-rpc.rb,bak
   - examples/cgi/json-rpc.rb
-  - examples/cgi/index.html,bak
   - examples/cgi/index.html
-  - examples/cgi/script/jsonrpc.js,bak
+  - examples/cgi/script/jsonrpc_async.js
   - examples/cgi/script/jsonrpc.js
-  - examples/cgi/services/sample.rb,bak
   - examples/cgi/services/sample.rb
   - examples/webrick/config.yml
   - examples/webrick/yellow_crossfade_01.gif
   - examples/webrick/script
   - examples/webrick/services
-  - examples/webrick/server.rb,bak
-  - examples/webrick/server.rb
-  - examples/webrick/index.html,bak
   - examples/webrick/index.html
-  - examples/webrick/Orbjson.log
-  - examples/webrick/script/jsonrpc.js,bak
+  - examples/webrick/index_async.html
+  - examples/webrick/server.rb
   - examples/webrick/script/jsonrpc.js
-  - examples/webrick/services/sample.rb,bak
+  - examples/webrick/script/jsonrpc_async.js
   - examples/webrick/services/sample.rb
-  - dep/handy
-  - dep/required
-  - dep/handy/script
-  - dep/handy/script/jsonrpc.js,bak
-  - dep/handy/script/jsonrpc.js
-  - dep/required/ruby-json
-  - dep/required/ruby-json/ruby-json-1.1.1.gem
 test_files: []
 rdoc_options: []
 extra_rdoc_files: []

data/dep/handy/script/jsonrpc.js

@@ -1,187 +0,0 @@
-/*
- * JSON-RPC JavaScript client
- *
- * $Id: jsonrpc.js,v 1.1.1.1 2005/02/28 03:06:30 jamesgbritt Exp $
- *
- * Copyright (c) 2003-2004 Jan-Klaas Kollhof
- * Copyright (c) 2005 Michael Clark, Metaparadigm Pte Ltd
- *
- * This code is based on Jan-Klaas' JavaScript o lait library (jsolait).
- *
- * 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(", ") + "]";
-}
-
-JSONRpcClient = function JSONRpcClient_ctor(serverURL, objectID) {
-    this.serverURL = serverURL;
-    this.objectID = objectID;
-
-    // Lazy initialization of the XMLHttpRequest singleton
-    if(!JSONRpcClient.http)
-      JSONRpcClient.http = JSONRpcClient.getHTTPRequest();
-
-    // Add standard methods
-    this.addMethods(["system.listMethods"]);
-
-    // Query the methods on the server and add them to this object
-    var m = this.sendRequest("system.listMethods", []);
-    this.addMethods(m);
-}
-
-JSONRpcClient.Exception = function JSONRpcClient_Exception_ctor(code, msg) {
-    this.code = code;
-    this.msg = msg;
-}
-
-JSONRpcClient.Exception.prototype.toString =
-function JSONRpcClient_Exception_toString(code, msg)  {
-    return "JSONRpcClientException: " + this.msg;
-}
-
-JSONRpcClient.Method =
-function JSONRpcClient_Method_ctor(client, methodName) {
-    var fn=function()  {
-      var args = [];
-      for(var i=0;i<arguments.length;i++) {
-          args.push(arguments[i]);
-      }
-      return fn.client.sendRequest.call(fn.client, fn.methodName, args);
-    }
-    fn.client = client;
-    fn.methodName = methodName;
-    return fn;
-}
-
-JSONRpcClient.prototype.addMethods =
-function JSONRpcClient_addMethods(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 JSONRpcClient.Method(this, methodNames[i]);
-      obj[name] = method;
-   }
-  }
-}
-
-JSONRpcClient.prototype.sendRequest =
-function JSONRpcClient_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
-    JSONRpcClient.http.open("POST", this.serverURL, false); // no async
-    // setRequestHeader is missing in Opera 8 Beta
-    try {
-      JSONRpcClient.http.setRequestHeader("Content-type", "text/plain");
-    } 
-    catch(e) {}
-    JSONRpcClient.http.send(req_data);
-
-    // Unmarshall the response
-    // DEBUG
-    try {
-      eval("var obj = " + JSONRpcClient.http.responseText);
-    }
-    catch(e) {
-      alert( e )            
-      alert( JSONRpcClient.http.responseText )            
-      obj.err = e.toString()
-      }
-    if( obj.error) {
-      alert( JSONRpcClient.http.responseText )      
-      throw new JSONRpcClient.Exception(obj.error.code, obj.error.msg);
-     }
-      var res = obj.result;
-
-    // Handle CallableProxy
-    if(res && res.objectID && res.JSONRPCType == "CallableReference")
-      return new JSONRpcClient(this.serverURL, res.objectID);
-
-    return res;
-}
-
-JSONRpcClient.getHTTPRequest = function JSONRpcClient_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 JSONRpcClient.Exception(0, "Can't create XMLHttpRequest object");
-}