# passport-imgur

> Imgur API authentication strategy for Passport.

Latest version **0.0.3** (published 2015-08-27) · 0 weekly downloads

## Install

```sh
npm install passport-imgur
pnpm add passport-imgur
yarn add passport-imgur
bun add passport-imgur
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-08-27 |
| First published | 2013-08-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.4.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Monday Freelem |
| Maintainers | mindfreakthemon |
| Keywords | passport, imgur, oauth, oauth2, auth, authentication, identity |

## Links

- npm: https://www.npmjs.com/package/passport-imgur
- Repository: https://github.com/mindfreakthemon/passport-imgur
- Homepage: https://github.com/mindfreakthemon/passport-imgur#readme
- Issues: https://github.com/mindfreakthemon/passport-imgur/issues
- npm.io page: https://npm.io/package/passport-imgur

## Dependencies (1)

- [passport-oauth](https://npm.io/package/passport-oauth.md) >= 0.1.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2015-08-27
- 0.0.2 — 2013-08-09
- 0.0.1 — 2013-08-09

## README

# Passport-Imgur

[Passport](http://passportjs.org/) strategy for authenticating with [Imgur](https://imgur.com/)
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](http://www.senchalabs.org/connect/)-style middleware, including
[Express](http://expressjs.com/).

## 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:

| Key | Format | Description          |
| ------------- | --------- | ----------- |
| id | 	Integer |	The account id for the username requested. |
| url | 	String |	The account username, will be the same as requested in the URL |
| bio | 	String |	A basic description the user has filled out |
| reputation | 	Float |	The reputation for the account, in it's numerical format. |
| created | 	Integer |	The epoch time of account creation |
| pro_expiration | 	Integer or Boolean |	False if not a pro user, their expiration date if they are. |
| email | 	string |	The users email address |
| high_quality | 	boolean |	The users ability to upload higher quality images, there will be less compression |
| public_images | 	boolean |	Automatically allow all images to be publicly accessible |
| album_privacy | 	string |	Set the album privacy to this privacy setting on creation |
| pro_expiration | 	integer | or boolean	False if not a pro user, their expiration date if they are. |
| accepted_gallery_terms | 	boolean |	True if the user has accepted the terms of uploading to the Imgur gallery. |
| active_emails | 	Array | of Strings	The email addresses that have been activated to allow uploading |
| messaging_enabled | 	boolean |	If the user is accepting incoming messages or not |
| blocked_users | 	Array | of objects	An array of users that have been blocked from messaging, the object is blocked_id and blocked_url. |
| show_mature | 	boolean |	True 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](http://expressjs.com/)
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

  - [Vitalii Rakovtsii](http://github.com/mindfreakthemon)

## License

[The MIT License](http://opensource.org/licenses/MIT)

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

---
_Source: https://npm.io/package/passport-imgur · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._