Skip to content

Commit 114717e

Browse files
committed
Rename oauth flow methods to their actual names
1 parent 63844b8 commit 114717e

File tree

10 files changed

+219
-176
lines changed

10 files changed

+219
-176
lines changed

lib/consumer/express.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ module.exports = function Grant (_config) {
8484
}
8585

8686
if (/^1$/.test(provider.oauth)) {
87-
flow.step1(provider, function (err, data) {
87+
flow.request(provider, function (err, data) {
8888
if (err) {
8989
callback(err)
9090
}
9191
else {
92-
grant.step1 = data
93-
var url = flow.step2(provider, data)
92+
grant.request = data
93+
var url = flow.authorize(provider, data)
9494
var error = !/^http|\//.test(url) ? url : null
9595
callback(error, url)
9696
}
@@ -99,7 +99,7 @@ module.exports = function Grant (_config) {
9999

100100
else if (/^2$/.test(provider.oauth)) {
101101
grant.state = provider.state
102-
var url = flow.step1(provider)
102+
var url = flow.authorize(provider)
103103
callback(null, url)
104104
}
105105

@@ -134,16 +134,24 @@ module.exports = function Grant (_config) {
134134
}
135135

136136
if (/^1$/.test(provider.oauth)) {
137-
flow.step3(provider, grant.step1, req.query, callback)
137+
flow.access(provider, grant.request, req.query, (err, data) => {
138+
if (err) {
139+
callback(err)
140+
}
141+
else {
142+
var response = flow.callback(provider, data)
143+
callback(null, response)
144+
}
145+
})
138146
}
139147

140148
else if (/^2$/.test(provider.oauth)) {
141-
flow.step2(provider, req.query, grant, function (err, data) {
149+
flow.access(provider, req.query, grant, function (err, data) {
142150
if (err) {
143151
callback(err)
144152
}
145153
else {
146-
var response = flow.step3(provider, data)
154+
var response = flow.callback(provider, data)
147155
callback(null, response)
148156
}
149157
})

lib/consumer/hapi.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ module.exports = function Grant (_config) {
7777
}
7878

7979
if (/^1$/.test(provider.oauth)) {
80-
flow.step1(provider, function (err, data) {
80+
flow.request(provider, function (err, data) {
8181
if (err) {
8282
callback(err)
8383
}
8484
else {
85-
grant.step1 = data
86-
var url = flow.step2(provider, data)
85+
grant.request = data
86+
var url = flow.authorize(provider, data)
8787
var error = !/^http|\//.test(url) ? url : null
8888
callback(error, url)
8989
}
@@ -92,7 +92,7 @@ module.exports = function Grant (_config) {
9292

9393
else if (/^2$/.test(provider.oauth)) {
9494
grant.state = provider.state
95-
var url = flow.step1(provider)
95+
var url = flow.authorize(provider)
9696
callback(null, url)
9797
}
9898

@@ -134,16 +134,24 @@ module.exports = function Grant (_config) {
134134
}
135135

136136
if (/^1$/.test(provider.oauth)) {
137-
flow.step3(provider, grant.step1, query, callback)
137+
flow.access(provider, grant.request, query, (err, data) => {
138+
if (err) {
139+
callback(err)
140+
}
141+
else {
142+
var response = flow.callback(provider, data)
143+
callback(null, response)
144+
}
145+
})
138146
}
139147

140148
else if (/^2$/.test(provider.oauth)) {
141-
flow.step2(provider, query, grant, function (err, data) {
149+
flow.access(provider, query, grant, function (err, data) {
142150
if (err) {
143151
callback(err)
144152
}
145153
else {
146-
var response = flow.step3(provider, data)
154+
var response = flow.callback(provider, data)
147155
callback(null, response)
148156
}
149157
})

lib/consumer/koa.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ var f = {
1111
2: require('../flow/oauth2')
1212
}
1313
var flows = {
14-
1: {step1: thunkify(f[1].step1), step2: f[1].step2, step3: thunkify(f[1].step3)},
15-
2: {step1: f[2].step1, step2: thunkify(f[2].step2), step3: f[2].step3}
14+
1: {request: thunkify(f[1].request), authorize: f[1].authorize, access: thunkify(f[1].access), callback: f[1].callback},
15+
2: {authorize: f[2].authorize, access: thunkify(f[2].access), callback: f[2].callback}
1616
}
1717

1818
// /:path*/connect/:provider/:override?
@@ -99,8 +99,8 @@ module.exports = function Grant (_config) {
9999

100100
if (/^1$/.test(provider.oauth)) {
101101
try {
102-
grant.step1 = yield flow.step1(provider)
103-
var url = flow.step2(provider, grant.step1)
102+
grant.request = yield flow.request(provider)
103+
var url = flow.authorize(provider, grant.request)
104104
var err = !/^http|\//.test(url) ? url : null
105105
callback(err, url)
106106
}
@@ -111,7 +111,7 @@ module.exports = function Grant (_config) {
111111

112112
else if (/^2$/.test(provider.oauth)) {
113113
grant.state = provider.state
114-
var url = flow.step1(provider)
114+
var url = flow.authorize(provider)
115115
callback(null, url)
116116
}
117117

@@ -147,7 +147,8 @@ module.exports = function Grant (_config) {
147147

148148
if (/^1$/.test(provider.oauth)) {
149149
try {
150-
var response = yield flow.step3(provider, grant.step1, this.query)
150+
var data = yield flow.access(provider, grant.request, this.query)
151+
var response = flow.callback(provider, data)
151152
callback(null, response)
152153
}
153154
catch (err) {
@@ -157,8 +158,8 @@ module.exports = function Grant (_config) {
157158

158159
else if (/^2$/.test(provider.oauth)) {
159160
try {
160-
var data = yield flow.step2(provider, this.query, grant)
161-
var response = flow.step3(provider, data)
161+
var data = yield flow.access(provider, this.query, grant)
162+
var response = flow.callback(provider, data)
162163
callback(null, response)
163164
}
164165
catch (err) {

lib/consumer/koa2.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ var f = {
1111
2: require('../flow/oauth2')
1212
}
1313
var flows = {
14-
1: {step1: util.promisify(f[1].step1), step2: f[1].step2, step3: util.promisify(f[1].step3)},
15-
2: {step1: f[2].step1, step2: util.promisify(f[2].step2), step3: f[2].step3}
14+
1: {request: util.promisify(f[1].request), authorize: f[1].authorize, access: util.promisify(f[1].access), callback: f[1].callback},
15+
2: {authorize: f[2].authorize, access: util.promisify(f[2].access), callback: f[2].callback}
1616
}
1717

1818
// /:path*/connect/:provider/:override?
@@ -99,8 +99,8 @@ module.exports = function Grant (_config) {
9999

100100
if (/^1$/.test(provider.oauth)) {
101101
try {
102-
grant.step1 = await flow.step1(provider)
103-
var url = flow.step2(provider, grant.step1)
102+
grant.request = await flow.request(provider)
103+
var url = flow.authorize(provider, grant.request)
104104
var err = !/^http|\//.test(url) ? url : null
105105
callback(err, url)
106106
}
@@ -111,7 +111,7 @@ module.exports = function Grant (_config) {
111111

112112
else if (/^2$/.test(provider.oauth)) {
113113
grant.state = provider.state
114-
var url = flow.step1(provider)
114+
var url = flow.authorize(provider)
115115
callback(null, url)
116116
}
117117

@@ -147,7 +147,8 @@ module.exports = function Grant (_config) {
147147

148148
if (/^1$/.test(provider.oauth)) {
149149
try {
150-
var response = await flow.step3(provider, grant.step1, ctx.query)
150+
var data = await flow.access(provider, grant.request, ctx.query)
151+
var response = flow.callback(provider, data)
151152
callback(null, response)
152153
}
153154
catch (err) {
@@ -157,8 +158,8 @@ module.exports = function Grant (_config) {
157158

158159
else if (/^2$/.test(provider.oauth)) {
159160
try {
160-
var data = await flow.step2(provider, ctx.query, grant)
161-
var response = flow.step3(provider, data)
161+
var data = await flow.access(provider, ctx.query, grant)
162+
var response = flow.callback(provider, data)
162163
callback(null, response)
163164
}
164165
catch (err) {

lib/flow/oauth1.js

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ var request = require('../client')
55
var utils = require('../utils')
66

77

8-
exports.step1 = function (provider, done) {
8+
exports.request = function (provider, done) {
99
var url = provider.request_url
1010
var options = {
1111
oauth: {
@@ -50,15 +50,15 @@ exports.step1 = function (provider, done) {
5050
})
5151
}
5252

53-
exports.step2 = function (provider, step1) {
54-
if (!step1.oauth_token && !step1.code) {
55-
var error = (Object.keys(step1).length)
56-
? step1 : {error: 'Grant: OAuth1 missing oauth_token parameter'}
53+
exports.authorize = function (provider, req) {
54+
if (!req.oauth_token && !req.code) {
55+
var error = (Object.keys(req).length)
56+
? req : {error: 'Grant: OAuth1 missing oauth_token parameter'}
5757
return utils.toQuerystring({}, error, true)
5858
}
5959
var url = provider.authorize_url
6060
var params = {
61-
oauth_token: step1.oauth_token
61+
oauth_token: req.oauth_token
6262
}
6363
if (provider.custom_params) {
6464
for (var key in provider.custom_params) {
@@ -70,7 +70,7 @@ exports.step2 = function (provider, step1) {
7070
}
7171
if (provider.getpocket) {
7272
params = {
73-
request_token: step1.code,
73+
request_token: req.code,
7474
redirect_uri: utils.redirect_uri(provider)
7575
}
7676
}
@@ -86,10 +86,10 @@ exports.step2 = function (provider, step1) {
8686
return url + '?' + qs.stringify(params)
8787
}
8888

89-
exports.step3 = function (provider, step1, step2, done) {
90-
if (!step2.oauth_token && !step1.code) {
91-
var error = (Object.keys(step2).length)
92-
? step2 : {error: 'Grant: OAuth1 missing oauth_token parameter'}
89+
exports.access = function (provider, req, authorize, done) {
90+
if (!authorize.oauth_token && !req.code) {
91+
var error = (Object.keys(authorize).length)
92+
? authorize : {error: 'Grant: OAuth1 missing oauth_token parameter'}
9393
done(utils.toQuerystring({}, error, true))
9494
return
9595
}
@@ -98,9 +98,9 @@ exports.step3 = function (provider, step1, step2, done) {
9898
oauth: {
9999
consumer_key: provider.key,
100100
consumer_secret: provider.secret,
101-
token: step2.oauth_token,
102-
token_secret: step1.oauth_token_secret,
103-
verifier: step2.oauth_verifier
101+
token: authorize.oauth_token,
102+
token_secret: req.oauth_token_secret,
103+
verifier: authorize.oauth_verifier
104104
}
105105
}
106106
if (provider.discogs) {
@@ -116,7 +116,7 @@ exports.step3 = function (provider, step1, step2, done) {
116116
},
117117
form: {
118118
consumer_key: provider.key,
119-
code: step1.code
119+
code: req.code
120120
}
121121
}
122122
}
@@ -132,11 +132,15 @@ exports.step3 = function (provider, step1, step2, done) {
132132
}, options))
133133
.then(({res, body}) => {
134134
if (provider.intuit) {
135-
body += '&realmId=' + step2.realmId
135+
body += '&realmId=' + authorize.realmId
136136
}
137-
done(null, utils.toQuerystring(provider, body))
137+
done(null, body)
138138
})
139139
.catch((err) => {
140140
done(utils.error(err))
141141
})
142142
}
143+
144+
exports.callback = function (provider, access) {
145+
return utils.toQuerystring(provider, access)
146+
}

lib/flow/oauth2.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var request = require('../client')
66
var utils = require('../utils')
77

88

9-
exports.step1 = function (provider) {
9+
exports.authorize = function (provider) {
1010
var url = provider.authorize_url
1111
var params = {
1212
client_id: provider.key,
@@ -42,14 +42,14 @@ exports.step1 = function (provider) {
4242
return url + '?' + querystring
4343
}
4444

45-
exports.step2 = function (provider, step1, session, done) {
46-
if (!step1.code) {
47-
var error = (Object.keys(step1).length)
48-
? step1 : {error: 'Grant: OAuth2 missing code parameter'}
45+
exports.access = function (provider, authorize, session, done) {
46+
if (!authorize.code) {
47+
var error = (Object.keys(authorize).length)
48+
? authorize : {error: 'Grant: OAuth2 missing code parameter'}
4949
done(utils.toQuerystring({}, error, true))
5050
return
5151
}
52-
else if ((step1.state && session.state) && (step1.state !== session.state)) {
52+
else if ((authorize.state && session.state) && (authorize.state !== session.state)) {
5353
var error = {error: 'Grant: OAuth2 state mismatch'}
5454
done(utils.toQuerystring({}, error, true))
5555
return
@@ -58,7 +58,7 @@ exports.step2 = function (provider, step1, session, done) {
5858
var options = {
5959
form: {
6060
grant_type: 'authorization_code',
61-
code: step1.code,
61+
code: authorize.code,
6262
client_id: provider.key,
6363
client_secret: provider.secret,
6464
redirect_uri: utils.redirect_uri(provider)
@@ -70,7 +70,7 @@ exports.step2 = function (provider, step1, session, done) {
7070
if (provider.concur) {
7171
delete options.form
7272
options.qs = {
73-
code: step1.code,
73+
code: authorize.code,
7474
client_id: provider.key,
7575
client_secret: provider.secret
7676
}
@@ -83,7 +83,7 @@ exports.step2 = function (provider, step1, session, done) {
8383
if (provider.smartsheet) {
8484
delete options.form.client_secret
8585
var hash = crypto.createHash('sha256')
86-
hash.update(provider.secret + '|' + step1.code)
86+
hash.update(provider.secret + '|' + authorize.code)
8787
options.form.hash = hash.digest('hex')
8888
}
8989
if (provider.surveymonkey) {
@@ -94,7 +94,7 @@ exports.step2 = function (provider, step1, session, done) {
9494
client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
9595
client_assertion: provider.secret,
9696
grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
97-
assertion: step1.code,
97+
assertion: authorize.code,
9898
redirect_uri: utils.redirect_uri(provider)
9999
}
100100
}
@@ -113,6 +113,6 @@ exports.step2 = function (provider, step1, session, done) {
113113
})
114114
}
115115

116-
exports.step3 = function (provider, step2) {
117-
return utils.toQuerystring(provider, step2)
116+
exports.callback = function (provider, access) {
117+
return utils.toQuerystring(provider, access)
118118
}

0 commit comments

Comments
 (0)