Merge pull request #10 from arangodb/traversals

Implemented traversal. Fixes #9.

Author: pluma

README.md

@@ -529,6 +529,14 @@ Retrieves a list of all incoming edges of the document with the given *documentH
 
 Retrieves a list of all outgoing edges of the document with the given *documentHandle*.
 
+#### edgeCollection.traversal(startVertex, [opts,] callback)
+
+Performs a traversal starting from the given *startVertex* and following edges contained in this edge collection.
+
+See [the HTTP API documentation](https://docs.arangodb.com/HttpTraversal/README.html) for details on the additional arguments.
+
+Please note that while *opts.filter*, *opts.visitor*, *opts.init*, *opts.expander* and *opts.sort* should be strings evaluating to well-formed JavaScript functions, it's not possible to pass in JavaScript functions directly because the functions need to be evaluated on the server and will be transmitted in plain text.
+
 ## Graph API
 
 ### graph.drop([dropCollections,] callback)
@@ -573,6 +581,14 @@ Removes the edge definition with the given *definitionName* form the graph.
 
 If *dropCollection* is set to `true`, the edge collection associated with the definition will also be deleted from the database.
 
+#### graph.traversal(startVertex, [opts,] callback)
+
+Performs a traversal starting from the given *startVertex* and following edges contained in any of the edge collections of this graph.
+
+See [the HTTP API documentation](https://docs.arangodb.com/HttpTraversal/README.html) for details on the additional arguments.
+
+Please note that while *opts.filter*, *opts.visitor*, *opts.init*, *opts.expander* and *opts.sort* should be strings evaluating to well-formed JavaScript functions, it's not possible to pass in JavaScript functions directly because the functions need to be evaluated on the server and will be transmitted in plain text.
+
 ### VertexCollection API
 
 Graph vertex collections extend the *Collection* API with the following methods.

lib/collection.js

@@ -247,6 +247,19 @@ extend(EdgeCollection.prototype, {
   },
   outEdges: function (vertex, callback) {
     return this._edges(vertex, 'out', callback);
+  },
+  traversal: function (startVertex, opts, callback) {
+    if (typeof opts === 'function') {
+      callback = opts;
+      opts = undefined;
+    }
+    this._api.post('traversal', extend({}, opts, {
+      startVertex: startVertex,
+      edgeCollection: this.name
+    }), function (err, data) {
+      if (err) callback(err);
+      else callback(null, data.result);
+    });
   }
 });
 

lib/graph.js

@@ -68,6 +68,19 @@ extend(Graph.prototype, {
       dropCollection = undefined;
     }
     this._gharial.delete('edge/' + definitionName, {dropCollection: dropCollection}, callback);
+  },
+  traversal: function (startVertex, opts, callback) {
+    if (typeof opts === 'function') {
+      callback = opts;
+      opts = undefined;
+    }
+    this._api.post('traversal', extend({}, opts, {
+      startVertex: startVertex,
+      graphName: this.name
+    }), function (err, data) {
+      if (err) callback(err);
+      else callback(null, data.result);
+    });
   }
 });