Made more fields nullable, they can be excluded using fields query param, fixes #477

JohnnyCrazy · JohnnyCrazy · commit f3c8a9d620a9 · 2020-07-13T16:03:19.000+02:00
diff --git a/SpotifyAPI.Web.Examples/Example.ASPBlazor/Pages/Index.razor b/SpotifyAPI.Web.Examples/Example.ASPBlazor/Pages/Index.razor
@@ -26,7 +26,7 @@ else
 
   private PrivateUser _me;
 
-  private int _totalPlaylistCount;
+  private int? _totalPlaylistCount;
 
   protected override void OnInitialized()
   {
diff --git a/SpotifyAPI.Web.Examples/Example.BlazorWASM/Pages/Index.razor b/SpotifyAPI.Web.Examples/Example.BlazorWASM/Pages/Index.razor
@@ -33,7 +33,7 @@ else
 
   private PrivateUser _me;
 
-  private int _totalPlaylistCount;
+  private int? _totalPlaylistCount;
 
   private Uri _authUri;
 
diff --git a/SpotifyAPI.Web/Clients/SimplePaginator.cs b/SpotifyAPI.Web/Clients/SimplePaginator.cs
@@ -64,6 +64,10 @@ public async IAsyncEnumerable<T> Paginate<T>(
     {
       Ensure.ArgumentNotNull(firstPage, nameof(firstPage));
       Ensure.ArgumentNotNull(connector, nameof(connector));
+      if (firstPage.Items == null)
+      {
+        throw new ArgumentException("The first page has to contain an Items list!", nameof(firstPage));
+      }
 
       var page = firstPage;
       foreach (var item in page.Items)
@@ -73,7 +77,7 @@ public async IAsyncEnumerable<T> Paginate<T>(
       while (page.Next != null)
       {
         page = await connector.Get<Paging<T>>(new Uri(page.Next, UriKind.Absolute)).ConfigureAwait(false);
-        foreach (var item in page.Items)
+        foreach (var item in page.Items!)
         {
           yield return item;
         }
@@ -89,6 +93,10 @@ public async IAsyncEnumerable<T> Paginate<T, TNext>(
       Ensure.ArgumentNotNull(firstPage, nameof(firstPage));
       Ensure.ArgumentNotNull(mapper, nameof(mapper));
       Ensure.ArgumentNotNull(connector, nameof(connector));
+      if (firstPage.Items == null)
+      {
+        throw new ArgumentException("The first page has to contain an Items list!", nameof(firstPage));
+      }
 
       var page = firstPage;
       foreach (var item in page.Items)
@@ -99,7 +107,7 @@ public async IAsyncEnumerable<T> Paginate<T, TNext>(
       {
         var next = await connector.Get<TNext>(new Uri(page.Next, UriKind.Absolute)).ConfigureAwait(false);
         page = mapper(next);
-        foreach (var item in page.Items)
+        foreach (var item in page.Items!)
         {
           yield return item;
         }
diff --git a/SpotifyAPI.Web/Models/IPaginatable.cs b/SpotifyAPI.Web/Models/IPaginatable.cs
@@ -5,17 +5,17 @@ namespace SpotifyAPI.Web
   public interface IPaginatable<T>
   {
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
-    string Next { get; set; }
+    string? Next { get; set; }
 
-    List<T> Items { get; set; }
+    List<T>? Items { get; set; }
   }
 
   public interface IPaginatable<T, TNext>
   {
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
-    string Next { get; set; }
+    string? Next { get; set; }
 
-    List<T> Items { get; set; }
+    List<T>? Items { get; set; }
   }
 }
 
diff --git a/SpotifyAPI.Web/Models/Request/RequestParams.cs b/SpotifyAPI.Web/Models/Request/RequestParams.cs
@@ -122,7 +122,8 @@ private void AddQueryParam(Dictionary<string, string> queryParams, PropertyInfo
               {
                 if (StringAttribute.GetValue(enumType, enumVal, out var stringVal))
                 {
-                  valueList.Add(stringVal);
+                  // .netstandard2.0 requires !
+                  valueList.Add(stringVal!);
                 }
               }
             }
@@ -131,7 +132,8 @@ private void AddQueryParam(Dictionary<string, string> queryParams, PropertyInfo
           {
             if (StringAttribute.GetValue(enumType, valueAsEnum, out var stringVal))
             {
-              valueList.Add(stringVal);
+              // .netstandard2.0 requires !
+              valueList.Add(stringVal!);
             }
           }
           queryParams.Add(attribute.Key ?? prop.Name, string.Join(",", valueList));
diff --git a/SpotifyAPI.Web/Models/Response/CursorPaging.cs b/SpotifyAPI.Web/Models/Response/CursorPaging.cs
@@ -5,19 +5,19 @@ namespace SpotifyAPI.Web
   public class CursorPaging<T> : IPaginatable<T>
   {
     public string Href { get; set; } = default!;
-    public List<T> Items { get; set; } = default!;
+    public List<T>? Items { get; set; } = default!;
     public int Limit { get; set; }
-    public string Next { get; set; } = default!;
+    public string? Next { get; set; } = default!;
     public Cursor Cursors { get; set; } = default!;
     public int Total { get; set; }
   }
 
   public class CursorPaging<T, TNext> : IPaginatable<T, TNext>
   {
     public string Href { get; set; } = default!;
-    public List<T> Items { get; set; } = default!;
+    public List<T>? Items { get; set; } = default!;
     public int Limit { get; set; }
-    public string Next { get; set; } = default!;
+    public string? Next { get; set; } = default!;
     public Cursor Cursors { get; set; } = default!;
     public int Total { get; set; }
   }
diff --git a/SpotifyAPI.Web/Models/Response/FullPlaylist.cs b/SpotifyAPI.Web/Models/Response/FullPlaylist.cs
@@ -3,23 +3,23 @@ namespace SpotifyAPI.Web
 {
   public class FullPlaylist
   {
-    public bool Collaborative { get; set; }
-    public Dictionary<string, string> ExternalUrls { get; set; } = default!;
-    public string Href { get; set; } = default!;
-    public string Id { get; set; } = default!;
-    public List<Image> Images { get; set; } = default!;
-    public string Name { get; set; } = default!;
-    public PublicUser Owner { get; set; } = default!;
-    public bool Public { get; set; }
-    public string SnapshotId { get; set; } = default!;
+    public bool? Collaborative { get; set; }
+    public Dictionary<string, string>? ExternalUrls { get; set; } = default!;
+    public string? Href { get; set; } = default!;
+    public string? Id { get; set; } = default!;
+    public List<Image>? Images { get; set; } = default!;
+    public string? Name { get; set; } = default!;
+    public PublicUser? Owner { get; set; } = default!;
+    public bool? Public { get; set; }
+    public string? SnapshotId { get; set; } = default!;
 
     /// <summary>
     /// A list of PlaylistTracks, which items can be a FullTrack or FullEpisode
     /// </summary>
     /// <value></value>
-    public Paging<PlaylistTrack<IPlayableItem>> Tracks { get; set; } = default!;
-    public string Type { get; set; } = default!;
-    public string Uri { get; set; } = default!;
+    public Paging<PlaylistTrack<IPlayableItem>>? Tracks { get; set; } = default!;
+    public string? Type { get; set; } = default!;
+    public string? Uri { get; set; } = default!;
   }
 }
 
diff --git a/SpotifyAPI.Web/Models/Response/Paging.cs b/SpotifyAPI.Web/Models/Response/Paging.cs
@@ -4,24 +4,24 @@ namespace SpotifyAPI.Web
 {
   public class Paging<T> : IPaginatable<T>
   {
-    public string Href { get; set; } = default!;
-    public List<T> Items { get; set; } = default!;
-    public int Limit { get; set; }
-    public string Next { get; set; } = default!;
-    public int Offset { get; set; }
-    public string Previous { get; set; } = default!;
-    public int Total { get; set; }
+    public string? Href { get; set; } = default!;
+    public List<T>? Items { get; set; } = default!;
+    public int? Limit { get; set; } = default!;
+    public string? Next { get; set; } = default!;
+    public int? Offset { get; set; } = default!;
+    public string? Previous { get; set; } = default!;
+    public int? Total { get; set; } = default!;
   }
 
   public class Paging<T, TNext> : IPaginatable<T, TNext>
   {
-    public string Href { get; set; } = default!;
-    public List<T> Items { get; set; } = default!;
-    public int Limit { get; set; }
-    public string Next { get; set; } = default!;
-    public int Offset { get; set; }
-    public string Previous { get; set; } = default!;
-    public int Total { get; set; }
+    public string? Href { get; set; } = default!;
+    public List<T>? Items { get; set; } = default!;
+    public int? Limit { get; set; } = default!;
+    public string? Next { get; set; } = default!;
+    public int? Offset { get; set; } = default!;
+    public string? Previous { get; set; } = default!;
+    public int? Total { get; set; } = default!;
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ else`
`26`	`26`
`27`	`27`	`private PrivateUser _me;`
`28`	`28`
`29`		`- private int _totalPlaylistCount;`
	`29`	`+ private int? _totalPlaylistCount;`
`30`	`30`
`31`	`31`	`protected override void OnInitialized()`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,10 @@ public async IAsyncEnumerable<T> Paginate<T>(`
`64`	`64`	`{`
`65`	`65`	`Ensure.ArgumentNotNull(firstPage, nameof(firstPage));`
`66`	`66`	`Ensure.ArgumentNotNull(connector, nameof(connector));`
	`67`	`+ if (firstPage.Items == null)`
	`68`	`+ {`
	`69`	`+ throw new ArgumentException("The first page has to contain an Items list!", nameof(firstPage));`
	`70`	`+ }`
`67`	`71`
`68`	`72`	`var page = firstPage;`
`69`	`73`	`foreach (var item in page.Items)`
`@@ -73,7 +77,7 @@ public async IAsyncEnumerable<T> Paginate<T>(`
`73`	`77`	`while (page.Next != null)`
`74`	`78`	`{`
`75`	`79`	`page = await connector.Get<Paging<T>>(new Uri(page.Next, UriKind.Absolute)).ConfigureAwait(false);`
`76`		`- foreach (var item in page.Items)`
	`80`	`+ foreach (var item in page.Items!)`
`77`	`81`	`{`
`78`	`82`	`yield return item;`
`79`	`83`	`}`
`@@ -89,6 +93,10 @@ public async IAsyncEnumerable<T> Paginate<T, TNext>(`
`89`	`93`	`Ensure.ArgumentNotNull(firstPage, nameof(firstPage));`
`90`	`94`	`Ensure.ArgumentNotNull(mapper, nameof(mapper));`
`91`	`95`	`Ensure.ArgumentNotNull(connector, nameof(connector));`
	`96`	`+ if (firstPage.Items == null)`
	`97`	`+ {`
	`98`	`+ throw new ArgumentException("The first page has to contain an Items list!", nameof(firstPage));`
	`99`	`+ }`
`92`	`100`
`93`	`101`	`var page = firstPage;`
`94`	`102`	`foreach (var item in page.Items)`
`@@ -99,7 +107,7 @@ public async IAsyncEnumerable<T> Paginate<T, TNext>(`
`99`	`107`	`{`
`100`	`108`	`var next = await connector.Get<TNext>(new Uri(page.Next, UriKind.Absolute)).ConfigureAwait(false);`
`101`	`109`	`page = mapper(next);`
`102`		`- foreach (var item in page.Items)`
	`110`	`+ foreach (var item in page.Items!)`
`103`	`111`	`{`
`104`	`112`	`yield return item;`
`105`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,17 +5,17 @@ namespace SpotifyAPI.Web`
`5`	`5`	`public interface IPaginatable<T>`
`6`	`6`	`{`
`7`	`7`	`[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]`
`8`		`- string Next { get; set; }`
	`8`	`+ string? Next { get; set; }`
`9`	`9`
`10`		`- List<T> Items { get; set; }`
	`10`	`+ List<T>? Items { get; set; }`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public interface IPaginatable<T, TNext>`
`14`	`14`	`{`
`15`	`15`	`[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]`
`16`		`- string Next { get; set; }`
	`16`	`+ string? Next { get; set; }`
`17`	`17`
`18`		`- List<T> Items { get; set; }`
	`18`	`+ List<T>? Items { get; set; }`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,8 @@ private void AddQueryParam(Dictionary<string, string> queryParams, PropertyInfo`
`122`	`122`	`{`
`123`	`123`	`if (StringAttribute.GetValue(enumType, enumVal, out var stringVal))`
`124`	`124`	`{`
`125`		`- valueList.Add(stringVal);`
	`125`	`+ // .netstandard2.0 requires !`
	`126`	`+ valueList.Add(stringVal!);`
`126`	`127`	`}`
`127`	`128`	`}`
`128`	`129`	`}`
`@@ -131,7 +132,8 @@ private void AddQueryParam(Dictionary<string, string> queryParams, PropertyInfo`
`131`	`132`	`{`
`132`	`133`	`if (StringAttribute.GetValue(enumType, valueAsEnum, out var stringVal))`
`133`	`134`	`{`
`134`		`- valueList.Add(stringVal);`
	`135`	`+ // .netstandard2.0 requires !`
	`136`	`+ valueList.Add(stringVal!);`
`135`	`137`	`}`
`136`	`138`	`}`
`137`	`139`	`queryParams.Add(attribute.Key ?? prop.Name, string.Join(",", valueList));`
Original file line number	Diff line number	Diff line change
`@@ -5,19 +5,19 @@ namespace SpotifyAPI.Web`
`5`	`5`	`public class CursorPaging<T> : IPaginatable<T>`
`6`	`6`	`{`
`7`	`7`	`public string Href { get; set; } = default!;`
`8`		`- public List<T> Items { get; set; } = default!;`
	`8`	`+ public List<T>? Items { get; set; } = default!;`
`9`	`9`	`public int Limit { get; set; }`
`10`		`- public string Next { get; set; } = default!;`
	`10`	`+ public string? Next { get; set; } = default!;`
`11`	`11`	`public Cursor Cursors { get; set; } = default!;`
`12`	`12`	`public int Total { get; set; }`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`public class CursorPaging<T, TNext> : IPaginatable<T, TNext>`
`16`	`16`	`{`
`17`	`17`	`public string Href { get; set; } = default!;`
`18`		`- public List<T> Items { get; set; } = default!;`
	`18`	`+ public List<T>? Items { get; set; } = default!;`
`19`	`19`	`public int Limit { get; set; }`
`20`		`- public string Next { get; set; } = default!;`
	`20`	`+ public string? Next { get; set; } = default!;`
`21`	`21`	`public Cursor Cursors { get; set; } = default!;`
`22`	`22`	`public int Total { get; set; }`
`23`	`23`	`}`