fix: encodeURIComponent path params (#1087)

samples/webmasters/query.js

@@ -0,0 +1,57 @@
+// Copyright 2016, Google, Inc.
+// 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';
+
+const {google} = require('googleapis');
+const sampleClient = require('../sampleclient');
+
+const webmasters = google.webmasters({
+  version: 'v3',
+  auth: sampleClient.oAuth2Client
+});
+
+function runSample (callback) {
+  webmasters.searchanalytics.query({
+    siteUrl: 'http://jbeckwith.com',
+    resource: {
+      startDate: '2018-01-01',
+      endDate: '2018-04-01'
+    }
+  }, (err, res) => {
+    if (err) {
+      console.error(err);
+      throw err;
+    }
+    console.log(res.data);
+    callback(res.data);
+  });
+}
+
+if (module === require.main) {
+  const scopes = [
+    'https://www.googleapis.com/auth/webmasters',
+    'https://www.googleapis.com/auth/webmasters.readonly'
+  ];
+  sampleClient.authenticate(scopes, err => {
+    if (err) {
+      throw err;
+    }
+    runSample(() => { /* complete */ });
+  });
+}
+
+module.exports = {
+  runSample,
+  client: sampleClient.oAuth2Client
+};

src/lib/apirequest.ts

@@ -119,7 +119,11 @@ export function createAPIRequest<T>(
 
   // Parse urls
   if (options.url) {
-    options.url = parseString(options.url, params);
+    const encodedParams = Object.assign(
+        {},
+        ...Object.keys(params).map(
+            x => ({[x]: encodeURIComponent(params[x])})));
+    options.url = parseString(options.url, encodedParams);
   }
   if (parameters.mediaUrl) {
     parameters.mediaUrl = parseString(parameters.mediaUrl, params);

test/samples/test.samples.sheets.ts

@@ -38,11 +38,12 @@ describe('sheets samples', () => {
   });
 
   it('should append values', done => {
-    const scope =
-        nock(baseUrl)
-            .post(
-                '/v4/spreadsheets/aSheetId/values/A1:A10:append?valueInputOption=USER_ENTERED')
-            .reply(200, {});
+    const range = 'A1:A10';
+    const scope = nock(baseUrl)
+                      .post(`/v4/spreadsheets/aSheetId/values/${
+                          encodeURIComponent(
+                              range)}:append?valueInputOption=USER_ENTERED`)
+                      .reply(200, {});
     samples.append.runSample('aSheetId', 'A1:A10', (data: {}) => {
       assert(data);
       scope.done();

test/samples/test.samples.webmasters.ts

@@ -0,0 +1,47 @@
+// Copyright 2018, Google, LLC.
+// 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.
+
+import * as assert from 'assert';
+import * as nock from 'nock';
+import {Utils} from './../utils';
+
+nock.disableNetConnect();
+
+// tslint:disable: no-any
+const samples: any = {
+  query: require('../../../samples/webmasters/query')
+};
+
+for (const p in samples) {
+  if (samples[p]) {
+    samples[p].client.credentials = {access_token: 'not-a-token'};
+  }
+}
+
+describe('webmaster samples', () => {
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  it('should query analytics', done => {
+    const siteUrl = 'http://jbeckwith.com';
+    const path = `/webmasters/v3/sites/${
+        encodeURIComponent(siteUrl)}/searchAnalytics/query`;
+    const scope = nock(Utils.baseUrl).post(path).reply(200, {});
+    samples.query.runSample((data: {}) => {
+      assert(data);
+      scope.done();
+      done();
+    });
+  });
+});

test/test.path.ts

@@ -153,24 +153,24 @@ describe('Path params', () => {
         });
   });
 
-  it('should not be urlencoded', (done) => {
-    const p = '/drive/v2/files/p@ram';
+  it('should be urlencoded', done => {
+    const p = `/drive/v2/files/${encodeURIComponent('p@ram')}`;
     nock(Utils.baseUrl).get(p).reply(200);
     localDrive.files.get(
         {fileId: 'p@ram'}, (err: Error, res: AxiosResponse) => {
           if (err) {
             return done(err);
           }
           const parm = Utils.getPath(res).split('/').pop();
-          assert.equal(parm, 'p@ram');
+          assert.equal(decodeURIComponent(parm!), 'p@ram');
           nock(Utils.baseUrl).get(p).reply(200);
           remoteDrive.files.get(
               {fileId: 'p@ram'}, (err2: Error, res2: AxiosResponse) => {
                 if (err2) {
                   return done(err2);
                 }
                 const parm = Utils.getPath(res).split('/').pop();
-                assert.equal(parm, 'p@ram');
+                assert.equal(decodeURIComponent(parm!), 'p@ram');
                 done();
               });
         });