@beauraines/rtm-api 1.4.2 → 1.6.0

package/src/user/index.js

@@ -133,7 +133,7 @@ class RTMUser {
    */
   get client() {
     if ( !this._client ) {
-      throw "User does not have Client specified";
+      throw 'User does not have Client specified';
     }
     return this._client;
   }
@@ -153,7 +153,7 @@ class RTMUser {
    */
   get timeline() {
     if ( !this._timeline ) {
-      throw "User does not have a valid timeline set";
+      throw 'User does not have a valid timeline set';
     }
     return this._timeline;
   }
@@ -274,9 +274,10 @@ class RTMUser {
    * - {@link RTMUser~tasks/increasePriority|increasePriority}
    * - {@link RTMUser~tasks/move|move}
    * - {@link RTMUser~tasks/setDueDate|setDueDate}
+   * - {@link RTMUser~tasks/setStartDate|setStartDate}
    * - {@link RTMUser~tasks/postpone|postpone}
    * - {@link RTMUser~tasks/setName|setName}
-   * @returns {{get: function, add:function, remove: function, complete: function, uncomplete: function, addNotes: function, addTags: function, removeTags: function, priority: function, decreasePriority: function, increasePriority: function, move: function, setDueDate: function, postpone: function, setName: function}}
+   * @returns {{get: function, add:function, remove: function, complete: function, uncomplete: function, addNotes: function, addTags: function, removeTags: function, priority: function, decreasePriority: function, increasePriority: function, move: function, setDueDate: function, setStartDate: function, postpone: function, setName: function}}
    */
   get tasks() {
     return require('./tasks.js')(this);

package/src/user/tasks.js

@@ -5,7 +5,7 @@ const _lists = require('../list/helper.js');
 const taskIds = require('../utils/taskIds.js');
 const errors = require('../response/error.js');
 const { getListId, getTaskId, getTaskSeriesId } = require('../utils/taskIds');
-const { callAPI, buildUrl } = require('../utils/fetch')
+const { callAPI, buildUrl } = require('../utils/fetch');
 const RTMTask = require('../task/index.js');
 
 /**
@@ -28,7 +28,7 @@ module.exports = function(user) {
   rtn.get = function(filter, callback) {
     if ( callback === undefined && typeof filter === 'function' ) {
       callback = filter;
-      filter = "";
+      filter = '';
     }
 
     // Callback counters
@@ -77,8 +77,8 @@ module.exports = function(user) {
         if ( list === undefined ) {
           list = {
             id: TASKS[i].list_id,
-            name: "List #" + TASKS[i].list_id
-          }
+            name: 'List #' + TASKS[i].list_id
+          };
         }
         TASKS[i]._list = list;
       }
@@ -92,10 +92,10 @@ module.exports = function(user) {
    * @return {JSON} 
    */
   rtn.rtmFetch = async function(filter) {
-    let url = buildUrl(user,filter)
+    let url = buildUrl(user,filter);
     let response = await callAPI(url);
-    return await response.rsp.tasks?.list
-  }
+    return await response.rsp.tasks?.list;
+  };
 
   /**
    * Get the RTMTask specified by its index. Unlike getTask(), this will only create an RTMTask
@@ -107,36 +107,36 @@ module.exports = function(user) {
    */
   rtn.rtmIndexFetchTask = async function(index,filter) {
 
-    let url = buildUrl(user,filter)
+    let url = buildUrl(user,filter);
     let response = await callAPI(url,user);
-    const lists =  response.rsp.tasks?.list
+    const lists =  response.rsp.tasks?.list;
 
 
     // index to ids
-    let listId = getListId(user.id,index)
-    let taskSeriesId = getTaskSeriesId(user.id,index)
-    let taskId = getTaskId(user.id,index)
+    let listId = getListId(user.id,index);
+    let taskSeriesId = getTaskSeriesId(user.id,index);
+    let taskId = getTaskId(user.id,index);
 
     if (listId == undefined || taskSeriesId == undefined || taskId == undefined) {
-      return {err: {code: -3}} // Not sure why this is the code
+      return {err: {code: -3}}; // Not sure why this is the code
     }
     // filter the response for the matching index
-    let taskList = lists.filter(x => x.id == listId)[0].taskseries
-    let taskSeries = taskList ? taskList.filter(x => x.id == taskSeriesId)[0] : null
+    let taskList = lists.filter(x => x.id == listId)[0].taskseries;
+    let taskSeries = taskList ? taskList.filter(x => x.id == taskSeriesId)[0] : null;
     taskSeries
       ? taskSeries.task = taskSeries.task.filter(x => x.id == taskId)[0]
-      : null
+      : null;
 
 
-    let err
-    let task
+    let err;
+    let task;
     if (!taskSeries ) {
-      err = {code: -3} // Not sure why this is the code 
+      err = {code: -3}; // Not sure why this is the code 
     }  else {
-      task = new RTMTask(user.id,listId,taskSeries,taskSeries.task)
+      task = new RTMTask(user.id,listId,taskSeries,taskSeries.task);
     }
-    return {err,task}
-  }
+    return {err,task};
+  };
 
   /**
    * Get the RTMTask specified by its index. While this will return only the matching RTMTask,
@@ -153,7 +153,7 @@ module.exports = function(user) {
   rtn.getTask = function(index, filter, callback) {
     if ( callback === undefined && typeof filter === 'function' ) {
       callback = filter;
-      filter = "";
+      filter = '';
     }
 
     // Get Task Info
@@ -347,7 +347,7 @@ module.exports = function(user) {
    * @function RTMUser~tasks/addNotes
    */
   rtn.addNotes = function(index, title, notes, callback) {
-    var title = (typeof title !== 'undefined') ? title : "";
+    var title = (typeof title !== 'undefined') ? title : '';
 
     // Get the Task
     _getTaskInfo(index, function(err, listId, taskSeriesId, taskId) {
@@ -360,7 +360,7 @@ module.exports = function(user) {
         listId,
         taskSeriesId,
         taskId,
-    	title,
+        title,
         notes,
         user,
         callback
@@ -588,7 +588,7 @@ module.exports = function(user) {
         return callback(err);
       }
 
-      // Decrease the Priority of the Task
+      // Sets the Due Date of the Task
       return _tasks.setDueDate(
         listId,
         taskSeriesId,
@@ -602,6 +602,36 @@ module.exports = function(user) {
 
   };
 
+  /**
+   * Set the Start Date of the specified Task
+   * @param {int} index Task Index
+   * @param {string} start The Start Date of the Task (RTM parsed date)
+   * @param {function} callback Callback function(err)
+   * @param {RTMError} callback.err RTM API Error Response, if encountered
+   * @function RTMUser~tasks/setStartDate
+   */
+  rtn.setStartDate = function(index, start, callback) {
+
+    // Get the Task
+    _getTaskInfo(index, function(err, listId, taskSeriesId, taskId) {
+      if ( err ) {
+        return callback(err);
+      }
+  
+      // Sets the Start Date of the Task
+      return _tasks.setStartDate(
+        listId,
+        taskSeriesId,
+        taskId,
+        start,
+        user,
+        callback
+      );
+  
+    });
+  
+  };
+
   /**
    * Set the Name of the specified Task
    * @param {int} index Task Index

package/src/utils/auth.js

@@ -86,14 +86,14 @@ function getAuthToken(frob, client, callback) {
  * @param {function} callback Callback function(err, verified)
  * @private
  */
- function verifyAuthToken(token, client, callback) {
+function verifyAuthToken(token, client, callback) {
 
-   // Get token from RTMUser
-   if ( typeof token === 'object' ) {
-     if ( token.constructor.name === 'RTMUser' ) {
-       token = token.authToken;
-     }
-   }
+  // Get token from RTMUser
+  if ( typeof token === 'object' ) {
+    if ( token.constructor.name === 'RTMUser' ) {
+      token = token.authToken;
+    }
+  }
 
   // Set request parameters
   let params = {
@@ -173,10 +173,10 @@ function _formQuery(params) {
   let parts = [];
   for ( let key in params ) {
     if ( params.hasOwnProperty(key) ) {
-      parts.push(encodeURIComponent(key) + "=" + encodeURIComponent(params[key]));
+      parts.push(encodeURIComponent(key) + '=' + encodeURIComponent(params[key]));
     }
   }
-  return parts.join("&");
+  return parts.join('&');
 }
 
 

package/src/utils/fetch.js

@@ -1,6 +1,6 @@
 const fetch = require('node-fetch');
-const sign = require('../utils/sign')
-
+const sign = require('../utils/sign');
+const debug = require('debug')('rtm-api-fetch');
 
 // API Configuration Properties
 const config = require('../../config');
@@ -18,12 +18,12 @@ function buildUrl(user,filter) {
     api_key: user._client._apiKey,
     v: version,
     format
-  }
+  };
 
-  let apiSig=sign(query,{secret:user._client._apiSecret})
+  let apiSig=sign(query,{secret:user._client._apiSecret});
 
-  let url = `${scheme}://${base}?${formQuery(query)}&api_sig=${apiSig}`
-  return url
+  let url = `${scheme}://${base}?${formQuery(query)}&api_sig=${apiSig}`;
+  return url;
 }
 
 
@@ -36,13 +36,13 @@ function buildUrl(user,filter) {
  * @returns {string} URL Encoded query string
  */
 function formQuery(params) {
-let parts = [];
-for ( let key in params ) {
+  let parts = [];
+  for ( let key in params ) {
     if ( params.hasOwnProperty(key) ) {
-    parts.push(encodeURIComponent(key) + "=" + encodeURIComponent(params[key]));
+      parts.push(encodeURIComponent(key) + '=' + encodeURIComponent(params[key]));
     }
-}
-return parts.join("&");
+  }
+  return parts.join('&');
 }
 
 /**
@@ -52,16 +52,18 @@ return parts.join("&");
  */
 async function callAPI(url) {
   try {
-      const response = await fetch(url);
-      if (await response.ok) {
-          return await response.json();
-      } else {
-          // TODO improve this error message
-          console.error('There was an error');
-      }
-    } catch (error) {
-        console.error(error)
+    const response = await fetch(url);
+    if (await response.ok) {
+      const responseJson = await response.json();
+	  debug(JSON.stringify(responseJson));
+	  return responseJson; 
+    } else {
+      // TODO improve this error message
+      console.error('There was an error');
     }
+  } catch (error) {
+    console.error(error);
+  }
 }
 
-module.exports = {callAPI,formQuery, buildUrl}
+module.exports = {callAPI,formQuery, buildUrl};

package/src/utils/get.js

@@ -8,6 +8,8 @@ const RTMClient = require('../client/index.js');
 const RTMUser = require('../user/index.js');
 const sign = require('./sign.js');
 
+const debug = require('debug')('rtm-api-get');
+
 // API Configuration Properties
 const config = require('../../config');
 const scheme = config.api.scheme;
@@ -64,7 +66,7 @@ function _makeRequest(scheme, options, callback) {
 
   // Require the http(s) module
   let http = undefined;
-  if ( scheme === "https" ) {
+  if ( scheme === 'https' ) {
     http = require('https');
   }
   else {
@@ -88,10 +90,11 @@ function _makeRequest(scheme, options, callback) {
 
       // Parse the API Response
       let parsed = parse(resp);
+      debug(JSON.stringify(parsed));
 
       // Return parsed result as error or success
       if ( !parsed.isOk ) {
-        return callback(parsed)
+        return callback(parsed);
       }
       else {
         return callback(null, parsed);
@@ -182,7 +185,7 @@ function _buildRequestUrl(method, params, user, client) {
   let query = _formQuery(args.params);
 
   // Build the API request URL
-  return scheme + '://' + base + "?" + query;
+  return scheme + '://' + base + '?' + query;
 
 }
 
@@ -236,10 +239,10 @@ function _formQuery(params) {
   let parts = [];
   for ( let key in params ) {
     if ( params.hasOwnProperty(key) ) {
-      parts.push(encodeURIComponent(key) + "=" + encodeURIComponent(params[key]));
+      parts.push(encodeURIComponent(key) + '=' + encodeURIComponent(params[key]));
     }
   }
-  return parts.join("&");
+  return parts.join('&');
 }
 
 

package/src/utils/sign.js

@@ -44,7 +44,7 @@ function sign(params, client) {
   let toHash = client.secret + cat;
 
   // Return the Hash
-  return crypto.createHash('md5').update(toHash).digest("hex");
+  return crypto.createHash('md5').update(toHash).digest('hex');
 
 }
 
@@ -80,7 +80,7 @@ function _sort(object) {
  * @private
  */
 function _concat(object) {
-  let rtn = "";
+  let rtn = '';
   for ( let key in object ) {
     if ( object.hasOwnProperty(key) ) {
       rtn += key + object[key];