1.32.0

Author: Eric Koleda

dist/OAuth2.gs

@@ -63,11 +63,13 @@ function createService(serviceName) {
 /**
  * Returns the redirect URI that will be used for a given script. Often this URI
  * needs to be entered into a configuration screen of your OAuth provider.
- * @param {string} scriptId The script ID of your script, which can be found in
- *     the Script Editor UI under "File > Project properties".
+ * @param {string} [optScriptId] The script ID of your script, which can be
+ *     found in the Script Editor UI under "File > Project properties". Defaults
+ *     to the script ID of the script being executed.
  * @return {string} The redirect URI.
  */
-function getRedirectUri(scriptId) {
+function getRedirectUri(optScriptId) {
+  var scriptId = optScriptId || ScriptApp.getScriptId();
   return 'https://script.google.com/macros/d/' + encodeURIComponent(scriptId) +
       '/usercallback';
 }
@@ -116,7 +118,6 @@ var Service_ = function(serviceName) {
   this.params_ = {};
   this.tokenFormat_ = TOKEN_FORMAT.JSON;
   this.tokenHeaders_ = null;
-  this.scriptId_ = eval('Script' + 'App').getScriptId();
   this.expirationMinutes_ = 60;
 };
 
@@ -384,6 +385,27 @@ Service_.prototype.setGrantType = function(grantType) {
   return this;
 };
 
+/**
+ * Sets the URI to redirect to when the OAuth flow has completed. By default the
+ * 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.
+ */
+Service_.prototype.setRedirectUri = function(redirectUri) {
+  this.redirectUri_ = redirectUri;
+  return this;
+};
+
+/**
+ * Returns the redirect URI that will be used for this service. Often this URI
+ * needs to be entered into a configuration screen of your OAuth provider.
+ * @return {string} The redirect URI.
+ */
+Service_.prototype.getRedirectUri = function() {
+  return this.redirectUri_ || getRedirectUri();
+};
+
 /**
  * Gets the authorization URL. The first step in getting an OAuth2 token is to
  * have the user visit this URL and approve the authorization request. The
@@ -396,12 +418,10 @@ Service_.prototype.setGrantType = function(grantType) {
 Service_.prototype.getAuthorizationUrl = function(optAdditionalParameters) {
   validate_({
     'Client ID': this.clientId_,
-    'Script ID': this.scriptId_,
     'Callback function name': this.callbackFunctionName_,
     'Authorization base URL': this.authorizationBaseUrl_
   });
 
-  var redirectUri = getRedirectUri(this.scriptId_);
   var stateTokenBuilder = eval('Script' + 'App').newStateToken()
       .withMethod(this.callbackFunctionName_)
       .withArgument('serviceName', this.serviceName_)
@@ -414,7 +434,7 @@ Service_.prototype.getAuthorizationUrl = function(optAdditionalParameters) {
   var params = {
     client_id: this.clientId_,
     response_type: 'code',
-    redirect_uri: redirectUri,
+    redirect_uri: this.getRedirectUri(),
     state: stateTokenBuilder.createToken()
   };
   params = extend_(params, this.params_);
@@ -441,15 +461,13 @@ Service_.prototype.handleCallback = function(callbackRequest) {
   validate_({
     'Client ID': this.clientId_,
     'Client Secret': this.clientSecret_,
-    'Script ID': this.scriptId_,
     'Token URL': this.tokenUrl_
   });
-  var redirectUri = getRedirectUri(this.scriptId_);
   var payload = {
     code: code,
     client_id: this.clientId_,
     client_secret: this.clientSecret_,
-    redirect_uri: redirectUri,
+    redirect_uri: this.getRedirectUri(),
     grant_type: 'authorization_code'
   };
   var token = this.fetchToken_(payload);
@@ -530,16 +548,6 @@ Service_.prototype.getLastError = function() {
   return this.lastError_;
 };
 
-/**
- * Returns the redirect URI that will be used for this service. Often this URI
- * needs to be entered into a configuration screen of your OAuth provider.
- * @return {string} The redirect URI.
- */
-Service_.prototype.getRedirectUri = function() {
-  return getRedirectUri(this.scriptId_);
-};
-
-
 /**
  * Fetches a new token from the OAuth server.
  * @param {Object} payload The token request payload.

docs/Service_.html

@@ -3501,6 +3501,160 @@ <h5>Parameters:</h5>
 
 
 
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    This service, for chaining.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type"><a href="Service_.html">Service_</a></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="setRedirectUri"><span class="type-signature"></span>setRedirectUri<span class="signature">(redirectUri)</span><span class="type-signature"> &rarr; {<a href="Service_.html">Service_</a>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Sets the URI to redirect to when the OAuth flow has completed. By default the
+library will provide this value automatically, but in some rare cases you may
+need to override it.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>redirectUri</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The redirect URI.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
 <h5>Returns:</h5>
 
 
@@ -4668,7 +4822,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 14 2018 09:13:44 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 08 2019 11:46:13 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>

docs/Storage_.html

@@ -763,7 +763,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 14 2018 09:13:44 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 08 2019 11:46:13 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>

docs/global.html

@@ -732,7 +732,7 @@ <h5>Returns:</h5>
 
 
 
-    <h4 class="name" id="getRedirectUri"><span class="type-signature"></span>getRedirectUri<span class="signature">(scriptId)</span><span class="type-signature"> &rarr; {string}</span></h4>
+    <h4 class="name" id="getRedirectUri"><span class="type-signature"></span>getRedirectUri<span class="signature">(optScriptId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
 
 
 
@@ -765,6 +765,8 @@ <h5>Parameters:</h5>
         <th>Type</th>
 
 
+        <th>Attributes</th>
+        
 
 
 
@@ -777,7 +779,7 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>scriptId</code></td>
+                <td class="name"><code>optScriptId</code></td>
 
 
             <td class="type">
@@ -790,11 +792,22 @@ <h5>Parameters:</h5>
             </td>
 
 
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
 
 
 
-            <td class="description last">The script ID of your script, which can be found in
-    the Script Editor UI under "File > Project properties".</td>
+            <td class="description last">The script ID of your script, which can be
+    found in the Script Editor UI under "File > Project properties". Defaults
+    to the script ID of the script being executed.</td>
         </tr>
 
 
@@ -1348,7 +1361,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 14 2018 09:13:44 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 08 2019 11:46:13 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.html

@@ -689,7 +689,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 14 2018 09:13:44 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 08 2019 11:46:13 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "apps-script-oauth2",
-  "version": "1.31.0",
+  "version": "1.32.0",
   "description": "OAuth2 for Apps Script is a library for Google Apps Script that provides the ability to create and authorize OAuth2 tokens as well as refresh them when they expire.",
   "repository": {
     "type": "git",