Added support for authenticity tokens (for requests sent directly from Canvas pages)

Author: gabeabrams

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.42] - 09/28/19
+
+Added support for authenticity tokens (for requests sent directly from Canvas pages)
+
 ## [1.0.39] - 09/27/19
 
 Fixed batch Gradebook Column entry update endpoint.

classes/EndpointCategory.js

@@ -60,6 +60,8 @@ class EndpointCategory {
    * @param {function} [uncache=create new uncache function] - A function that
    *   takes paths and a response object, uncaches those paths, then resolves
    *   to the response object
+   * @param {string} [config.authenticityToken] - An authenticity token
+   *   to add to all requests no matter what (cannot be overridden)
    */
   constructor(oldConfig = {}, Subclass) {
     const config = this._preProcessParams(oldConfig);
@@ -89,6 +91,7 @@ class EndpointCategory {
           cache: config.cache,
           uncache: config.uncache,
           api: config.api,
+          authenticityToken: config.authenticityToken,
           defaults: {
             accessToken: config.accessToken,
             itemsPerPage: config.itemsPerPage,

classes/instantiateEndpoint/genVisitEndpoint.js

@@ -26,6 +26,8 @@ const preProcessParams = require('./helpers/preProcessParams');
  *   method is GET and cache is included
  * @param {function} [sendRequest=caccl-send-request instance] - a custom
  *   function that sends https requests (we recommend not including this)
+ * @param {string} [authenticityToken] - An authenticity token
+ *   to add to all requests no matter what (cannot be overridden)
  * @param {string}
  */
 module.exports = (config = {}) => {
@@ -40,6 +42,7 @@ module.exports = (config = {}) => {
     numRetries,
     cache,
     uncache,
+    authenticityToken,
   } = config;
 
   // Set up sendRequest
@@ -88,6 +91,7 @@ module.exports = (config = {}) => {
           params,
           itemsPerPage,
           accessToken,
+          authenticityToken,
         });
 
         // We are using the cached value. Keep note of this

classes/instantiateEndpoint/helpers/preProcessParams.js

@@ -49,6 +49,8 @@ const _recursivelyExcludeParams = (obj) => {
  * @param {number} itemsPerPage - the number of items per page. Only valid for
  *   GET requests
  * @param {string} [accessToken] - the Canvas access token to add to params
+ * @param {string} [authenticityToken] - An authenticity token
+ *   to add to all requests no matter what (cannot be overridden)
  * @param {object} [params={}] - the original https parameters of the request
  * @return {object} pre-processed request parameters
  */
@@ -63,6 +65,11 @@ module.exports = (config) => {
     newParams.access_token = config.accessToken;
   }
 
+  // Add authenticity token
+  if (config.authenticityToken) {
+    newParams.authenticity_token = config.authenticityToken;
+  }
+
   // Set up number of entries per page
   if (config.method === 'GET' && !newParams.per_page) {
     newParams.per_page = config.itemsPerPage;

classes/instantiateEndpoint/index.js

@@ -27,6 +27,8 @@ const genVisitEndpoint = require('./genVisitEndpoint');
  *   passes through a response, or just passes through a response if not caching
  * @param {object} api - Top level instance of endpoints/Endpoints.js that
  *   the EndpointCategory we're adding an endpoint to is an ancestor of
+ * @param {string} [authenticityToken] - An authenticity token
+ *   to add to all requests no matter what (cannot be overridden)
  * @param {string} [defaults.accessToken] - a default access token to apply to
  *   all requests
  * @param {number} [defaults.itemsPerPage=100] - the default number of pages to
@@ -47,6 +49,7 @@ module.exports = (config = {}) => {
     uncache,
     action,
     requiredParams,
+    authenticityToken,
   } = config;
   const defaults = (config.defaults || {});
 
@@ -85,6 +88,7 @@ module.exports = (config = {}) => {
       cache,
       uncache,
       canvasHost,
+      authenticityToken,
       accessToken: (
         options.accessToken
         || defaults.accessToken

index.js

@@ -34,5 +34,7 @@ const API = require('./endpoints/API');
  * @param {number} [config.itemsPerPage=100] - Number of items to
  *   request on a get request. Can be overridden for an individual request by
  *   including numPerPage option
+ * @param {string} [config.authenticityToken] - An authenticity token
+ *   to add to all requests no matter what (cannot be overridden)
  */
 module.exports = API;