resultsMap function to handle special cases of nested collections. In

this case the inconsistent response from CF to instance inquiries,
wherein the result is an object with string index -> instance key/values
instead of an array

lib/collections.js

@@ -34,7 +34,7 @@ var factory = module.exports = function (request) {
         };
     };
 
-    var Collection = function (collection, schema, innerCollections, parent) {
+    var Collection = function (collection, schema, innerCollections, options) {
         /**
          * Collection manages interaction with RESTful collection on
          * cloudfoundry, such as orgs, apps, services, spaces, etc
@@ -47,16 +47,24 @@ var factory = module.exports = function (request) {
                 Object.merge(obj, id);
                 if (id.metadata) {
                     id = id.metadata.guid;
+                } else if (typeof id.index !== 'undefined') {
+                    id = id.index;
                 }
             }
 
             (innerCollections || []).each(function (each) {
-                var method, innerCollectionName, isNestedCollection = false;
+                var method,
+                    innerCollectionName,
+                    options = {},
+                    isNestedCollection = false;
 
                 if (typeof each === 'object') {
                     method = each.method;
                     innerCollectionName = each.endpoint || method;
                     isNestedCollection = !! each.nested;
+                    if (each.resultsMap) {
+                        options.resultsMap = each.resultsMap;
+                    }
                 } else {
                     method = each.camelize(false);
                     innerCollectionName = each;
@@ -65,7 +73,9 @@ var factory = module.exports = function (request) {
                 if (isNestedCollection) {
                     obj[method] =
                         new Collection(util.format('%s/%s/%s', collection, id,
-                            innerCollectionName), {}, each.nested);
+                            innerCollectionName),
+                            {},
+                            each.nested, options);
                 } else {
                     obj[method] = new InnerCollection(collection,
                                                       id,
@@ -150,9 +160,17 @@ var factory = module.exports = function (request) {
                     return callback(err);
                 }
 
+                if (options && options.resultsMap) {
+                    results = options.resultsMap(results);
+                }
+
                 results = results.map(makeObject);
 
-                callback(null, multiResults ? results : results[0]);
+                if (! multiResults) {
+                    results = results[0];
+                }
+
+                callback(null, results);
             });
         };
 

lib/vcap.js

@@ -40,9 +40,24 @@ var VcapClient = module.exports = function (info) {
     }, [ 'routes', 'summary', 'service_bindings', {
         method: 'instances',
         nested: [{
-            method:   'logs',
-            endpoint: 'files/logs'
-        }]
+            method:     'logs',
+            endpoint:   'files/logs'
+        }],
+        resultsMap:     function (results) {
+            // the result from CF seems to be inconsistent. rather than an
+            // array of instances, it's a map where keys are string index
+            // numbers. We convert it here, recording the index to the `index`
+            // field as a parsed int
+
+            var asArray = [];
+
+            Object.keys(results[0], function (key, value) {
+                value.index = parseInt(key, 10);
+                asArray[value.index] = value;
+            });
+
+            return asArray;
+        }
     }]);
 
     this.services = collections.create('services', {

test/collections.js

@@ -189,7 +189,15 @@ describe('collections', function () {
                         method: 'inner2',
                         nested: [{
                             method: 'inner2inner2'
-                        }]
+                        }],
+
+                        resultsMap: function (results) {
+                            results.each(function (each, index) {
+                                each.fake = index;
+                            });
+
+                            return results;
+                        }
                     }
                 ]
             );
@@ -206,8 +214,10 @@ describe('collections', function () {
                 done();
             });
 
-            collection.get(0).inner2.get(function (err, result_) {
+            collection.get(0).inner2.get(function (err, results) {
                 assert(! err, err);
+                assert.equal(results[0].fake, 0); // proves resultsMap was
+                                                  // executed
             });
         });
     });