Merge branch 'expose-ejson'. Add ddp-random to package.json

Author: vsivsi

README.markdown

@@ -3,7 +3,7 @@ Node DDP Client
 
 A callback style DDP ([Meteor](http://meteor.com/)'s Distributed Data Protocol) node client, originally based alansikora's [node-js_ddp-client](https://github.com/alansikora/node-js_ddp-client) and Meteor's python client. Uses a more callback style approach.
 
-The client implements the pre1 and pre2 versions of DDP. 
+The client implements the pre1 and pre2 versions of DDP.
 
 Installation
 ============
@@ -21,13 +21,13 @@ Please see the example in `examples/example.js`. Or here for reference:
 var DDPClient = require("ddp");
 
 var ddpclient = new DDPClient({
-  host: "localhost", 
+  host: "localhost",
   port: 3000,
   /* optional: */
   auto_reconnect: true,
   auto_reconnect_timer: 500,
   use_ejson: true,           // Use Meteor's EJSON to preserve certain data types.
-  use_ssl: false,            
+  use_ssl: false,
   maintain_collections: true // Set to false to maintain your own collections.
 });
 
@@ -58,10 +58,10 @@ ddpclient.connect(function(error) {
         function (err, result) {   // callback which returns the method call results
           console.log('called function, result: ' + result);
         },
-        function () {              // callback which fires when server has finished 
+        function () {              // callback which fires when server has finished
           console.log('updated');  // sending any updated documents as a result of
-          console.log(ddpclient.collections.posts);  // calling this method 
-        }                          
+          console.log(ddpclient.collections.posts);  // calling this method
+        }
       );
     }, 3000);
 
@@ -86,9 +86,9 @@ ddpclient.on('message', function (msg) {
   console.log("ddp message: " + msg);
 });
 
-/* 
+/*
  * If you need to do something specific on close or errors.
- * You can also disable auto_reconnect and 
+ * You can also disable auto_reconnect and
  * call ddpclient.connect() when you are ready to re-connect.
 */
 ddpclient.on('socket-close', function(code, message) {
@@ -99,6 +99,10 @@ ddpclient.on('socket-error', function(error) {
   console.log("Error: %j", error);
 });
 
+/*
+ * If use_ejson is true, you can access the EJSON object used by ddp.
+ */
+var oid = new ddpclient.EJSON.ObjectID();
 ```
 
 Unimplemented Features
@@ -117,3 +121,4 @@ Contributions:
  * Mike Bannister (@possiblities)
  * Chris Mather (@eventedmind)
  * James Gill (@jagill)
+ * Vaughn Iverson

lib/ddp-client.js

@@ -29,6 +29,10 @@ DDPClient = function(opts) {
   self.ddp_version = ('ddp_version' in opts) ? opts.ddp_version : 'pre2';
   self.supported_ddp_versions = ['pre2', 'pre1'];
 
+  // Expose EJSON object, so client can use EJSON.addType(...)
+  if (self.use_ejson)
+    self.EJSON = EJSON
+
   // very very simple collections (name -> [{id -> document}])
   if (self.maintain_collections)
     self.collections = {};

package.json

@@ -24,7 +24,8 @@
     "underscore": "1.5.2",
     "ddp-ejson": "0.8.1-2",
     "ddp-srp": "0.8.1-1",
-    "faye-websocket": "~0.7.1"
+    "faye-websocket": "~0.7.1",
+    "ddp-random": "~0.8.1-1"
   },
   "devDependencies": {
     "mocha": "1.9.x",

test/ddp-client.js

@@ -102,6 +102,15 @@ describe('EJSON', function() {
     done();
   });
 
+  it('should expose the EJSON object', function(done) {
+    var ddpclient = new DDPClient();
+
+    assert(ddpclient.EJSON);
+    assert(ddpclient.EJSON.addType);
+
+    done();
+  });
+
   it('should not be used when disabled', function(done) {
     var ddpclient = new DDPClient({ use_ejson : false });