1.38.0

Author: Eric Koleda

dist/OAuth2.gs

@@ -123,7 +123,7 @@ Service_.LOCK_EXPIRATION_MILLISECONDS_ = 30 * 1000;
  * this URL should be
  * https://accounts.google.com/o/oauth2/auth.
  * @param {string} authorizationBaseUrl The authorization endpoint base URL.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setAuthorizationBaseUrl = function(authorizationBaseUrl) {
   this.authorizationBaseUrl_ = authorizationBaseUrl;
@@ -134,7 +134,7 @@ Service_.prototype.setAuthorizationBaseUrl = function(authorizationBaseUrl) {
  * Sets the service's token URL (required). For Google services this URL should
  * be https://accounts.google.com/o/oauth2/token.
  * @param {string} tokenUrl The token endpoint URL.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setTokenUrl = function(tokenUrl) {
   this.tokenUrl_ = tokenUrl;
@@ -145,7 +145,7 @@ Service_.prototype.setTokenUrl = function(tokenUrl) {
  * Sets the service's refresh URL. Some OAuth providers require a different URL
  * to be used when generating access tokens from a refresh token.
  * @param {string} refreshUrl The refresh endpoint URL.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setRefreshUrl = function(refreshUrl) {
   this.refreshUrl_ = refreshUrl;
@@ -155,7 +155,7 @@ Service_.prototype.setRefreshUrl = function(refreshUrl) {
 /**
  * Sets the format of the returned token. Default: OAuth2.TOKEN_FORMAT.JSON.
  * @param {OAuth2.TOKEN_FORMAT} tokenFormat The format of the returned token.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setTokenFormat = function(tokenFormat) {
   this.tokenFormat_ = tokenFormat;
@@ -166,7 +166,7 @@ Service_.prototype.setTokenFormat = function(tokenFormat) {
  * Sets the additional HTTP headers that should be sent when retrieving or
  * refreshing the access token.
  * @param {Object.<string,string>} tokenHeaders A map of header names to values.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setTokenHeaders = function(tokenHeaders) {
   this.tokenHeaders_ = tokenHeaders;
@@ -190,7 +190,7 @@ Service_.prototype.setTokenHeaders = function(tokenHeaders) {
  * request.
  * @param {tokenHandler} tokenHandler tokenHandler A function to invoke on the
  *     payload of the request for an access token.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setTokenPayloadHandler = function(tokenHandler) {
   this.tokenPayloadHandler_ = tokenHandler;
@@ -204,7 +204,7 @@ Service_.prototype.setTokenPayloadHandler = function(tokenHandler) {
  * which should be passed to this service's <code>handleCallback()</code> method
  * to complete the process.
  * @param {string} callbackFunctionName The name of the callback function.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setCallbackFunction = function(callbackFunctionName) {
   this.callbackFunctionName_ = callbackFunctionName;
@@ -221,7 +221,7 @@ Service_.prototype.setCallbackFunction = function(callbackFunctionName) {
  * the Script Editor, and then click on the link "Google Developers Console" in
  * the resulting dialog.
  * @param {string} clientId The client ID to use for the OAuth flow.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setClientId = function(clientId) {
   this.clientId_ = clientId;
@@ -233,7 +233,7 @@ Service_.prototype.setClientId = function(clientId) {
  * documentation for <code>setClientId()</code> for more information on how to
  * create client IDs and secrets.
  * @param {string} clientSecret The client secret to use for the OAuth flow.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setClientSecret = function(clientSecret) {
   this.clientSecret_ = clientSecret;
@@ -246,7 +246,7 @@ Service_.prototype.setClientSecret = function(clientSecret) {
  * may be appropriate if you want to share access across users.
  * @param {PropertiesService.Properties} propertyStore The property store to use
  *     when persisting credentials.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  * @see https://developers.google.com/apps-script/reference/properties/
  */
 Service_.prototype.setPropertyStore = function(propertyStore) {
@@ -261,7 +261,7 @@ Service_.prototype.setPropertyStore = function(propertyStore) {
  * may be appropriate if you want to share access across users.
  * @param {CacheService.Cache} cache The cache to use when persisting
  *     credentials.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  * @see https://developers.google.com/apps-script/reference/cache/
  */
 Service_.prototype.setCache = function(cache) {
@@ -275,7 +275,7 @@ Service_.prototype.setCache = function(cache) {
  * stored credentials at a time. This can prevent race conditions that arise
  * when two executions attempt to refresh an expired token.
  * @param {LockService.Lock} lock The lock to use when accessing credentials.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  * @see https://developers.google.com/apps-script/reference/lock/
  */
 Service_.prototype.setLock = function(lock) {
@@ -290,7 +290,7 @@ Service_.prototype.setLock = function(lock) {
  * @param {string|Array.<string>} scope The scope or scopes to request.
  * @param {string} [optSeparator] The optional separator to use when joining
  *     multiple scopes. Default: space.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setScope = function(scope, optSeparator) {
   var separator = optSeparator || ' ';
@@ -304,7 +304,7 @@ Service_.prototype.setScope = function(scope, optSeparator) {
  * on what parameter values they support.
  * @param {string} name The parameter name.
  * @param {string} value The parameter value.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setParam = function(name, value) {
   this.params_[name] = value;
@@ -314,7 +314,7 @@ Service_.prototype.setParam = function(name, value) {
 /**
  * Sets the private key to use for Service Account authorization.
  * @param {string} privateKey The private key.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setPrivateKey = function(privateKey) {
   this.privateKey_ = privateKey;
@@ -325,7 +325,7 @@ Service_.prototype.setPrivateKey = function(privateKey) {
  * Sets the issuer (iss) value to use for Service Account authorization.
  * If not set the client ID will be used instead.
  * @param {string} issuer This issuer value
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setIssuer = function(issuer) {
   this.issuer_ = issuer;
@@ -336,7 +336,7 @@ Service_.prototype.setIssuer = function(issuer) {
  * Sets additional JWT claims to use for Service Account authorization.
  * @param {Object.<string,string>} additionalClaims The additional claims, as
  *     key-value pairs.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setAdditionalClaims = function(additionalClaims) {
   this.additionalClaims_ = additionalClaims;
@@ -346,7 +346,7 @@ Service_.prototype.setAdditionalClaims = function(additionalClaims) {
 /**
  * Sets the subject (sub) value to use for Service Account authorization.
  * @param {string} subject This subject value
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setSubject = function(subject) {
   this.subject_ = subject;
@@ -357,7 +357,7 @@ Service_.prototype.setSubject = function(subject) {
  * Sets number of minutes that a token obtained through Service Account
  * authorization should be valid. Default: 60 minutes.
  * @param {string} expirationMinutes The expiration duration in minutes.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setExpirationMinutes = function(expirationMinutes) {
   this.expirationMinutes_ = expirationMinutes;
@@ -371,7 +371,7 @@ Service_.prototype.setExpirationMinutes = function(expirationMinutes) {
  * it to "client_credentials" and then also set the token headers to include
  * the Authorization header required by the OAuth2 provider.
  * @param {string} grantType The OAuth2 grant_type value.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setGrantType = function(grantType) {
   this.grantType_ = grantType;
@@ -383,7 +383,7 @@ Service_.prototype.setGrantType = function(grantType) {
  * library will provide this value automatically, but in some rare cases you may
  * need to override it.
  * @param {string} redirectUri The redirect URI.
- * @return {Service_} This service, for chaining.
+ * @return {!Service_} This service, for chaining.
  */
 Service_.prototype.setRedirectUri = function(redirectUri) {
   this.redirectUri_ = redirectUri;
@@ -540,10 +540,11 @@ Service_.prototype.getIdToken = function() {
 
 /**
  * Resets the service, removing access and requiring the service to be
- * re-authorized.
+ * re-authorized. Also removes any additional values stored in the service's
+ * storage.
  */
 Service_.prototype.reset = function() {
-  this.getStorage().removeValue(null);
+  this.getStorage().reset();
 };
 
 /**
@@ -585,7 +586,7 @@ Service_.prototype.fetchToken_ = function(payload, optUrl) {
 /**
  * Gets the token from a UrlFetchApp response.
  * @param {UrlFetchApp.HTTPResponse} response The response object.
- * @return {Object} The parsed token.
+ * @return {!Object} The parsed token.
  * @throws If the token cannot be parsed or the response contained an error.
  * @private
  */
@@ -612,7 +613,7 @@ Service_.prototype.getTokenFromResponse_ = function(response) {
 /**
  * Parses the token using the service's token format.
  * @param {string} content The serialized token content.
- * @return {Object} The parsed token.
+ * @return {!Object} The parsed token.
  * @private
  */
 Service_.prototype.parseToken_ = function(content) {
@@ -913,7 +914,7 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
 
   if (!optSkipMemoryCheck) {
     // Check in-memory cache.
-    if (value = this.memory_[key]) {
+    if (value = this.memory_[prefixedKey]) {
       if (value === Storage_.CACHE_NULL_VALUE) {
         return null;
       }
@@ -924,7 +925,7 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
   // Check cache.
   if (this.cache_ && (jsonValue = this.cache_.get(prefixedKey))) {
     value = JSON.parse(jsonValue);
-    this.memory_[key] = value;
+    this.memory_[prefixedKey] = value;
     if (value === Storage_.CACHE_NULL_VALUE) {
       return null;
     }
@@ -939,13 +940,13 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
           jsonValue, Storage_.CACHE_EXPIRATION_TIME_SECONDS);
     }
     value = JSON.parse(jsonValue);
-    this.memory_[key] = value;
+    this.memory_[prefixedKey] = value;
     return value;
   }
 
   // Not found. Store a special null value in the memory and cache to reduce
   // hits on the PropertiesService.
-  this.memory_[key] = Storage_.CACHE_NULL_VALUE;
+  this.memory_[prefixedKey] = Storage_.CACHE_NULL_VALUE;
   if (this.cache_) {
     this.cache_.put(prefixedKey, JSON.stringify(Storage_.CACHE_NULL_VALUE),
         Storage_.CACHE_EXPIRATION_TIME_SECONDS);
@@ -968,7 +969,7 @@ Storage_.prototype.setValue = function(key, value) {
     this.cache_.put(prefixedKey, jsonValue,
         Storage_.CACHE_EXPIRATION_TIME_SECONDS);
   }
-  this.memory_[key] = value;
+  this.memory_[prefixedKey] = value;
 };
 
 /**
@@ -977,13 +978,39 @@ Storage_.prototype.setValue = function(key, value) {
  */
 Storage_.prototype.removeValue = function(key) {
   var prefixedKey = this.getPrefixedKey_(key);
+  this.removeValueWithPrefixedKey_(prefixedKey);
+};
+
+/**
+ * Resets the storage, removing all stored data.
+ * @param {string} key The key.
+ */
+Storage_.prototype.reset = function() {
+  var prefix = this.getPrefixedKey_();
+  var prefixedKeys = Object.keys(this.memory_);
+  if (this.properties_) {
+    var props = this.properties_.getProperties();
+    prefixedKeys = Object.keys(props).filter(function(prefixedKey) {
+      return prefixedKey === prefix || prefixedKey.indexOf(prefix + '.') === 0;
+    });
+  }
+  for (var i = 0; i < prefixedKeys.length; i++) {
+    this.removeValueWithPrefixedKey_(prefixedKeys[i]);
+  };
+};
+
+/**
+ * Removes a stored value.
+ * @param {string} key The key.
+ */
+Storage_.prototype.removeValueWithPrefixedKey_ = function(prefixedKey) {
   if (this.properties_) {
     this.properties_.deleteProperty(prefixedKey);
   }
   if (this.cache_) {
     this.cache_.remove(prefixedKey);
   }
-  delete this.memory_[key];
+  delete this.memory_[prefixedKey];
 };
 
 /**
@@ -1053,7 +1080,7 @@ function validate_(params) {
 /**
  * Gets the time in seconds, rounded down to the nearest second.
  * @param {Date} date The Date object to convert.
- * @return {Number} The number of seconds since the epoch.
+ * @return {number} The number of seconds since the epoch.
  * @private
  */
 function getTimeInSeconds_(date) {