add tests & docs

stephenplusplus · stephenplusplus · commit 33bdc6486e77 · 2016-10-12T13:23:34.000-04:00
diff --git a/packages/monitoring/README.md b/packages/monitoring/README.md
@@ -5,6 +5,12 @@
 
 - [Official Documentation][cloud-monitoring-docs]
 
+## This is an auto-generated API
+
+It does not follow the conventions you're familiar with from other parts of our library. A handwritten layer is not yet available.
+
+The example below shows you how to instantiate the generated client. For further documentation, please browse the [Monitoring .proto files][cloud-monitoring-protos] on GitHub.
+
 
 ```sh
 $ npm install --save @google-cloud/monitoring
@@ -66,3 +72,4 @@ var monitoring = require('@google-cloud/monitoring')({
 [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
 [dev-console]: https://console.developers.google.com/project
 [cloud-monitoring-docs]: https://cloud.google.com/monitoring/docs
+[cloud-monitoring-protos]: https://github.com/googleapis/googleapis/tree/master/google/monitoring/v3
diff --git a/packages/monitoring/package.json b/packages/monitoring/package.json
@@ -56,8 +56,12 @@
     "google-gax": "^0.7.0",
     "extend": "^3.0.0"
   },
+  "devDependencies": {
+    "mocha": "^3.1.2"
+  },
   "scripts": {
-    "publish-module": "node ../../scripts/publish.js logging"
+    "publish-module": "node ../../scripts/publish.js monitoring",
+    "test": "mocha test/*.js"
   },
   "license": "Apache-2.0",
   "engines": {
diff --git a/packages/monitoring/src/index.js b/packages/monitoring/src/index.js
@@ -13,6 +13,48 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/*!
+ * @module monitoring
+ */
+
 'use strict';
 
+/**
+ * <p class="notice">
+ *   **This is a Beta release of Stackdriver Monitoring.** This API is not
+ *   covered by any SLA or deprecation policy and may be subject to
+ *   backward-incompatible changes.
+ * </p>
+ *
+ * [Stackdriver Monitoring](https://cloud.google.com/monitoring/docs) collects
+ * metrics, events, and metadata from Google Cloud Platform, Amazon Web Services
+ * (AWS), hosted uptime probes, application instrumentation, and a variety of
+ * common application components including Cassandra, Nginx, Apache Web Server,
+ * Elasticsearch and many others. Stackdriver ingests that data and generates
+ * insights via dashboards, charts, and alerts.
+ *
+ * <h2>This is an auto-generated API</h2>
+ *
+ * It does not follow the conventions you're familiar with from other parts of
+ * our library. A handwritten layer is not yet available.
+ *
+ * The example below shows you how to instantiate the generated client. For
+ * further documentation, please browse the
+ * [Monitoring .proto files](https://github.com/googleapis/googleapis/tree/master/google/monitoring/v3)
+ * on GitHub.
+ *
+ * @constructor
+ * @alias module:monitoring
+ */
+function Monitoring() {
+  throw new Error([
+    'Cloud Monitoring must be accessed through the auto-generated client.',
+    'See',
+    'https://googlecloudplatform.github.io/google-cloud-node/#/docs/monitoring',
+    'for more information.'
+  ].join(' '));
+}
+
+module.exports = Monitoring;
 module.exports.v3 = require('./v3');
diff --git a/packages/monitoring/test/index.js b/packages/monitoring/test/index.js
@@ -0,0 +1,37 @@
+/**
+ * Copyright 2016 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 Monitoring = require('../src/index.js');
+
+describe('Monitoring', function() {
+  describe('instantiation', function() {
+    it('should throw if invoked', function() {
+      var expectedMessage = [
+        'Cloud Monitoring must be accessed through the auto-generated client.',
+        ' See https://googlecloudplatform.github.io/google-cloud-node/#/docs/',
+        'monitoring for more information.'
+      ].join('');
+
+      assert.throws(function() {
+        new Monitoring();
+      }, new RegExp(expectedMessage));
+    });
+  });
+});
