Add simple escape mechanism for parameters that conflict with those r…

…eserved by the client library
googleapis · Jul 9, 2015 · 12f5caf · 12f5caf
1 parent ee94558
commit 12f5caf
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 13 deletions.
diff --git a/lib/apirequest.js b/lib/apirequest.js
@@ -102,6 +102,26 @@ function createAPIRequest(parameters, callback) {
     params // API call params
   );
 
+  var media = params.media || {};
+  var resource = params.resource;
+  var authClient = params.auth ||
+    parameters.context._options.auth ||
+    parameters.context.google._options.auth;
+
+  var defaultMime = typeof media.body === 'string' ? 'text/plain' : 'application/octet-stream';
+  delete params.media;
+  delete params.resource;
+  delete params.auth;
+
+  // Un-alias parameters that were modified due to conflicts with reserved names
+  Object.keys(params).forEach(function(key) {
+	if (key.slice(-1) === '_') {
+      var new_key = key.slice(0, -1);
+	  params[new_key] = params[key];
+      delete params[key];
+    }
+  });
+
   // Normalize callback
   callback = createCallback(callback);
 
@@ -115,17 +135,6 @@ function createAPIRequest(parameters, callback) {
     return null;
   }
 
-  var media = params.media || {};
-  var resource = params.resource;
-  var authClient = params.auth ||
-    parameters.context._options.auth ||
-    parameters.context.google._options.auth;
-
-  var defaultMime = typeof media.body === 'string' ? 'text/plain' : 'application/octet-stream';
-  delete params.media;
-  delete params.resource;
-  delete params.auth;
-
   // Parse urls and urlescape path params
   options.url = parsePath(options.url, params);
   parameters.mediaUrl = parsePath(parameters.mediaUrl, params);

diff --git a/lib/generator.js b/lib/generator.js
@@ -47,7 +47,7 @@ var BEAUTIFY_OPTIONS = {
   'unescape_strings': false,
   'wrap_line_length': 0
 };
-
+var RESERVED_PARAMS = ['resource', 'media', 'auth'];
 var templateContents = fs.readFileSync(API_TEMPLATE, { encoding: 'utf8' });
 var indexTemplContents = fs.readFileSync(API_INDEX_TEMPLATE, { encoding: 'utf8' });
 var transporter = new DefaultTransporter();
@@ -114,6 +114,13 @@ function getPathParams(params) {
   return pathParams;
 }
 
+function getSafeParamName(param) {
+  if (RESERVED_PARAMS.indexOf(param) != -1) {
+    return param + '_';	  
+  }
+  return param;
+}
+
 /**
  * Disable auto-escaping its output
  * @type {Boolean}
@@ -124,6 +131,7 @@ swig.setFilter('getAPIs', getAPIs);
 swig.setFilter('oneLine', oneLine);
 swig.setFilter('cleanComments', cleanComments);
 swig.setFilter('getPathParams', getPathParams);
+swig.setFilter('getSafeParamName', getSafeParamName);
 swig.setDefaults({ loader: swig.loaders.fs(path.join(__dirname, '..', 'templates'))});
 
 /**

diff --git a/templates/method-partial.js b/templates/method-partial.js
@@ -11,7 +11,7 @@
  *
  * @param  {object{% if !m.parameterOrder && !m.request %}={% endif %}} params - Parameters for request
  {% for pname, p in m.parameters -%}
- * @param  {{ lb }}{{ p.type }}{% if ! p.required %}={% endif %}{{ rb }} params.{{ pname }} - {{ p.description|oneLine|cleanComments|safe }}
+ * @param  {{ lb }}{{ p.type }}{% if ! p.required %}={% endif %}{{ rb }} params.{{ pname|getSafeParamName }} - {{ p.description|oneLine|cleanComments|safe }}
  {% endfor -%}
 {% if m.supportsMediaUpload -%}
 {% if m.request -%}

diff --git a/test/test.query.js b/test/test.query.js
@@ -58,6 +58,11 @@ describe('Query params', function() {
     assert.equal(req.uri.query, 'madeThisUp=hello');
   });
 
+  it('should be set if params passed are aliased names', function() {
+    var req = drive.files.get({ fileId: '123', resource_: 'hello' }, noop);
+    assert.equal(req.uri.query, 'resource=hello');
+  });
+
   it('should chain together with & in order', function() {
     var req = drive.files.get({
       fileId: '123',