@feup-infolab/node-b2drop

A B2Drop client for NodeJS

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@feup-infolab/node-b2drop
001.1.06 years ago6 years agoMinified + gzip package size for @feup-infolab/node-b2drop in KB

Readme

Build Status Codacy Badge Codacy Badge npm version Chat on gitter
node-b2drop
NodeJS client for B2Drop, based on OwnCloud
Table of Contents
Installation Module Details
* [B2Drop](#b2drop)
* [B2DropShare](#b2dropshare)
Examples

Installation

$ npm i @feup-infolab/node-b2drop

Module Details

### Introduction

   The module is divides in two main classes  B2drop and B2ropShare, the main reason for that
is to give the maximum flexibility using this cloud storage service.
#### B2Drop
B2Drop is responsible for all operations related to user private 
area. This operations can be divided in two groups: WebDav  and 
the functions to extend the previous group capabilities using requests.

The WebDav functions group send the user and password on every request via https.

The extended features uses request and requesttoken to validate the request.

##### WebDav
![workflow B2drop webdav](resources/flow1.png "B2drop WebDav")

##### Extended Features
![workflow B2drop extra funcs](resources/flow3.png "B2drop request")

##### Methods
- B2Drop(username, password) - Constructor - changeFolderSetting (folderUri, folderID, setting, callback) - Change folder setting (only change 1 setting for each call) - checkIfFolderExits (folderPath, callbakc) - Check if a folder exits in provided path - createFolder (folderUri, callback) - Create folder in folderUri - delete(fileUri, callback) - Delete file at fileUri - deleteFolder (folderUri, callback) - Delete folder in folderUri - get(fileUri, outputStream, callback) - Get file from fileUri - getAuthToken (callback) - get Authentication Token form B2drop website - getDirectoryContents (folderPath, callback) - List folder content - getQuota (callback) - Get available and used space in the cloud - getShareLink (folderUri, password, callback) - Create and get share link and set folder to editable and folder password
- put(fileUri, inputStream, callback) - Upload file to fileUri - testConnection (callback) - Simple test to check if username and password are valid ### B2DropShare
B2DropShare is responsible for all operations related to users shared area, only uses WebDav.



#### WebDav
workflow B2drop WebDav
#### Methods
- B2DropShare ( sharelink, password) - Constructor - createFolder(folderUri, callback) - Create folder in folderUri - checkIfFolderExits ( folderPath, callback)- Check if folder exists in provided path - delete(fileUri, callback) - Delete file at fileUri - deleteFolder(folderUri, callback) - Delete folder in folderUri - put(fileUri, inputStream, callback) - Upload file to fileUri - get(fileUri, outputStream, callback) - Get file from fileUri - getDirectoryContents(folderPath, callback) - List folder content

Examples

#### Create Share Link
```js
     const b2drop = require('node-b2drop').B2Drop;
     
     var account = new b2drop(b2dropAccount.username, b2dropAccount.password);
         account.getShareLink(testPathFolder1, passwordFolder, function (err, response, shareLink)
         {
             console.log(shareLink);
         };
});
```
#### Upload File
```js
      const b2drop = require('node-b2drop').B2Drop;
     
      var fileUri;
      var inputStream = fs.createReadStream(testFile.location);

      inputStream.on("open", function ()
         {
             var account = new b2drop(b2dropAccount.username, b2dropAccount.password);
             account.put(fileUri, inputStream, function (err)
             {
               console.log(err);
             });
        }
}); ```

Test


$ npm test