Indexing code cleanup and minor API refinements.

In particular, get{Node|Relationship}Indexes() now returns an array of string
names rather than a straight map, but has the map properties too.
And it returns an empty array in the 204 case rather than null.

Author: aseemk

lib/GraphDatabase._coffee

@@ -409,144 +409,167 @@ module.exports = class GraphDatabase
     ### Indexes: ###
 
     #
-    # Get list of node indexes.
+    # Get the current existing node indexes.
+    # "Returns" (via callback) an array of string index names, but the array
+    # also serves as a dictionary of index name to its config properties.
     #
     # @param callback {Function}
+    # @return {Array<String>}
+    #
+    #   db.getNodeIndexes(function (err, indexes) {
+    #       if (err) throw err;
+    #       indexes.forEach(function (name) {
+    #           console.log('Index', name, 'has config:', indexes[name]);
+    #       });
+    #   });
     #
     getNodeIndexes: (_) ->
         try
             services = @getServices _
+            response = @_request.get services.node_index, _
 
-            url = "#{services.node_index}/"
-
-            response = @_request.get url, _
-
-            if response.statusCode isnt status.OK and response.statusCode isnt status.NO_CONTENT
+            if response.statusCode not in [status.OK, status.NO_CONTENT]
                 # Database error
                 throw response
 
-            # Success
-            return response.body
+            # Success: transform the map into an array-map hybrid.
+            map = response.body or {}
+            arr = []
+            for name, props of map
+                arr.push name
+                arr[name] = props
+            return arr
 
         catch error
             throw adjustError error
 
     #
     # Create node index.
     #
-    # @param index {String}
+    # @param name {String}
     # @param callback {Function}
     #
-    createNodeIndex: (index, _) ->
+    createNodeIndex: (name, _) ->
         try
             services = @getServices _
 
             response = @_request.post
-                url: "#{services.node_index}/"
-                json:
-                    name: index
+                url: services.node_index
+                json: {name}
             , _
 
             if response.statusCode isnt status.CREATED
                 # Database error
                 throw response
 
             # Success
-            return response.body
+            return
 
         catch error
             throw adjustError error
 
     #
     # Delete a node index.
     #
-    # @param index {String}
+    # @param name {String}
     # @param callback {Function}
     #
-    deleteNodeIndex: (index, _) ->
+    deleteNodeIndex: (name, _) ->
         try
             services = @getServices _
-
-            url = "#{services.node_index}/#{index}"
-            response = @_request.del url, _
+            response = @_request.del
+                url: "#{services.node_index}/#{encodeURIComponent name}"
+            , _
 
             if response.statusCode isnt status.NO_CONTENT
                 # Database error
                 throw response
 
             # Success
-            return null
+            return
 
         catch error
             throw adjustError error
 
     #
-    # Get list of relationship indexes.
+    # Get the current existing relationship indexes.
+    # "Returns" (via callback) an array of string index names, but the array
+    # also serves as a dictionary of index name to its config properties.
     #
     # @param callback {Function}
+    # @return {Array<String>}
+    #
+    #   db.getRelationshipIndexes(function (err, indexes) {
+    #       if (err) throw err;
+    #       indexes.forEach(function (name) {
+    #           console.log('Index', name, 'has config:', indexes[name]);
+    #       });
+    #   });
     #
     getRelationshipIndexes: (_) ->
         try
             services = @getServices _
+            response = @_request.get services.relationship_index, _
 
-            url = "#{services.relationship_index}/"
-            response = @_request.get url, _
-
-            if response.statusCode isnt status.OK and response.statusCode isnt status.NO_CONTENT
+            if response.statusCode not in [status.OK, status.NO_CONTENT]
                 # Database error
                 throw response
 
-            # Success
-            return response.body
+            # Success: transform the map into an array-map hybrid.
+            map = response.body or {}
+            arr = []
+            for name, props of map
+                arr.push name
+                arr[name] = props
+            return arr
 
         catch error
             throw adjustError error
 
     #
     # Create relationship index.
     #
-    # @param index {String}
+    # @param name {String}
     # @param callback {Function}
     #
-    createRelationshipIndex: (index, _) ->
+    createRelationshipIndex: (name, _) ->
         try
             services = @getServices _
 
             response = @_request.post
                 url: "#{services.relationship_index}/"
-                json:
-                    name: index
+                json: {name}
             , _
 
             if response.statusCode isnt status.CREATED
                 # Database error
                 throw response
 
             # Success
-            return response.body
+            return
 
         catch error
             throw adjustError error
 
     #
     # Delete a relationship index.
     #
-    # @param index {String}
+    # @param name {String}
     # @param callback {Function}
     #
-    deleteRelationshipIndex: (index, _) ->
+    deleteRelationshipIndex: (name, _) ->
         try
             services = @getServices _
-
-            url = "#{services.relationship_index}/#{index}"
-            response = @_request.del url, _
+            response = @_request.del
+                url: "#{services.relationship_index}/#{encodeURIComponent name}"
+            , _
 
             if response.statusCode isnt status.NO_CONTENT
                 # Database error
                 throw response
 
             # Success
-            return null
+            return
 
         catch error
             throw adjustError error

test/crud._coffee

@@ -23,42 +23,51 @@ mat = null
 relationship = null
 
 # index list
-nodeIndexes = null
-relIndexes = null
 nodeIndexName = 'testUsers'
 relIndexName = 'testFollows'
 
+
+## TESTS:
+
 @crud =
 
     'getNodeIndexes': (_) ->
         nodeIndexes = db.getNodeIndexes _
-        if nodeIndexes
-            expect(nodeIndexes).to.be.an 'object'
-        else
-            # requires a clean db to test
-            expect(nodeIndexes).to.be undefined
+
+        # we should always get back an array of names, but the array should
+        # have map-like properties for the index config details too:
+        expect(nodeIndexes).to.be.an 'array'
+        for name in nodeIndexes
+            expect(nodeIndexes).to.have.key name
+            expect(nodeIndexes[name]).to.be.an 'object'
+            expect(nodeIndexes[name].type).to.be.a 'string'
 
     'getRelationshipIndexes': (_) ->
         relIndexes = db.getRelationshipIndexes _
-        if relIndexes
-            expect(relIndexes).to.be.an 'object'
-        else
-            # requires a clean db to test
-            expect(relIndexes).to.be undefined
+
+        # we should always get back an array of names, but the array should
+        # have map-like properties for the index config details too:
+        expect(relIndexes).to.be.an 'array'
+        for name in relIndexes
+            expect(relIndexes).to.have.key name
+            expect(relIndexes[name]).to.be.an 'object'
+            expect(relIndexes[name].type).to.be.a 'string'
 
     'createNodeIndex': (_) ->
-        testIndex = db.createNodeIndex nodeIndexName, _
-        expect(testIndex).to.be.an 'object'
+        db.createNodeIndex nodeIndexName, _
+
+        # our newly created index should now be in the list of indexes:
         nodeIndexes = db.getNodeIndexes _
-        expect(nodeIndexes).to.be.an 'object'
-        expect(nodeIndexes[nodeIndexName]).to.be.an 'object'
+        expect(nodeIndexes).to.contain nodeIndexName
+        expect(nodeIndexes).to.have.key nodeIndexName
 
     'createRelationshipIndex': (_) ->
-        testIndex = db.createRelationshipIndex relIndexName, _
-        expect(testIndex).to.be.an 'object'
+        db.createRelationshipIndex relIndexName, _
+
+        # our newly created index should now be in the list of indexes:
         relIndexes = db.getRelationshipIndexes _
-        expect(relIndexes).to.be.an 'object'
-        expect(relIndexes[relIndexName]).to.be.an 'object'
+        expect(relIndexes).to.contain relIndexName
+        expect(relIndexes).to.have.key relIndexName
 
     'create nodes': (_) ->
         daniel = db.createNode danielData
@@ -222,30 +231,26 @@ relIndexName = 'testFollows'
         expect(matRelationship).to.be null
         expect(idRelationship).to.be null
 
-
-    # TODO delete tests! that's the 'd' in 'crud'!
+    # TODO test deleting nodes and relationships!
 
     'deleteNodeIndex': (_) ->
-        testIndex = db.deleteNodeIndex nodeIndexName, _
-        expect(testIndex).to.be null
+        db.deleteNodeIndex nodeIndexName, _
+
+        # our index should no longer be in the list of indexes:
         nodeIndexes = db.getNodeIndexes _
-        if nodeIndexes
-            expect(nodeIndexes).to.be.an 'object'
-            expect(nodeIndexes[nodeIndexName]).to.be undefined
-        else
-            expect(nodeIndexes).to.be undefined
+        expect(nodeIndexes).to.not.contain nodeIndexName
+        expect(nodeIndexes).to.not.have.key nodeIndexName
 
     'deleteRelationshipIndex': (_) ->
-        testIndex = db.deleteRelationshipIndex relIndexName, _
-        expect(testIndex).to.be null
+        db.deleteRelationshipIndex relIndexName, _
+
+        # our index should no longer be in the list of indexes:
         relIndexes = db.getRelationshipIndexes _
-        if relIndexes
-            expect(relIndexes).to.be.an 'object'
-            expect(relIndexes[relIndexName]).to.be undefined
-        else
-            expect(relIndexes).to.be undefined
+        expect(relIndexes).to.not.contain relIndexName
+        expect(relIndexes).to.not.have.key relIndexName
 
 
+## HELPERS:
 
 testRelationship = (relationship) ->
     expect(relationship).to.be.an 'object'