asana 1.0.2 → 2.0.0

package/lib/auth/native_flow.js

@@ -1,106 +0,0 @@
-var readline = require('readline');
-var Bluebird = require('bluebird');
-var oauthUtil = require('./oauth_util');
-
-/**
- * Default function to return instructions for the user to authorize the app.
- * Written to stdout during `run`.
- * @param {String} url The authorization URL
- * @returns {String} Instructions for the user
- */
-function defaultInstructions(url) {
-  return [
-    '* * * * * * * * * * * * * * * * * * * * * * * * * * *',
-    'Please open a browser to the url:',
-    '',
-    url,
-    '',
-    'and follow the prompts to authorize this application.',
-    '* * * * * * * * * * * * * * * * * * * * * * * * * * *'
-  ].join('\n');
-}
-
-/**
- * Default function to return the prompt for the user to enter the
- * authorization code. Written to stdout immediately preceding keyboard input
- * during `run`.
- * @returns {String} A message to prompt the user to enter the code.
- */
-function defaultPrompt() {
-  return 'Enter the code here: ';
-}
-
-/**
- * An Oauth flow that can be run from the console or an app that does
- * not have the ability to open and manage a browser on its own.
- * @param {Object} options
- * @option {App} app App to authenticate for
- * @option {String function(String)} [instructions] Function returning the
- *     instructions to output to the user. Passed the authorize url.
- * @option {String function()} [prompt] String to output immediately before
- *     waiting for a line from stdin.
- * @constructor
- */
-function NativeFlow(options) {
-  this.app = options.app;
-  this.instructions = options.instructions || defaultInstructions;
-  this.prompt = options.prompt || defaultPrompt;
-  this.redirectUri = oauthUtil.NATIVE_REDIRECT_URI;
-}
-
-/**
- * Run the Oauth flow, prompting the user to go to the authorization URL
- * and enter the code it displays when finished.
- *
- * @return {Promise<Object>} The access token object, which will include
- *     `access_token` and `refresh_token`.
- */
-NativeFlow.prototype.run = function() {
-  var me = this;
-  return me.promptForCode(me.authorizeUrl()).then(function(code) {
-    return me.accessToken(code);
-  });
-};
-
-/**
- * @returns {String} The URL used to authorize the user for the app.
- */
-NativeFlow.prototype.authorizeUrl = function() {
-  return this.app.asanaAuthorizeUrl({
-    redirectUri: this.redirectUri
-  });
-};
-
-/**
- * @param {String} code An authorization code obtained via `asanaAuthorizeUrl`.
- * @return {Promise<Object>} The token, which will include the `access_token`
- *     used for API access, as well as a `refresh_token` which can be stored
- *     to get a new access token without going through the flow again.
- */
-NativeFlow.prototype.accessToken = function(code) {
-  return this.app.accessTokenFromCode(code, {
-    redirectUri: this.redirectUri
-  });
-};
-
-/**
- * @return {Promise} The access token, which will include a refresh token
- *     that can be stored in the future to create a client without going
- *     through the Oauth flow.
- */
-NativeFlow.prototype.promptForCode = function(url) {
-  var me = this;
-  var rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout
-  });
-  return new Bluebird(function(resolve) {
-    console.log(me.instructions(url));
-    rl.question(me.prompt(), function(code) {
-      rl.close();
-      return resolve(code);
-    });
-  });
-};
-
-module.exports = NativeFlow;

package/lib/auth/oauth_authenticator.js

@@ -1,125 +0,0 @@
-var util = require('util');
-var Bluebird = require('bluebird');
-var Authenticator = require('./authenticator');
-
-/**
- * Creates an authenticator that uses Oauth for authentication.
- *
- * @param {Object} options Configure the authenticator; must specify one
- *     of `flow` or `credentials`.
- * @option {App}           app           The app being authenticated for.
- * @option {OauthFlow}     [flow]        The flow to use to get credentials
- *     when needed.
- * @option {String|Object} [credentials] Initial credentials to use. This can
- *     be either the object returned from an access token request (which
- *     contains the token and some other metadata) or just the `access_token`
- *     field.
- * @constructor
- */
-function OauthAuthenticator(options) {
-  Authenticator.call(this);
-  if (typeof(options.credentials) === 'string') {
-    this.credentials = {
-      'access_token': options.credentials
-    };
-  } else {
-    this.credentials = options.credentials || null;
-  }
-  this.flow = options.flow || null;
-  this.app = options.app;
-  this.refreshCredentialsCallback = options.refreshCredentialsCallback || null;
-}
-
-util.inherits(OauthAuthenticator, Authenticator);
-
-/**
- * @param {Object} request The request to modify, for the `request` library.
- * @return {Object} The `request` parameter, modified to include authentication
- *     information using the stored credentials.
- */
-OauthAuthenticator.prototype.authenticateRequest = function(request) {
-  /* jshint camelcase: false */
-  if (this.credentials === null) {
-    throw new Error(
-      'Cannot authenticate a request without first obtaining credentials');
-  }
-  // When browserify-d, the `auth` component of the `request` library
-  // doesn't work so well, so we just manually set the bearer token instead.
-  request.headers = request.headers || {};
-  request.headers.Authorization = 'Bearer ' + this.credentials.access_token;
-  return request;
-};
-
-/**
- * Requests new credentials, discarding any that it may already have.
- * @return {Promise} Resolves when credentials have been successfully
- *     established and `authenticateRequests` can expect to succeed.
- */
-OauthAuthenticator.prototype.establishCredentials = function() {
-  /* jshint camelcase: false */
-  var me = this;
-  if (me.flow) {
-    // Request new credentials
-    me.credentials = null;
-    return me.flow.run().then(function(credentials) {
-      me.credentials = credentials;
-    });
-  } else {
-    if (me.credentials.access_token) {
-      // Assume what we have is ok.
-      return Bluebird.resolve();
-    } else if (me.credentials.refresh_token) {
-      // We were given a refresh token but NOT an access token. Get access.
-      return me.refreshCredentials();
-    } else {
-      // What kind of credentials did we get anyway?
-      return Bluebird.reject(new Error('Invalid credentials'));
-    }
-  }
-};
-
-/**
- * Attempts to refresh credentials, if possible, given the current credentials.
- * @return {Promise} Resolves to `true` if credentials have been successfully
- *     established and `authenticateRequests` can expect to succeed, else
- *     resolves to `false`.
- */
-OauthAuthenticator.prototype.refreshCredentials = function() {
-  /* jshint camelcase: false */
-  var me = this;
-  if (me.credentials && me.credentials.refresh_token) {
-    // We have a refresh token. Use it to get a new access token.
-    // Only have one outstanding request, any simultaneous requests waiting on
-    // refresh should gate on this promise.
-    if (!me.refreshPromise) {
-      var refreshToken = me.credentials.refresh_token;
-      me.refreshPromise = me.app.accessTokenFromRefreshToken(refreshToken).then(
-          function(credentials) {
-
-            // Update credentials, but hang on to refresh token.
-            if (!credentials.refresh_token) {
-              credentials.refresh_token = refreshToken;
-            }
-            me.credentials = credentials;
-            me.refreshPromise = null;
-
-            if (me.refreshCredentialsCallback !== null) {
-              me.refreshCredentialsCallback(me.credentials);
-            }
-
-            return true;
-          });
-    }
-    return me.refreshPromise;
-  } else if (me.flow) {
-    // Try running the flow again to get credentials.
-    return this.establishCredentials().then(function(credentials) {
-      return credentials !== null;
-    });
-  } else {
-    // We are unable to refresh credentials automatically.
-    return Bluebird.resolve(false);
-  }
-};
-
-module.exports = OauthAuthenticator;

package/lib/auth/oauth_error.js

@@ -1,24 +0,0 @@
-var util = require('util');
-
-/**
- * @param options {Object} A data blob parsed from a query string or JSON 
- * response from the Asana API
- * @option {String} error The string code identifying the error.
- * @option {String} [error_uri] A link to help and information about the error.
- * @option {String} [error_description] A description of the error.
- * @constructor
- */
-function OauthError(options) {
-  /* jshint camelcase:false */
-  Error.call(this);
-  if (typeof(options) !== 'object' || !options.error) {
-    throw new Error('Invalid Oauth error: ' + options);
-  }
-  this.code = options.error;
-  this.description = options.error_description || null;
-  this.uri = options.error_uri || null;
-}
-
-util.inherits(OauthError, Error);
-
-module.exports = OauthError;

package/lib/auth/oauth_util.js

@@ -1,52 +0,0 @@
-/* jshint browser:true */
-var querystring = require('querystring');
-var url = require('url');
-
-var NATIVE_REDIRECT_URI = 'urn:ietf:wg:oauth:2.0:oob';
-var NATIVE_AUTO_REDIRECT_URI = 'urn:ietf:wg:oauth:2.0:oob:auto';
-
-/**
- * @returns {String} A unique parameter to use as a CSRF token to pass in
- *     the `state` parameter of an Oauth request.
- */
-function randomState() {
-  return 'asana_' +
-    Math.random().toString(36) +
-    Date.now().toString(36);
-}
-
-/**
- * Parses a URL and returns any Oauth result that may be encoded therein.
- * @param currentUrl {String} Complete URL of a page.
- * @returns {Object|null} Oauth fields found in the hash of the URL, or null
- *     if the URL does not contain a valid hash.
- */
-function parseOauthResultFromUrl(currentUrl) {
-  var oauthUrl = url.parse(currentUrl);
-  return oauthUrl.hash ? querystring.parse(oauthUrl.hash.substr(1)) : null;
-}
-
-/**
- * Clean Oauth results out of the current browser URL, for security and
- * cleanliness purposes.
- * @returns {Object|null} Oauth fields found in the hash of the URL, or null
- *     if the URL does not contain a valid hash.
- */
-function removeOauthResultFromCurrentUrl() {
-  if (window.history && window.history.replaceState) {
-    var url = window.location.href;
-    var hashIndex = url.indexOf('#');
-    window.history.replaceState({},
-      document.title, url.substring(0, hashIndex));
-  } else {
-    window.location.hash = '';
-  }
-}
-
-module.exports = {
-  NATIVE_REDIRECT_URI: NATIVE_REDIRECT_URI,
-  NATIVE_AUTO_REDIRECT_URI: NATIVE_AUTO_REDIRECT_URI,
-  randomState: randomState,
-  parseOauthResultFromUrl: parseOauthResultFromUrl,
-  removeOauthResultFromCurrentUrl: removeOauthResultFromCurrentUrl
-};

package/lib/auth/popup_flow.js

@@ -1,135 +0,0 @@
-/* jshint browser:true */
-var util = require('util');
-var oauthUtil = require('./oauth_util');
-var Bluebird = require('bluebird');
-var BaseBrowserFlow = require('./base_browser_flow');
-var OauthError = require('./oauth_error');
-
-/**
- * An Oauth flow that runs in the browser and requests user authorization by
- * popping up a window and prompting the user.
- * @param {Object} options See `BaseBrowserFlow` for options.
- * @constructor
- */
-function PopupFlow(options) {
-  BaseBrowserFlow.call(this, options);
-  this._authorizationPromise = null;
-}
-
-util.inherits(PopupFlow, BaseBrowserFlow);
-
-PopupFlow.prototype.startAuthorization = function(authUrl, state) {
-  var me = this;
-
-  var popup, popupTimer, listener;
-  function cleanup() {
-    if (popup && popupTimer) {
-      clearInterval(popupTimer);
-      popupTimer = null;
-    }
-    if (listener) {
-      window.removeEventListener('message', listener, false);
-      listener = null;
-    }
-  }
-
-  me._authorizationPromise = new Bluebird(function(resolve, reject) {
-    listener = function(event) {
-      var receivedUrl;
-      try {
-        receivedUrl = event.data.receivedUrl;
-      } catch (e) {}
-      if (receivedUrl) {
-        // Every request should have a unique `state` parameter.
-        // We can key off of that to determine whether this request was
-        // intended for this window.
-        var params = oauthUtil.parseOauthResultFromUrl(receivedUrl);
-        if (params.state === state) {
-          state = null; // don't ever respond to again
-          cleanup();
-          if (params.error) {
-            reject(new OauthError(params));
-          } else {
-            resolve(params);
-          }
-        }
-      }
-    };
-    window.addEventListener('message', listener, false);
-    popup = window.open(authUrl, 'asana_oauth', me._popupParams(800, 600));
-
-    // Detect popup blocking and fail.
-    if (!popup) {
-      cleanup();
-      reject(new OauthError({
-        'error': 'access_denied',
-        'error_description': 'The popup window containing the ' +
-            'authorization UI was blocked by the browser.'
-      }));
-      return;
-    }
-
-    // Detect popup closure (which may not be handled by the content, because
-    // it may never load) and fail. If the popup posts a message to us, we
-    // SHOULD get that message before it closes and this interval fires,
-    // but just in case we wait for two successive intervals.
-    var seenClosed = false;
-    popupTimer = setInterval(function() {
-      if (popup.closed) {
-        if (seenClosed) {
-          cleanup();
-          reject(new OauthError({
-            'error': 'access_denied',
-            'error_description': 'The popup window containing the ' +
-                'authorization UI was closed by the user.'
-          }));
-        } else {
-          seenClosed = true;
-        }
-      }
-    }, 500);
-  });
-  return Bluebird.resolve();
-};
-
-PopupFlow.prototype.finishAuthorization = function() {
-  return this._authorizationPromise;
-};
-
-PopupFlow.prototype._popupParams = function(popupWidth, popupHeight) {
-  var left = window.screenX || window.screenLeft || 0;
-  var top = window.screenY || window.screenTop || 0;
-  var width = window.outerWidth || document.documentElement.clientWidth;
-  var height = window.outerHeight || document.documentElement.clientHeight;
-
-  var popupLeft = Math.max(left, Math.round(left + (width - popupWidth) / 2));
-  var popupTop = Math.max(top, Math.round(top + (height - popupHeight) / 2.5));
-
-  return util.format(
-    'left=%d,top=%d,' +
-    'width=%d,height=%d,' +
-    'dialog=yes,dependent=yes,scrollbars=yes,location=yes',
-    popupLeft, popupTop, popupWidth, popupHeight);
-};
-
-PopupFlow.runReceiver = function() {
-  window.addEventListener('load', function() {
-    var currentUrl = window.location.href;
-    oauthUtil.removeOauthResultFromCurrentUrl();
-    var opener = window.opener;
-    if (window.parent !== window.top) {
-      opener = opener || window.parent;
-    }
-    if (window.opener) {
-      console.log('Posting message', currentUrl, window.location.origin);
-      opener.postMessage({
-        receivedUrl: currentUrl
-      }, window.location.origin);
-      window.close();
-    } else {
-      console.log('No opener found for this window, not sending message');
-    }
-  }, false);
-};
-
-module.exports = PopupFlow;

package/lib/auth/redirect_flow.js

@@ -1,54 +0,0 @@
-/* jshint browser:true */
-var util = require('util');
-var oauthUtil = require('./oauth_util');
-var BaseBrowserFlow = require('./base_browser_flow');
-var OauthError = require('./oauth_error');
-var Bluebird = require('bluebird');
-
-/**
- * An Oauth flow that runs in the browser and requests user authorization by
- * redirecting to an authorization page on Asana, and redirecting back with
- * the credentials.
- * @param {Object} options See `BaseBrowserFlow` for options.
- * @constructor
- */
-function RedirectFlow(options) {
-  BaseBrowserFlow.call(this, options);
-}
-
-util.inherits(RedirectFlow, BaseBrowserFlow);
-
-RedirectFlow.prototype.getStateParam = function() {
-  // If we're coming off the redirect, then we should use the state passed
-  // back from the URL.
-  var oauthResult = oauthUtil.parseOauthResultFromUrl(window.location.href);
-  if (oauthResult !== null && oauthResult.state) {
-    return oauthResult.state;
-  }
-  return BaseBrowserFlow.prototype.getStateParam.call(this);
-};
-
-RedirectFlow.prototype.startAuthorization = function(authUrl) {
-  // If we're coming off the redirect, then move directly to finish auth
-  var result = oauthUtil.parseOauthResultFromUrl(window.location.href);
-  if (result !== null) {
-    return Bluebird.resolve();
-  }
-  window.location.href = authUrl;
-  return new Bluebird(function() {
-    // This promise will never resolve - we should leave the page first.
-  });
-};
-
-RedirectFlow.prototype.finishAuthorization = function() {
-  var currentUrl = window.location.href;
-  oauthUtil.removeOauthResultFromCurrentUrl();
-  var result = oauthUtil.parseOauthResultFromUrl(currentUrl);
-  if (result.error) {
-    return Bluebird.reject(new OauthError(result));
-  } else {
-    return Bluebird.resolve(result);
-  }
-};
-
-module.exports = RedirectFlow;