Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I mentioned this in Slack recently, but quick backstory:
I was working on a talk showing how you can use Watson's NLU and Box in Node-RED to automatically tag documents based on their content. Unfortunately, I found the Box Node insufficient in three key areas:
This PR addresses the issues by:
tags
) to be assigned to a file(I have a demo of this, and there might even be a video of my talk available soon, but I think the audio is probably bad. 😬 I should probably just make a webcast.)
CAVEAT: I found a potential memory/resource leak in the Box SDK for Node.js which is corrected by in-progress PR box/box-node-sdk#304. Once that's merged and released, I'll update the dependency.
Breaking Changes
payload
,not hanging directly off of the message
from the Box SDK
box watch
(events) Node no longer holds opinions about what theevents look like--it no longer filters, modifies, or aggregates the
events and the event data--the event data format now mirrors the Box
API documentation (which means it's at least documented somewhere).
Note that the Enterprise Event Stream events have a different format
than the User Event Stream events!
must be a major release.
Enhancements
a folder ID, offset, and limit
tags)
box in
(download) Nodebox in
Node; as appropriate,any download can be "downloaded as" plain text, PDF, and various-sized
images
box watch
(event) Nodebox watch
Nodebox out
(upload) Nodelarge, failed uploads in
box out
Nodebox out
Node; if a file does not exist it will be created, otherwise a new
version will be created.
Refactors
directly
lib/box-api.js
, which is the configuration Nodeitself; is now essentially an adapter for the Box Node SDK
TokenStore
class, corresponding to interface defined by theBox Node SDK, to manage tokens for OAuth2 authentication--essentially
an adapter to Node-RED's credentials system
previously the same
.js
files into one-per-Node;box.js
now simply loadsall files in
lib/
authentication mode
Fixes / Other
should-sinon
frompackage.json
package-lock.json
incurred by the use of the Box SDK; I would recommend actually testing
at a higher level and stubbing SDK methods to avoid worrying about
what the requests look like--we don't actually care, because that's
the Box SDK's problem!
yet, and unfortunately I don't have time to work on it
box/**/*.js
from JSHint checks, since I was fighting with it;see jshint config isn't quite right #225