asana 1.0.2 → 2.0.0

package/bower.json

@@ -1,29 +0,0 @@
-{
-  "name": "asana",
-  "main": "dist/asana.js",
-  "version": "1.0.2",
-  "homepage": "https://github.com/Asana/node-asana",
-  "authors": [
-    "Greg Slovacek <greg@asana.com>",
-    "Phips Peter <pspeter333@gmail.com>"
-  ],
-  "description": "A JavaScript client for the 1.0 version of the Asana API",
-  "moduleType": [
-    "amd",
-    "globals",
-    "node"
-  ],
-  "keywords": [
-    "asana",
-    "api",
-    "oauth"
-  ],
-  "license": "MIT",
-  "ignore": [
-    "**/.*",
-    "node_modules",
-    "bower_components",
-    "test",
-    "tests"
-  ]
-}

package/gulpfile.js

@@ -1,205 +0,0 @@
-var browserify = require('browserify');
-var fs = require('fs');
-var bump = require('gulp-bump');
-var filter = require('gulp-filter');
-var git = require('gulp-git');
-var gulp = require('gulp');
-var istanbul = require('gulp-istanbul');
-var jshint = require('gulp-jshint');
-var mocha = require('gulp-mocha');
-var tagVersion = require('gulp-tag-version');
-var uglify = require('gulp-uglify');
-var vinylBuffer = require('vinyl-buffer');
-var vinylSourceStream = require('vinyl-source-stream');
-
-/**
- * Paths
- */
-var index = './index.js';
-var lib = 'lib/**/*.js';
-var root = '*.js';
-var test = 'test/**/*.js';
-
-/**
- * Bundles the code, full version to `asana.js` and minified to `asana-min.js`
- */
-function browserTask(minify) {
-  return function(done) {
-    var task = browserify(
-        {
-          entries: [index],
-          standalone: 'Asana'
-        })
-        .bundle()
-        .pipe(vinylSourceStream('asana' + (minify ? '-min' : '') + '.js'));
-    if (minify) {
-      task = task
-          .pipe(vinylBuffer())
-          .pipe(uglify().on('error', function(err) {
-              console.log(err.toString());
-              this.emit('end');
-          }));
-    }
-    task.pipe(gulp.dest('dist'));
-
-    done();
-  };
-}
-
-/**
- * Ensure that the git working directory is clean.
- */
-function ensureGitClean(done) {
-  git.status(function(err, out) {
-    if (err) { throw err; }
-    if (!/nothing to commit/.exec(out)) {
-      throw new Error(
-        'Git working directory not clean, will not bump version'
-        );
-    }
-  });
-
-  done();
-}
-gulp.task('ensure-git-clean', ensureGitClean);
-
-/**
- * Bumping version number and tagging the repository with it.
- * Please read http://semver.org/
- *
- * You can use the commands
- *
- *     gulp bump-patch   # makes v0.1.0 → v0.1.1
- *     gulp bump-minor   # makes v0.1.1 → v0.2.0
- *     gulp bump-major   # makes v0.2.1 → v1.0.0
- *
- * To bump the version numbers accordingly after you did a patch,
- * introduced a feature or made a backwards-incompatible release.
- */
-function bumpVersion(importance) {
-  // Update VERSION file
-  function updateVersionFile(cb) {
-    fs.readFile('VERSION', 'utf-8', function (err, data) {
-      if (err) {
-        console.log(err);
-      }
-
-      var versionArray = data.split('.');
-      var major = versionArray[0];
-      var minor = versionArray[1];
-      var patch = versionArray[2];
-
-      if (importance === 'major') {
-        major = (parseInt(major) + 1).toString();
-      }
-      if (importance === 'minor') {
-        minor = (parseInt(minor) + 1).toString();
-      }
-      if (importance === 'patch') {
-        patch = (parseInt(patch) + 1).toString();
-      }
-
-      var updatedVersion = [major, minor, patch].join('.');
-
-      fs.writeFile('VERSION', updatedVersion, function (err) {
-        if (err) {
-          console.log(err);
-        }
-      });
-    });
-    cb();
-  }
-
-  // Bump version in package.json and bower.json
-  function updateVersion() {
-    return gulp
-      .src(['./package.json', './bower.json'])
-      .pipe(bump({ type: importance }))
-      .pipe(gulp.dest('./'));
-  }
-
-  // Add, commit version files and tag commit with new version
-  function addCommitTagPush(cb) {
-    gulp
-      .src(['./package.json', './bower.json', './VERSION'])
-      .pipe(git.add())
-      .pipe(git.commit('Bump package version'))
-      .pipe(filter('package.json'))
-      .pipe(tagVersion());
-    cb();
-  }
-
-  // Update the version files in parallel and then commit the changes
-  return gulp.series(
-    gulp.parallel(updateVersionFile, updateVersion),
-    addCommitTagPush
-  )();
-}
-function bumpPatch(cb) {
-  bumpVersion('patch');
-  cb();
-}
-gulp.task('bump-patch', gulp.series('ensure-git-clean', bumpPatch));
-function bumpMinor(cb) {
-  bumpVersion('minor');
-  cb();
-}
-gulp.task('bump-minor', gulp.series('ensure-git-clean', bumpMinor));
-function bumpMajor(cb) {
-  bumpVersion('major');
-  cb();
-}
-gulp.task('bump-major', gulp.series('ensure-git-clean', bumpMajor));
-
-/**
- * Lints all of the JavaScript files and fails if the tasks do not pass
- */
-function lint() {
-  return gulp.src([root, lib, test])
-      .pipe(jshint())
-      .pipe(jshint.reporter('jshint-stylish'))
-      .pipe(jshint.reporter('fail'));
-}
-gulp.task('lint', lint);
-
-/**
- * Tests the code with mocha and ensures 100% code coverage
- */
-function spec(callback) {
-  gulp.src(lib)
-      .pipe(istanbul({
-        includeUntested: true
-      }))
-      .pipe(istanbul.hookRequire())
-      .on('finish', function() {
-        gulp.src(test)
-            .pipe(mocha({
-              reporter: 'nyan'
-            }))
-            .pipe(istanbul.writeReports({
-              reporters: ['text', 'text-summary']
-            }))
-            .on('end', function() {
-              var errOrNull = null;
-              var coverage = istanbul.summarizeCoverage();
-              var incomplete = Object.keys(coverage).filter(function(key) {
-                return coverage[key].pct < 49; // TODO: Get this to 100%
-              });
-              if (incomplete.length > 0) {
-                console.log('Incomplete coverage for ' + incomplete.join(', '));
-              }
-              callback(errOrNull);
-            });
-      });
-}
-
-gulp.task('spec', gulp.series('lint', spec));
-
-gulp.task('browser', browserTask(false));
-gulp.task('browser-min', browserTask(true));
-
-/**
- * High Level Tasks
- */
-gulp.task('bundle', gulp.series('browser', 'browser-min'));
-gulp.task('test', gulp.series('bundle', 'spec'));

package/index.js

@@ -1,7 +0,0 @@
-exports.Client = require('./lib/client');
-exports.Dispatcher = require('./lib/dispatcher');
-exports.auth = require('./lib/auth');
-exports.errors = require('./lib/errors');
-exports.resources = require('./lib/resources');
-
-exports.VERSION = require('./package.json').version;

package/lib/auth/app.js

@@ -1,136 +0,0 @@
-var url = require('url');
-var request = require('request');
-var Bluebird = require('bluebird');
-var OauthError = require('./oauth_error');
-
-/**
- * @params {Object} params Parameters for the `request` call.
- * @return {Promise} Promise representing the request, will resolve to the
- *     `Object` returned or an `OauthError`.
- */
-var doRequest = function(params) {
-  return new Bluebird(function(resolve, reject) {
-    request(params, function(err, res, payload) {
-      if (err) {
-        return reject(err);
-      }
-      if (res.statusCode !== 200) {
-        return reject(payload);
-      }
-      var result = JSON.parse(payload);
-      if (result.error) {
-        return reject(new OauthError(result));
-      } else {
-        return resolve(result);
-      }
-    });
-  });
-};
-
-/**
- * An abstraction around an App used with Asana.
- *
- * @options {Object} Options to construct the app
- * @option {String} clientId       The ID of the app
- * @option {String} [clientSecret] The secret key, if available here
- * @option {String} [redirectUri]  The default redirect URI
- * @option {String} [scope]        Scope to use, supports `default` and `scim`
- * @option {String} [asanaBaseUrl] Base URL to use for Asana, for debugging
- * @constructor
- */
-function App(options) {
-  this.clientId = options.clientId;
-  this.clientSecret = options.clientSecret || null;
-  this.redirectUri = options.redirectUri || null;
-  this.scope = options.scope || 'default';
-  this.asanaBaseUrl = options.asanaBaseUrl || 'https://app.asana.com/';
-  this.tokenExchangeEndpoint = options.tokenExchangeEndpoint || null;
-}
-
-
-/**
- * @param {Object} options  Overrides to the app's defaults
- * @option {String} asanaBaseUrl
- * @option {String} redirectUri
- * @returns {String} The URL used to authorize a user for the app.
- */
-App.prototype.asanaAuthorizeUrl = function(options) {
-  options = options || {};
-  return url.resolve(
-    options.asanaBaseUrl || this.asanaBaseUrl,
-    url.format({
-      pathname: '/-/oauth_authorize',
-      query: {
-        'client_id': this.clientId,
-        'response_type': 'code',
-        'redirect_uri': options.redirectUri || this.redirectUri,
-        'scope': this.scope
-      }
-    }));
-};
-
-
-/**
- * @param {Object} options  Overrides to the app's defaults
- * @option {String} asanaBaseUrl
- * @option {String} redirectUri
- * @returns {String} The URL used to acquire an access token.
- */
-App.prototype.asanaTokenUrl = function(options) {
-  options = options || {};
-  return this.tokenExchangeEndpoint || url.resolve(
-    options.asanaBaseUrl || this.asanaBaseUrl,
-    '/-/oauth_token');
-};
-
-/**
- * @param {String} code An authorization code obtained via `asanaAuthorizeUrl`.
- * @param {Object} options  Overrides to the app's defaults
- * @option {String} asanaBaseUrl
- * @option {String} redirectUri
- * @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.
- */
-App.prototype.accessTokenFromCode = function(code, options) {
-  options = options || {};
-  var params = {
-    method: 'POST',
-    url: this.asanaTokenUrl(options),
-    form: {
-      'grant_type': 'authorization_code',
-      'client_id': this.clientId,
-      'client_secret': this.clientSecret,
-      'redirect_uri': options.redirectUri || this.redirectUri,
-      'code': code
-    }
-  };
-  return doRequest(params);
-};
-
-/**
- * @param {String} refreshToken A refresh token obtained via Oauth.
- * @param {Object} options Overrides to the app's defaults
- * @option {String} asanaBaseUrl
- * @option {String} redirectUri
- * @return {Promise<Object>} The token, which will include the `access_token`
- *     used for API access.
- */
-App.prototype.accessTokenFromRefreshToken = function(refreshToken, options) {
-  options = options || {};
-  var params = {
-    method: 'POST',
-    url: this.asanaTokenUrl(options),
-    form: {
-      'grant_type': 'refresh_token',
-      'client_id': this.clientId,
-      'client_secret': this.clientSecret,
-      'redirect_uri': options.redirectUri || this.redirectUri,
-      'refresh_token': refreshToken
-    }
-  };
-  return doRequest(params);
-};
-
-
-module.exports = App;

package/lib/auth/authenticator.js

@@ -1,41 +0,0 @@
-/**
- * A layer to abstract the differences between using different types of
- * authentication (Oauth vs. Basic). The Authenticator is responsible for
- * establishing credentials and applying them to outgoing requests.
- * @constructor
- */
-function 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.
- */
-Authenticator.prototype.authenticateRequest = function(request) {
-  throw new Error('not implemented', request);
-};
-
-/**
- * Establishes credentials.
- *
- * @return {Promise} Resolves when initial credentials have been
- *     completed and `authenticateRequest` calls can expect to succeed.
- */
-Authenticator.prototype.establishCredentials = function() {
-  throw new Error('not implemented');
-};
-
-/**
- * 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`.
- */
-Authenticator.prototype.refreshCredentials = function() {
-  throw new Error('not implemented');
-};
-
-
-module.exports = Authenticator;

package/lib/auth/auto_detect.js

@@ -1,36 +0,0 @@
-/* jshint browser: true */
-var NativeFlow = require('./native_flow');
-var RedirectFlow = require('./redirect_flow');
-var ChromeExtensionFlow = require('./chrome_extension_flow');
-var defaultEnvironment = require('../default_environment');
-
-/**
- * Auto-detects the type of Oauth flow to use that's appropriate to the
- * environment.
- *
- * @returns {Function|null} The type of Oauth flow to use, or null if no
- *     appropriate type could be determined.
- */
-function autoDetect(env) {
-  env = env || defaultEnvironment();
-  if (typeof(env.chrome) !== 'undefined' &&
-    env.chrome.runtime && env.chrome.runtime.id) {
-    if (env.chrome.tabs && env.chrome.tabs.create) {
-      return ChromeExtensionFlow;
-    } else {
-      // Chrome packaged app, not supported yet.
-      return null;
-    }
-  }
-  if (typeof(env.window) !== 'undefined' && env.window.navigator) {
-    // Browser
-    return RedirectFlow;
-  }
-  if (typeof(env.process) !== 'undefined' && env.process.env) {
-    // NodeJS script
-    return NativeFlow;
-  }
-  return null;
-}
-
-module.exports = autoDetect;

package/lib/auth/base_browser_flow.js

@@ -1,97 +0,0 @@
-/* jshint browser:true */
-var url = require('url');
-var oauthUtil = require('./oauth_util');
-
-// TODO: options.storage, for an interface to load/save/delete credentials
-//     e.g. in cookies or in localStorage maybe
-// TODO: options.remember, to store in storage (true by default?)
-// TODO: testing across browsers
-// TODO: standardize logging with option (add logger? 3rd party something?)
-// TODO: tests
-
-/**
- * A base class for any flow that runs in the browser. All subclasses use the
- * "implicit grant" flow to authenticate via the browser.
- * @param {Object} options
- * @option {App} app The app this flow is for
- * @option {String} [redirectUri] The URL that Asana should redirect to once
- *     user authorization is complete. Defaults to the URL configured in
- *     the app, and if none then the current page URL.
- * @constructor
- */
-function BaseBrowserFlow(options) {
-  this.options = options;
-}
-
-/**
- * @param {String} authUrl The URL the user should be navigated to in order
- *     to authorize the app.
- * @param {String} state   The unique state generated for this auth request.
- * @return {Promise} Resolved when authorization has successfully started,
- *     i.e. the user has been navigated to a page requesting authorization.
- */
-BaseBrowserFlow.prototype.startAuthorization = function(authUrl, state) {
-  throw new Error('Not implemented', authUrl, state);
-};
-
-/**
- * @return {Promise<Object>} Credentials returned from Oauth.
- */
-BaseBrowserFlow.prototype.finishAuthorization = function(state) {
-  throw new Error('Not implemented', state);
-};
-
-/**
- * @return {String} The URL to redirect to that will receive the
- */
-BaseBrowserFlow.prototype.receiverUrl = function() {
-  var relativeUrl =
-    this.options.redirectUri || this.options.app.redirectUri || '';
-  return url.resolve(window.location.href, relativeUrl);
-};
-
-/**
- * @return {String} The URL to redirect to that will receive the
- */
-BaseBrowserFlow.prototype.asanaBaseUrl = function() {
-  return this.options.app.asanaBaseUrl;
-};
-
-/**
- * @returns {String} Generate a new unique state parameter for a request.
- */
-BaseBrowserFlow.prototype.getStateParam = function() {
-  return oauthUtil.randomState();
-};
-
-/**
- * @returns {String} The URL used to authorize the user for the app.
- */
-BaseBrowserFlow.prototype.authorizeUrl = function() {
-  // All browser flows should use the implicit grant (`token`) flow.
-  return url.resolve(this.asanaBaseUrl(), url.format({
-    pathname: '/-/oauth_authorize',
-    query: {
-      'client_id': this.options.app.clientId,
-      'response_type': 'token',
-      'redirect_uri': this.receiverUrl(),
-      'scope': this.options.app.scope,
-      'state': this.state
-    }
-  }));
-};
-
-/**
- * Run the appropriate parts of the Oauth flow, attempting to establish user
- * authorization.
- * @returns {Promise<Object>} A promise that resolves to the Oauth credentials.
- */
-BaseBrowserFlow.prototype.run = function() {
-  var me = this;
-  me.state = me.getStateParam(me.options);
-  return me.startAuthorization(me.authorizeUrl(), me.state).then(function() {
-    return me.finishAuthorization(me.state);
-  });
-};
-
-module.exports = BaseBrowserFlow;

package/lib/auth/basic_authenticator.js

@@ -1,33 +0,0 @@
-var util = require('util');
-var Bluebird = require('bluebird');
-var Authenticator = require('./authenticator');
-
-/**
- * @param {String} apiKey The key to use to access the API.
- * @constructor
- */
-function BasicAuthenticator(apiKey) {
-  this.apiKey = apiKey;
-}
-
-util.inherits(BasicAuthenticator, Authenticator);
-
-BasicAuthenticator.prototype.authenticateRequest = function(request) {
-  request.auth = {
-    username: this.apiKey,
-    password: ''
-  };
-  return request;
-};
-
-BasicAuthenticator.prototype.establishCredentials = function() {
-  // Credentials are already built-in.
-  return Bluebird.resolve();
-};
-
-BasicAuthenticator.prototype.refreshCredentials = function() {
-  // We have no way of refreshing credentials.
-  return Bluebird.resolve(false);
-};
-
-module.exports = BasicAuthenticator;

package/lib/auth/chrome_extension_flow.js

@@ -1,94 +0,0 @@
-/* jshint browser: true */
-/* global chrome */
-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 a Chrome browser extension and requests user
- * authorization by opening a temporary tab to prompt the user.
- * @param {Object} options See `BaseBrowserFlow` for options, plus the below:
- * @options {String} [receiverPath] Full path and filename from the base
- *     directory of the extension to the receiver page. This is an HTML file
- *     that has been made web-accessible, and that calls the receiver method
- *     `Asana.auth.ChromeExtensionFlow.runReceiver();`.
- * @constructor
- */
-function ChromeExtensionFlow(options) {
-  BaseBrowserFlow.call(this, options);
-  this._authorizationPromise = null;
-  this._receiverUrl = chrome.runtime.getURL(
-      options.receiverPath || 'asana_oauth_receiver.html');
-}
-
-util.inherits(ChromeExtensionFlow, BaseBrowserFlow);
-
-ChromeExtensionFlow.prototype.receiverUrl = function() {
-  return this._receiverUrl;
-};
-
-ChromeExtensionFlow.prototype.startAuthorization = function(authUrl, state) {
-  var me = this;
-  var receiverTabId = null;
-  me._authorizationPromise = new Bluebird(function(resolve, reject) {
-    var listener = function(message, sender) {
-      // The message must come from our receiver window, which would have a URL
-      // that is our receiver URL, plus a hash with some oauth results in it.
-      if (!sender || !sender.tab || sender.tab.id !== receiverTabId ||
-          sender.tab.url.substring(0, me._receiverUrl.length) !==
-              me._receiverUrl) {
-        return;
-      }
-      var receivedUrl = message.receivedUrl;
-      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
-          var dummyError;
-          chrome.tabs.remove(receiverTabId, function() {
-            // Calling the `lastError` getter will silence a warning we get
-            // in case the tab has already closed.
-            dummyError = chrome.runtime.lastError;
-          });
-          chrome.runtime.onMessage.removeListener(listener);
-          if (params.error) {
-            reject(new OauthError(params));
-          } else {
-            resolve(params);
-          }
-        }
-      }
-    };
-    chrome.runtime.onMessage.addListener(listener);
-    chrome.tabs.create({
-      url: authUrl,
-      active: true
-    }, function(tab) {
-      receiverTabId = tab.id;
-    });
-  });
-  return Bluebird.resolve();
-};
-
-ChromeExtensionFlow.prototype.finishAuthorization = function() {
-  return this._authorizationPromise;
-};
-
-/**
- * Runs the receiver code to send the Oauth result to the requesting tab.
- */
-ChromeExtensionFlow.runReceiver = function() {
-  window.addEventListener('load', function() {
-    var currentUrl = window.location.href;
-    oauthUtil.removeOauthResultFromCurrentUrl();
-    chrome.runtime.sendMessage({ receivedUrl: currentUrl });
-    window.close();
-  }, false);
-};
-
-module.exports = ChromeExtensionFlow;

package/lib/auth/index.js

@@ -1,9 +0,0 @@
-exports.BaseBrowserFlow = require('./base_browser_flow');
-exports.ChromeExtensionFlow = require('./chrome_extension_flow');
-exports.NativeFlow = require('./native_flow');
-exports.PopupFlow = require('./popup_flow');
-exports.RedirectFlow = require('./redirect_flow');
-
-exports.autoDetect = require('./auto_detect');
-exports.OauthError = require('./oauth_error');
-exports.App = require('./app');