2.2.0

Author: chris-burgin

changelog.md

@@ -1,4 +1,7 @@
 # Changelog
+## 2.2.0
+- Implemented automatic string cleaning to prevent file save errors.
+
 ## 2.1.3
 - Implemented Prettier.
 - Formated files with Prettier.

lib/cleanString.js

@@ -0,0 +1,35 @@
+// returns a string that has been striped of all characters that would
+// cause errors in dropbox
+
+const cleanString = str =>
+  str
+    .replace(/\*/g, "")
+    .replace(/\|/g, "")
+    .replace(/&/g, "")
+    .replace(/!/g, "")
+    .replace(/@/g, "")
+    .replace(/#/g, "")
+    .replace(/\$/g, "")
+    .replace(/%/g, "")
+    .replace(/\^/g, "")
+    .replace(/\(/g, "")
+    .replace(/\)/g, "")
+    .replace(/-/g, "")
+    .replace(/_/g, "")
+    .replace(/\+/g, "")
+    .replace(/=/g, "")
+    .replace(/~/g, "")
+    .replace(/`/g, "")
+    .replace(/"/g, "")
+    .replace(/'/g, "")
+    .replace(/;/g, "")
+    .replace(/:/g, "")
+    .replace(/>/g, "")
+    .replace(/</g, "")
+    .replace(/\{/g, "")
+    .replace(/\}/g, "")
+    .replace(/\[/g, "")
+    .replace(/\]/g, "")
+    .replace(/\?/g, "")
+
+module.exports = cleanString

lib/dropbox.js

@@ -2,6 +2,7 @@
 const { Transform } = require("stream")
 const Dropbox = require("dropbox")
 const streamLength = require("stream-length")
+const cleanString = require("./cleanString")
 
 // Dropbox Upload Stream
 class DropboxUploadStream extends Transform {
@@ -89,7 +90,7 @@ class DropboxUploadStream extends Transform {
           offset: this.offset, // offset, current location of chunk
         },
         commit: {
-          path: this.options.saveLocation, // path to save thew new file
+          path: cleanString(this.options.saveLocation), // path to save thew new file
           mode: "add", // add mode, this will NOT overwrite an existing file
           autorename: true, // if there is duplicates rename ex. file(2).txt
           mute: false, // show notifications to db users that files were changed
@@ -99,7 +100,9 @@ class DropboxUploadStream extends Transform {
         // we are finished uploading the file
         if (this.options.debugMode) {
           console.log(
-            `Filed Uploaded for save location ${this.options.saveLocation}`
+            `Filed Uploaded for save location ${cleanString(
+              this.options.saveLocation
+            )}`
           )
         }
 

lib/transform.js

@@ -1,5 +1,6 @@
 // import modules
 const { Transform } = require("stream")
+const cleanString = require("./cleanString")
 
 class TransformStream extends Transform {
   constructor(options) {
@@ -37,7 +38,7 @@ class TransformStream extends Transform {
         console.log(
           `Passing buffer (size: ${Math.round(
             this.buffer.byteLength / 1024
-          )} KB) for save location ${this.options.saveLocation}`
+          )} KB) for save location ${cleanString(this.options.saveLocation)}`
         )
       }
 
@@ -58,7 +59,7 @@ class TransformStream extends Transform {
       console.log(
         `Passing buffer (size: ${Math.round(
           this.buffer.byteLength / 1024
-        )} KB) for save location ${this.options.saveLocation}`
+        )} KB) for save location ${cleanString(this.options.saveLocation)}`
       )
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dropbox_session_upload",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "Node wrapper around the dropbox upload session API to help concurrently upload files over 150mb to dropbox.",
   "main": "index.js",
   "scripts": {