-
Notifications
You must be signed in to change notification settings - Fork 27
/
CrowdinApiClient.cs
457 lines (365 loc) · 16.6 KB
/
CrowdinApiClient.cs
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Crowdin.Api.Applications;
using Crowdin.Api.Bundles;
using Crowdin.Api.Core;
using Crowdin.Api.Core.Converters;
using Crowdin.Api.Core.RateLimiting;
using Crowdin.Api.Core.Resilience;
using Crowdin.Api.Dictionaries;
using Crowdin.Api.Distributions;
using Crowdin.Api.Fields;
using Crowdin.Api.Glossaries;
using Crowdin.Api.Issues;
using Crowdin.Api.Labels;
using Crowdin.Api.Languages;
using Crowdin.Api.MachineTranslationEngines;
using Crowdin.Api.ProjectsGroups;
using Crowdin.Api.Reports;
using Crowdin.Api.Screenshots;
using Crowdin.Api.SecurityLogs;
using Crowdin.Api.SourceFiles;
using Crowdin.Api.SourceStrings;
using Crowdin.Api.Storage;
using Crowdin.Api.StringComments;
using Crowdin.Api.StringTranslations;
using Crowdin.Api.Tasks;
using Crowdin.Api.Teams;
using Crowdin.Api.TranslationMemory;
using Crowdin.Api.Translations;
using Crowdin.Api.TranslationStatus;
using Crowdin.Api.Users;
using Crowdin.Api.Vendors;
using Crowdin.Api.Webhooks;
using Crowdin.Api.Webhooks.Organization;
using Crowdin.Api.Workflows;
using JetBrains.Annotations;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
#nullable enable
namespace Crowdin.Api
{
[PublicAPI]
public class CrowdinApiClient : ICrowdinApiClient
{
public BundlesApiExecutor Bundles { get; }
public DictionariesApiExecutor Dictionaries { get; }
public DistributionsApiExecutor Distributions { get; }
public GlossariesApiExecutor Glossaries { get; }
public IssuesApiExecutor Issues { get; }
public LabelsApiExecutor Labels { get; }
public LanguagesApiExecutor Languages { get; }
public MachineTranslationEnginesApiExecutor MachineTranslationEngines { get; }
public ProjectsGroupsApiExecutor ProjectsGroups { get; }
public ReportsApiExecutor Reports { get; }
public ScreenshotsApiExecutor Screenshots { get; }
public SecurityLogsApiExecutor SecurityLogs { get; }
public SourceFilesApiExecutor SourceFiles { get; }
public SourceStringsApiExecutor SourceStrings { get; }
public StorageApiExecutor Storage { get; }
public StringCommentsApiExecutor StringComments { get; }
public StringTranslationsApiExecutor StringTranslations { get; }
public TasksApiExecutor Tasks { get; }
public TeamsApiExecutor Teams { get; }
public TranslationMemoryApiExecutor TranslationMemory { get; }
public TranslationsApiExecutor Translations { get; }
public TranslationStatusApiExecutor TranslationStatus { get; }
public UsersApiExecutor Users { get; }
public VendorsApiExecutor Vendors { get; }
public WebhooksApiExecutor Webhooks { get; }
public WorkflowsApiExecutor Workflows { get; }
public OrganizationWebhooksApiExecutor OrganizationWebhooks { get; }
public ApplicationsApiExecutor Applications { get; }
public FieldsApiExecutor Fields { get; }
private readonly string _baseUrl;
private readonly HttpClient _httpClient;
private readonly IRateLimiter? _rateLimiter;
private readonly IRetryService? _retryService;
private static readonly MediaTypeHeaderValue DefaultContentType = MediaTypeHeaderValue.Parse("application/json");
private static readonly JsonSerializerSettings DefaultJsonSerializerOptions =
new JsonSerializerSettings
{
NullValueHandling = NullValueHandling.Ignore,
Converters =
{
new DescriptionEnumConverter(),
new FileExportOptionsConverter(),
new FileImportOptionsConverter(),
new FileInfoConverter(),
new LanguageTranslationsConverter(),
new ToStringConverter(),
new ProjectFileFormatSettingsConverter(),
new ProjectStringsExporterSettingsConverter(),
new ReportSettingsTemplateConverter(),
new WorkflowStepConverter(),
new FieldConfigConverter(),
new AiPromptConfigurationConverter(),
new AiProviderCredentialsConverter()
}
};
public IJsonParser DefaultJsonParser { get; }
public CrowdinApiClient(
CrowdinCredentials credentials,
HttpClient? httpClient = null,
IJsonParser? jsonParser = null,
IRateLimiter? rateLimiter = null,
IRetryService? retryService = null)
{
_httpClient = httpClient ?? new HttpClient();
DefaultJsonParser = jsonParser ?? new JsonParser(DefaultJsonSerializerOptions);
_rateLimiter = rateLimiter;
_retryService = retryService;
_httpClient.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", credentials.AccessToken);
// pass base url full
if (!string.IsNullOrWhiteSpace(credentials.BaseUrl))
{
_baseUrl = credentials.BaseUrl!;
}
// pass org name -> from base url
else if (!string.IsNullOrWhiteSpace(credentials.Organization))
{
_baseUrl = $"https://{credentials.Organization!}.api.crowdin.com/api/v2";
}
// || -> use regular url (no org, no baseurl passed)
else
{
_baseUrl = "https://api.crowdin.com/api/v2";
}
Bundles = new BundlesApiExecutor(this);
Dictionaries = new DictionariesApiExecutor(this);
Distributions = new DistributionsApiExecutor(this);
Glossaries = new GlossariesApiExecutor(this);
Issues = new IssuesApiExecutor(this);
Labels = new LabelsApiExecutor(this);
Languages = new LanguagesApiExecutor(this);
MachineTranslationEngines = new MachineTranslationEnginesApiExecutor(this);
ProjectsGroups = new ProjectsGroupsApiExecutor(this);
Reports = new ReportsApiExecutor(this);
Screenshots = new ScreenshotsApiExecutor(this);
SecurityLogs = new SecurityLogsApiExecutor(this);
SourceFiles = new SourceFilesApiExecutor(this);
SourceStrings = new SourceStringsApiExecutor(this);
Storage = new StorageApiExecutor(this);
StringComments = new StringCommentsApiExecutor(this);
StringTranslations = new StringTranslationsApiExecutor(this);
Tasks = new TasksApiExecutor(this);
Teams = new TeamsApiExecutor(this);
TranslationMemory = new TranslationMemoryApiExecutor(this);
Translations = new TranslationsApiExecutor(this);
TranslationStatus = new TranslationStatusApiExecutor(this);
Users = new UsersApiExecutor(this);
Vendors = new VendorsApiExecutor(this);
Webhooks = new WebhooksApiExecutor(this);
Workflows = new WorkflowsApiExecutor(this);
OrganizationWebhooks = new OrganizationWebhooksApiExecutor(this);
Applications = new ApplicationsApiExecutor(this);
Fields = new FieldsApiExecutor(this);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendGetRequest(string subUrl, IDictionary<string, string>? queryParams)
{
Func<HttpRequestMessage> requestFn = () => new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri(FormRequestUrl(subUrl, queryParams))
};
return SendRequest(requestFn);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendPostRequest(
string subUrl, object? body,
IDictionary<string, string>? extraHeaders)
{
Func<HttpRequestMessage> requestFn = () =>
{
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri(FormRequestUrl(subUrl))
};
request.Content = body != null ? CreateJsonContent(body) : CreateEmptyJsonContent();
if (extraHeaders != null && extraHeaders.Count > 0)
{
foreach (KeyValuePair<string, string> kvp in extraHeaders)
{
request.Headers.Add(kvp.Key, kvp.Value);
}
}
return request;
};
return SendRequest(requestFn);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendPutRequest(string subUrl, object? body)
{
Func<HttpRequestMessage> requestFn = () =>
{
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri(FormRequestUrl(subUrl))
};
if (body != null)
{
request.Content = CreateJsonContent(body);
}
return request;
};
return SendRequest(requestFn);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendPatchRequest(
string subUrl, IEnumerable<PatchEntry> body,
IDictionary<string, string>? queryParams)
{
Func<HttpRequestMessage> requestFn = () => new HttpRequestMessage
{
Method = new HttpMethod("PATCH"),
Content = CreateJsonContent(body),
RequestUri = new Uri(FormRequestUrl(subUrl, queryParams))
};
return SendRequest(requestFn);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendPatchRequest(
string subUrl, object body,
IDictionary<string, string>? queryParams)
{
Func<HttpRequestMessage> requestFn = () => new HttpRequestMessage
{
Method = new HttpMethod("PATCH"),
Content = CreateJsonContent(body),
RequestUri = new Uri(FormRequestUrl(subUrl, queryParams))
};
return SendRequest(requestFn);
}
Task<HttpStatusCode> ICrowdinApiClient.SendDeleteRequest(string subUrl, IDictionary<string, string>? queryParams)
{
return ((ICrowdinApiClient) this)
.SendDeleteRequest_FullResult(subUrl, queryParams)
.ContinueWith(task => task.Result.StatusCode);
}
Task<CrowdinApiResult> ICrowdinApiClient.SendDeleteRequest_FullResult(string subUrl, IDictionary<string, string>? queryParams)
{
Func<HttpRequestMessage> requestFn = () => new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri(FormRequestUrl(subUrl, queryParams))
};
return SendRequest(requestFn);
}
Task<CrowdinApiResult> ICrowdinApiClient.UploadFile(string subUrl, string filename, Stream fileStream)
{
Func<HttpRequestMessage> requestFn = () =>
{
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
Content = new StreamContent(fileStream),
RequestUri = new Uri(FormRequestUrl(subUrl)),
};
request.Headers.Add("Crowdin-API-FileName", filename);
request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
return request;
};
return SendRequest(requestFn);
}
public static async Task<T[]> WithFetchAll<T>(
Func<int, int, Task<ResponseList<T>>> runRequest,
int? maxAmountOfItems = null,
int amountPerRequest = 25)
{
int limit = maxAmountOfItems < amountPerRequest ? maxAmountOfItems.Value : amountPerRequest;
var offset = 0;
var outResultList = new List<T>();
while (true)
{
ResponseList<T> response = await runRequest(limit, offset);
outResultList.AddRange(response.Data);
if (response.Data.Count < limit) break;
offset += limit;
if (maxAmountOfItems.HasValue)
{
if (outResultList.Count == maxAmountOfItems.Value) break;
if (maxAmountOfItems.Value - outResultList.Count < limit)
{
limit = maxAmountOfItems.Value - outResultList.Count;
}
}
}
return outResultList.ToArray();
}
private async Task<CrowdinApiResult> SendRequest(Func<HttpRequestMessage> createRequestMessage)
{
Task<HttpResponseMessage> SendHttpRequest(int _ = default)
{
return _httpClient.SendAsync(createRequestMessage());
}
Task<HttpResponseMessage> SendRequestViaRateLimiterIfAvailable()
{
return _rateLimiter != null
? _rateLimiter.ExecuteRequest(SendHttpRequest)
: SendHttpRequest();
}
var result = new CrowdinApiResult();
HttpResponseMessage response = _retryService != null
? await _retryService.ExecuteRequestAsync(SendRequestViaRateLimiterIfAvailable)
: await SendRequestViaRateLimiterIfAvailable();
await CheckDefaultPreconditionsAndErrors(response);
result.StatusCode = response.StatusCode;
if (response.Content.Headers.ContentType.MediaType.Contains(DefaultContentType.MediaType))
{
result.JsonObject = await response.Content.ParseJsonBodyAsync();
}
result.Headers = response.Headers;
return result;
}
private HttpContent CreateEmptyJsonContent()
{
MediaTypeHeaderValue contentType = DefaultContentType;
return new StringContent("{}", Encoding.UTF8, contentType.MediaType);
}
private HttpContent CreateJsonContent(object body)
{
string bodyJson = JsonConvert.SerializeObject(body, DefaultJsonSerializerOptions);
MediaTypeHeaderValue contentType = DefaultContentType;
return new StringContent(bodyJson, Encoding.UTF8, contentType.MediaType);
}
private string FormRequestUrl(string relativeUrlPart)
{
return $"{_baseUrl}{relativeUrlPart}";
}
private string FormRequestUrl(string relativeUrlPart, IDictionary<string, string>? queryParams)
{
return queryParams is null
? FormRequestUrl(relativeUrlPart)
: FormRequestUrl(relativeUrlPart) + '?' + queryParams.ToQueryString();
}
internal static async Task CheckDefaultPreconditionsAndErrors(HttpResponseMessage response)
{
if (response.IsSuccessStatusCode) return;
JObject doc = await response.Content.ParseJsonBodyAsync();
if (response.StatusCode is HttpStatusCode.BadRequest)
{
ErrorResource[] errorResources = doc["errors"]!
.Select(subObject => JsonConvert.DeserializeObject<ErrorResource>(subObject["error"]!.ToString()))
.ToArray()!;
var messageBuilder = new StringBuilder("Invalid Request Parameters: ");
messageBuilder.Append($"Key [{errorResources[0].Key}]: {errorResources[0].Errors[0].Message}");
if (errorResources.Length > 1 ||
errorResources[0].Errors.Length > 1)
{
messageBuilder.Append(". More errors see in Related property");
}
throw new CrowdinApiException(messageBuilder.ToString(), errorResources);
}
JToken error = doc["error"]!;
var code = error["code"]!.Value<int>();
var message = error["message"]!.Value<string>();
throw new CrowdinApiException(code, message ?? "Unknown error occurred");
}
}
}