Orbjson 0.0.3 → 0.0.4

data/README

@@ -1,8 +1,31 @@
 README for Roy Orbjson , the JSON-RPC/Ruby ORB
 
-Orbjson is a JSON-RPC ORB library that allows Web applications 
-to respond to JSON-RPC requests (including, but not limited to, 
-the XmlHttpRequest object), executing Ruby code on the server 
-but sending back JSON-serialized objects to the client.
+Orbjson is a JSON-RPC ORB (object request broker) library that allows Web applications to respond to JSON-RPC requests (including, but not limited to, the XmlHttpRequest object), executing Ruby code on the server but sending back JSON-serialized objects to the client.
+
+Client code may then be written that treats all method invocations as  local; the jsonrpc.js handles the object serialization for the client, and the ruby-json code handles the json marshaling on the server.
+
+For more API detals, see the docs for Orbjson::System
+
+For a more general explanation, with an example, please see http://orbjson.rubyforge.org/tutorial
+
+For general inforamtion, please see http://orbjson.rubyforge.org
+
+Copyright (C) 2005 James Britt & Neurogami LLC
+
+Big thanks to Florian Franks for his ruby-json lib, and Jamis Buck for Needle
+ 
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License,
+ version 2, as published by the Free Software Foundation.
+ 
+ This program 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 General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public
+ License along with this program; if not, write to the Free
+ Software Foundation, Inc., 59 Temple Place, Suite 330,
+ Boston, MA 02111-1307 USA.
 
 

data/bin/orbjson

@@ -38,6 +38,11 @@ USAGE
 end
 
 
+def copy_common( dest_path )
+  File.copy File.join( SKEL_DIR, 'script', 'jsonrpc.js' ), File.join( dest_path , 'script'), true
+  File.copy File.join( SKEL_DIR, 'script', 'jsonrpc_async.js' ), File.join( dest_path , 'script'), true  
+end
+
 def run
   case command = ARGV[0] || usage()
   when 'create-cgi'
@@ -53,7 +58,8 @@ def run
     File.makedirs path
     File.makedirs File.join(path, 'script')
     File.copy File.join( src, 'json-rpc.rb' ), path, true
-    File.copy File.join( SKEL_DIR, 'script', 'jsonrpc.js' ), File.join( path, 'script'), true
+    copy_common( path )
+
   
   when 'create-webrick'
     path = ARGV[1] || usage()
@@ -69,7 +75,7 @@ def run
     File.makedirs File.join(path, 'script')
     File.copy File.join( src, 'server.rb' ), path, true
     File.copy File.join( src, 'config.yml' ), path, true
-    File.copy File.join( SKEL_DIR, 'script', 'jsonrpc.js' ), File.join( path, 'script'), true
+    copy_common( path )
   else
     usage()
   end

data/examples/cgi/script/jsonrpc.js

@@ -1,7 +1,7 @@
 /*
  * JSON-RPC JavaScript client
  *
- * $Id: jsonrpc.js,v 1.1.1.1 2005/02/28 03:06:30 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/cgi/script/jsonrpc_async.js

@@ -0,0 +1,260 @@
+/*
+ * JSON-RPC JavaScript client
+ *
+ * $Id: jsonrpc_async.js,v 1.1 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 );
+      }
+
+    }
+
+    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/index.html

@@ -61,7 +61,7 @@
    <form name='metatagForm' action='#' method="get">
     <fieldset id='metatagFields'>
       <legend>Topic info</legend>
-						<div id='details'></div>
+			<div id='details'></div>
     </fieldset>
    </form>
   </div>

data/examples/webrick/{index.html,bak → index_async.html}

@@ -1,69 +1,77 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>Metatagging</title>
-  <script type="text/javascript" src="./script/jsonrpc.js"></script>	
-  <script language="javascript" type="text/javascript">
-   	var jsonurl = "http://127.0.0.1:2222/json-rpc";
-    var jsonrpc = null;
-
-	  function init() {
-     	jsonrpc = new JSONRpcClient( jsonurl );			
-    }
-
-    function show_details( topic  ) {
-      var el = document.getElementById(  'details' );
-      var html = jsonrpc.details.fetch( topic)
-      el.innerHTML = html;      
-    }
-
-  </script>
-
-  <style type="text/css">
-    #metatagFields #reset {
-      text-align: right;
-    }
-    body {
-      font-family: Verdana, Arial, Helvetica, sans-serif;
-      color: #666666;
-    }
-   a {
-     text-decoration: none;
-   }
-   
-   fieldset {
-     background-image: url(yellow_crossfade_01.gif);
-     background-repeat: repeat-y;
-     background-position: left top;
-   }
-   
-   #metatagFields {
-    width: 300px;
-    margin-top: 10px;
-   }
-   
-   #metatagFields legend {
-    background-color: #FFFFFF;
-    border: 1px dashed #333333;
-   }
-  </style>
-	
- </head>
- <body onload='init()' >
-  
-<div id='instructions'>Select a topic to seee more about it</div>
-  <div id='curentItemList'>
-   <a href='javascript:show_details( "JSON")'>JSON</a>,  <a href='javascript:show_details( "JSON-RPC")'>JSON-RPC</a>, <a href='javascript:show_details( "Ruby")' >Ruby</a>
- </div>
-  
-  <div id='currentSelectionSet'>
-   <form name='metatagForm' action='#' method="get">
-    <fieldset id='metatagFields'>
-      <legend>Topic info</legend>
-						<div id='details'></div>
-    </fieldset>
-   </form>
-  </div>
- </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Metatagging</title>
+  <script type="text/javascript" src="./script/jsonrpc_async.js"></script>	
+  <script language="javascript" type="text/javascript">
+  
+   	var jsonurl = "http://127.0.0.1:2222/json-rpc";
+    var jsonrpc = null;
+    var details = null;
+
+	  function init() {
+     	jsonrpc = new JSONRpcAsyncClient( jsonurl );			
+      details = jsonrpc.details
+    }
+
+    function show_details( topic  ) {
+      var el = document.getElementById(  'details' );
+      
+      f = function( res ){
+        el.innerHTML =  res
+      }
+      
+      details.fetch( f, topic )
+
+    }
+
+  </script>
+
+  <style type="text/css">
+    #metatagFields #reset {
+      text-align: right;
+    }
+    body {
+      font-family: Verdana, Arial, Helvetica, sans-serif;
+      color: #666666;
+    }
+   a {
+     text-decoration: none;
+   }
+   
+   fieldset {
+     background-image: url(yellow_crossfade_01.gif);
+     background-repeat: repeat-y;
+     background-position: left top;
+   }
+   
+   #metatagFields {
+    width: 300px;
+    margin-top: 10px;
+   }
+   
+   #metatagFields legend {
+    background-color: #FFFFFF;
+    border: 1px dashed #333333;
+   }
+  </style>
+	
+ </head>
+ <body onload='init()' >
+  
+<div id='instructions'>Select a topic to seee more about it</div>
+  <div id='curentItemList'>
+   <a href='javascript:show_details( "JSON")'>JSON</a>,  <a href='javascript:show_details( "JSON-RPC")'>JSON-RPC</a>, <a href='javascript:show_details( "Ruby")' >Ruby</a>
+ </div>
+  
+  <div id='currentSelectionSet'>
+   <form name='metatagForm' action='#' method="get">
+    <fieldset id='metatagFields'>
+      <legend>Topic info</legend>
+			<div id='details'></div>
+    </fieldset>
+   </form>
+  </div>
+ </body>
+</html>