Shift to neo4j-driver as name

Author: jakewins

README.md

@@ -1,72 +1,75 @@
 # Neo4j Driver for Javascript
 
-An alpha-level database driver for a new Neo4j remoting protocol.
+An alpha-level database driver for Neo4j 3.0.0+.
 
 Note: This is in active development, the API is not stable. Please try it out and give us feedback, but expect things to break in the medium term!
 
 ## Include module in Node.js application
 
+```shell
+npm install neo4j-driver
+```
+
 ```javascript
-var neo4j = require('neo4j').v1;
+var neo4j = require('neo4j-driver/v1');
 ```
 
 ## Include in web browser
-A global object `neo4j` will be available.
+
+We build a special browser version of the driver, which supports connecting to Neo4j over WebSockets.
 
 ```html
 <script src="lib/browser/neo4j-web.min.js"></script>
 ```
 
-## Usage examples (for both Node.js and browser environments)
+This will make a global `neo4j` object available, where you can access the `v1` API at `neo4j.v1`:
 
 ```javascript
-var statement = ['MERGE (alice:Person {name:{name_a},age:{age_a}})',
-    'MERGE (bob:Person {name:{name_b},age:{age_b}})',
-    'CREATE UNIQUE (alice)-[alice_knows_bob:KNOWS]->(bob)',
-    'RETURN alice, bob, alice_knows_bob'
-];
+var driver = neo4j.v1.driver("bolt://localhost");
+```
 
-var params = {
-    name_a: 'Alice',
-    age_a: 33,
-    name_b: 'Bob',
-    age_b: 44
-};
+## Usage examples
 
+```javascript
 
-// Create a Session object to contain all Cypher activity.
+// Create a driver instance
 var driver = neo4j.driver("bolt://localhost");
+
+// Create a session to run Cypher statements in.
+// Note: Always make sure to close sessions when you are done using them!
 var session = driver.session();
 
-// Run a Cypher statement within an implicit transaction
-// The streaming way:
-session.run(statement.join(' '), params).subscribe({
+// Run a Cypher statement, reading the result in a streaming manner as records arrive:
+session
+  .run("MATCH (alice {name : {nameParam} }) RETURN alice.age", { nameParam:'Alice' })
+  .subscribe({
     onNext: function(record) {
-        // On receipt of RECORD
-        for(var i in record) {
-            console.log(i, ': ', record[i]);
-        }
-    }, onCompleted: function() {
-        session.close();
-    }, onError: function(error) {
-        console.log(error);
+      console.log(record);
+    }, 
+    onCompleted: function() {
+      // Completed!
+      session.close();
+    }, 
+    onError: function(error) {
+      console.log(error);
     }
-});
+  });
 
 // or
-// the Promise way, where the complete response is collected:
-session.run(statement.join(' '), params)
-    .then(function(records){
-        records.forEach(function(record) {
-            for(var i in record) {
-                console.log(i, ': ', record[i]);
-            }
-        });
-        session.close();
-    })
-    .catch(function(error) {
-        console.log(error);
+// the Promise way, where the complete result is collected before we act on it:
+session
+  .run("MATCH (alice {name : {nameParam} }) RETURN alice.age", { nameParam:'Alice' })
+  .then(function(records){
+    records.forEach(function(record) {
+      console.log(record);
     });
+
+    // Completed!
+    session.close();
+  })
+  .catch(function(error) {
+    console.log(error);
+  });
 ```
 
 ## Building
@@ -85,23 +88,47 @@ This runs the test suite against a fresh download of Neo4j.
 Or `npm test` if you already have a running version of a compatible Neo4j server.
 
 ### Testing on windows
-Running tests on windows requires PhantomJS installed and its bin folder added in windows system variable `Path`.
-To run the same test suite, run `.\runTest.ps1` instead in powershell with admin right.
-The admin right is required to start/stop Neo4j properly as a system service.
+Running tests on windows requires PhantomJS installed and its bin folder added in windows system variable `Path`.  
+To run the same test suite, run `.\runTest.ps1` instead in powershell with admin right.  
+The admin right is required to start/stop Neo4j properly as a system service.  
 While there is no need to grab admin right if you are running tests against an existing Neo4j server using `npm test`.
 
 ## A note on numbers and the Integer type
-For this driver to fully map to the Neo4j type system handling of 64-bits Integers is needed.
-Javascript can saftely represent numbers between `-(2`<sup>`53`</sup>` - 1)` and `(2`<sup>`53`</sup>` - 1)`.
-Therefore, an Integer type is introduced.
+The Neo4j type system includes 64-bit integer values.
+However, Javascript can only safely represent integers between `-(2`<sup>`53`</sup>` - 1)` and `(2`<sup>`53`</sup>` - 1)`.  
+In order to support the full Neo4j type system, the driver includes an explicit Integer types.
+Any time the driver recieves an Integer value from Neo4j, it will be represented with the Integer type by the driver.
 
 ### Write integers
-Number written directly e.g. `session.run("CREATE (n:Node {age: {age}})", {age: 22})` will be of type `Float` in Neo4j.
-To write the `age` as an integer the `neo4j.int` method should be used.
-E.g. `session.run("CREATE (n:Node {age: {age}})", {age: neo4j.int(22)})`.
+Number written directly e.g. `session.run("CREATE (n:Node {age: {age}})", {age: 22})` will be of type `Float` in Neo4j.  
+To write the `age` as an integer the `neo4j.int` method should be used:
+
+```javascript
+var neo4j = require('neo4j-driver');
+
+session.run("CREATE (n {age: {myIntParam}})", {myIntParam: neo4j.int(22)});
+```
+
+To write integers larger than can be represented as JavaScript numbers, use a string argument to `neo4j.int`:
+
+```javascript
+session.run("CREATE (n {age: {myIntParam}})", {myIntParam: neo4j.int("9223372036854775807")});
+```
 
 ### Read integers
-To get the value of a from Neo4j received integer, the safeast way would be to use the `.toString()` method on
-an Integer object.
-E.g. `console.log(result.age.toString())`.
-To check if a variable is of the Integer type, the method `neo4j.isInt(variable)` can be used.
+Since Integers can be larger than can be represented as JavaScript numbers, it is only safe to convert Integer instances to JavaScript numbers if you know that they will not exceed `(2`<sup>`53`</sup>` - 1)` in size:
+
+```javascript
+var aSmallInteger = neo4j.int(123);
+var aNumber = aSmallInteger.toNumber();
+```
+
+If you will be handling integers larger than that, you can use the Integer instances directly, or convert them to strings:
+
+```javascript
+var aLargerInteger = neo4j.int("9223372036854775807");
+var integerAsString = aLargerInteger.toString();
+```
+
+To help you work with Integers, the Integer class exposes a large set of arithmetic methods.
+Refer to the Integer API docs for details.

gulpfile.js

@@ -35,11 +35,13 @@ var babelify = require('babelify');
 var babel = require('gulp-babel');
 var watch = require('gulp-watch');
 var batch = require('gulp-batch');
+var replace = require('gulp-replace');
+var decompress = require('gulp-decompress');
 var fs = require("fs");
 var runSequence = require('run-sequence');
 var path = require('path');
 var childProcess = require("child_process");
-var decompress = require('gulp-decompress');
+var minimist = require('minimist');
 
 gulp.task('default', ["test"]);
 
@@ -52,7 +54,7 @@ gulp.task('build-browser', function () {
   var browserOutput = 'lib/browser';
   // Our app bundler
   var appBundler = browserify({
-    entries: ['src/neo4j.js'],
+    entries: ['src/index.js'],
     cache: {},
     standalone: 'neo4j',
     packageCache: {}
@@ -196,10 +198,16 @@ var runPowershell = function( cmd ) {
     child.stdin.end(); //end input
 }
 
-// gulp.task('start-neo4j', ['download-neo4j'], shell.task([
-//   'chmod +x ' + neo4jHome + '/bin/neo4j',
-//   neo4jHome + '/bin/neo4j start',
-// ]));
+gulp.task('set', function() {
+  // Get the --version arg from command line
+  var version = minimist(process.argv.slice(2), { string: 'version' }).version;
+
+  // Change the version in relevant files
+  return gulp.src(['package.json'], {base: "./"})
+      .pipe(replace('0.0.0-dev', version))
+      .pipe(gulp.dest('./'));
+
+});
 
 gulp.task('start-neo4j', ['download-neo4j'], function() {
   if(isWin) {

package.json

@@ -1,9 +1,9 @@
 {
   "name": "neo4j-driver",
-  "version": "1.0.0-alpha.1",
+  "version": "0.0.0-dev",
   "description": "Connect to Neo4j 3.0.0 and up from JavaScript",
   "author": "Neo Technology Inc.",
-  "license": "Apache License 2.0",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/neo4j/neo4j-javascript-driver.git"
@@ -27,20 +27,22 @@
     "gulp-batch": "^1.0.5",
     "gulp-concat": "^2.6.0",
     "gulp-cucumber": "^0.0.12",
+    "gulp-decompress": "^1.2.0",
     "gulp-download": "^0.0.1",
     "gulp-if": "^1.2.5",
     "gulp-jasmine": "^2.1.0",
     "gulp-jasmine-browser": "^0.2.3",
+    "gulp-replace": "^0.5.4",
     "gulp-shell": "^0.4.3",
     "gulp-uglify": "^1.4.2",
     "gulp-util": "^3.0.6",
     "gulp-watch": "^4.3.5",
     "jasmine-reporters": "^2.0.7",
+    "minimist": "^1.2.0",
     "phantomjs2-ext": "^0.1.0",
     "run-sequence": "^1.1.4",
     "through2": "~2.0.0",
     "vinyl-buffer": "^1.0.0",
-    "vinyl-source-stream": "^1.1.0",
-    "gulp-decompress": "^1.2.0"
+    "vinyl-source-stream": "^1.1.0"
   }
 }

src/neo4j.js renamed to src/index.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-import neo4j from '../neo4j';
+import neo4j from '../index';
 
 /**
   * A ResultSummary instance contains structured metadata for a {Result}.

src/v1/result-summary.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-var neo4j = require("../lib/neo4j").v1;
+var neo4j = require("../lib/index").v1;
 
 describe('driver', function() {
   it('should expose sessions', function() {

test/driver.test.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-var neo4j = require("../lib/neo4j").v1;
+var neo4j = require("../lib/index").v1;
 var StatementType = require("../lib/v1/result-summary").statementType;
 
 describe('session', function() {

test/session.test.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-var neo4j = require("../lib/neo4j").v1;
+var neo4j = require("../lib/index").v1;
 
 describe('floating point values', function() {
   it('should support float 1.0 ', testVal( 1 ) );