QueryBuilder.cs
24.9 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
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
using Contentful.Core.Models;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Text;
using System.Threading.Tasks;
namespace Contentful.Core.Search
{
/// <summary>
/// Utility builder class to construct a correct search query for the Contentful API.
/// </summary>
public class QueryBuilder<T>
{
/// <summary>
/// The querystring values.
/// </summary>
protected readonly List<KeyValuePair<string, string>> _querystringValues = new List<KeyValuePair<string, string>>();
/// <summary>
/// Creates a new instance of a querybuilder.
/// </summary>
/// <returns>The created <see cref="QueryBuilder{T}"/>.</returns>
public static QueryBuilder<T> New => new QueryBuilder<T>();
/// <summary>
/// Adds a search parameter to restrict the result by content type.
/// </summary>
/// <param name="contentTypeId">The ID of the content type to restrict by.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> ContentTypeIs(string contentTypeId)
{
_querystringValues.Add(new KeyValuePair<string, string>("content_type", contentTypeId));
return this;
}
/// <summary>
/// Adds a search parameter to search across all text and symbol fields.
/// </summary>
/// <param name="query">The case insensitive query to search for. Has to be at least 2 characters long to be applied.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FullTextSearch(string query)
{
if (!string.IsNullOrEmpty(query) && query.Length >= 2)
{
_querystringValues.Add(new KeyValuePair<string, string>("query", query));
}
return this;
}
/// <summary>
/// Adds a search parameter on proximity of a coordinate of a location field.
/// </summary>
/// <param name="field">The location field to check proximity for.</param>
/// <param name="coordinate">The coordinate.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> InProximityOf(string field, string coordinate)
{
_querystringValues.Add(new KeyValuePair<string, string>($"{field}[near]", coordinate));
return this;
}
/// <summary>
/// Adds a search parameter on proximity of a coordinate of a location field.
/// </summary>
/// <param name="selector">The expression of a location field to check proximity for.</param>
/// <param name="coordinate">The coordinate.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> InProximityOf<U>(Expression<Func<T, U>> selector, string coordinate)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return InProximityOf(memberName, coordinate);
}
/// <summary>
/// Adds a restriction parameter to only return resources with a location field within the specified area.
/// </summary>
/// <param name="field">The location field to check if it is within the bounding box.</param>
/// <param name="latitude1">The latitude of the bottom left corner of the rectangle.</param>
/// <param name="longitude1">The longitude of the bottom left corner of the rectangle.</param>
/// <param name="latitude2">The latitude of the top right corner of the rectangle.</param>
/// <param name="longitude2">The longitude of the top right corner of the rectangle.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> WithinArea(string field, string latitude1, string longitude1,
string latitude2, string longitude2)
{
_querystringValues.Add(new KeyValuePair<string, string>($"{field}[within]", $"{latitude1},{longitude1},{latitude2},{longitude2}"));
return this;
}
/// <summary>
/// Adds a restriction parameter to only return resources with a location field within the specified area.
/// </summary>
/// <param name="selector">The location field to check if it is within the bounding box.</param>
/// <param name="latitude1">The latitude of the bottom left corner of the rectangle.</param>
/// <param name="longitude1">The longitude of the bottom left corner of the rectangle.</param>
/// <param name="latitude2">The latitude of the top right corner of the rectangle.</param>
/// <param name="longitude2">The longitude of the top right corner of the rectangle.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> WithinArea<U>(Expression<Func<T, U>> selector, string latitude1, string longitude1,
string latitude2, string longitude2)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return WithinArea(memberName, latitude1, longitude1,
latitude2, longitude2);
}
/// <summary>
/// Adds a restriction parameter to only return resources with a location field within a certain radius of a coordinate.
/// </summary>
/// <param name="field">The location field to check if it is within the radius.</param>
/// <param name="latitude">The latitude of the centre of the bounding circle.</param>
/// <param name="longitude">The longitude of the centre of the bounding circle.</param>
/// <param name="radius">The radius in kilometers of the bounding circle.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> WithinRadius(string field, string latitude, string longitude, float radius)
{
_querystringValues.Add(new KeyValuePair<string, string>($"{field}[within]", $"{latitude},{longitude},{radius}"));
return this;
}
/// <summary>
/// Adds a restriction parameter to only return resources with a location field within a certain radius of a coordinate.
/// </summary>
/// <param name="selector">The expression of the location field to check if it is within the radius.</param>
/// <param name="latitude1">The latitude of the centre of the bounding circle.</param>
/// <param name="longitude1">The longitude of the centre of the bounding circle.</param>
/// <param name="radius">The radius in kilometers of the bounding circle.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> WithinRadius<U>(Expression<Func<T, U>> selector, string latitude1, string longitude1, float radius)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return WithinRadius(memberName, latitude1, longitude1, radius);
}
/// <summary>
/// Adds an order expression to the query. An order expression is most simply created using the <see cref="SortOrderBuilder{T}"/> class.
/// </summary>
/// <param name="order">The order expression.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> OrderBy(string order)
{
_querystringValues.Add(new KeyValuePair<string, string>("order", order));
return this;
}
/// <summary>
/// Adds a limit to the number of results returned for the query.
/// </summary>
/// <param name="limit">The maximum number of hits returned.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> Limit(int limit)
{
_querystringValues.Add(new KeyValuePair<string, string>("limit", limit.ToString()));
return this;
}
/// <summary>
/// Adds a skip to the results returned for the query.
/// Use in conjunction with <see cref="OrderBy"/> and <see cref="Limit"/> to effectively page through content.
/// </summary>
/// <param name="skip">The number of items skipped.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> Skip(int skip)
{
_querystringValues.Add(new KeyValuePair<string, string>("skip", skip.ToString()));
return this;
}
/// <summary>
/// Select the number of levels of referenced content that should be included in the response.
/// The default is 1 if this querystring parameter is omitted.
/// </summary>
/// <param name="levels">The number of levels of referenced content to include.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> Include(int levels)
{
_querystringValues.Add(new KeyValuePair<string, string>("include", levels.ToString()));
return this;
}
/// <summary>
/// Filters the returned resources by the specified locale.
/// </summary>
/// <param name="locale">The locale to filter by.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> LocaleIs(string locale)
{
_querystringValues.Add(new KeyValuePair<string, string>("locale", locale));
return this;
}
/// <summary>
/// Adds a restriction parameter for what mimetypes should be returned by the query.
/// </summary>
/// <param name="mimetype">The mimetype to filter by.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> MimeTypeIs(MimeTypeRestriction mimetype)
{
_querystringValues.Add(new KeyValuePair<string, string>("mimetype_group", $"{mimetype.ToString().ToLower()}"));
return this;
}
/// <summary>
/// Adds a restriction that a certain field must exactly match the specified value.
/// </summary>
/// <param name="field">The field that must match the value.</param>
/// <param name="value">The value that the field must exactly match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldEquals(string field, string value)
{
return AddFieldRestriction(field, value, string.Empty);
}
/// <summary>
/// Adds a restriction that a certain field must exactly match the specified value.
/// </summary>
/// <param name="selector">The expression of the field that must match the value.</param>
/// <param name="value">The value that the field must exactly match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldEquals<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldEquals(memberName, value);
}
/// <summary>
/// Adds a restriction that a certain field must not exactly match the specified value.
/// </summary>
/// <param name="field">The field that must not match the value.</param>
/// <param name="value">The value that the field must not match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldDoesNotEqual(string field, string value)
{
return AddFieldRestriction(field, value, "[ne]");
}
/// <summary>
/// Adds a restriction that a certain field must not exactly match the specified value.
/// </summary>
/// <param name="selector">The expression of the field that must not match the value.</param>
/// <param name="value">The value that the field must not match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldDoesNotEqual<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldDoesNotEqual(memberName, value);
}
/// <summary>
/// Adds a restriction that a certain field must exactly match all the specified values.
/// Only applicable for array fields.
/// </summary>
/// <param name="field">The field that must exactly match all the values.</param>
/// <param name="values">The values that the field must inlcude all of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldEqualsAll(string field, IEnumerable<string> values)
{
return AddFieldRestriction(field, string.Join(",", values), "[all]");
}
/// <summary>
/// Adds a restriction that a certain field must exactly match all the specified values.
/// Only applicable for array fields.
/// </summary>
/// <param name="selector">The expression of the field that must exactly match all the values.</param>
/// <param name="values">The values that the field must inlcude all of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldEqualsAll<U>(Expression<Func<T, U>> selector, IEnumerable<string> values)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldEqualsAll(memberName, values);
}
/// <summary>
/// Adds a restriction that a certain field must include at least one of the specified values.
/// </summary>
/// <param name="field">The field that must exactly match at least one of the specified values.</param>
/// <param name="values">The values that the field must include at least one of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldIncludes(string field, IEnumerable<string> values)
{
return AddFieldRestriction(field, string.Join(",", values), "[in]");
}
/// <summary>
/// Adds a restriction that a certain field must include at least one of the specified values.
/// </summary>
/// <param name="selector">The expression of the field that must exactly match at least one of the specified values.</param>
/// <param name="values">The values that the field must include at least one of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldIncludes<U>(Expression<Func<T, U>> selector, IEnumerable<string> values)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldIncludes(memberName, values);
}
/// <summary>
/// Adds a restriction that a certain field must not include any of the specified values.
/// </summary>
/// <param name="field">The field that must not contain any of the specified values.</param>
/// <param name="values">The values that the field must not include any of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldExcludes(string field, IEnumerable<string> values)
{
return AddFieldRestriction(field, string.Join(",", values), "[nin]");
}
/// <summary>
/// Adds a restriction that a certain field must not include any of the specified values.
/// </summary>
/// <param name="selector">The expression of the field that must not contain any of the specified values.</param>
/// <param name="values">The values that the field must not include any of.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldExcludes<U>(Expression<Func<T, U>> selector, IEnumerable<string> values)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldExcludes(memberName, values);
}
/// <summary>
/// Adds a restriction that a certain field must exist and not be null.
/// </summary>
/// <param name="field">The field that must exist and also not be null.</param>
/// <param name="mustExist">Whether or not the field must exist or not exist. A value of false means only include entries where the particular field does NOT exist.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldExists(string field, bool mustExist = true)
{
_querystringValues.Add(new KeyValuePair<string, string>($"{field}[exists]", mustExist.ToString().ToLower()));
return this;
}
/// <summary>
/// Adds a restriction that a certain field must exist and not be null.
/// </summary>
/// <param name="selector">The expression of the field that must exist and also not be null.</param>
/// <param name="mustExist">Whether or not the field must exist or not exist. A value of false means only include entries where the particular field does NOT exist.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldExists<U>(Expression<Func<T, U>> selector, bool mustExist = true)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldExists(memberName, mustExist);
}
/// <summary>
/// Adds a restriction that a certain field must be less than the specified value.
/// </summary>
/// <param name="field">The field to compare against.</param>
/// <param name="value">The value the field must be less than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldLessThan(string field, string value)
{
return AddFieldRestriction(field, value, "[lt]");
}
/// <summary>
/// Adds a restriction that a certain field must be less than the specified value.
/// </summary>
/// <param name="selector">The expression of the field to compare against.</param>
/// <param name="value">The value the field must be less than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldLessThan<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldLessThan(memberName, value);
}
/// <summary>
/// Adds a restriction that a certain field must be less than or equal to the specified value.
/// </summary>
/// <param name="field">The field to compare against.</param>
/// <param name="value">The value the field must be less than or equal to.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldLessThanOrEqualTo(string field, string value)
{
return AddFieldRestriction(field, value, "[lte]");
}
/// <summary>
/// Adds a restriction that a certain field must be less than or equal to the specified value.
/// </summary>
/// <param name="selector">The expression of the field to compare against.</param>
/// <param name="value">The value the field must be less than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldLessThanOrEqualTo<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldLessThanOrEqualTo(memberName, value);
}
/// <summary>
/// Adds a restriction that a certain field must be greater than the specified value.
/// </summary>
/// <param name="field">The field to compare against.</param>
/// <param name="value">The value the field must be greater than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldGreaterThan(string field, string value)
{
return AddFieldRestriction(field, value, "[gt]");
}
/// <summary>
/// Adds a restriction that a certain field must be greater than the specified value.
/// </summary>
/// <param name="selector">The expression of the field to compare against.</param>
/// <param name="value">The value the field must be greater than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldGreaterThan<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldGreaterThan(memberName, value);
}
/// <summary>
/// Adds a restriction that a certain field must be greater than or equal to the specified value.
/// </summary>
/// <param name="field">The field to compare against.</param>
/// <param name="value">The value the field must be greater than or equal to.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldGreaterThanOrEqualTo(string field, string value)
{
return AddFieldRestriction(field, value, "[gte]");
}
/// <summary>
/// Adds a restriction that a certain field must be greater than the specified value.
/// </summary>
/// <param name="selector">The expression of the field to compare against.</param>
/// <param name="value">The value the field must be greater than.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldGreaterThanOrEqualTo<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldGreaterThanOrEqualTo(memberName, value);
}
/// <summary>
/// Adds a search parameter to search in a specific field for a match for a value.
/// Not to be confused with the <see cref="FullTextSearch"/> method that searches across all fields.
/// </summary>
/// <param name="field">The field to search for matches.</param>
/// <param name="value">The value the field must match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldMatches(string field, string value)
{
return AddFieldRestriction(field, value, "[match]");
}
/// <summary>
/// Adds a search parameter to search in a specific field for a match for a value.
/// Not to be confused with the <see cref="FullTextSearch"/> method that searches across all fields.
/// </summary>
/// <param name="selector">The expression of the field to search for matches.</param>
/// <param name="value">The value the field must match.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
public QueryBuilder<T> FieldMatches<U>(Expression<Func<T, U>> selector, string value)
{
var memberName = FieldHelpers<T>.GetPropertyName(selector);
return FieldMatches(memberName, value);
}
/// <summary>
/// Adds the restriction for a specific field, value and operator.
/// </summary>
/// <param name="field">The field to restrict.</param>
/// <param name="value">The value to restrict by.</param>
/// <param name="operator">The operator to apply restriction with.</param>
/// <returns>The <see cref="QueryBuilder{T}"/> instance.</returns>
protected QueryBuilder<T> AddFieldRestriction(string field, string value, string @operator)
{
_querystringValues.Add(new KeyValuePair<string, string>($"{field}{@operator}", value));
return this;
}
/// <summary>
/// Builds the query and returns the formatted querystring.
/// </summary>
/// <returns>The formatted querystring.</returns>
public string Build()
{
var sb = new StringBuilder();
var hasQuery = false;
foreach (var parameter in _querystringValues)
{
sb.Append(hasQuery ? '&' : '?');
sb.Append(parameter.Key);
sb.Append('=');
sb.Append(parameter.Value);
hasQuery = true;
}
return sb.ToString();
}
}
}