datastore: add declarative methods - fixes #392

lib/common/util.js

@@ -203,6 +203,22 @@ function getType(value) {
   return Object.prototype.toString.call(value).match(/\s(\w+)\]/)[1];
 }
 
+/**
+ * Assign a value to a property in an Array iterator.
+ *
+ * @param {string} prop - Name of the property to assign to the object.
+ * @param {*} value - Value of the property.
+ * @return {function}
+ */
+function propAssign(prop, value) {
+  return function(obj) {
+    obj[prop] = value;
+    return obj;
+  };
+}
+
+module.exports.propAssign = propAssign;
+
 /**
  * Check if an object is of the given type.
  *

lib/datastore/request.js

@@ -147,6 +147,15 @@ DatastoreRequest.prototype.get = function(keys, callback) {
   });
 };
 
+/**
+ * Maps to {module:datastore/dataset#save}, forcing the method to be `insert`.
+ */
+DatastoreRequest.prototype.insert = function(entities, callback) {
+  var isArray = util.is(entities, 'array');
+  entities = util.arrayize(entities).map(util.propAssign('method', 'insert'));
+  this.save(isArray ? entities : entities[0], callback);
+};
+
 /**
  * Insert or update the specified object(s). If a key is incomplete, its
  * associated object is inserted and the original Key object is updated to
@@ -527,6 +536,24 @@ DatastoreRequest.prototype.allocateIds = function(incompleteKey, n, callback) {
   });
 };
 
+/**
+ * Maps to {module:datastore/dataset#save}, forcing the method to be `update`.
+ */
+DatastoreRequest.prototype.update = function(entities, callback) {
+  var isArray = util.is(entities, 'array');
+  entities = util.arrayize(entities).map(util.propAssign('method', 'update'));
+  this.save(isArray ? entities : entities[0], callback);
+};
+
+/**
+ * Maps to {module:datastore/dataset#save}, forcing the method to be `upsert`.
+ */
+DatastoreRequest.prototype.upsert = function(entities, callback) {
+  var isArray = util.is(entities, 'array');
+  entities = util.arrayize(entities).map(util.propAssign('method', 'upsert'));
+  this.save(isArray ? entities : entities[0], callback);
+};
+
 /**
  * Make a request to the API endpoint. Properties to indicate a transactional or
  * non-transactional operation are added automatically.

test/common/util.js

@@ -437,4 +437,12 @@ describe('common/util', function() {
       });
     });
   });
+
+  describe('propAssign', function() {
+    it('should assign a property and value to an object', function() {
+      var obj = {};
+      util.propAssign('prop', 'value')(obj);
+      assert.equal(obj.prop, 'value');
+    });
+  });
 });

test/datastore/request.js

@@ -142,6 +142,26 @@ describe('Request', function() {
     });
   });
 
+  describe('insert', function() {
+    it('should pass the correct arguments to save', function(done) {
+      request.save = function(entities, callback) {
+        assert.deepEqual(entities, {
+          key: {
+            namespace: 'ns',
+            path: ['Company'],
+          },
+          data: {},
+          method: 'insert'
+        });
+
+        callback();
+      };
+
+      var key = new entity.Key({ namespace: 'ns', path: ['Company'] });
+      request.insert({ key: key, data: {} }, done);
+    });
+  });
+
   describe('save', function() {
     it('should save with incomplete key', function(done) {
       request.makeReq_ = function(method, req, callback) {
@@ -461,6 +481,46 @@ describe('Request', function() {
     });
   });
 
+  describe('update', function() {
+    it('should pass the correct arguments to save', function(done) {
+      request.save = function(entities, callback) {
+        assert.deepEqual(entities, {
+          key: {
+            namespace: 'ns',
+            path: ['Company'],
+          },
+          data: {},
+          method: 'update'
+        });
+
+        callback();
+      };
+
+      var key = new entity.Key({ namespace: 'ns', path: ['Company'] });
+      request.update({ key: key, data: {} }, done);
+    });
+  });
+
+  describe('upsert', function() {
+    it('should pass the correct arguments to save', function(done) {
+      request.save = function(entities, callback) {
+        assert.deepEqual(entities, {
+          key: {
+            namespace: 'ns',
+            path: ['Company'],
+          },
+          data: {},
+          method: 'upsert'
+        });
+
+        callback();
+      };
+
+      var key = new entity.Key({ namespace: 'ns', path: ['Company'] });
+      request.upsert({ key: key, data: {} }, done);
+    });
+  });
+
   describe('allocateIds', function() {
     it('should produce proper allocate IDs req protos', function(done) {
       request.makeReq_ = function(method, req, callback) {