added get project api call (#2506)

added get project call https://cloud.google.com/compute/docs/reference/v1/projects

Author: Ashley Schuett

packages/google-cloud-compute/src/index.js

@@ -50,6 +50,12 @@ var Network = require('./network.js');
  */
 var Operation = require('./operation.js');
 
+/**
+ * @type {module: compute/project}
+ * @private
+ */
+var Project = require('./project.js');
+
 /**
  * @type {module:compute/region}
  * @private
@@ -2632,6 +2638,20 @@ Compute.prototype.operation = function(name) {
   return new Operation(this, name);
 };
 
+/**
+ * Get a reference to your Google Compute Engine project.
+ *
+ * @resource [Projects Overview]{@link https://cloud.google.com/compute/docs/reference/v1/projects}
+ *
+ * @return {module:compute/project}
+ *
+ * @example
+ * var project = gce.project();
+ */
+Compute.prototype.project = function() {
+  return new Project(this);
+};
+
 /**
  * Get a reference to a Google Compute Engine region.
  *
@@ -2771,6 +2791,7 @@ common.util.promisifyAll(Compute, {
     'machineType',
     'network',
     'operation',
+    'project',
     'region',
     'rule',
     'service',
@@ -2785,6 +2806,7 @@ Compute.Firewall = Firewall;
 Compute.HealthCheck = HealthCheck;
 Compute.Network = Network;
 Compute.Operation = Operation;
+Compute.Project = Project;
 Compute.Region = Region;
 Compute.Rule = Rule;
 Compute.Service = Service;

packages/google-cloud-compute/src/project.js

@@ -0,0 +1,108 @@
+/*!
+ * Copyright 2017 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*!
+ * @module compute/project
+ */
+
+'use strict';
+
+var common = require('@google-cloud/common');
+var util = require('util');
+
+/*! Developer Documentation
+ *
+ * @param {module:compute} compute - Compute object this project belongs to.
+ */
+/**
+ * A Project object allows you to interact with your Google Compute Engine
+ * project.
+ *
+ * @resource [Projects Overview]{@link https://cloud.google.com/compute/docs/projects}
+ * @resource [Projects Resource]{@link https://cloud.google.com/compute/docs/reference/v1/projects}
+ *
+ * @constructor
+ * @alias module:compute/project
+ *
+ * @example
+ * var project = gce.project();
+ */
+function Project(compute) {
+  this.id = compute.projectId;
+
+  var methods = {
+    /**
+     * Get a Project object.
+     *
+     * @example
+     * project.get(function(err, project, apiResponse) {
+     *   // `project` is a Project object.
+     * });
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * project.get().then(function(data) {
+     *   var project = data[0];
+     *   var apiResponse = data[1];
+     * });
+     */
+    get: true,
+
+    /**
+     * Get the project's metadata.
+     *
+     * @resource [Projects: get API Documentation]{@link https://cloud.google.com/compute/docs/reference/v1/projects/get}
+     * @resource [Projects Resource]{@link https://cloud.google.com/compute/docs/reference/v1/projects}
+     *
+     * @param {function=} callback - The callback function.
+     * @param {?error} callback.err - An error returned while making this
+     *     request.
+     * @param {object} callback.metadata - The machine type's metadata.
+     * @param {object} callback.apiResponse - The full API response.
+     *
+     * @example
+     * project.getMetadata(function(err, metadata, apiResponse) {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * project.getMetadata().then(function(data) {
+     *   var metadata = data[0];
+     *   var apiResponse = data[1];
+     * });
+     */
+    getMetadata: true
+  };
+
+  common.ServiceObject.call(this, {
+    parent: compute,
+    baseUrl: '',
+    id: '',
+    methods: methods
+  });
+}
+
+util.inherits(Project, common.ServiceObject);
+
+/*! Developer Documentation
+ *
+ * All async methods (except for streams) will return a Promise in the event
+ * that a callback is omitted.
+ */
+common.util.promisifyAll(Project);
+
+module.exports = Project;

packages/google-cloud-compute/system-test/compute.js

@@ -739,6 +739,30 @@ describe('Compute', function() {
     });
   });
 
+  describe('project', function() {
+    var project;
+
+    beforeEach(function() {
+      project = compute.project();
+    });
+
+    it('should get the project', function(done) {
+      project.get(function(err, project) {
+        assert.ifError(err);
+        assert(project.metadata);
+        done();
+      });
+    });
+
+    it('should get metadata about the project', function(done) {
+      project.getMetadata(function(err, metadata) {
+        assert.ifError(err);
+        assert(metadata);
+        done();
+      });
+    });
+  });
+
   describe('regions', function() {
     it('should get a list of regions', function(done) {
       compute.getRegions(function(err, regions) {

packages/google-cloud-compute/test/index.js

@@ -46,6 +46,7 @@ var fakeUtil = extend({}, util, {
       'machineType',
       'network',
       'operation',
+      'project',
       'region',
       'rule',
       'service',
@@ -106,6 +107,10 @@ function FakeOperation() {
   this.calledWith_ = slice.call(arguments);
 }
 
+function FakeProject() {
+  this.calledWith_ = slice.call(arguments);
+}
+
 function FakeRegion() {
   this.calledWith_ = slice.call(arguments);
   this.address = function() { return {}; };
@@ -155,6 +160,7 @@ describe('Compute', function() {
       './health-check.js': FakeHealthCheck,
       './network.js': FakeNetwork,
       './operation.js': FakeOperation,
+      './project.js': FakeProject,
       './region.js': FakeRegion,
       './rule.js': FakeRule,
       './service.js': FakeServiceClass,
@@ -2545,6 +2551,14 @@ describe('Compute', function() {
     });
   });
 
+  describe('project', function() {
+    it('should return a Project object', function() {
+      var project = compute.project();
+      assert(project instanceof FakeProject);
+      assert.strictEqual(project.calledWith_[0], compute);
+    });
+  });
+
   describe('region', function() {
     var NAME = 'region-name';
 

packages/google-cloud-compute/test/project.js

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2017 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+var assert = require('assert');
+var extend = require('extend');
+var proxyquire = require('proxyquire');
+var util = require('@google-cloud/common').util;
+
+var promisified = false;
+var fakeUtil = extend({}, util, {
+  promisifyAll: function(Class) {
+    if (Class.name === 'Project') {
+      promisified = true;
+    }
+  }
+});
+
+function FakeServiceObject() {
+  this.calledWith_ = arguments;
+}
+
+describe('Project', function() {
+  var Project;
+  var project;
+
+  var PROJECT_ID = 'project-1';
+  var COMPUTE = {
+    projectId: PROJECT_ID,
+    authConfig: { a: 'b', c: 'd' }
+  };
+
+  before(function() {
+    Project = proxyquire('../src/project.js', {
+      '@google-cloud/common': {
+        ServiceObject: FakeServiceObject,
+        util: fakeUtil
+      }
+    });
+  });
+
+  beforeEach(function() {
+    project = new Project(COMPUTE);
+  });
+
+  describe('instantiation', function() {
+    it('should promisify all the things', function() {
+      assert(promisified);
+    });
+
+    it('should localize the ID', function() {
+      assert.strictEqual(project.id, PROJECT_ID);
+    });
+
+    it('should inherit from ServiceObject', function() {
+      assert(project instanceof FakeServiceObject);
+
+      var calledWith = project.calledWith_[0];
+
+      assert.strictEqual(calledWith.parent, COMPUTE);
+      assert.strictEqual(calledWith.baseUrl, '');
+      assert.strictEqual(calledWith.id, '');
+      assert.deepStrictEqual(calledWith.methods, {
+        get: true,
+        getMetadata: true
+      });
+    });
+  });
+});