Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial commit.

  • Loading branch information...
commit d6f3fafa08d8182cc2f5afd83365e11012a0451c 0 parents
@gasi gasi authored
Showing with 488 additions and 0 deletions.
  1. +2 −0  .gitignore
  2. +202 −0 LICENSE
  3. +44 −0 README.md
  4. +223 −0 lib/neo4j.js
  5. +17 −0 package.json
2  .gitignore
@@ -0,0 +1,2 @@
+.DS_Store
+test/
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
44 README.md
@@ -0,0 +1,44 @@
+Neo4j REST API Client for Node.js
+=================================
+
+This client library let's you access the [Neo4j REST API][neo-rest-api] through
+a simple JavaScript API.
+
+
+Installation
+------------
+
+ npm link
+
+Usage
+-----
+
+ var Neo4jClient = require('neo4j');
+ var client = new Neo4jClient('localhost', 7474)
+ var print = function (err, res) {
+ console.log(err ? err : res);
+ };
+
+ client.createNode({'hello': 'world'}, print);
+
+
+Test
+----
+
+ node test/
+
+
+License
+-------
+
+This library is licensed under the [Apache License, Version 2.0][license].
+
+Reporting Issues
+----------------
+
+If you encounter any bugs or other issues, please file them in the
+[issue tracker][issue-tracker].
+
+[neo-rest-api]: http://components.neo4j.org/neo4j-server/snapshot/rest.html
+[issue-tracker]: https://github.com/gasi/node-neo4j/issues
+[license]: http://www.apache.org/licenses/LICENSE-2.0.html
223 lib/neo4j.js
@@ -0,0 +1,223 @@
+//////////////////////////////////////////////////////////////////////////////
+//
+// Neo4j REST client for Node.js
+//
+// Copyright 2011 Daniel Gasienica <daniel@gasienica.ch>
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+//
+//////////////////////////////////////////////////////////////////////////////
+
+var http = require('http');
+var qs = require('querystring');
+
+var Neo4jClient = exports = module.exports = function Neo4jClient(host, port, basePath) {
+ this.host = host || 'localhost';
+ this.port = port || 7474;
+ this.basePath = basePath || '/db/data';
+};
+
+Neo4jClient.prototype.getRoot = function (callback) {
+ var options = {
+ method: 'GET'
+ };
+ this.request('/', options, jsonBodyHandler(callback));
+};
+
+Neo4jClient.prototype.getNode = function (id, callback) {
+ var options = {
+ method: 'GET'
+ };
+ this.request('/node/' + id + '/properties', options, jsonBodyHandler(callback));
+};
+
+Neo4jClient.prototype.createNode = function (data, callback) {
+ var options = {
+ method: 'POST',
+ data: data ? JSON.stringify(data) : data
+ };
+ this.request('/node', options,
+ function(err, res) {
+ var error;
+ if (err) {
+ callback(err, null);
+ } else if (res.statusCode !== 201) {
+ error = createErrorFromResponse(res);
+ switch(res.statusCode) {
+ case 400:
+ error.message = 'Invalid data sent.';
+ break;
+ }
+ callback(error, null);
+ } else {
+ var location = res.headers['location'];
+ callback(null, location);
+ }
+ }
+ );
+};
+
+Neo4jClient.prototype.updateNode = function (id, data, callback) {
+ var options = {
+ method: 'PUT',
+ data: JSON.stringify(data)
+ };
+ this.request('/node/' + id + '/properties', options,
+ function(err, res) {
+ var error;
+ if (err) {
+ callback(err);
+ } else if (res.statusCode !== 204) {
+ error = createErrorFromResponse(res);
+ switch(res.statusCode) {
+ case 400:
+ error.message = 'Invalid data sent.';
+ break;
+ case 404:
+ error.message = 'Node not found';
+ break;
+ default:
+ break;
+ }
+ callback(error);
+ } else {
+ callback(null);
+ }
+ }
+ );
+};
+
+Neo4jClient.prototype.deleteNode = function (id, callback) {
+ var options = {
+ method: 'DELETE'
+ };
+ this.request('/node/' + id, options,
+ function(err, res) {
+ var error;
+ if (err) {
+ callback(err);
+ } else if (res.statusCode !== 204) {
+ error = createErrorFromResponse(res);
+ switch(res.statusCode) {
+ case 404:
+ error.message = 'Node not found';
+ break;
+ case 409:
+ error.message = 'Node could not be deleted (still has relationships?)';
+ break;
+ default:
+ break;
+ }
+ callback(error);
+ } else {
+ callback(null);
+ }
+ }
+ );
+};
+
+Neo4jClient.prototype.request = function (path, options, callback) {
+ var path = path || '/';
+
+ var options = options || {};
+ var method = options.method || 'GET';
+ var data = options.data || null;
+ var params = options.params || null;
+
+ // normalize path to begin with a slash
+ if (path.charAt(0) !== '/') {
+ path = '/' + path;
+ }
+
+ // add base path
+ path = this.basePath + path;
+
+ // attach query string parameters
+ if (params) {
+ var separator = '?';
+ if (path.indexOf('?') !== -1) {
+ separator = '&';
+ }
+ path += separator + qs.stringify(params);
+ }
+
+ var requestOptions = {
+ host: this.host,
+ port: this.port,
+ method: method,
+ path: path,
+ headers: {
+ 'Accept': 'application/json'
+ }
+ };
+
+ if (data) {
+ requestOptions.headers['Content-Type'] = 'application/json';
+ }
+
+ var request = http.request(requestOptions, function (res) {
+ res.setEncoding('utf8');
+ var body = '';
+ res.on('data', function (chunk) {
+ body += chunk;
+ });
+ res.on('end', function () {
+ res.body = body
+ callback(null, res);
+ });
+ });
+
+ request.on('error', function (err) {
+ callback(error, null);
+ });
+
+ if (data) {
+ request.write(data);
+ }
+
+ request.end();
+};
+
+
+function createErrorFromResponse(response) {
+ var error = {
+ statusCode: response.statusCode,
+ headers: response.headers
+ };
+ return error;
+}
+
+function jsonBodyHandler(callback) {
+ return function(err, res) {
+ var error = null;
+ if (err) {
+ callback(err, null);
+ } else if (res.statusCode !== 200) {
+ error = createErrorFromResponse(res);
+ callback(error, null);
+ } else {
+ var data;
+ try {
+ data = JSON.parse(res.body);
+ } catch(e) {
+ error = new Error('Failed to parse JSON.');
+ error.innerError = e;
+ }
+ if (error) {
+ callback(error, null);
+ } else {
+ callback(null, data);
+ }
+ }
+ };
+}
17 package.json
@@ -0,0 +1,17 @@
+{
+ "name": "neo4j",
+ "description": "Neo4j REST client for Node.js",
+ "version": "0.0.1",
+ "author": "Daniel Gasienica <daniel@gasienica.ch>",
+ "main": "lib/neo4j",
+ "keywords": [
+ "neo4j",
+ "graph",
+ "database",
+ "client",
+ "REST"
+ ],
+ "engines": {
+ "node": ">= 0.4.2"
+ }
+}
Please sign in to comment.
Something went wrong with that request. Please try again.