@beauraines/rtm-api 1.4.1 → 1.5.0

package/.eslintrc.json

@@ -0,0 +1,31 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+        "indent": [
+            "error",
+            2
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/.github/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main,master ]
+  pull_request:
+    branches: [ main,master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x,18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [1.5.0](https://github.com/beauraines/rtm-api/compare/v1.3.1...v1.5.0) (2023-03-12)
+
+
+### Features
+
+* add debug ([#14](https://github.com/beauraines/rtm-api/issues/14)) ([3314648](https://github.com/beauraines/rtm-api/commit/3314648ca1680f4b25c602a5700afef7d99fb247))
+
+### [1.4.2](https://github.com/beauraines/rtm-api/compare/v1.3.1...v1.4.2) (2023-03-05)

package/README.md

@@ -56,7 +56,7 @@ user.tasks.get('priority:1', function(err, tasks) {
 This module can be installed via `npm`:
 
 ```
-npm install rtm-api
+npm i @beauraines/rtm-api
 ```
 
 or downloaded directly from the [GitHub repository](https://github.com/beauraines/rtm-api).

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@beauraines/rtm-api",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Remember the Milk API Interface",
-  "author": "Beau Raines <beau.raines@gmail.com>",
+  "author": "David Waring <dev@davidwaring.net> (https://davidwaring.net)",
+  "contributors": [
+    "Beau Raines <beau.raines@gmail.com>"
+  ],
   "license": "MIT",
   "keywords": [
     "rtm",
@@ -14,10 +17,18 @@
   ],
   "main": "src/client/index.js",
   "scripts": {
-    "docs": "jsdoc -c jsdoc.json --readme README.md --template $NODE_PATH/@dwaring87/docdash"
+    "docs": "jsdoc -c jsdoc.json --readme README.md --template $NODE_PATH/@dwaring87/docdash",
+    "test": "jest --passWithNoTests",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "release": "standard-version",
+    "should-release": "should-release"
   },
   "devDependencies": {
     "@dwaring87/docdash": "^0.4.1",
+    "eslint": "^8.35.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.4.3",
     "jsdoc": "^3.6.3"
   },
   "repository": {
@@ -28,6 +39,9 @@
     "url": "https://github.com/beauraines/rtm-api/issues"
   },
   "dependencies": {
-    "node-fetch": "^2.6.7"
+    "debug": "^4.3.4",
+    "node-fetch": "^2.6.7",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0"
   }
 }

package/src/client/user.js

@@ -53,14 +53,14 @@ module.exports = function(client) {
         apiKey: user.client.key,
         apiSecret: user.client.secret,
         perms: user.client.perms
-      }
+      };
     }
     else {
       rtn.client = {
         apiKey: client.key,
         apiSecret: client.key,
         perms: client.perms
-      }
+      };
     }
 
     return rtn;
@@ -94,7 +94,7 @@ module.exports = function(client) {
       return user;
     }
     else {
-      throw "Missing User Properties";
+      throw 'Missing User Properties';
     }
   };
 

package/src/list/helper.js

@@ -51,7 +51,7 @@ function add(name, filter, user, callback) {
 
   // Invalid List Names
   if ( name === 'Inbox' || name === 'Sent' ) {
-    throw "Invalid List Name"
+    throw 'Invalid List Name';
   }
 
   // Set Parameters

package/src/response/error.js

@@ -50,7 +50,7 @@ class RTMError extends RTMResponse{
    * @returns {string}
    */
   toString() {
-    return super.toString() + " ERROR " + this._code + ": " + this._msg;
+    return super.toString() + ' ERROR ' + this._code + ': ' + this._msg;
   }
 
 }
@@ -65,7 +65,7 @@ class RTMError extends RTMResponse{
  * @returns {RTMError}
  */
 RTMError.networkError = function() {
-  return new RTMError(-1, "Network Error: Could not make request to RTM API Server");
+  return new RTMError(-1, 'Network Error: Could not make request to RTM API Server');
 };
 
 /**
@@ -75,7 +75,7 @@ RTMError.networkError = function() {
  * @returns {RTMError}
  */
 RTMError.responseError = function() {
-  return new RTMError(-2, "Response Error: Could not parse the response from the RTM API Server");
+  return new RTMError(-2, 'Response Error: Could not parse the response from the RTM API Server');
 };
 
 /**
@@ -86,7 +86,7 @@ RTMError.responseError = function() {
  * @returns {RTMError}
  */
 RTMError.referenceError = function() {
-  return new RTMError(-3, "Reference Error: Could not find item by reference index number or name");
+  return new RTMError(-3, 'Reference Error: Could not find item by reference index number or name');
 };
 
 /**
@@ -97,7 +97,7 @@ RTMError.referenceError = function() {
  * @returns {RTMError}
  */
 RTMError.rateLimitError = function() {
-  return new RTMError(-4, "Rate Limit Error: Your Account has temporarily reached the RTM API Rate Limit.  Please wait a minute and try the request again later.");
+  return new RTMError(-4, 'Rate Limit Error: Your Account has temporarily reached the RTM API Rate Limit.  Please wait a minute and try the request again later.');
 };
 
 /**
@@ -108,7 +108,7 @@ RTMError.rateLimitError = function() {
  * @returns {RTMError}
  */
 RTMError.serverError = function() {
-  return new RTMError(-5, "RTM API Server Error: The RTM API Server is not responding.  Please try the request again later.");
+  return new RTMError(-5, 'RTM API Server Error: The RTM API Server is not responding.  Please try the request again later.');
 };
 
 module.exports = RTMError;

package/src/response/response.js

@@ -77,7 +77,7 @@ class RTMResponse {
    * @returns {string}
    */
   toString() {
-    return "[" + this._status + "]";
+    return '[' + this._status + ']';
   }
 
 }
@@ -88,14 +88,14 @@ class RTMResponse {
  * @type {string}
  * @default
  */
-RTMResponse.STATUS_OK = "ok";
+RTMResponse.STATUS_OK = 'ok';
 
 /**
  * RTM Status of 'fail' = error
  * @type {string}
  * @default
  */
-RTMResponse.STATUS_FAIL = "fail";
+RTMResponse.STATUS_FAIL = 'fail';
 
 
 

package/src/response/success.js

@@ -37,7 +37,7 @@ class RTMSuccess extends RTMResponse {
    * @returns {string}
    */
   toString() {
-    return super.toString() + " " + JSON.stringify(this.props);
+    return super.toString() + ' ' + JSON.stringify(this.props);
   }
 
 }

package/src/task/helper.js

@@ -76,42 +76,42 @@ function add(name, props, user, callback) {
 
   // Parse the props keys
   if ( props.due ) {
-    name = name + " ^" + props.due;
+    name = name + ' ^' + props.due;
   }
   if ( props.priority ) {
-    name = name + " !" + props.priority
+    name = name + ' !' + props.priority;
   }
   if ( props.list ) {
-    name = name + " #" + props.list;
+    name = name + ' #' + props.list;
   }
   if ( props.tags ) {
     if ( !Array.isArray(props.tags) ) {
       props.tags = [props.tags];
     }
     for ( let i = 0; i < props.tags.length; i++ ) {
-      name = name + " #" + props.tags[i];
+      name = name + ' #' + props.tags[i];
     }
   }
   if ( props.location ) {
-    name = name + " @" + props.location;
+    name = name + ' @' + props.location;
   }
   if ( props.start ) {
-    name = name + " ~" + props.start;
+    name = name + ' ~' + props.start;
   }
   if ( props.repeat ) {
-    name = name + " *" + props.repeat;
+    name = name + ' *' + props.repeat;
   }
   if ( props.estimate ) {
-    name = name + " =" + props.estimate;
+    name = name + ' =' + props.estimate;
   }
   if ( props.to ) {
-    name = name + " +" + props.to;
+    name = name + ' +' + props.to;
   }
   if ( props.url ) {
-    name = name + " " + props.url;
+    name = name + ' ' + props.url;
   }
   if ( props.note ) {
-    name = name + " //" + props.note;
+    name = name + ' //' + props.note;
   }
 
   // Set the request params
@@ -233,7 +233,7 @@ function addNotes(listId, taskSeriesId, taskId, title, notes, user, callback) {
     list_id: listId,
     taskseries_id: taskSeriesId,
     task_id: taskId,
-	note_title: title,
+    note_title: title,
     note_text: notes
   };
   user.get('rtm.tasks.notes.add', params, function(err) {
@@ -274,7 +274,7 @@ function remove(listId, taskSeriesId, taskId, user, callback) {
  */
 function movePriority(listId, taskSeriesId, taskId, direction, user, callback) {
   if ( direction.toLowerCase() !== 'up' && direction.toLowerCase() !== 'down' ) {
-    throw "Incorrect priority direction.  Must be either 'up' or 'down'";
+    throw 'Incorrect priority direction.  Must be either \'up\' or \'down\'';
   }
   let params = {
     timeline: user.timeline,

package/src/task/index.js

@@ -215,12 +215,12 @@ class RTMTask {
      * Task subtask flag
      * @type {boolean}
      */
-    this.isSubtask = series.parent_task_id != "" ? true : false;
+    this.isSubtask = series.parent_task_id != '' ? true : false;
 
     /** Task parent task id
      * @type {integer|undefined}
      */
-    this.parentTaskId = series.parent_task_id != "" ? parseFloat(series.parent_task_id) : undefined;
+    this.parentTaskId = series.parent_task_id != '' ? parseFloat(series.parent_task_id) : undefined;
 
 
   }
@@ -240,7 +240,7 @@ class RTMTask {
    */
   get list() {
     if ( this._list === undefined ) {
-      throw "Tasks not loaded with associated Lists"
+      throw 'Tasks not loaded with associated Lists';
     }
     return this._list;
   }

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;
   }

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) {

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];