@wwwouter/passport-pocket

    2.0.3 • Public • Published

    Passport-Pocket

    Based upon https://github.com/Siedrix/passport-pocket

    Passport strategy for authenticating with Pocket using the OAuth 1.0a API.

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

    Installation

    $ npm install @wwwouter/passport-pocket
    

    Usage

    Configure Strategy

    The Pocket authentication strategy authenticates users using a Pocket account. The strategy requires a verify callback, which receives the access token and username as arguments. The verify callback must call done providing a user to complete authentication.

    In order to identify your application to Pocket, specify the consumer key and callback URL within options. The consumer key and secret are obtained by creating an application at Pockets's developer site.

    POCKET_CONSUMER_KEY = "Pocket consumer key";
    
    // Passport Set up
    var pocketStrategy = new PocketStrategy({
    		consumerKey    : POCKET_CONSUMER_KEY,
    		callbackURL    : "http://127.0.0.1:3000/auth/pocket/callback"
    	},function(username, accessToken, done) {
    		process.nextTick(function () {
    			return done(null, {
    				username    : username,
    				accessToken : accessToken
    			});
    		});
    	}
    );
    
    passport.use(pocketStrategy);
    

    Authenticate Requests

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

    For example, as route middleware in an Express application:

    // Passport routes for express
    server.get('/auth/pocket',passport.authenticate('pocket'),
    function(req, res){
        // The request will be redirected to Pocket for authentication, so this
        // function will not be called.
    });
    
    server.get('/auth/pocket/callback', passport.authenticate('pocket', { failureRedirect: '/login' }),
    function(req, res) {
        res.redirect('/');
    });
    

    Examples

    For a complete, working example check the server.js file in the example folder.

    Thanks to

    License

    PHPBBMODDERS BEERWARE LICENSE
    version 1, may 7 2008
    
    this license is based on Poul-Henning Kamp 's original
    beerware license. it's been slightly modified to be more suitable for having
    in a separate file.
    
    as long as you keep any copyright notices and any mentions of this license
    intact (and include this file if it is a released package), you can do
    whatever you want with this stuff. if we meet one day, and you think it's
    worth it, you can buy me a beer in return.
    
    there is no warranty for this work, use it at your own risk.
    

    Install

    npm i @wwwouter/passport-pocket

    DownloadsWeekly Downloads

    9

    Version

    2.0.3

    License

    none

    Last publish

    Collaborators

    • wwwouter