2.0.1

Author: chris-burgin

.eslintrc.js

@@ -0,0 +1,36 @@
+module.exports = {
+    "env": {
+        "browser": false,
+        "node": true,
+        "commonjs": true,
+        "es6": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "sourceType": "module",
+        "ecmaVersion": 6,
+        "ecmaFeatures": {
+            "experimentalObjectRestSpread": true
+        }
+    },
+    "rules": {
+        "indent": [
+            "error",
+            2
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "double"
+        ],
+        "semi": [
+            "error",
+            "never"
+        ],
+        "no-console": 0,
+        "no-process-env": 0,
+    }
+};

changelog.md

@@ -1,3 +1,9 @@
 # Changelog
+## 2.0.1
+- Added eslint support.
+- Updated formating.
+- Added detailed comments.
+- Added debugMode feature.
+
 ## 2.0.0
-- This is the first offical release. No "changes" for this release
+- This is the first offical release. No "changes" for this release.

example/index.js

@@ -21,6 +21,6 @@ const files = [
 ]
 
 // upload the files
-dropboxSessionUpload(files, process.env.DROPBOXTOKEN)
+dropboxSessionUpload(files, process.env.DROPBOXTOKEN, true /* debug mode, defaults to false */)
   .catch(error => console.log(error))
   .then(() => console.log("Done Uploading!"))

index.js

@@ -1,4 +1,2 @@
-'use strict'
-
-// export
-module.exports = require('./lib/index')
+// exposes the entry point for the package
+module.exports = require("./lib/index")

lib/dropbox.js

@@ -8,7 +8,7 @@ class DropboxUploadStream extends Transform {
     // super options
     super(options)
 
-    // setup options
+    // setup options (apiKey, debugMode)
     this.options = options
 
     // setup session and offset information
@@ -20,81 +20,83 @@ class DropboxUploadStream extends Transform {
   }
 
   _transform(chunk, encoding, next) {
-
-    if (!this.sessionId) {
+    // check if session is set
+    if (this.sessionId) {
+      // call sessionAppend if session already exists
+      this.sessionAppend(chunk, next)
+    } else {
+      // return the session start if it does not exists
       return this.sessionStart(chunk, next)
     }
-
-    this.sessionAppend(chunk, next)
   }
 
   _flush(next) {
+    // finish the session on flush
     this.sessionFinish(next)
   }
 
-	/**
-	 * Starts a dropbox session
-	 *
-	 * @param chunk
-	 * @param next
-	 */
   sessionStart(chunk, next) {
+    // start the session on dropbox, sending the first chunk
     this.dropbox.filesUploadSessionStart({
       close: false,
       contents: chunk
-    })
-      .then((response) => {
-        this.sessionId = response.session_id
-        this.offset += chunk.byteLength
-        return next()
-      }, next)
+    }).then(response => {
+      // set the session id
+      this.sessionId = response.session_id
+
+      // update the offset
+      this.offset += chunk.byteLength
+
+      // return next
+      return next()
+    }, next /* call next if there is an error*/)
   }
 
-	/**
-	 * Appends data to an open dropbox session
-	 *
-	 * @param chunk
-	 * @param next
-	 */
   sessionAppend(chunk, next) {
+    // append chunk to a session that has already been started
     this.dropbox.filesUploadSessionAppendV2({
       cursor: {
-        session_id: this.sessionId,
-        offset: this.offset
+        session_id: this.sessionId, // id for this upload session
+        offset: this.offset // offset, current location of chunk
       },
       close: false,
-      contents: chunk
+      contents: chunk // current chunk being uploaded
     })
       .then(() => {
+        // set the new offset
         this.offset += chunk.byteLength
+
+        // were done, next
         next()
-      }, next)
+      }, next /* call next if there is an error*/)
   }
 
-	/**
-	 * Closes the session and commits the file(s)
-	 *
-	 * @param next
-	 */
   sessionFinish(next) {
+    // let dropbox know we are finished uploading
     this.dropbox.filesUploadSessionFinish({
       "cursor": {
-        "session_id": this.sessionId,
-        "offset": this.offset
+        "session_id": this.sessionId, // id for this upload session
+        "offset": this.offset // offset, current location of chunk
       },
       "commit": {
-        "path": this.options.saveLocation,
-        "mode": "add",
-        "autorename": true,
-        "mute": false
+        "path": 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
       }
-    })
-      .then(() => {
+    }).then(() => {
+      // we are finished uploading the file
+      if (this.options.debugMode) {
         console.log(`Filed Uploaded for save location ${this.options.saveLocation}`)
-        this.sessionId = null
-        this.offset = 0
-        next()
-      }, next)
+      }
+
+      // reset sessionId and offset
+      this.sessionId = null
+      this.offset = 0
+
+      // trigger next because we are done
+      next()
+    }, next /* call next if there is an error*/)
   }
 }
 

lib/index.js

@@ -1,11 +1,11 @@
-"use strict"
-
-// Import Required Functions
+// import upload function
 const upload = require("./upload")
 
-// Uploader Function
-const dropboxSessionUpload = (files, apiKey) => 
+// returns a Promise.all(uploads) where
+// the uploads is an array of promises
+const dropboxSessionUpload = (files, apiKey, debugMode=false) => 
   // wait for all files to be uploaded
-  Promise.all(files.map(f => upload({...f, apiKey})))
+  Promise.all(files.map(f => upload({ ...f, apiKey, debugMode})))
 
+// export the function
 module.exports = dropboxSessionUpload

lib/transform.js

@@ -1,46 +1,66 @@
-const debug = require("debug")("stream-to-dropbox:transform-stream")
+// import modules
 const { Transform } = require("stream")
 
 class TransformStream extends Transform {
   constructor(options) {
+    // super options
     super(options)
 
-    // setup options
+    // setup options (apiKey, debugMode)
     this.options = options
 
     // setup chunk size of 1mb
     this.chunkSize = options.chunkSize || 1 * 1024 * 1024 // 1 MB
   }
 
-	// Buffer the input to reach minimal size of options.chunkSize
+  // buffer the input to reach minimal size of options.chunkSize
   checkBuffer(chunk) {
-    if (!this.buffer) {
-      this.buffer = Buffer.from(chunk)
-    } else {
+    // check if buffer is already set
+    if (this.buffer) {
+      // conact a chunk to the existing buffer
       this.buffer = Buffer.concat([this.buffer, chunk])
+    } else {
+      // no buffer exists, set a new one
+      this.buffer = Buffer.from(chunk)
     }
 
+    // return true if buffer length is greater or equal to the chunk size
     return this.buffer.byteLength >= this.chunkSize
   }
 
   _transform(chunk, encoding, next) {
-    // If buffer is too small, wait for more chunks
-    if (!this.checkBuffer(chunk)) {
+    // if buffer is too small, wait for more chunks
+    if (this.checkBuffer(chunk)) {
+      // chunk is big enough to save
+      // saving message
+      if (this.options.debugMode) {
+        console.log(`Passing buffer (size: ${Math.round(this.buffer.byteLength / 1024)} KB) for save location ${this.options.saveLocation}`)
+      }
+
+      // pass the buffer to be saved
+      next(null, this.buffer)
+
+      // Clear the buffer
+      this.buffer = undefined
+    } else {
+      // buffer is to small
       return next()
     }
-
-    // Chunk is big enough
-    console.log(`Passing buffer (size: ${Math.round(this.buffer.byteLength / 1024)} KB) for save location ${this.options.saveLocation}`)
-    next(null, this.buffer)
-    // Clear the buffer
-    this.buffer = undefined
   }
 
   _flush(next) {
-    console.log(`Passing buffer (size: ${Math.round(this.buffer.byteLength / 1024)} KB) for save location ${this.options.saveLocation}`)
+    // save message
+    if (this.options.debugMode) {
+      console.log(`Passing buffer (size: ${Math.round(this.buffer.byteLength / 1024)} KB) for save location ${this.options.saveLocation}`)
+    }
+
+    // pass the buffer to be saved
     next(null, this.buffer)
+
+    // clear the buffer
     this.buffer = undefined
   }
 }
 
+// export module
 module.exports = TransformStream

lib/upload.js

@@ -1,23 +1,32 @@
-"use strict"
-
-// Import Required Classes
+// import required classes
 const TransformStream = require("./transform")
 const DropboxUploadStream = require("./dropbox")
 
-// Uploader Function
-const upload = (data) => 
+// return a promise that is resolved when the file
+// is successfully uploaded or rejected when
+// there is an error
+const upload = data => 
   new Promise((resolve, reject) => {
-    // Prepare the Streams
-    const transformStream = new TransformStream({ ...data, chunkSize: 8000 * 1024 })
+    // setup transform stream with the upload data and a 8mb chunk size
+    const transformStream = 
+      new TransformStream({ ...data, chunkSize: 8000 * 1024 })
+
+    // setup dropbox stream with the upload data
     const dropboxUpload = new DropboxUploadStream(data)
 
-    // pipe to the file
-    data.file.pipe(transformStream).pipe(dropboxUpload)
-      .on("error", (err) => {
-        reject(err)
-      })
-      .on("finish", () => {
-        resolve()
-      })})
+    // pipe our file
+    data.file
+      // pipe in transform and dropbox upload
+      .pipe(transformStream)
+      .pipe(dropboxUpload)
+
+      // event listeners
+      .on("error", err => 
+        // error, reject and return the error
+        reject(err))
+      .on("finish", () => 
+        // no error, resolve
+        resolve())})
 
+// export upload module
 module.exports = upload