1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
'use strict';
const Co = require('co');
const OAuth = require('oauth');
const Pify = require('pify');
const internals = {};
internals.kRequestTokenUrl = 'https://api.twitter.com/oauth/request_token';
internals.kAccessTokenUrl = 'https://api.twitter.com/oauth/access_token';
internals.kVerifyCredentialsUrl = 'https://api.twitter.com/1.1/account/verify_credentials.json';
internals.kOauthVersion = '1.0A';
internals.kOauthSignatureMethod = 'HMAC-SHA1';
/**
* Helper to communicate with the twitter API
*
* @class TwitterHelper
* @param {Dasein.tTwitterConfiguration} config the configuration to
* initialize the twitter API
* @see {@link https://dev.twitter.com/web/sign-in/implementing|Implementing
* Sign in with Twitter}
*
*/
module.exports = internals.TwitterHelper = class TwitterHelper {
constructor(config) {
this._oAuth = new OAuth.OAuth(
internals.kRequestTokenUrl,
internals.kAccessTokenUrl,
config.consumerKey,
config.consumerSecret,
internals.kOauthVersion,
null,
internals.kOauthSignatureMethod
);
}
/**
* Calls the API to get a request token.
*
* @function getRequestToken
* @memberof TwitterHelper
* @instance
* @return {Promise<TwitterHelper.tRequestToken>} the request token response
*/
getRequestToken() {
const self = this;
return Co(function * () {
const getOAuthRequestToken = Pify(self._oAuth.getOAuthRequestToken.bind(self._oAuth), { multiArgs: true });
const [oAuthToken, oAuthTokenSecret] = yield getOAuthRequestToken();
/**
* The request token and secret pair from the twitter API
*
* @memberof TwitterHelper
* @typedef {object} tRequestToken
* @property {string} oAuthToken The oAuth request token
* @property {string} oAuthTokenSecret The oAuth request token
* secret
*/
return {
oAuthToken,
oAuthTokenSecret
};
});
}
/**
* Calls the API to get an access token
*
* @function getAccessToken
* @memberof TwitterHelper
* @instance
* @param {string} oAuthToken An oAuth request token
* @param {string} oAuthVerifier An oAuth verifier sent from the
* twitter callback
* @return {Promise<TwitterHelper.tAccessToken>} the acess token response
*/
getAccessToken(oAuthToken, oAuthVerifier) {
const self = this;
return Co(function * () {
const getOAuthAccessToken = Pify(self._oAuth.getOAuthAccessToken.bind(self._oAuth), { multiArgs: true });
const [oAuthAccessToken, oAuthAccessTokenSecret] = yield getOAuthAccessToken(oAuthToken,
'',
oAuthVerifier);
/**
* The access token and secret pair from the twitter API
*
* @memberof TwitterHelper
* @typedef {object} tAccessToken
* @property {string} oAuthAccessToken The oAuth access token
* @property {string} oAuthAccessTokenSecret The oAuth access token
* secret
*/
return {
oAuthAccessToken,
oAuthAccessTokenSecret
};
});
}
/**
* Gets a user object from twitter
*
* @function getUser
* @memberof TwitterHelper
* @instance
* @param {string} oAuthAccessToken An oAuth access token
* @param {string} oAuthAccessTokenSecret An oAuth access token secret
* @return {Promise<external:TwitterUser>} the user object from
* twitter
*/
getUser(oAuthAccessToken, oAuthAccessTokenSecret) {
const self = this;
return Co(function * () {
const get = Pify(self._oAuth.get.bind(self._oAuth), { multiArgs: true });
const [userResponse] = yield get(internals.kVerifyCredentialsUrl,
oAuthAccessToken,
oAuthAccessTokenSecret);
/**
* The twitter user from the API
* @external TwitterUser
* @see {@link https://dev.twitter.com/overview/api/users|Twitter
* Api Overview: Users}
*/
return JSON.parse(userResponse);
});
}
};
|
