项目作者: docusign

项目描述 :
The official DocuSign Passport package
高级语言: JavaScript
项目地址: git://github.com/docusign/passport-docusign.git
创建时间: 2017-09-24T04:36:40Z
项目社区:https://github.com/docusign/passport-docusign

开源协议:MIT License

下载


The Official DocuSign Passport package

NPM version
NPM downloads
Build status

Passport strategy for authenticating with DocuSign
using the OAuth 2.0 API.

This module lets you authenticate using DocuSign in your Node.js applications.
By plugging into Passport, DocuSign authentication can be easily and
unobtrusively integrated into any application or framework that supports
Connect-style middleware, including
Express.

Requirements

Node 0.8 or later.

Install

  1. $ npm install passport-docusign

Usage

Register your Application

Before using passport-docusign, you must register an application with
DocuSign. If you have not already done so, a new application can be created at
DocuSign Developers.

Configure Strategy

The DocuSign authentication strategy authenticates users using a DocuSign
account and OAuth 2.0 tokens. The app ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a verify callback, which receives the access token and optional
refresh token, as well as profile which contains the authenticated user’s
DocuSign profile. The verify callback must call cb providing a user to
complete authentication.

  1. passport.use(new DocusignStrategy({
  2. clientID: DOCUSIGN_INTEGRATION_KEY,
  3. clientSecret: DOCUSIGN_APP_SECRET,
  4. callbackURL: "http://localhost:3000/auth/docusign/callback"
  5. },
  6. function(accessToken, refreshToken, profile, cb) {
  7. User.findOrCreate({ email: profile.email }, function (err, user) {
  8. return cb(err, user);
  9. });
  10. }
  11. ));

Authenticate Requests

Use passport.authenticate(), specifying the 'docusign' strategy, to
authenticate requests.

For example, as route middleware in an Express
application:

  1. app.get('/auth/docusign',
  2. passport.authenticate('docusign'));
  3. app.get('/auth/docusign/callback',
  4. passport.authenticate('docusign', { failureRedirect: '/login' }),
  5. function(req, res) {
  6. // Successful authentication, redirect home.
  7. res.redirect('/');
  8. });

Examples

See https://github.com/docusign/docusign-code-examples/blob/master/node/NodeSDKSamples.js#L32.

FAQ

How do I use passport-docusign in production?

All you need to do is turn the ‘production’ flag to true.

  1. app.get('/auth/docusign',
  2. passport.authenticate('docusign', { production: true }));

Contributing

Tests

The test suite is located in the test/ directory. All new features are
expected to have corresponding test cases. Ensure that the complete test suite
passes by executing:

  1. $ make test

Coverage

The test suite covers 100% of the code base. All new feature development is
expected to maintain that level. Coverage reports can be viewed by executing:

  1. $ make test-cov
  2. $ make view-cov

License

The MIT License

Additional Resources