forked from chizutan5/goth
-
Notifications
You must be signed in to change notification settings - Fork 0
/
twitch.go
306 lines (280 loc) · 11.2 KB
/
twitch.go
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
// Package twitch implements the OAuth2 protocol for authenticating users through Twitch.
// This package can be used as a reference implementation of an OAuth2 provider for Twitch.
package twitch
import (
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"github.com/markbates/goth"
"golang.org/x/oauth2"
)
const (
authURL string = "https://id.twitch.tv/oauth2/authorize"
tokenURL string = "https://id.twitch.tv/oauth2/token"
userEndpoint string = "https://api.twitch.tv/helix/users"
)
const (
// ScopeAnalyticsReadExtensions provides access to view analytics data for
// the Twitch Extensions owned by the authenticated account.
ScopeAnalyticsReadExtensions string = "analytics:read:extensions"
// ScopeAnalyticsReadGames provides accesss to view analytics data for the
// games owned by the authenticated account.
ScopeAnalyticsReadGames = "analytics:read:games"
// ScopeBitsRead provides access to view Bits information for a channel.
ScopeBitsRead = "bits:read"
// ScopeChannelEditCommercial provides access to run commercials on a
// channel.
ScopeChannelEditCommercial = "channel:edit:commercial"
// ScopeChannelManageBroadcast provides access to manage a channel’s
// broadcast configuration, including updating channel configuration and
// managing stream markers and stream tags.
ScopeChannelManageBroadcast = "channel:manage:broadcast"
// ScopeChannelManageExtensions provides access to manage a channel’s
// Extension configuration, including activating Extensions.
ScopeChannelManageExtensions = "channel:manage:extensions"
// ScopeChannelManagePolls provides access to manage a channel’s polls.
ScopeChannelManagePolls = "channel:manage:polls"
// ScopeChannelManagePredictions provides access to manage a channel’s
// Channel Points Predictions.
ScopeChannelManagePredictions = "channel:manage:predictions"
// ScopeChannelManageRedemptions provides access to manage Channel Points
// custom rewards and their redemptions on a channel.
ScopeChannelManageRedemptions = "channel:manage:redemptions"
// ScopeChannelManageSchedule provides access to manage a channel’s stream
// schedule.
ScopeChannelManageSchedule = "channel:manage:schedule"
// ScopeChannelManageVideos provides access to manage a channel’s videos,
// including deleting videos.
ScopeChannelManageVideos = "channel:manage:videos"
// ScopeChannelReadEditors provides access to view a list of users with the
// editor role for a channel.
ScopeChannelReadEditors = "channel:read:editors"
// ScopeChannelReadGoals provides access to view Creator Goals for a
// channel.
ScopeChannelReadGoals = "channel:read:goals"
// ScopeChannelReadHypeTrain provides access to view Hype Train information
// for a channel.
ScopeChannelReadHypeTrain = "channel:read:hype_train"
// ScopeChannelReadPolls provides access to view a channel’s polls.
ScopeChannelReadPolls = "channel:read:polls"
// ScopeChannelReadPredictions provides access to view a channel’s Channel
// Points Predictions.
ScopeChannelReadPredictions = "channel:read:predictions"
// ScopeChannelReadRedemptions provides access to view Channel Points custom
// rewards and their redemptions on a channel.
ScopeChannelReadRedemptions = "channel:read:redemptions"
// ScopeChannelReadStreamKey provides access to view an authorized user’s
// stream key.
ScopeChannelReadStreamKey = "channel:read:stream_key"
// ScopeChannelReadSubscriptions provides access to view a list of all
// subscribers to a channel and check if a user is subscribed to a channel.
ScopeChannelReadSubscriptions = "channel:read:subscriptions"
// ScopeClipsEdit provides access to manage Clips for a channel.
ScopeClipsEdit = "clips:edit"
// ScopeModerationRead provides access to view a channel’s moderation data
// including Moderators, Bans, Timeouts, and AutoMod settings.
ScopeModerationRead = "moderation:read"
// ScopeModeratorManageBannedUsers provides access to ban and unban users.
ScopeModeratorManageBannedUsers = "moderator:manage:banned_users"
// ScopeModeratorReadBlockedTerms provides access to view a broadcaster’s
// list of blocked terms.
ScopeModeratorReadBlockedTerms = "moderator:read:blocked_terms"
// ScopeModeratorManageBlockedTerms provides access to manage a
// broadcaster’s list of blocked terms.
ScopeModeratorManageBlockedTerms = "moderator:manage:blocked_terms"
// ScopeModeratorManageAutoMod provides access to manage messages held for
// review by AutoMod in channels where you are a moderator.
ScopeModeratorManageAutoMod = "moderator:manage:automod"
// ScopeModeratorReadAutoModSettings provides access to view a broadcaster’s
// AutoMod settings.
ScopeModeratorReadAutoModSettings = "moderator:read:automod_settings"
// ScopeModeratorManageAutoModSettings provides access to manage a
// broadcaster’s AutoMod settings.
ScopeModeratorManageAutoModSettings = "moderator:manage:automod_settings"
// ScopeModeratorReadChatSettings provides access to view a broadcaster’s
// chat room settings.
ScopeModeratorReadChatSettings = "moderator:read:chat_settings"
// ScopeModeratorManageChatSettings provides access to manage a
// broadcaster’s chat room settings.
ScopeModeratorManageChatSettings = "moderator:manage:chat_settings"
// ScopeUserEdit provides access to manage a user object.
ScopeUserEdit = "user:edit"
// ScopeUserEditFollows is deprecated. Was previously used for
// “Create User Follows” and “Delete User Follows.”
ScopeUserEditFollows = "user:edit:follows"
// ScopeUserManageBlockedUsers provides access to manage the block list of a
// user.
ScopeUserManageBlockedUsers = "user:manage:blocked_users"
// ScopeUserReadBlockedUsers provides access to view the block list of a
// user.
ScopeUserReadBlockedUsers = "user:read:blocked_users"
// ScopeUserReadBroadcast provides access to view a user’s broadcasting
// configuration, including Extension configurations.
ScopeUserReadBroadcast = "user:read:broadcast"
// ScopeUserReadEmail provides access to view a user’s email address.
ScopeUserReadEmail = "user:read:email"
// ScopeUserReadFollows provides access to view the list of channels a user
// follows.
ScopeUserReadFollows = "user:read:follows"
// ScopeUserReadSubscriptions provides access to view if an authorized user
// is subscribed to specific channels.
ScopeUserReadSubscriptions = "user:read:subscriptions"
// ScopeChannelSubscriptions is a v5 scope.
ScopeChannelSubscriptions = ScopeChannelReadSubscriptions
// ScopeChannelCommercial is a v5 scope.
ScopeChannelCommercial = ScopeChannelEditCommercial
// ScopeChannelEditor is a v5 scope which maps to channel:manage:broadcast
// and channel:manage:videos.
ScopeChannelEditor = "channel_editor"
// ScopeUserFollowsEdit is a v5 scope.
ScopeUserFollowsEdit = ScopeUserEditFollows
// ScopeChannelRead is a v5 scope which maps to channel:read:editors,
// channel:read:stream_key, and user:read:email.
ScopeChannelRead = "channel_read"
// ScopeUserRead is a v5 scope.
ScopeUserRead = ScopeUserReadEmail
// ScopeUserBlocksRead is a v5 scope.
ScopeUserBlocksRead = ScopeUserReadBlockedUsers
// ScopeUserBlocksEdit is a v5 scope.
ScopeUserBlocksEdit = ScopeUserManageBlockedUsers
// ScopeUserSubscriptions is a v5 scope.
ScopeUserSubscriptions = ScopeUserReadSubscriptions
)
// New creates a new Twitch provider, and sets up important connection details.
// You should always call `twitch.New` to get a new Provider. Never try to create
// one manually.
func New(clientKey string, secret string, callbackURL string, scopes ...string) *Provider {
p := &Provider{
ClientKey: clientKey,
Secret: secret,
CallbackURL: callbackURL,
providerName: "twitch",
}
p.config = newConfig(p, scopes)
return p
}
// Provider is the implementation of `goth.Provider` for accessing Twitch
type Provider struct {
ClientKey string
Secret string
CallbackURL string
HTTPClient *http.Client
config *oauth2.Config
providerName string
}
// Name gets the name used to retrieve this provider.
func (p *Provider) Name() string {
return p.providerName
}
// SetName is to update the name of the provider (needed in case of multiple providers of 1 type)
func (p *Provider) SetName(name string) {
p.providerName = name
}
// Client ...
func (p *Provider) Client() *http.Client {
return goth.HTTPClientWithFallBack(p.HTTPClient)
}
// Debug is no-op for the Twitch package.
func (p *Provider) Debug(debug bool) {}
// BeginAuth asks Twitch for an authentication end-point.
func (p *Provider) BeginAuth(state string) (goth.Session, error) {
url := p.config.AuthCodeURL(state)
s := &Session{
AuthURL: url,
}
return s, nil
}
// FetchUser will go to Twitch and access basic info about the user.
func (p *Provider) FetchUser(session goth.Session) (goth.User, error) {
s := session.(*Session)
user := goth.User{
AccessToken: s.AccessToken,
Provider: p.Name(),
RefreshToken: s.RefreshToken,
ExpiresAt: s.ExpiresAt,
}
if user.AccessToken == "" {
// data is not yet retrieved since accessToken is still empty
return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName)
}
req, err := http.NewRequest("GET", userEndpoint, nil)
if err != nil {
return user, err
}
req.Header.Set("Client-Id", p.config.ClientID)
req.Header.Set("Authorization", "Bearer "+s.AccessToken)
resp, err := p.Client().Do(req)
if err != nil {
return user, err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return user, fmt.Errorf("%s responded with a %d trying to fetch user information", p.providerName, resp.StatusCode)
}
err = userFromReader(resp.Body, &user)
return user, err
}
func userFromReader(r io.Reader, user *goth.User) error {
var users struct {
Data []struct {
ID string `json:"id"`
Name string `json:"login"`
Nickname string `json:"display_name"`
Description string `json:"description"`
AvatarURL string `json:"profile_image_url"`
Email string `json:"email"`
} `json:"data"`
}
err := json.NewDecoder(r).Decode(&users)
if err != nil {
return err
}
if len(users.Data) == 0 {
return errors.New("user not found")
}
u := users.Data[0]
user.Name = u.Name
user.Email = u.Email
user.NickName = u.Nickname
user.Location = "No location is provided by the Twitch API"
user.AvatarURL = u.AvatarURL
user.Description = u.Description
user.UserID = u.ID
return nil
}
func newConfig(p *Provider, scopes []string) *oauth2.Config {
c := &oauth2.Config{
ClientID: p.ClientKey,
ClientSecret: p.Secret,
RedirectURL: p.CallbackURL,
Endpoint: oauth2.Endpoint{
AuthURL: authURL,
TokenURL: tokenURL,
},
Scopes: []string{},
}
if len(scopes) > 0 {
for _, scope := range scopes {
c.Scopes = append(c.Scopes, scope)
}
} else {
c.Scopes = []string{ScopeUserReadEmail}
}
return c
}
// RefreshTokenAvailable refresh token is provided by auth provider or not
func (p *Provider) RefreshTokenAvailable() bool {
return true
}
// RefreshToken get new access token based on the refresh token
func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) {
token := &oauth2.Token{RefreshToken: refreshToken}
ts := p.config.TokenSource(goth.ContextForClient(p.Client()), token)
newToken, err := ts.Token()
if err != nil {
return nil, err
}
return newToken, err
}