Socket
Socket
Sign inDemoInstall

passport-imgur

Package Overview
Dependencies
1
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

passport-imgur

Imgur API authentication strategy for Passport.


Version published
Weekly downloads
42
decreased by-35.38%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Passport-Imgur

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

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

Install

$ npm install passport-imgur

Usage

Configure Strategy

The Imgur authentication strategy authenticates users using a Imgur account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret, and callback URL.

passport.use(new ImgurStrategy({
    clientID: IMGUR_CLIENT_ID,
    clientSecret: IMGUR_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/imgur/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ imgurId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));
Profile details

The Imgur authentication strategy provides the following user data fields:

KeyFormatDescription
idIntegerThe account id for the username requested.
urlStringThe account username, will be the same as requested in the URL
bioStringA basic description the user has filled out
reputationFloatThe reputation for the account, in it's numerical format.
createdIntegerThe epoch time of account creation
pro_expirationInteger or BooleanFalse if not a pro user, their expiration date if they are.
emailstringThe users email address
high_qualitybooleanThe users ability to upload higher quality images, there will be less compression
public_imagesbooleanAutomatically allow all images to be publicly accessible
album_privacystringSet the album privacy to this privacy setting on creation
pro_expirationintegeror boolean False if not a pro user, their expiration date if they are.
accepted_gallery_termsbooleanTrue if the user has accepted the terms of uploading to the Imgur gallery.
active_emailsArrayof Strings The email addresses that have been activated to allow uploading
messaging_enabledbooleanIf the user is accepting incoming messages or not
blocked_usersArrayof objects An array of users that have been blocked from messaging, the object is blocked_id and blocked_url.
show_maturebooleanTrue if the user has opted to have mature images displayed in gallery list endpoints.
Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/imgur',
  passport.authenticate('imgur'));

app.get('/auth/imgur/callback', 
  passport.authenticate('imgur', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Credits

License

The MIT License

Copyright (c) 2011-2013 Vitalii Rakovtsii <http://middle-of-nowhere.name/>

Keywords

FAQs

Package last updated on 27 Aug 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc