https://github.com/microauth/microauth-twitter

Twitter oauth for micro
https://github.com/microauth/microauth-twitter

auth authentication javascript js micro microauth microservice nodejs twitter

Last synced: about 2 months ago
JSON representation

Twitter oauth for micro

• Host: GitHub
• URL: https://github.com/microauth/microauth-twitter
• Owner: microauth
• License: mit
• Created: 2017-04-12T12:35:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T09:22:22.000Z (over 4 years ago)
• Last Synced: 2024-08-04T00:11:51.144Z (5 months ago)
• Topics: auth, authentication, javascript, js, micro, microauth, microservice, nodejs, twitter
• Language: JavaScript
• Size: 312 KB
• Stars: 39
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-micro - microauth-twitter
• awesome-list-microservice - microauth-twitter

README

        
# microauth-twitter

> Twitter oauth for [micro](https://github.com/zeit/micro/)

[![Build Status](https://travis-ci.org/microauth/microauth-twitter.svg?branch=master)](https://travis-ci.org/microauth/microauth-twitter)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![Greenkeeper badge](https://badges.greenkeeper.io/microauth/microauth-twitter.svg)](https://greenkeeper.io/)

Add [twitter](https://twitter.com) authentication to your [micro](https://github.com/zeit/micro/) service as easy as a flick of your fingers.

This module is a part of [microauth](https://github.com/microauth/microauth) collection.

## Installation

```sh

npm install --save microauth-twitter

# or

yarn add microauth-twitter

```

## Usage

app.js

```js

const { send } = require('micro');

const microAuthTwitter = require('microauth-twitter');

const options = {

  consumerKey: 'CONSUMER_KEY',

  consumerSecret: 'CONSUMER_SECRET',

  callbackUrl: 'http://localhost:3000/auth/twitter/callback',

  path: '/auth/twitter'

};

const twitterAuth = microAuthTwitter(options);

// third `auth` argument will provide error or result of authentication

// so it will { err: errorObject} or { result: {

//  provider: 'twitter',

//  accessToken: 'blahblah',

//  accessTokenSecret: 'blahblah',

//  info: userInfo

// }}

const handler = async (req, res, auth) => {

  if (!auth) {

    return send(res, 404, 'Not Found');

  }

  if (auth.err) {

    // Error handler

    return send(res, 403, 'Forbidden');

  }

  // save something in database here

  return `Hello ${auth.result.info.screen_name}`;

};

module.exports = twitterAuth(handler);

```

Run:

```sh

micro app.js

```

Now visit `http://localhost:3000/auth/twitter`

## Author

[Dmitry Pavlovsky](http://palosk.in)