Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amareshsm/survey-monkey-oauth
Oauth2 authentication tool for SurveyMonkey
https://github.com/amareshsm/survey-monkey-oauth
surveymonkey surveymonkey-api surveymonkey-auth surveymonkey-oauth
Last synced: 8 days ago
JSON representation
Oauth2 authentication tool for SurveyMonkey
- Host: GitHub
- URL: https://github.com/amareshsm/survey-monkey-oauth
- Owner: amareshsm
- Created: 2021-01-23T18:17:39.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-30T18:19:17.000Z (almost 4 years ago)
- Last Synced: 2024-10-27T15:42:01.880Z (about 2 months ago)
- Topics: surveymonkey, surveymonkey-api, surveymonkey-auth, surveymonkey-oauth
- Language: JavaScript
- Homepage: https://github.com/amareshsm/survey-monkey-oauth
- Size: 208 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://opensource.org/licenses/ISC)
[](//npmjs.com/package/react-js-css-loaders)
[](https://travis-ci.org/amareshsm/survey-monkey-oauth)
# SurveyMonkey oauth #
Oauth2 authentication tools for SurveyMonkey
## Quick overview ##
### Step 1: Configuration setup ###
```
const lib = require('survey-monkey-oauth')({
clientId: process.env.clientId,
clientSecret: process.env.clientSecret,
baseURL: 'http://localhost:3000/', /* optional, default baseURL is http://localhost:3000/ */
redirectPath: '/callback/', /* optional, default redirectPath is /callback/ */
scope: 'scopes',
})
```
### Step 2: Routes configuration ###
```
if (req.url.match(/login/)) return lib.authorize(req, res)
if (req.url.match(/callback/)) return lib.generateToken(req, res)
```
### Step 3: Listening for response ###
```
// on success
lib.on('success', (tokenRes, res) => {
console.log('success !!!', tokenRes.data)
res.end('token successfully generated')
})
// on failure
lib.on('error', (errorRes, res) => {
console.log('error', errorRes)
})
```
### Usage ###
#### [Using native-addons](https://github.com/amareshsm/survey-monkey-oauth/tree/master/demo/native-api) ####
```
const http = require('http')
const port = 3000
const hostname = '127.0.0.1'
const lib = require('survey-monkey-oauth')({
clientId: process.env.clientId,
clientSecret: process.env.clientSecret,
baseURL: 'http://localhost:3000/', /* redirect url base */
redirectPath: '/callback/', /* redirect url pathname */
scope: '', /* scopes to request permissions from app users during OAuth */
})
/* on success */
lib.on('success', (tokenRes, res) => {
console.log('success !!!', tokenRes.data)
res.end('token successfully generated')
})
/* on failure */
lib.on('error', (errorRes, res) => {
console.log('error', errorRes)
})
const server = http.createServer((req, res) => {
res.statusCode = 200
res.setHeader('Content-Type', 'text/plain')
if (req.url.match(/login/)) return lib.authorize(req, res) /* /login - initiates oauth authentication */
if (req.url.match(/callback/)) return lib.generateToken(req, res) /* /callback - initiates authorization process */
})
server.listen(port, hostname, () => {
console.log(`Server running at http://${hostname}:${port}/`)
})
```
##### ***Note: redirectPath and callback route which initiates authorization process must be the same*** #####
#### [Using express](https://github.com/amareshsm/survey-monkey-oauth/tree/master/demo/express-framework) ####
```
const express = require('express')
const app = express()
const port = 3000
const lib = require('survey-monkey-oauth')({
clientId: process.env.clientId,
clientSecret: process.env.clientSecret,
baseURL: 'http://localhost:3000/', /* redirect url base */
redirectPath: '/callback/', /* redirect url pathname */
scope: '', /* scopes to request permissions from app users during OAuth */
})
// on success
lib.on('success', (tokenRes, res) => {
console.log('success', tokenRes.data)
res.end('token successfully generated')
})
// on failure
lib.on('error', (errorRes, res) => {
console.log('error', errorRes)
})
app.get('/', (req, res) => {
res.send('Hello World!')
})
app.get('/login/', (req, res) => {
lib.authorize(req, res) /* /login - initiates oauth authentication */
})
app.get('/callback/', (req, res) => {
lib.generateToken(req, res) /* /callback - initiates authorization process */
})
app.listen(port, () => {
console.log(`Example app listening at http://localhost:${port}`)
})
```
### samples available under `/demo` : ###
* [using-node-native-addons](https://github.com/amareshsm/survey-monkey-oauth/tree/master/demo/native-api)
* [using-express-framework](https://github.com/amareshsm/survey-monkey-oauth/tree/master/demo/express-framework)