@makefully/dutifully 1.18.0 → 1.19.0

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.19.0
+
+- Authenticate Showfully yap chores with `Authorization: Bearer` and `POST /yap/:service` (token no longer in the URL path).
+
 ## 1.18.0
 
 - Store GIF content hashes in a Comment Extension (`CheerfullyHashes:{...}`), lossless.

package/README.md

@@ -11,10 +11,12 @@ To use the API, you will need to specify a root `./env-cheerfully.json` file wit
 ```javascript
 {
     "server": "http://server:port",
-    "accessToken": "accessTokenToUseCheerfullyService"
+    "accessToken": "BearerTokenForShowfullyYap"
 }
 ```
 
+`accessToken` is sent as `Authorization: Bearer …` on yap submit/status/download (Showfully 1.4+). For local Showfully, use the same value as `SHOWFULLY_DEBUG_TOKEN` with `SHOWFULLY_ALLOW_DEBUG_TOKEN=1`.
+
 ## Services
 
 All services can be specified in `cheerfully.json` as described in the following sections. Services can be run as scripts specified in `package.json` as:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/dutifully",
-    "version": "1.18.0",
+    "version": "1.19.0",
     "description": "Client tools for Cheerfully service.",
     "main": "./src/index.js",
     "bin": {

package/src/classes/Cheer.js

@@ -15,13 +15,17 @@ const
         }
         return buf.subarray(0, max).toString('utf8').replace(/\s+/g, ' ').trim();
     },
-    postStream = (url, stream) => new Promise ((resolve, reject) => {
+    authHeaders = (accessToken) => (accessToken
+        ? {Authorization: `Bearer ${accessToken}`}
+        : {}),
+    postStream = (url, stream, headers = {}) => new Promise ((resolve, reject) => {
         const
             protocol = url.startsWith('https') ? https : http;
             req = protocol.request(url, {
                 method: 'post',
                 headers: {
-                    'Content-Type': 'application/zip'
+                    'Content-Type': 'application/zip',
+                    ...headers
                 }
             }, async (res) => {
                 let data = '';
@@ -61,7 +65,7 @@ const
                                 let response = null;
 
                                 try {
-                                    response = await fetchStream(`${url}/${choreId}`);
+                                    response = await fetchStream(`${url}/${choreId}`, headers);
                                 } catch (e) {
                                     console.warn(e);
 
@@ -101,11 +105,11 @@ const
 
         stream.pipe(req);
     }),
-    fetchStream = (url) => new Promise((resolve, reject) => {
+    fetchStream = (url, headers = {}) => new Promise((resolve, reject) => {
         const
             protocol = url.startsWith('https') ? https : http;
 
-        protocol.get(url, (res) => {
+        protocol.get(url, {headers}, (res) => {
             const
                 contentType = res.headers['content-type'] || '',
                 statusCode = res.statusCode || 0;
@@ -285,7 +289,11 @@ const
                 try {
                     const
                         archiveStream = await archive((archive) => this.beforeSend(archive)),
-                        data = await postStream(`${cleanPath(server)}/yap/${service}/${accessToken}`, archiveStream);
+                        data = await postStream(
+                            `${cleanPath(server)}/yap/${service}`,
+                            archiveStream,
+                            authHeaders(accessToken)
+                        );
 
                     // listen for all archive data to be written
                     archiveStream.on('close', function () {