-
Notifications
You must be signed in to change notification settings - Fork 315
Expand file tree
/
Copy pathOAuthClient.cs
More file actions
296 lines (262 loc) · 11.4 KB
/
OAuthClient.cs
File metadata and controls
296 lines (262 loc) · 11.4 KB
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
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using SpotifyAPI.Web.Http;
namespace SpotifyAPI.Web
{
public class OAuthClient : APIClient, IOAuthClient
{
public OAuthClient() : this(SpotifyClientConfig.CreateDefault()) { }
public OAuthClient(IAPIConnector apiConnector) : base(apiConnector) { }
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062")]
public OAuthClient(SpotifyClientConfig config) : base(ValidateConfig(config)) { }
/// <summary>
/// Requests a new token using pkce flow
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow-with-proof-key-for-code-exchange-pkce
/// </remarks>
/// <returns></returns>1
public Task<PKCETokenResponse> RequestToken(PKCETokenRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Refreshes a token using pkce flow
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow-with-proof-key-for-code-exchange-pkce
/// </remarks>
/// <returns></returns>1
public Task<PKCETokenResponse> RequestToken(PKCETokenRefreshRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Requests a new token using client_ids and client_secrets.
/// If the token is expired, simply call the funtion again to get a new token
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow
/// </remarks>
/// <returns></returns>1
public Task<ClientCredentialsTokenResponse> RequestToken(ClientCredentialsRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Refresh an already received token via Authorization Code Auth
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
/// </remarks>
/// <returns></returns>
public Task<AuthorizationCodeRefreshResponse> RequestToken(AuthorizationCodeRefreshRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Request an initial token via Authorization Code Auth
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
/// </remarks>
/// <returns></returns>
public Task<AuthorizationCodeTokenResponse> RequestToken(AuthorizationCodeTokenRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Swaps out a received code with a access token using a remote server
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/ios/guides/token-swap-and-refresh/
/// </remarks>
/// <returns></returns>
public Task<AuthorizationCodeTokenResponse> RequestToken(TokenSwapTokenRequest request, CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
/// <summary>
/// Gets a refreshed access token using an already received refresh token using a remote server
/// </summary>
/// <param name="request"></param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/ios/guides/token-swap-and-refresh/
/// </remarks>
/// <returns></returns>
public Task<AuthorizationCodeRefreshResponse> RequestToken(
TokenSwapRefreshRequest request,
CancellationToken cancel = default)
{
return RequestToken(request, API, cancel);
}
public static Task<PKCETokenResponse> RequestToken(
PKCETokenRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("client_id", request.ClientId),
new KeyValuePair<string?, string?>("grant_type", "authorization_code"),
new KeyValuePair<string?, string?>("code", request.Code),
new KeyValuePair<string?, string?>("redirect_uri", request.RedirectUri.ToString()),
new KeyValuePair<string?, string?>("code_verifier", request.CodeVerifier),
};
return SendOAuthRequest<PKCETokenResponse>(apiConnector, form, null, null, cancel);
}
public static Task<PKCETokenResponse> RequestToken(
PKCETokenRefreshRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("client_id", request.ClientId),
new KeyValuePair<string?, string?>("grant_type", "refresh_token"),
new KeyValuePair<string?, string?>("refresh_token", request.RefreshToken),
};
return SendOAuthRequest<PKCETokenResponse>(apiConnector, form, null, null, cancel);
}
public static Task<AuthorizationCodeRefreshResponse> RequestToken(
TokenSwapRefreshRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default
)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("refresh_token", request.RefreshToken)
};
#pragma warning disable CA2000
return apiConnector.Post<AuthorizationCodeRefreshResponse>(
request.RefreshUri, null, new FormUrlEncodedContent(form),
cancel
);
#pragma warning restore CA2000
}
public static Task<AuthorizationCodeTokenResponse> RequestToken(
TokenSwapTokenRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default
)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("code", request.Code)
};
#pragma warning disable CA2000
return apiConnector.Post<AuthorizationCodeTokenResponse>(
request.TokenUri, null, new FormUrlEncodedContent(form),
cancel
);
#pragma warning restore CA2000
}
public static Task<ClientCredentialsTokenResponse> RequestToken(
ClientCredentialsRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default
)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("grant_type", "client_credentials")
};
return SendOAuthRequest<ClientCredentialsTokenResponse>(apiConnector, form, request.ClientId, request.ClientSecret, cancel);
}
public static Task<AuthorizationCodeRefreshResponse> RequestToken(
AuthorizationCodeRefreshRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default
)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("grant_type", "refresh_token"),
new KeyValuePair<string?, string?>("refresh_token", request.RefreshToken)
};
return SendOAuthRequest<AuthorizationCodeRefreshResponse>(apiConnector, form, request.ClientId, request.ClientSecret, cancel);
}
public static Task<AuthorizationCodeTokenResponse> RequestToken(
AuthorizationCodeTokenRequest request,
IAPIConnector apiConnector,
CancellationToken cancel = default
)
{
Ensure.ArgumentNotNull(request, nameof(request));
Ensure.ArgumentNotNull(apiConnector, nameof(apiConnector));
var form = new List<KeyValuePair<string?, string?>>
{
new KeyValuePair<string?, string?>("grant_type", "authorization_code"),
new KeyValuePair<string?, string?>("code", request.Code),
new KeyValuePair<string?, string?>("redirect_uri", request.RedirectUri.ToString())
};
return SendOAuthRequest<AuthorizationCodeTokenResponse>(apiConnector, form, request.ClientId, request.ClientSecret, cancel);
}
private static Task<T> SendOAuthRequest<T>(
IAPIConnector apiConnector,
List<KeyValuePair<string?, string?>> form,
string? clientId,
string? clientSecret,
CancellationToken cancel = default)
{
var headers = BuildAuthHeader(clientId, clientSecret);
#pragma warning disable CA2000
return apiConnector.Post<T>(SpotifyUrls.OAuthToken, null, new FormUrlEncodedContent(form), headers, cancel);
#pragma warning restore CA2000
}
private static Dictionary<string, string> BuildAuthHeader(string? clientId, string? clientSecret)
{
if (clientId == null || clientSecret == null)
{
return new Dictionary<string, string>();
}
var base64 = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{clientId}:{clientSecret}"));
return new Dictionary<string, string>
{
{ "Authorization", $"Basic {base64}"}
};
}
private static APIConnector ValidateConfig(SpotifyClientConfig config)
{
Ensure.ArgumentNotNull(config, nameof(config));
return new APIConnector(
config.BaseAddress,
config.Authenticator,
config.JSONSerializer,
config.HTTPClient,
config.RetryHandler,
config.HTTPLogger
);
}
}
}