Add support for 2-legged OAuth, Yelp sample (which uses 2-legged), and fix a signing bug the sample revealed.

Author: Eric Koleda

MemoryProperties.gs

@@ -0,0 +1,62 @@
+/**
+ * Creates a new MemoryProperties, an implementation of the Properties
+ * interface that stores values in memory.
+ * @constructor
+ */
+var MemoryProperties = function() {
+  this.properties = {};
+};
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#deleteallproperties}
+ */
+MemoryProperties.prototype.deleteAllProperties = function() {
+  this.properties = {};
+};
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#deletepropertykey}
+ */
+MemoryProperties.prototype.deleteProperty = function(key) {
+  delete this.properties[key];
+};
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#getkeys}
+ */
+MemoryProperties.prototype.getKeys = function() {
+  return Object.keys(this.properties);
+}
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#getproperties}
+ */
+MemoryProperties.prototype.getProperties = function() {
+  return _.clone(this.properties);
+}
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#getproperty}
+ */
+MemoryProperties.prototype.getProperty = function(key) {
+  return this.properties[key];
+}
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#setpropertiesproperties-deleteallothers}
+ */
+MemoryProperties.prototype.setProperties = function(properties, opt_deleteAllOthers) {
+  if (opt_deleteAllOthers) {
+    this.deleteAllProperties();
+  }
+  Object.keys(properties).forEach(function(key) {
+    this.setProperty(key, properties[key]);
+  });
+};
+
+/**
+ * @see {@link https://developers.google.com/apps-script/reference/properties/properties#setpropertykey-value}
+ */
+MemoryProperties.prototype.setProperty = function(key, value) {
+  this.properties[key] = String(value);
+};

Service.gs

@@ -31,6 +31,7 @@ var Service_ = function(serviceName) {
   this.oauthVersion_ = '1.0a';
   this.projectKey_ = eval('Script' + 'App').getProjectKey();
   this.signatureMethod_ = 'HMAC-SHA1';
+  this.propertyStore_ = new MemoryProperties();
 };
 
 /**
@@ -98,7 +99,7 @@ Service_.prototype.setMethod = function(method) {
 
 /**
  * Sets the OAuth signature method to use. 'HMAC-SHA1' is the default.
- * @param {string} signatureMethod The OAuth signature method. Allowed values 
+ * @param {string} signatureMethod The OAuth signature method. Allowed values
  *     are 'HMAC-SHA1' and 'PLAINTEXT'.
  * @return {Service_} This service, for chaining.
  */
@@ -171,10 +172,10 @@ Service_.prototype.setConsumerSecret = function(consumerSecret) {
 };
 
 /**
- * Sets the property store to use when persisting credentials (required). In
+ * Sets the property store to use when persisting credentials (optional). In
  * most cases this should be user properties, but document or script properties
- * may be appropriate if you want
- * to share access across users.
+ * may be appropriate if you want to share access across users. If not set tokens
+ * will be stored in memory only.
  * @param {PropertiesService.Properties} propertyStore The property store to use
  *     when persisting credentials.
  * @return {Service_} This service, for chaining.
@@ -198,6 +199,22 @@ Service_.prototype.setCache = function(cache) {
   return this;
 };
 
+/**
+ * Sets the access token and token secret to use (optional). For use with APIs
+ * that support a 1-legged flow where no user interaction is required.
+ * @param {string} token The access token.
+ * @param {string} secret The token secret.
+ * @return {Service_} This service, for chaining.
+ */
+Service_.prototype.setAccessToken = function(token, secret) {
+  this.saveToken_({
+    public: token,
+    secret: secret,
+    type: 'access'
+  });
+  return this;
+};
+
 /**
  * Starts the authorization process. A new token will be generated and the
  * authorization URL for that token will be returned. Have the user visit this
@@ -381,7 +398,6 @@ Service_.prototype.fetchInternal_ = function(url, params, opt_token,
       secret: this.consumerSecret_
     }
   });
-  var payload = _.extend({}, params.payload, oauthParams);
   var request = {
     url: url,
     method: params.method

Signer.gs

@@ -192,12 +192,14 @@
   * @return {Object}
   */
   OAuth.prototype.deParam = function(string) {
-    var arr = string.split('&');
+    var arr = decodeURIComponent(string)
+        .replace(/\+/g, ' ')
+        .split('&');
     var data = {};
 
     for(var i = 0; i < arr.length; i++) {
       var item = arr[i].split('=');
-      data[item[0]] = decodeURIComponent(item[1]);
+      data[item[0]] = item[1];
     }
     return data;
   };

samples/Yelp.gs

@@ -0,0 +1,56 @@
+var CONSUMER_KEY = '...';
+var CONSUMER_SECRET = '...';
+var TOKEN = '...';
+var TOKEN_SECRET = '...';
+
+/**
+ * Authorizes and makes a request to the Yelp API.
+ */
+function run() {
+  var service = getService();
+  if (service.hasAccess()) {
+    var url = 'https://api.yelp.com/v2/search?term=food&location=San+Francisco';
+    var response = service.fetch(url);
+    var result = JSON.parse(response.getContentText());
+    Logger.log(JSON.stringify(result, null, 2));
+  } else {
+    var authorizationUrl = service.authorize();
+    Logger.log('Open the following URL and re-run the script: %s',
+        authorizationUrl);
+  }
+}
+
+/**
+ * Reset the authorization state, so that it can be re-tested.
+ */
+function reset() {
+  var service = getService();
+  service.reset();
+}
+
+/**
+ * Configures the service.
+ */
+function getService() {
+  return OAuth1.createService('Yelp')
+      // Set the consumer key and secret.
+      .setConsumerKey(CONSUMER_KEY)
+      .setConsumerSecret(CONSUMER_SECRET)
+
+      // Manually set the token and secret, as provided by the Yelp developer
+      // console.
+      .setAccessToken(TOKEN, TOKEN_SECRET);
+}
+
+/**
+ * Handles the OAuth2 callback.
+ */
+function authCallback(request) {
+  var service = getService();
+  var authorized = service.handleCallback(request);
+  if (authorized) {
+    return HtmlService.createHtmlOutput('Success!');
+  } else {
+    return HtmlService.createHtmlOutput('Denied');
+  }
+}