Allow Enum in QueryParams and added more endpoints

JohnnyCrazy · JohnnyCrazy · commit 7c94de211020 · 2020-05-03T22:34:03.000+02:00
diff --git a/SpotifyAPI.Web/Clients/Interfaces/IPlaylistsClient.cs b/SpotifyAPI.Web/Clients/Interfaces/IPlaylistsClient.cs
@@ -29,5 +29,7 @@ public interface IPlaylistsClient
     Task<Paging<SimplePlaylist>> CurrentUsers(PlaylistCurrentUsersRequest request);
 
     Task<bool> ChangeDetails(string playlistId, PlaylistChangeDetailsRequest request);
+
+    Task<SnapshotResponse> ReorderItems(string playlistId, PlaylistReorderItemsRequest request);
   }
 }
diff --git a/SpotifyAPI.Web/Clients/Interfaces/ISearchClient.cs b/SpotifyAPI.Web/Clients/Interfaces/ISearchClient.cs
@@ -0,0 +1,9 @@
+using System.Threading.Tasks;
+
+namespace SpotifyAPI.Web
+{
+  public interface ISearchClient
+  {
+    Task<SearchResponse> Item(SearchRequest request);
+  }
+}
diff --git a/SpotifyAPI.Web/Clients/Interfaces/ISpotifyClient.cs b/SpotifyAPI.Web/Clients/Interfaces/ISpotifyClient.cs
@@ -9,5 +9,7 @@ public interface ISpotifyClient
     IShowsClient Shows { get; }
 
     IPlaylistsClient Playlists { get; }
+
+    ISearchClient Search { get; }
   }
 }
diff --git a/SpotifyAPI.Web/Clients/PlaylistsClient.cs b/SpotifyAPI.Web/Clients/PlaylistsClient.cs
@@ -126,5 +126,13 @@ public async Task<bool> ChangeDetails(string playlistId, PlaylistChangeDetailsRe
       var statusCode = await API.Put(URLs.Playlist(playlistId), null, request.BuildBodyParams());
       return statusCode == HttpStatusCode.OK;
     }
+
+    public Task<SnapshotResponse> ReorderItems(string playlistId, PlaylistReorderItemsRequest request)
+    {
+      Ensure.ArgumentNotNullOrEmptyString(playlistId, nameof(playlistId));
+      Ensure.ArgumentNotNull(request, nameof(request));
+
+      return API.Put<SnapshotResponse>(URLs.PlaylistTracks(playlistId), null, request.BuildBodyParams());
+    }
   }
 }
diff --git a/SpotifyAPI.Web/Clients/SearchClient.cs b/SpotifyAPI.Web/Clients/SearchClient.cs
@@ -0,0 +1,18 @@
+using System.Threading.Tasks;
+using SpotifyAPI.Web.Http;
+using URLs = SpotifyAPI.Web.SpotifyUrls;
+
+namespace SpotifyAPI.Web
+{
+  public class SearchClient : APIClient, ISearchClient
+  {
+    public SearchClient(IAPIConnector apiConnector) : base(apiConnector) { }
+
+    public Task<SearchResponse> Item(SearchRequest request)
+    {
+      Ensure.ArgumentNotNull(request, nameof(request));
+
+      return API.Get<SearchResponse>(URLs.Search(), request.BuildQueryParams());
+    }
+  }
+}
diff --git a/SpotifyAPI.Web/Clients/SpotifyClient.cs b/SpotifyAPI.Web/Clients/SpotifyClient.cs
@@ -19,6 +19,7 @@ public SpotifyClient(SpotifyClientConfig config)
       Browse = new BrowseClient(_apiConnector);
       Shows = new ShowsClient(_apiConnector);
       Playlists = new PlaylistsClient(_apiConnector);
+      Search = new SearchClient(_apiConnector);
     }
 
     public IUserProfileClient UserProfile { get; }
@@ -28,5 +29,7 @@ public SpotifyClient(SpotifyClientConfig config)
     public IShowsClient Shows { get; }
 
     public IPlaylistsClient Playlists { get; }
+
+    public ISearchClient Search { get; }
   }
 }
diff --git a/SpotifyAPI.Web/Clients/SpotifyClientConfig.cs b/SpotifyAPI.Web/Clients/SpotifyClientConfig.cs
@@ -43,8 +43,7 @@ IHTTPLogger httpLogger
     internal IAPIConnector CreateAPIConnector()
     {
       Ensure.ArgumentNotNull(BaseAddress, nameof(BaseAddress));
-      Ensure.ArgumentNotNull(Authenticator, nameof(Authenticator),
-        ". Use WithToken or WithAuthenticator to specify a authentication");
+      Ensure.ArgumentNotNull(Authenticator, nameof(Authenticator));
       Ensure.ArgumentNotNull(JSONSerializer, nameof(JSONSerializer));
       Ensure.ArgumentNotNull(HTTPClient, nameof(HTTPClient));
 
diff --git a/SpotifyAPI.Web/Models/Request/PlaylistGetItemsRequest.cs b/SpotifyAPI.Web/Models/Request/PlaylistGetItemsRequest.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 
 namespace SpotifyAPI.Web
@@ -6,7 +7,7 @@ public class PlaylistGetItemsRequest : RequestParams
   {
     public PlaylistGetItemsRequest()
     {
-      AdditionalTypes = new List<string>() { "track", "episode" };
+      AdditionalTypes = AdditionalType.All;
     }
 
     [QueryParam("fields")]
@@ -26,6 +27,16 @@ public PlaylistGetItemsRequest()
     /// </summary>
     /// <value></value>
     [QueryParam("additional_types")]
-    public List<string> AdditionalTypes { get; set; }
+    public AdditionalType AdditionalTypes { get; set; }
+
+    [Flags]
+    public enum AdditionalType
+    {
+      [String("track")]
+      Track = 0,
+      [String("episode")]
+      Episode = 1,
+      All = Track | Episode
+    }
   }
 }
diff --git a/SpotifyAPI.Web/Models/Request/PlaylistGetRequest.cs b/SpotifyAPI.Web/Models/Request/PlaylistGetRequest.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 
 namespace SpotifyAPI.Web
@@ -6,14 +7,24 @@ public class PlaylistGetRequest : RequestParams
   {
     public PlaylistGetRequest()
     {
-      AdditionalTypes = new List<string> { "track", "episode" };
+      AdditionalTypes = AdditionalType.All;
     }
 
     /// <summary>
     ///   This is set to `"track", "episode"` by default.
     /// </summary>
     /// <value></value>
     [QueryParam("additional_types")]
-    public List<string> AdditionalTypes { get; set; }
+    public AdditionalType AdditionalTypes { get; set; }
+
+    [Flags]
+    public enum AdditionalType
+    {
+      [String("track")]
+      Track = 0,
+      [String("episode")]
+      Episode = 1,
+      All = Track | Episode
+    }
   }
 }
diff --git a/SpotifyAPI.Web/Models/Request/PlaylistRemoveItemsRequest.cs b/SpotifyAPI.Web/Models/Request/PlaylistRemoveItemsRequest.cs
@@ -5,13 +5,9 @@ namespace SpotifyAPI.Web
 {
   public class PlaylistRemoveItemsRequest : RequestParams
   {
-    public PlaylistRemoveItemsRequest(List<Item> tracks)
-    {
-      Tracks = tracks;
-    }
-
     [BodyParam("tracks")]
     public List<Item> Tracks { get; set; }
+
     [BodyParam("snapshot_id")]
     public string SnapshotId { get; set; }
 
@@ -26,8 +22,12 @@ public Item(string uri)
       {
         Uri = uri;
       }
+
       [JsonProperty("uri")]
       public string Uri { get; set; }
+
+      [JsonProperty("positions", NullValueHandling = NullValueHandling.Ignore)]
+      public List<int> Positions { get; set; }
     }
   }
 }
diff --git a/SpotifyAPI.Web/Models/Request/PlaylistReorderItemsRequest.cs b/SpotifyAPI.Web/Models/Request/PlaylistReorderItemsRequest.cs
@@ -0,0 +1,23 @@
+namespace SpotifyAPI.Web
+{
+  public class PlaylistReorderItemsRequest : RequestParams
+  {
+    [BodyParam("range_start")]
+    public int? RangeStart { get; set; }
+
+    [BodyParam("insert_before")]
+    public int? InsertBefore { get; set; }
+
+    [BodyParam("range_length")]
+    public int? RangeLength { get; set; }
+
+    [BodyParam("snapshot_id")]
+    public string SnapshotId { get; set; }
+
+    protected override void CustomEnsure()
+    {
+      Ensure.ArgumentNotNull(RangeStart, nameof(RangeStart));
+      Ensure.ArgumentNotNull(InsertBefore, nameof(InsertBefore));
+    }
+  }
+}
diff --git a/SpotifyAPI.Web/Models/Request/RequestParams.cs b/SpotifyAPI.Web/Models/Request/RequestParams.cs
@@ -47,10 +47,31 @@ public Dictionary<string, string> BuildQueryParams()
         {
           if (value is List<string>)
           {
-            List<string> list = value as List<string>;
+            var list = value as List<string>;
             var str = string.Join(",", list);
             queryParams.Add(attribute.Key ?? prop.Name, str);
           }
+          else if (value is Enum)
+          {
+            var valueAsEnum = value as Enum;
+            var enumType = valueAsEnum.GetType();
+            var valueList = new List<string>();
+
+            foreach (Enum enumVal in Enum.GetValues(valueAsEnum.GetType()))
+            {
+              if (valueAsEnum.HasFlag(enumVal))
+              {
+                if (enumType
+                  .GetMember(enumVal.ToString())[0]
+                  .GetCustomAttributes(typeof(StringAttribute))
+                  .FirstOrDefault() is StringAttribute stringAttr)
+                {
+                  valueList.Add(stringAttr.Value);
+                }
+              }
+            }
+            queryParams.Add(attribute.Key ?? prop.Name, string.Join(",", valueList));
+          }
           else
           {
             queryParams.Add(attribute.Key ?? prop.Name, value.ToString());
diff --git a/SpotifyAPI.Web/Models/Request/SearchRequest.cs b/SpotifyAPI.Web/Models/Request/SearchRequest.cs
@@ -0,0 +1,56 @@
+using System;
+
+namespace SpotifyAPI.Web
+{
+  public class SearchRequest : RequestParams
+  {
+    [QueryParam("type")]
+    public Type? Types { get; set; }
+
+    [QueryParam("q")]
+    public string Query { get; set; }
+
+    [QueryParam("market")]
+    public string Market { get; set; }
+
+    [QueryParam("limit")]
+    public int? Limit { get; set; }
+
+    [QueryParam("offset")]
+    public int? Offset { get; set; }
+
+    [QueryParam("include_external")]
+    public External? IncludeExternal { get; set; }
+
+    protected override void CustomEnsure()
+    {
+      Ensure.ArgumentNotNull(Types, nameof(Types));
+      Ensure.ArgumentNotNullOrEmptyString(Query, nameof(Query));
+    }
+
+    [Flags]
+    public enum External
+    {
+      [String("audio")]
+      Audio = 0,
+    }
+
+    [Flags]
+    public enum Type
+    {
+      [String("album")]
+      Album = 0,
+      [String("artist")]
+      Artist = 1,
+      [String("playlist")]
+      Playlist = 2,
+      [String("track")]
+      Track = 4,
+      [String("show")]
+      Show = 8,
+      [String("episode")]
+      Episode = 16,
+      All = Album | Artist | Playlist | Track | Show | Episode
+    }
+  }
+}
diff --git a/SpotifyAPI.Web/Models/Response/FullArtist.cs b/SpotifyAPI.Web/Models/Response/FullArtist.cs
@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+
+namespace SpotifyAPI.Web
+{
+  public class FullArtist
+  {
+    public Dictionary<string, string> ExternalUrls { get; set; }
+    public Followers Followers { get; set; }
+    public List<string> Genres { get; set; }
+    public string Href { get; set; }
+    public string Id { get; set; }
+    public List<Image> Images { get; set; }
+    public string Name { get; set; }
+    public int Popularity { get; set; }
+    public string Type { get; set; }
+    public string Uri { get; set; }
+  }
+}
diff --git a/SpotifyAPI.Web/Models/Response/SearchResponse.cs b/SpotifyAPI.Web/Models/Response/SearchResponse.cs
@@ -0,0 +1,11 @@
+namespace SpotifyAPI.Web
+{
+  public class SearchResponse
+  {
+    public Paging<FullArtist> Artists { get; set; }
+    public Paging<SimpleAlbum> Albums { get; set; }
+    public Paging<FullTrack> Tracks { get; set; }
+    public Paging<SimpleShow> Shows { get; set; }
+    public Paging<SimpleEpisode> Episodes { get; set; }
+  }
+}
diff --git a/SpotifyAPI.Web/SpotifyUrls.cs b/SpotifyAPI.Web/SpotifyUrls.cs
@@ -41,6 +41,8 @@ public static class SpotifyUrls
 
     public static Uri CurrentUserPlaylists() => EUri($"me/playlists");
 
+    public static Uri Search() => EUri($"search");
+
     private static Uri EUri(FormattableString path) => new Uri(path.ToString(_provider), UriKind.Relative);
   }
 }
diff --git a/SpotifyAPI.Web/Util/Ensure.cs b/SpotifyAPI.Web/Util/Ensure.cs
@@ -14,15 +14,14 @@ internal static class Ensure
     /// </summary>
     /// <param name = "value">The argument value to check</param>
     /// <param name = "name">The name of the argument</param>
-    /// <param name = "additional">Additional Exception Text</param>
-    public static void ArgumentNotNull(object value, string name, string additional = null)
+    public static void ArgumentNotNull(object value, string name)
     {
       if (value != null)
       {
         return;
       }
 
-      throw new ArgumentNullException($"{name}{additional}");
+      throw new ArgumentNullException(name);
     }
 
     /// <summary>
diff --git a/SpotifyAPI.Web/Util/StringAttribute.cs b/SpotifyAPI.Web/Util/StringAttribute.cs
@@ -0,0 +1,14 @@
+using System;
+
+namespace SpotifyAPI.Web
+{
+  public class StringAttribute : Attribute
+  {
+    public StringAttribute(string value)
+    {
+      Value = value;
+    }
+
+    public string Value { get; set; }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -29,5 +29,7 @@ public interface IPlaylistsClient`
`29`	`29`	`Task<Paging<SimplePlaylist>> CurrentUsers(PlaylistCurrentUsersRequest request);`
`30`	`30`
`31`	`31`	`Task<bool> ChangeDetails(string playlistId, PlaylistChangeDetailsRequest request);`
	`32`	`+`
	`33`	`+ Task<SnapshotResponse> ReorderItems(string playlistId, PlaylistReorderItemsRequest request);`
`32`	`34`	`}`
`33`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,7 @@ public interface ISpotifyClient`
`9`	`9`	`IShowsClient Shows { get; }`
`10`	`10`
`11`	`11`	`IPlaylistsClient Playlists { get; }`
	`12`	`+`
	`13`	`+ ISearchClient Search { get; }`
`12`	`14`	`}`
`13`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,5 +126,13 @@ public async Task<bool> ChangeDetails(string playlistId, PlaylistChangeDetailsRe`
`126`	`126`	`var statusCode = await API.Put(URLs.Playlist(playlistId), null, request.BuildBodyParams());`
`127`	`127`	`return statusCode == HttpStatusCode.OK;`
`128`	`128`	`}`
	`129`	`+`
	`130`	`+ public Task<SnapshotResponse> ReorderItems(string playlistId, PlaylistReorderItemsRequest request)`
	`131`	`+ {`
	`132`	`+ Ensure.ArgumentNotNullOrEmptyString(playlistId, nameof(playlistId));`
	`133`	`+ Ensure.ArgumentNotNull(request, nameof(request));`
	`134`	`+`
	`135`	`+ return API.Put<SnapshotResponse>(URLs.PlaylistTracks(playlistId), null, request.BuildBodyParams());`
	`136`	`+ }`
`129`	`137`	`}`
`130`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ public SpotifyClient(SpotifyClientConfig config)`
`19`	`19`	`Browse = new BrowseClient(_apiConnector);`
`20`	`20`	`Shows = new ShowsClient(_apiConnector);`
`21`	`21`	`Playlists = new PlaylistsClient(_apiConnector);`
	`22`	`+ Search = new SearchClient(_apiConnector);`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`public IUserProfileClient UserProfile { get; }`
`@@ -28,5 +29,7 @@ public SpotifyClient(SpotifyClientConfig config)`
`28`	`29`	`public IShowsClient Shows { get; }`
`29`	`30`
`30`	`31`	`public IPlaylistsClient Playlists { get; }`
	`32`	`+`
	`33`	`+ public ISearchClient Search { get; }`
`31`	`34`	`}`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,7 @@ IHTTPLogger httpLogger`
`43`	`43`	`internal IAPIConnector CreateAPIConnector()`
`44`	`44`	`{`
`45`	`45`	`Ensure.ArgumentNotNull(BaseAddress, nameof(BaseAddress));`
`46`		`- Ensure.ArgumentNotNull(Authenticator, nameof(Authenticator),`
`47`		`- ". Use WithToken or WithAuthenticator to specify a authentication");`
	`46`	`+ Ensure.ArgumentNotNull(Authenticator, nameof(Authenticator));`
`48`	`47`	`Ensure.ArgumentNotNull(JSONSerializer, nameof(JSONSerializer));`
`49`	`48`	`Ensure.ArgumentNotNull(HTTPClient, nameof(HTTPClient));`
`50`	`49`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System;`
`1`	`2`	`using System.Collections.Generic;`
`2`	`3`
`3`	`4`	`namespace SpotifyAPI.Web`
`@@ -6,7 +7,7 @@ public class PlaylistGetItemsRequest : RequestParams`
`6`	`7`	`{`
`7`	`8`	`public PlaylistGetItemsRequest()`
`8`	`9`	`{`
`9`		`- AdditionalTypes = new List<string>() { "track", "episode" };`
	`10`	`+ AdditionalTypes = AdditionalType.All;`
`10`	`11`	`}`
`11`	`12`
`12`	`13`	`[QueryParam("fields")]`
`@@ -26,6 +27,16 @@ public PlaylistGetItemsRequest()`
`26`	`27`	`/// </summary>`
`27`	`28`	`/// <value></value>`
`28`	`29`	`[QueryParam("additional_types")]`
`29`		`- public List<string> AdditionalTypes { get; set; }`
	`30`	`+ public AdditionalType AdditionalTypes { get; set; }`
	`31`	`+`
	`32`	`+ [Flags]`
	`33`	`+ public enum AdditionalType`
	`34`	`+ {`
	`35`	`+ [String("track")]`
	`36`	`+ Track = 0,`
	`37`	`+ [String("episode")]`
	`38`	`+ Episode = 1,`
	`39`	`+ All = Track \| Episode`
	`40`	`+ }`
`30`	`41`	`}`
`31`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,9 @@ namespace SpotifyAPI.Web`
`5`	`5`	`{`
`6`	`6`	`public class PlaylistRemoveItemsRequest : RequestParams`
`7`	`7`	`{`
`8`		`- public PlaylistRemoveItemsRequest(List<Item> tracks)`
`9`		`- {`
`10`		`- Tracks = tracks;`
`11`		`- }`
`12`		`-`
`13`	`8`	`[BodyParam("tracks")]`
`14`	`9`	`public List<Item> Tracks { get; set; }`
	`10`	`+`
`15`	`11`	`[BodyParam("snapshot_id")]`
`16`	`12`	`public string SnapshotId { get; set; }`
`17`	`13`
`@@ -26,8 +22,12 @@ public Item(string uri)`
`26`	`22`	`{`
`27`	`23`	`Uri = uri;`
`28`	`24`	`}`
	`25`	`+`
`29`	`26`	`[JsonProperty("uri")]`
`30`	`27`	`public string Uri { get; set; }`
	`28`	`+`
	`29`	`+ [JsonProperty("positions", NullValueHandling = NullValueHandling.Ignore)]`
	`30`	`+ public List<int> Positions { get; set; }`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`	`}`