express-dropbox-oauth

Dropbox OAuth Middleware for express

• Install
• Dropbox App
• Init
• Use
• Database
• Database Adapters
• Example InMemory Database
• Example App
• License

Install

npm install express-dropbox-oauth --save

Dropbox App

Create and Manage your Dropbox App here: Dropbox App Console.

Init

// var app = [initiate app...]
// var database = [initiate database...] see Database

var ExpressDropboxOAuth = require('express-dropbox-oauth');
var credentials = {
  key: 'myAppKey',
  secret: 'myAppSecret'
};
var expressDropboxAuth = new ExpressDropboxOAuth(credentials, database);

Use

See Example App

Authenticate

Try to create Auth-Token in Database.

function errorRoute(err, req, res, next) {
  res.send('Authentication failed with error: ' + err);
}
app.get('/authenticate', expressDropboxAuth.doAuth(errorRoute), function(req, res) {
  res.send('Authentication succeeded!');
});

Check Auth

Check if Auth-Token exists and is working.

function errorRoute(err, req, res, next) {
  res.send('Restricted Area!');
}
app.get('/onlyAuthenticated', expressDropboxAuth.checkAuth(errorRoute), function(req, res) {
  res.send('Hey Mate!');
});

Log Out

Remove Auth-Token from Database and reset client.

function errorRoute(err, req, res, next) {
  res.send('Logout failed, please retry.');
}
app.get('/logout', expressDropboxAuth.logout(errorRoute), function(req, res) {
  res.send('Bye...');
});

Dropbox Client

Use dropbox-js for something fancy.

app.get('/profile', expressDropboxAuth.checkAuth(), function(req, res) {
  expressDropboxAuth.dropboxClient.getUserInfo(function(err, user) {
    res.send('Hello ' + user.name);
  });
});

Database

We can use any Database adapter from idkeyvalue.

For example NeDB

// var userId = [initiate userId if needed. Leave empty for single user stuff]
var Datastore = require('nedb');
var NedbAdapter = require('idkeyvalue').NedbAdapter

// See nedb documentation for In-Memory databases etc.
var database = new Datastore(filename: 'myDatabase.nedb', autoload: true);
var databaseAdapter = new NedbAdapter(database, userId);
var expressDropboxAuth = new ExpressDropboxAuth(credentials, databaseAdapter);

// Do crazy stuff now! (see Use)

Example App

Run coffee scripts/example.coffee --appKey=myAppKey --appSecret=myAppSecret

This starts up an example server http://localhost:3000 with an in-memory database.

Options:

  --appKey        Required: The Key of our App
  --appSecret     Required: The Secret of our App
  --databaseFile  Use (and create) the given database file instead of just memory
  --userId        Fake another user (requires --databaseFile)
  --port          Use another port (Default: 3000)

License

The MIT License

Copyright (c) 2014 Hannes Diercks

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.