Passport strategy for authenticating with PraiseCharts using the OAuth 1.0a API.
This module lets you authenticate using PraiseCharts in your Node.js applications. By plugging into Passport, PraiseCharts authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-praisecharts
Before using passport-praisecharts
, you must register an application with PraiseCharts. Your application will be issued a consumer key (API Key) and consumer secret (API Secret), which need to be provided to the strategy. You will also need to configure a callback URL which matches the route in your application.
The PraiseCharts authentication strategy authenticates users using a PraiseCharts account
and OAuth tokens. The consumer key and consumer 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
corresponding secret as arguments, as well as profile
which contains the
authenticated user's PraiseCharts profile. The verify
callback must call cb
providing a user to complete authentication.
passport.use(new PraiseChartsStrategy({
consumerKey: PRAISECHARTS_CONSUMER_KEY,
consumerSecret: PRAISECHARTS_CONSUMER_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/praisecharts/callback"
},
function(token, tokenSecret, profile, cb) {
User.findOrCreate({ praisechartsId: profile.id }, function (err, user) {
return cb(err, user);
});
}
));
Use passport.authenticate()
, specifying the 'praisecharts'
strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/praisecharts',
passport.authenticate('praisecharts'));
app.get('/auth/praisecharts/callback',
passport.authenticate('praisecharts', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.
Originally forked from passport-twitter