Switch to witLowerCaseKeys_ method, and other small fixes.

Author: Eric Koleda

src/Service.js

@@ -699,7 +699,7 @@ Service_.prototype.lockable_ = function(func) {
 /**
  * Obtain an access token using the custom grant type specified. Most often
  * this will be "client_credentials", and a client ID and secret are set an
- * "Authorization: Baseic ..." header will be added using thos values.
+ * "Authorization: Basic ..." header will be added using those values.
  */
 Service_.prototype.exchangeGrant_ = function() {
  validate_({
@@ -711,15 +711,16 @@ Service_.prototype.exchangeGrant_ = function() {
  };
  payload = extend_(payload, this.params_);
 
- // For the client_credentials grant type, add a basic authorization header
- // if the client ID and client secret are set and no authorization header has
- // been set yet (AKA do the expected thing).
+ // For the client_credentials grant type, add a basic authorization header:
+ // - If the client ID and client secret are set.
+ // - No authorization header has been set yet.
+ var lowerCaseHeaders = witLowerCaseKeys_(this.tokenHeaders_);
  if (this.grantType_ === 'client_credentials' &&
  this.clientId_ &&
  this.clientSecret_ &&
- !getValueCaseInsensitive_(this.tokenHeaders_, 'Authorization')) {
+ (!lowerCaseHeaders || !lowerCaseHeaders.authorization)) {
  this.tokenHeaders_ = this.tokenHeaders_ || {};
- this.tokenHeaders_.Authorization = 'Basic ' +
+ this.tokenHeaders_.authorization = 'Basic ' +
  Utilities.base64Encode(this.clientId_ + ':' + this.clientSecret_);
  }
 

src/Utilities.js

@@ -77,26 +77,21 @@ function extend_(destination, source) {
  return destination;
 }
 
-/* exported getValueCaseInsensitive_ */
+/* exported witLowerCaseKeys_ */
 /**
- * Gets the value stored in the object under the given key, in a
- * case-insensitive way.
- * @param {Object} obj The object to search in.
- * @param {string} key The key to search for.
- * @return {Object} the value under that key, or undefined otherwise
+ * Gets a copy of an object with all the keys converted to lower-case strings.
+ *
+ * @param {Object} obj The object to copy.
+ * @return {Object} a shallow copy of the object with all lower-case keys.
  */
-function getValueCaseInsensitive_(obj, key) {
- if (obj == null || typeof obj !== 'object' ||
- key == null || !key.toString) {
- return undefined;
- }
- if (key in obj) {
- return obj[key];
+function witLowerCaseKeys_(obj) {
+ if (obj === null || typeof obj !== 'object') {
+ return obj;
  }
+ // For each key in the source object, add a lower-case version to a new
+ // object, and return it.
  return Object.keys(obj).reduce(function(result, k) {
- if (result) return result;
- if (k.toLowerCase() === key.toLowerCase()) {
- return obj[k];
- }
- }, undefined);
+ result[k.toLowerCase()] = obj[k];
+ return result;
+ }, {});
 }

test/test.js

@@ -243,13 +243,12 @@ describe('Service', function() {
  });
 
  describe('#exchangeGrant_()', function() {
- var getValueCaseInsensitive_ = OAuth2.getValueCaseInsensitive_;
+ var witLowerCaseKeys_ = OAuth2.witLowerCaseKeys_;
 
  it('should not set auth header if the grant type is not client_credentials',
  function(done) {
  mocks.UrlFetchApp.resultFunction = function(url, urlOptions) {
- assert.isUndefined(
- getValueCaseInsensitive_(urlOptions.headers, 'Authorization'));
+ assert.isUndefined(witLowerCaseKeys_(urlOptions.headers).authorization);
  done();
  };
  var service = OAuth2.createService('test')
@@ -261,8 +260,7 @@ describe('Service', function() {
  it('should not set auth header if the client ID is not set',
  function(done) {
  mocks.UrlFetchApp.resultFunction = function(url, urlOptions) {
- assert.isUndefined(
- getValueCaseInsensitive_(urlOptions.headers, 'Authorization'));
+ assert.isUndefined(witLowerCaseKeys_(urlOptions.headers).authorization);
  done();
  };
  var service = OAuth2.createService('test')
@@ -274,8 +272,7 @@ describe('Service', function() {
  it('should not set auth header if the client secret is not set',
  function(done) {
  mocks.UrlFetchApp.resultFunction = function(url, urlOptions) {
- assert.isUndefined(
- getValueCaseInsensitive_(urlOptions.headers, 'Authorization'));
+ assert.isUndefined(witLowerCaseKeys_(urlOptions.headers).authorization);
  done();
  };
  var service = OAuth2.createService('test')
@@ -288,7 +285,8 @@ describe('Service', function() {
  it('should not set auth header if it is already set',
  function(done) {
  mocks.UrlFetchApp.resultFunction = function(url, urlOptions) {
- assert.equal(urlOptions.headers.Authorization, 'something');
+ assert.equal(witLowerCaseKeys_(urlOptions.headers).authorization,
+ 'something');
  done();
  };
  var service = OAuth2.createService('test')
@@ -297,7 +295,7 @@ describe('Service', function() {
  .setClientId('abc')
  .setClientSecret('def')
  .setTokenHeaders({
- Authorization: 'something'
+ authorization: 'something'
  });
  service.exchangeGrant_();
  });
@@ -306,7 +304,8 @@ describe('Service', function() {
  'the client ID and client secret are set and the authorization header' +
  'is not already set', function(done) {
  mocks.UrlFetchApp.resultFunction = function(url, urlOptions) {
- assert.equal(urlOptions.headers.Authorization, 'Basic YWJjOmRlZg==');
+ assert.equal(witLowerCaseKeys_(urlOptions.headers).authorization,
+ 'Basic YWJjOmRlZg==');
  done();
  };
  var service = OAuth2.createService('test')
@@ -337,34 +336,38 @@ describe('Utilities', function() {
  });
  });
 
- describe('#getValueCaseInsensitive_()', function() {
- var getValueCaseInsensitive_ = OAuth2.getValueCaseInsensitive_;
-
- it('should find identical keys', function() {
- assert.isTrue(getValueCaseInsensitive_({'a': true}, 'a'));
- assert.isTrue(getValueCaseInsensitive_({'A': true}, 'A'));
- assert.isTrue(getValueCaseInsensitive_({'Ab': true}, 'Ab'));
- });
-
- it('should find matching keys of different cases', function() {
- assert.isTrue(getValueCaseInsensitive_({'a': true}, 'A'));
- assert.isTrue(getValueCaseInsensitive_({'A': true}, 'a'));
- assert.isTrue(getValueCaseInsensitive_({'Ab': true}, 'aB'));
- assert.isTrue(getValueCaseInsensitive_({'a2': true}, 'A2'));
+ describe('#witLowerCaseKeys_()', function() {
+ var witLowerCaseKeys_ = OAuth2.witLowerCaseKeys_;
+ var data = {
+ 'a': true,
+ 'A': true,
+ 'B': true,
+ 'Cc': true,
+ 'D2': true,
+ 'E!@#': true
+ };
+ var lowerCaseData = witLowerCaseKeys_(data);
+
+ it('should contain lower-case keys', function() {
+ assert.isTrue(lowerCaseData['a']);
+ assert.isTrue(lowerCaseData['b']);
+ assert.isTrue(lowerCaseData['cc']);
+ assert.isTrue(lowerCaseData['d2']);
+ assert.isTrue(lowerCaseData['e!@#']);
  });
 
- it('should work with non-alphabetic keys', function() {
- assert.isTrue(getValueCaseInsensitive_({'A2': true}, 'a2'));
- assert.isTrue(getValueCaseInsensitive_({'2': true}, '2'));
- assert.isTrue(getValueCaseInsensitive_({2: true}, 2));
- assert.isTrue(getValueCaseInsensitive_({'!@#': true}, '!@#'));
+ it('should not contain upper-case keys', function() {
+ assert.isUndefined(lowerCaseData['A']);
+ assert.isUndefined(lowerCaseData['B']);
+ assert.isUndefined(lowerCaseData['Cc']);
+ assert.isUndefined(lowerCaseData['D2']);
+ assert.isUndefined(lowerCaseData['E!@#']);
  });
 
- it('should work null and undefined', function() {
- assert.isUndefined(getValueCaseInsensitive_(null, 'key'));
- assert.isUndefined(getValueCaseInsensitive_(undefined, 'key'));
- assert.isUndefined(getValueCaseInsensitive_({'a': true}, null));
- assert.isUndefined(getValueCaseInsensitive_({'a': true}, undefined));
+ it('should handle null, undefined, and empty objects', function() {
+ assert.isNull(witLowerCaseKeys_(null));
+ assert.isUndefined(witLowerCaseKeys_(undefined));
+ assert.isEmpty(witLowerCaseKeys_({}));
  });
  });
 });