Add skeleton implementation for Datastore provider (#138)

The backend team is still working on event payload changes, so this just helps them tests with an `Event<any>` implementation. It is very intentional that this is not exposed in index.ts; alpha testers will manually reach into lib/providers/datastore.

Author: inlined

spec/index.spec.ts

@@ -36,6 +36,7 @@ import './testing.spec';
 import './providers/analytics.spec';
 import './providers/auth.spec';
 import './providers/database.spec';
+import './providers/datastore.spec';
 import './providers/https.spec';
 import './providers/pubsub.spec';
 import './providers/storage.spec';

spec/providers/datastore.spec.ts

@@ -0,0 +1,70 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import * as datastore from '../../src/providers/datastore';
+import { expect } from 'chai';
+
+describe('Datastore Functions', () => {
+
+  before(() => {
+    process.env.GCLOUD_PROJECT = 'project1';
+  });
+
+  after(() => {
+    delete process.env.GCLOUD_PROJECT;
+  });
+
+  describe('DataConstructors', () => {
+    function expectedTrigger(resource: string) {
+      return {
+        eventTrigger: {
+          resource,
+          eventType: `providers/${datastore.provider}/eventTypes/document.write`,
+        },
+      };
+    }
+
+    it('should allow terse constructors', () => {
+      let resource = 'projects/project1/databases/(default)/documents/users/{uid}';
+      let cloudFunction = datastore.document('users/{uid}').onWrite(() => null);
+      expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource));
+    });
+
+    it('should allow custom namespaces', () => {
+      let resource = 'projects/project1/databases/(default)/documents@v2/users/{uid}';
+      let cloudFunction = datastore.namespace('v2').document('users/{uid}').onWrite(() => null);
+      expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource));
+    });
+
+    it('should allow custom databases', () => {
+      let resource = 'projects/project1/databases/myDB/documents/users/{uid}';
+      let cloudFunction = datastore.database('myDB').document('users/{uid}').onWrite(() => null);
+      expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource));
+    });
+
+    it('should allow both custom database and namespace', () => {
+      let resource = 'projects/project1/databases/myDB/documents@v2/users/{uid}';
+      let cloudFunction = datastore.database('myDB').namespace('v2').document('users/{uid}').onWrite(() => null);
+      expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource));
+    });
+  });
+});

src/providers/datastore.ts

@@ -0,0 +1,79 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import { makeCloudFunction, CloudFunction, Event } from '../cloud-functions';
+
+/** @internal */
+export const provider = (new Buffer('Y2xvdWQuZmlyc3RvcmU=', 'base64')).toString();
+
+/** @internal */
+export const defaultDatabase = '(default)';
+
+/** Handle events in the Firebase Auth user lifecycle. */
+export function database(database: string = defaultDatabase) {
+  return new DatabaseBuilder(`projects/${process.env.GCLOUD_PROJECT}/databases/${database}`);
+}
+
+export function namespace(namespace: string) {
+  return database().namespace(namespace);
+}
+
+export function document(path: string) {
+  return database().document(path);
+}
+
+export class DatabaseBuilder {
+  /** @internal */
+  constructor(private resource: string) {}
+
+  namespace(namespace: string) {
+    return new NamespaceBuilder(`${this.resource}/documents@${namespace}`);
+  }
+
+  document(path: string) {
+    return (new NamespaceBuilder(`${this.resource}/documents`)).document(path);
+  }
+}
+
+export class NamespaceBuilder {
+  /** @internal */
+  constructor(private resource: string) {}
+
+  document(path: string) {
+    return new DocumentBuilder(`${this.resource}/${path}`);
+  }
+}
+
+export class DocumentBuilder {
+  /** @internal */
+  constructor(private resource: string) {
+    // TODO what validation do we want to do here?
+  }
+
+  onWrite(handler: (event: Event<any>) => PromiseLike<any> | any): CloudFunction<any> {
+    return makeCloudFunction({
+      provider, handler,
+      resource: this.resource,
+      eventType: 'document.write',
+    });
+  }
+}