fix: cleanup and fix samples (googleapis#916)

Author: JustinBeckwith

package-lock.json

@@ -58,19 +58,20 @@
   ],
   "version": "24.0.0",
   "scripts": {
-    "posttest": "npm run check && npm run lint && npm run license-check",
+    "posttest": "npm run check && npm run license-check",
     "test": "npm run cover",
     "doc": "jsdoc -c jsdoc-conf.json",
     "prepare": "npm run compile",
     "build-tools": "tsc -p tsconfig.tools.json",
     "compile": "tsc -p .",
-    "lint": "semistandard \"samples/**/*.js\"",
+    "check-samples": "semistandard \"samples/**/*.js\"",
     "generate-apis": "npm run build-tools && node build/src/scripts/generate.js && clang-format -i -style='{Language: JavaScript, BasedOnStyle: Google, ColumnLimit: 80}' src/apis/**/*.ts",
     "cover": "nyc --cache mocha build/test/ --recursive -t 10000 -S -R spec --require intelli-espower-loader && nyc report --reporter=html",
     "pretest": "npm run compile",
     "clean": "gts clean",
-    "check": "gts check",
-    "fix": "gts fix",
+    "check": "gts check && npm run check-samples",
+    "fix": "gts fix && npm run fix-samples",
+    "fix-samples": "semistandard --fix \"samples/**/*.js\"",
     "license-check": "jsgl --local ."
   },
   "author": "Google Inc.",
@@ -102,6 +103,7 @@
     "mkdirp": "0.5.1",
     "nock": "9.1.5",
     "mocha": "4.1.0",
+    "nconf": "^0.10.0",
     "nunjucks": "^3.0.1",
     "nyc": "11.4.1",
     "opn": "5.1.0",

package.json

@@ -1,6 +1,9 @@
 # Samples by API
+The following samples show basic usage of various APIs. Throughout these samples, you will find code that relies on various authentication methods.
+- **OAuth2** - To use the OAuth2 samples, create a credential in the cloud developer console, and save the file as `oauth2.keys.json` in the samples directory.
+- **Service account** - To use the service account based samples, create a new service account in the cloud developer console, and save the file as `jwt.keys.json` in the samples directory.
+- **API Key** - To use simple API keys, create a new API Key in the cloud developer console, then store the key in the `api_key` field of `config.json`.
 
-The following samples show basic usage of various APIs.
 
 ## ![](http://www.google.com/images/icons/product/analytics-32.png) Google Analytics API
 

samples/README.md

@@ -13,55 +13,52 @@
 
 'use strict';
 
-var google = require('../../lib/googleapis.js');
-var analytics = google.analytics('v3');
-var OAuth2Client = google.auth.OAuth2;
-
-// Client ID and client secret are available at
-// https://code.google.com/apis/console
-var CLIENT_ID = 'YOUR CLIENT ID HERE';
-var CLIENT_SECRET = 'YOUR CLIENT SECRET HERE';
-var REDIRECT_URL = 'YOUR REDIRECT URL HERE';
-
-var oauth2Client = new OAuth2Client(CLIENT_ID, CLIENT_SECRET, REDIRECT_URL);
-
-oauth2Client.setCredentials({
-  access_token: 'ACCESS TOKEN HERE'
-});
+const google = require('googleapis');
+const analytics = google.analytics('v3');
+const sampleClient = require('../sampleclient');
 
 // Custom Goals must be exist prior to used as an objectiveMetric
-var objectiveMetric = 'ga:goal1Completions';
+const objectiveMetric = 'ga:goal1Completions';
 
 // Serving frameworks listed below:
 // https://developers.google.com/analytics/devguides/platform/experiments#serving-framework
-var servingFramework = 'API';
+const servingFramework = 'API';
 
 // Invalid URLs are used when user is not redirected when showing an experiment
 // Read more: http://goo.gl/oVwKH1
-var variations = [
+const variations = [
   {'name': 'Default', 'url': 'http://www.example.com', 'status': 'ACTIVE'},
-  {'name': 'Variation 1', 'url': 'http://www.1.com', 'status': 'ACTIVE'},
-  {'name': 'Variation 2', 'url': 'http://www.2.com', 'status': 'ACTIVE'}
+  {'name': 'variation 1', 'url': 'http://www.1.com', 'status': 'ACTIVE'},
+  {'name': 'variation 2', 'url': 'http://www.2.com', 'status': 'ACTIVE'}
 ];
 
 // Specify Experiment configuration
-var resourceBody = {
+const resourceBody = {
   'name': 'Example Experiment',
   'status': 'READY_TO_RUN',
   'objectiveMetric': objectiveMetric,
   'servingFramework': servingFramework,
   'variations': variations
 };
 
-analytics.management.experiments.insert({
-  auth: oauth2Client,
-  accountId: 'your-accountId',
-  webPropertyId: 'your-webPropertyId',
-  profileId: 'your-profileId',
-  resource: resourceBody
-}, function (err, body) {
+const scopes = [
+  'https://www.googleapis.com/auth/analytics'
+];
+
+sampleClient.authenticate(scopes, (err, authClient) => {
   if (err) {
-    return console.log(err);
+    throw err;
   }
-  console.log(body);
+  analytics.management.experiments.insert({
+    auth: authClient,
+    accountId: 'your-accountId',
+    webPropertyId: 'your-webPropertyId',
+    profileId: 'your-profileId',
+    resource: resourceBody
+  }, (err, body) => {
+    if (err) {
+      throw err;
+    }
+    console.log(body);
+  });
 });

samples/analytics/analytics.js

@@ -13,18 +13,20 @@
 
 'use strict';
 
-var google = require('../../lib/googleapis');
-var blogger = google.blogger('v3');
-var util = require('util');
+const google = require('googleapis');
+const blogger = google.blogger('v3');
+const nconf = require('nconf');
+const path = require('path');
+
+// Ex: node blogger.js --api_key "YOUR API KEY"
+nconf.argv().env().file(path.join(__dirname, 'config.json'));
 
 blogger.blogs.get({
-  key: '<YOUR API KEY HERE>',
-  blogId: '<YOUR BLOG ID HERE>'
-}, function (err, result) {
+  key: nconf.get('api_key'),
+  blogId: 3213900
+}, (err, result) => {
   if (err) {
     console.error(err);
   }
-  if (result) {
-    console.log(util.inspect(result));
-  }
+  console.log(result);
 });

samples/blogger/blogger.js

@@ -13,11 +13,11 @@
 
 'use strict';
 
-var request = require('request');
-var google = require('../../lib/googleapis.js');
-var compute = google.compute('v1');
-var uri = 'http://metadata/computeMetadata/v1/project/project-id';
-var headers = { 'Metadata-Flavor': 'Google' };
+const request = require('request');
+const google = require('googleapis');
+const compute = google.compute('v1');
+const uri = 'http://metadata/computeMetadata/v1/project/project-id';
+const headers = { 'Metadata-Flavor': 'Google' };
 
 // This example can be run from a GCE VM in your project.  The example fetches
 // your project ID from the VM's metadata server, and then uses the Compute API
@@ -26,10 +26,14 @@ var headers = { 'Metadata-Flavor': 'Google' };
 // See the defaultauth.js sample for an alternate way of fetching compute credentials.
 //
 google.options({ auth: new google.auth.Compute() });
-request.get({ uri: uri, headers: headers }, function (err, response, project) {
-  if (!err && response.statusCode === 200) {
-    compute.zones.list({ project: project }, function (err, result) {
-      console.log(err, result);
-    });
+request.get({ uri, headers }, (err, res, project) => {
+  if (err) {
+    throw err;
   }
+  if (res.statusCode !== 200) {
+    throw new Error(`Response failed with status ${res.statusCode}`);
+  }
+  compute.zones.list({ project }, (err, result) => {
+    console.log(err, result);
+  });
 });

samples/compute/compute.js

@@ -0,0 +1,4 @@
+{
+  "api_key": "YOUR_API_KEY",
+  "customsearch_engine_id": "YOUR_CUSTOMSEARCH_ENGINE_ID"
+}

samples/config.json

@@ -13,22 +13,36 @@
 
 'use strict';
 
-var google = require('../../lib/googleapis.js');
-var customsearch = google.customsearch('v1');
+// Example:  node customsearch.js example_term
+
+const google = require('googleapis');
+const customsearch = google.customsearch('v1');
+const nconf = require('nconf');
+const path = require('path');
+
+// Ex: node customsearch.js
+//      "Google Node.js"
+//      --api_key "YOUR KEY"
+//      --customsearch_engine_id="YOUR ID"
+nconf.argv().env().file(path.join(__dirname, 'config.json'));
 
 // You can get a custom search engine id at
 // https://www.google.com/cse/create/new
-const CX = 'INSERT YOUR CUSTOM SEARCH ENGINE ID here';
-const API_KEY = 'INSERT YOUR API KEY HERE';
-const SEARCH = 'INSERT A GOOGLE REQUEST HERE';
+const CX = nconf.get('customsearch_engine_id');
+const API_KEY = nconf.get('api_key');
+const SEARCH = process.argv[2];
 
-customsearch.cse.list({ cx: CX, q: SEARCH, auth: API_KEY }, function (err, resp) {
+customsearch.cse.list({
+  cx: CX,
+  q: SEARCH,
+  auth: API_KEY
+}, (err, res) => {
   if (err) {
-    return console.log('An error occured', err);
+    throw err;
   }
   // Got the response from custom search
-  console.log('Result: ' + resp.searchInformation.formattedTotalResults);
-  if (resp.items && resp.items.length > 0) {
-    console.log('First result name is ' + resp.items[0].title);
+  console.log('Result: ' + res.searchInformation.formattedTotalResults);
+  if (res.items && res.items.length > 0) {
+    console.log('First result name is ' + res.items[0].title);
   }
 });

samples/customsearch/customsearch.js

@@ -13,8 +13,8 @@
 
 'use strict';
 
-var google = require('../lib/googleapis.js');
-var compute = google.compute('v1');
+const google = require('googleapis');
+const compute = google.compute('v1');
 
 /**
  * The getApplicationDefault method creates the appropriate type of credential client for you,
@@ -34,9 +34,10 @@ var compute = google.compute('v1');
  */
 
 // Get the appropriate type of credential client, depending upon the runtime environment.
-google.auth.getApplicationDefault(function (err, authClient) {
+google.auth.getApplicationDefault((err, authClient) => {
   if (err) {
-    return console.log('Failed to get the default credentials: ' + String(err));
+    console.error('Failed to get the default credentials.');
+    throw err;
   }
   // The createScopedRequired method returns true when running on GAE or a local developer
   // machine. In that case, the desired scopes must be passed in manually. When the code is
@@ -48,8 +49,11 @@ google.auth.getApplicationDefault(function (err, authClient) {
   }
   // Fetch the list of GCE zones within a project.
   // NOTE: You must fill in your valid project ID before running this sample!
-  var projectId = 'fill in your project id here!';
-  compute.zones.list({ project: projectId, auth: authClient }, function (err, result) {
-    console.log(err, result);
+  const projectId = 'fill in your project id here!';
+  compute.zones.list({ project: projectId, auth: authClient }, (err, result) => {
+    if (err) {
+      throw err;
+    }
+    console.log(result);
   });
 });

samples/defaultauth.js

@@ -13,36 +13,38 @@
 
 'use strict';
 
-// Dependencies
-var googleapis = require('googleapis');
-var authData = require('./authData');
+const googleapis = require('googleapis');
+const nconf = require('nconf');
+const path = require('path');
 
-console.log('Auth data is: ', authData);
+nconf.argv().env().file(path.join(__dirname, '../jwt.keys.json'));
 
 // Create JWT auth object
-var jwt = new googleapis.auth.JWT(
-  authData.email,
-  authData.keyFile,
-  authData.key,
-  authData.scopes,
-  authData.subject
+const jwt = new googleapis.auth.JWT(
+  nconf.get('client_email'),
+  null,
+  nconf.get('private_key'),
+  [
+    'https://www.googleapis.com/auth/admin.directory.group',
+    'https://www.googleapis.com/auth/admin.directory.group.member'
+  ]
 );
 
 // Authorize
-jwt.authorize(function (err, data) {
+jwt.authorize((err, data) => {
   if (err) {
     throw err;
   }
   console.log('You have been successfully authenticated: ', data);
 
   // Get Google Admin API
-  var admin = googleapis.admin('directory_v1');
+  const admin = googleapis.admin('directory_v1');
 
   // Delete group
   admin.groups.insert({
     groupKey: '[email protected]',
     auth: jwt
-  }, function (err, data) {
+  }, (err, data) => {
     console.log(err || data);
   });
 });