/// <summary>
/// Search the gallery with a given query string.
/// </summary>
/// <param name="qAll">Search for all of these words (and).</param>
/// <param name="qAny">Search for any of these words (or).</param>
/// <param name="qExactly">Search for exactly this word or phrase.</param>
/// <param name="qNot">Exclude results matching this word or phrase.</param>
/// <param name="fileType">Show results for a specific file type.</param>
/// <param name="imageSize">Show results for a specific image size.</param>
/// <param name="sort">The order that the gallery should be sorted by. Default: Time</param>
/// <param name="window">The time period that should be used in filtering requests. Default: Day</param>
/// <param name="page">The data paging number. Default: null</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public Basic<IEnumerable<GalleryItem>> SearchGalleryAdvanced(
string qAll = null, string qAny = null,
string qExactly = null, string qNot = null,
ImageFileType? fileType = null, ImageSize? imageSize = null,
GallerySortOrder? sort = GallerySortOrder.Time,
TimeWindow? window = TimeWindow.All, int? page = null)
{
if (string.IsNullOrWhiteSpace(qAll) &&
string.IsNullOrWhiteSpace(qAny) &&
string.IsNullOrWhiteSpace(qExactly) &&
string.IsNullOrWhiteSpace(qNot))
throw new ArgumentNullException(null,
"At least one search parameter must be provided (All | Any | Exactly | Not).");
sort = sort ?? GallerySortOrder.Time;
window = window ?? TimeWindow.All;
var sortValue = $"{sort}".ToLower();
var windowValue = $"{window}".ToLower();
var url = $"gallery/search/{sortValue}/{windowValue}/{page}";
url = GalleryRequestBuilder.SearchGalleryAdvancedRequest(url, qAll, qAny, qExactly, qNot, fileType,
imageSize);
using (var request = RequestBuilderBase.CreateRequest(HttpMethod.Get, url))
{
var httpResponse = HttpClient.SendAsync(request).Result;
var jsonString = httpResponse.Content.ReadAsStringAsync().Result;
var output = Newtonsoft.Json.JsonConvert.DeserializeObject<Basic<IEnumerable<GalleryItem>>>(httpResponse.Content.ReadAsStringAsync().Result.ToString());
return output;
}
}
/// <summary>
/// Search the gallery with a given query string.
/// </summary>
/// <param name="qAll">Search for all of these words (and).</param>
/// <param name="qAny">Search for any of these words (or).</param>
/// <param name="qExactly">Search for exactly this word or phrase.</param>
/// <param name="qNot">Exclude results matching this word or phrase.</param>
/// <param name="fileType">Show results for a specific file type.</param>
/// <param name="imageSize">Show results for a specific image size.</param>
/// <param name="sort">The order that the gallery should be sorted by. Default: Time</param>
/// <param name="window">The time period that should be used in filtering requests. Default: Day</param>
/// <param name="page">The data paging number. Default: null</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public async Task <IEnumerable <IGalleryItem> > SearchGalleryAdvancedAsync(
string qAll = null, string qAny = null,
string qExactly = null, string qNot = null,
ImageFileType?fileType = null, ImageSize?imageSize = null,
GallerySortOrder?sort = GallerySortOrder.Time,
TimeWindow?window = TimeWindow.All, int?page = null)
{
if (string.IsNullOrWhiteSpace(qAll) &&
string.IsNullOrWhiteSpace(qAny) &&
string.IsNullOrWhiteSpace(qExactly) &&
string.IsNullOrWhiteSpace(qNot))
{
throw new ArgumentNullException(null,
"At least one search parameter must be provided (All | Any | Exactly | Not).");
}
sort = sort ?? GallerySortOrder.Time;
window = window ?? TimeWindow.All;
var sortValue = $"{sort}".ToLower();
var windowValue = $"{window}".ToLower();
var url = $"gallery/search/{sortValue}/{windowValue}/{page}";
url = GalleryRequestBuilder.SearchGalleryAdvancedRequest(url, qAll, qAny, qExactly, qNot, fileType,
imageSize);
using (var request = RequestBuilderBase.CreateRequest(HttpMethod.Get, url))
{
var searchResults = await SendRequestAsync <IEnumerable <GalleryItem> >(request).ConfigureAwait(false);
return(searchResults);
}
}
/// <summary>
/// Search the gallery with a given query string.
/// </summary>
/// <param name="query">
/// Query string to search by. This parameter also supports boolean operators (AND, OR, NOT) and
/// indices (tag: user: title: ext: subreddit: album: meme:). An example compound query would be 'title: cats AND dogs
/// ext: gif'
/// </param>
/// <param name="sort">The order that the gallery should be sorted by. Default: Time</param>
/// <param name="window">The time period that should be used in filtering requests. Default: Day</param>
/// <param name="page">The data paging number. Default: null</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public async Task <IEnumerable <IGalleryItem> > SearchGalleryAsync(string query,
GallerySortOrder?sort = GallerySortOrder.Time,
TimeWindow?window = TimeWindow.All, int?page = null)
{
if (string.IsNullOrWhiteSpace(query))
{
throw new ArgumentNullException(nameof(query));
}
sort = sort ?? GallerySortOrder.Time;
window = window ?? TimeWindow.All;
var sortValue = $"{sort}".ToLower();
var windowValue = $"{window}".ToLower();
var url = $"gallery/search/{sortValue}/{windowValue}/{page}";
url = GalleryRequestBuilder.SearchGalleryRequest(url, query);
using (var request = RequestBuilderBase.CreateRequest(HttpMethod.Get, url))
{
var searchResults = await SendRequestAsync <IEnumerable <GalleryItem> >(request).ConfigureAwait(false);
return(searchResults);
}
}
/// <summary>
/// Share an Album or Image to the Gallery. OAuth authentication required.
/// </summary>
/// <param name="galleryItemId">The gallery item id.</param>
/// <param name="title">The title of the image. This is required.</param>
/// <param name="topicId">The topic id - not the topic name.</param>
/// <param name="bypassTerms">
/// If the user has not accepted the terms yet, this endpoint will return an error. To by-pass
/// the terms in general simply set this value to true.
/// </param>
/// <param name="mature">If the post is mature, set this value to true.</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public async Task <bool> PublishToGalleryAsync(string galleryItemId, string title, string topicId = null,
bool?bypassTerms = null,
bool?mature = null)
{
if (string.IsNullOrWhiteSpace(galleryItemId))
{
throw new ArgumentNullException(nameof(galleryItemId));
}
if (string.IsNullOrWhiteSpace(title))
{
throw new ArgumentNullException(nameof(title));
}
if (ApiClient.OAuth2Token == null)
{
throw new ArgumentNullException(nameof(ApiClient.OAuth2Token), OAuth2RequiredExceptionMessage);
}
var url = $"gallery/{galleryItemId}";
using (var request = GalleryRequestBuilder.PublishToGalleryRequest(url, title, topicId, bypassTerms, mature))
{
var published = await SendRequestAsync <bool>(request).ConfigureAwait(false);
return(published);
}
}
public void SearchGalleryRequest_Equal()
{
var client = new ImgurClient("123", "1234");
var requestBuilder = new GalleryRequestBuilder();
var mockUrl = $"{client.EndpointUrl}gallery/search";
var actual = GalleryRequestBuilder.SearchGalleryRequest(mockUrl, "star wars");
var expected = "https://api.imgur.com/3/gallery/search?q=star+wars";
Assert.Equal(expected, actual);
}
public void SearchGalleryAdvancedRequest_WithQueryNull_ThrowsArgumentNullException()
{
var requestBuilder = new GalleryRequestBuilder();
var exception = Record.Exception(() => GalleryRequestBuilder.SearchGalleryAdvancedRequest("Xio"));
Assert.NotNull(exception);
Assert.IsType <ArgumentNullException>(exception);
Assert.True(
exception.Message.Contains("At least one search parameter must be provided (All | Any | Exactly | Not)"));
}
public void PublishToGalleryRequest_WithUrlNull_ThrowsArgumentNullException()
{
var requestBuilder = new GalleryRequestBuilder();
var exception = Record.Exception(() => GalleryRequestBuilder.PublishToGalleryRequest(null, "test"));
Assert.NotNull(exception);
Assert.IsType <ArgumentNullException>(exception);
var argNullException = (ArgumentNullException)exception;
Assert.Equal(argNullException.ParamName, "url");
}
public void SearchGalleryRequest_WithQueryNull_ThrowsArgumentNullException()
{
var requestBuilder = new GalleryRequestBuilder();
var exception = Record.Exception(() => GalleryRequestBuilder.SearchGalleryRequest("Xio", null));
Assert.NotNull(exception);
Assert.IsType <ArgumentNullException>(exception);
var argNullException = (ArgumentNullException)exception;
Assert.Equal(argNullException.ParamName, "query");
}
public void SearchGalleryAdvancedRequest_Equal()
{
var client = new ImgurClient("123", "1234");
var requestBuilder = new GalleryRequestBuilder();
var mockUrl = $"{client.EndpointUrl}gallery/search";
var actual = GalleryRequestBuilder.SearchGalleryAdvancedRequest(mockUrl, "star wars", "luke han leia", "Obi-Wan",
"Kirk", ImageFileType.Anigif, ImageSize.Lrg);
var expected =
"https://api.imgur.com/3/gallery/search?q_all=star+wars&q_any=luke+han+leia&q_exactly=Obi-Wan&q_not=Kirk&q_type=anigif&q_size_px=lrg";
Assert.Equal(expected, actual);
}
public async Task PublishToGalleryRequest_WithTitleOnly_Equal()
{
var client = new ImgurClient("123", "1234");
var requestBuilder = new GalleryRequestBuilder();
var mockUrl = $"{client.EndpointUrl}gallery/XysioD";
var request = GalleryRequestBuilder.PublishToGalleryRequest(mockUrl, "Hello World!");
Assert.NotNull(request);
var expected = "title=Hello+World%21";
Assert.Equal(expected, await request.Content.ReadAsStringAsync().ConfigureAwait(false));
Assert.Equal("https://api.imgur.com/3/gallery/XysioD", request.RequestUri.ToString());
Assert.Equal(HttpMethod.Post, request.Method);
}
/// <summary>
/// Share an Album or Image to the Gallery. OAuth authentication required.
/// </summary>
/// <param name="galleryItemId">The gallery item id.</param>
/// <param name="title">The title of the image. This is required.</param>
/// <param name="topicId">The topic id - not the topic name.</param>
/// <param name="bypassTerms">
/// If the user has not accepted the terms yet, this endpoint will return an error. To by-pass
/// the terms in general simply set this value to true.
/// </param>
/// <param name="mature">If the post is mature, set this value to true.</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public Basic<bool> PublishToGallery(string galleryItemId, string title, string topicId = null,
bool? bypassTerms = null,
bool? mature = null)
{
if (string.IsNullOrWhiteSpace(galleryItemId))
throw new ArgumentNullException(nameof(galleryItemId));
if (string.IsNullOrWhiteSpace(title))
throw new ArgumentNullException(nameof(title));
if (ApiClient.OAuth2Token == null)
throw new ArgumentNullException(nameof(ApiClient.OAuth2Token), OAuth2RequiredExceptionMessage);
var url = $"gallery/{galleryItemId}";
using (var request = GalleryRequestBuilder.PublishToGalleryRequest(url, title, topicId, bypassTerms, mature))
{
var httpResponse = HttpClient.SendAsync(request).Result;
var jsonString = httpResponse.Content.ReadAsStringAsync().Result;
var output = Newtonsoft.Json.JsonConvert.DeserializeObject<Basic<bool>>(httpResponse.Content.ReadAsStringAsync().Result.ToString());
return output;
}
}
/// <summary>
/// Search the gallery with a given query string.
/// </summary>
/// <param name="query">
/// Query string to search by. This parameter also supports boolean operators (AND, OR, NOT) and
/// indices (tag: user: title: ext: subreddit: album: meme:). An example compound query would be 'title: cats AND dogs
/// ext: gif'
/// </param>
/// <param name="sort">The order that the gallery should be sorted by. Default: Time</param>
/// <param name="window">The time period that should be used in filtering requests. Default: Day</param>
/// <param name="page">The data paging number. Default: null</param>
/// <exception cref="ArgumentNullException">
/// Thrown when a null reference is passed to a method that does not accept it as a
/// valid argument.
/// </exception>
/// <exception cref="ImgurException">Thrown when an error is found in a response from an Imgur endpoint.</exception>
/// <exception cref="MashapeException">Thrown when an error is found in a response from a Mashape endpoint.</exception>
/// <returns></returns>
public Basic<IEnumerable<GalleryItem>> SearchGallery(string query,
GallerySortOrder? sort = GallerySortOrder.Time,
TimeWindow? window = TimeWindow.All, int? page = null)
{
if (string.IsNullOrWhiteSpace(query))
throw new ArgumentNullException(nameof(query));
sort = sort ?? GallerySortOrder.Time;
window = window ?? TimeWindow.All;
var sortValue = $"{sort}".ToLower();
var windowValue = $"{window}".ToLower();
var url = $"gallery/search/{sortValue}/{windowValue}/{page}";
url = GalleryRequestBuilder.SearchGalleryRequest(url, query);
using (var request = RequestBuilderBase.CreateRequest(HttpMethod.Get, url))
{
var httpResponse = HttpClient.SendAsync(request).Result;
var jsonString = httpResponse.Content.ReadAsStringAsync().Result;
var output = Newtonsoft.Json.JsonConvert.DeserializeObject<Basic<IEnumerable<GalleryItem>>>(httpResponse.Content.ReadAsStringAsync().Result.ToString());
return output;
}
}
