Fix JSDoc and regenerate scaffolding. (#39)

* Fix JSDoc and regenerate scaffolding. * updating GAPIC generated files * fix contributors, regenerate scaffolding * run CI as non-root user to speed up grpc module install * Remove temp fix for #38
googleapis · Jan 12, 2018 · 53f1505 · 53f1505
1 parent 4d41791
commit 53f1505
Show file tree

Hide file tree

Showing 28 changed files with 1,498 additions and 2,029 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -91,6 +91,7 @@ jobs:
   node4:
     docker:
       - image: node:4
+        user: node
     steps:
       - checkout
       - run:
@@ -106,44 +107,57 @@ jobs:
   node6:
     docker:
       - image: node:6
+        user: node
     <<: *unit_tests
   node7:
     docker:
       - image: node:7
+        user: node
     <<: *unit_tests
   node8:
     docker:
       - image: node:8
+        user: node
     <<: *unit_tests
   node9:
     docker:
       - image: node:9
+        user: node
     <<: *unit_tests
 
   lint:
     docker:
       - image: node:8
+        user: node
     steps:
       - checkout
       - run:
           name: Install modules and dependencies.
           command: |
+            mkdir /home/node/.npm-global
             npm install
             npm link
+          environment:
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Link the module being tested to the samples.
           command: |
             cd samples/
             npm link @google-cloud/pubsub
             npm install
             cd ..
+          environment:
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Run linting.
           command: npm run lint
+          environment:
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
 
   docs:
     docker:
       - image: node:8
+        user: node
     steps:
       - checkout
       - run:
@@ -156,6 +170,7 @@ jobs:
   sample_tests:
     docker:
       - image: node:8
+        user: node
     steps:
       - checkout
       - run:
@@ -167,30 +182,37 @@ jobs:
       - run:
           name: Install and link the module.
           command: |
+            mkdir /home/node/.npm-global
             npm install
             npm link
+          environment:
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Link the module being tested to the samples.
           command: |
             cd samples/
             npm link @google-cloud/pubsub
             npm install
             cd ..
+          environment:
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Run sample tests.
           command: npm run samples-test
           environment:
             GCLOUD_PROJECT: long-door-651
-            GOOGLE_APPLICATION_CREDENTIALS: /var/pubsub/.circleci/key.json
+            GOOGLE_APPLICATION_CREDENTIALS: /home/node/pubsub-samples/.circleci/key.json
+            NPM_CONFIG_PREFIX: /home/node/.npm-global
       - run:
           name: Remove unencrypted key.
           command: rm .circleci/key.json
           when: always
-    working_directory: /var/pubsub/
+    working_directory: /home/node/pubsub-samples
 
   system_tests:
     docker:
       - image: node:8
+        user: node
     steps:
       - checkout
       - run:
@@ -215,6 +237,7 @@ jobs:
   publish_npm:
     docker:
       - image: node:8
+        user: node
     steps:
       - checkout
       - run:

diff --git a/.mailmap b/.mailmap
@@ -4,3 +4,4 @@ Luke Sneeringer <[email protected]> Luke Sneeringer <[email protected]
 Stephen Sawchuk <[email protected]> Stephen Sawchuk <[email protected]>
 Stephen Sawchuk <[email protected]> Stephen Sawchuk <[email protected]>
 Stephen Sawchuk <[email protected]> Stephen <[email protected]>
+Alexander Fenster <[email protected]> Alexander Fenster <[email protected]>
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -18,4 +18,5 @@ Matthew Arbesfeld <[email protected]>
 Song Wang <[email protected]>
 Stephen Sawchuk <[email protected]>
 Tim Swast <[email protected]>
+greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>
 mkamioner <[email protected]>
diff --git a/README.md b/README.md
@@ -2,8 +2,6 @@
 
 # [Google Cloud Pub/Sub: Node.js Client](https://github.com/googleapis/nodejs-pubsub)
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/googleapis/nodejs-pubsub.svg)](https://greenkeeper.io/)
-
 [![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style&#x3D;flat)](https://cloud.google.com/terms/launch-stages)
 [![CircleCI](https://img.shields.io/circleci/project/github/googleapis/nodejs-pubsub.svg?style=flat)](https://circleci.com/gh/googleapis/nodejs-pubsub)
 [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/googleapis/nodejs-pubsub?branch=master&svg=true)](https://ci.appveyor.com/project/googleapis/nodejs-pubsub)
@@ -72,20 +70,21 @@ const PubSub = require('@google-cloud/pubsub');
 const projectId = 'YOUR_PROJECT_ID';
 
 // Instantiates a client
-const pubsubClient = PubSub({
-  projectId: projectId
+const pubsubClient = new PubSub({
+  projectId: projectId,
 });
 
 // The name for the new topic
 const topicName = 'my-new-topic';
 
 // Creates the new topic
-pubsubClient.createTopic(topicName)
-  .then((results) => {
+pubsubClient
+  .createTopic(topicName)
+  .then(results => {
     const topic = results[0];
     console.log(`Topic ${topic.name} created.`);
   })
-  .catch((err) => {
+  .catch(err => {
     console.error('ERROR:', err);
   });
 ```

diff --git a/package.json b/package.json
@@ -41,10 +41,11 @@
     "Jun Mukai <[email protected]>",
     "Justin King <[email protected]>",
     "Matthew Arbesfeld <[email protected]>",
-    "Mo Kamioner <[email protected]>",
     "Song Wang <[email protected]>",
     "Stephen Sawchuk <[email protected]>",
-    "Tim Swast <[email protected]>"
+    "Tim Swast <[email protected]>",
+    "greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>",
+    "mkamioner <[email protected]>"
   ],
   "scripts": {
     "system-test": "repo-tools test run --cmd mocha -- system-test/*.js --no-timeouts",

diff --git a/samples/package.json b/samples/package.json
@@ -12,7 +12,7 @@
     "node": ">=4.3.2"
   },
   "scripts": {
-    "ava": "ava -T 20s --verbose test/*.test.js system-test/*.test.js",
+    "ava": "ava -T 20s --verbose system-test/*.test.js",
     "cover": "nyc --reporter=lcov --cache ava -T 20s --verbose test/*.test.js system-test/*.test.js && nyc report",
     "test": "repo-tools test run --cmd npm -- run cover"
   },

diff --git a/samples/quickstart.js b/samples/quickstart.js
@@ -23,7 +23,7 @@ const PubSub = require('@google-cloud/pubsub');
 const projectId = 'YOUR_PROJECT_ID';
 
 // Instantiates a client
-const pubsubClient = PubSub({
+const pubsubClient = new PubSub({
   projectId: projectId,
 });