Add ToString() method to fluent API requests.

src/Hqub.MusicBrainz.Client/Example6.cs

@@ -60,20 +60,34 @@ public static async Task Search(MusicBrainzClient client, string genre, int limi
 
             for (; i < pages && i < MAX_PAGES; i++)
             {
-                // Try to avoid rate limit ...
-                await Task.Delay(1000);
+                // Advance browse offset.
+                request.Offset(i * limit);
 
-                // Advance browse offset and fetch results.
+                // Check if the request is in cache.
+                bool cached = await client.Cache.Contains(request.ToString());
+
+                if (!cached)
+                {
+                    // Try to avoid MusicBrainz rate limit ...
+                    await Task.Delay(1000);
+                }
+
+                // Fetch results.
                 groups = await request.Offset(i * limit).GetAsync();
 
                 DisplayReleases(groups, i + 1, pages);
             }
 
+            Console.WriteLine();
+
             if (i == MAX_PAGES)
             {
-                Console.WriteLine();
                 Console.WriteLine("Stopping at page {0} ...", i);
             }
+            else
+            {
+                Console.WriteLine("Done ...");
+            }
         }
 
         private static void DisplayArtists(ArtistList artists)

src/Hqub.MusicBrainz/Services/BrowseRequest.cs

@@ -1,15 +1,14 @@
 namespace Hqub.MusicBrainz.Services
 {
     using Hqub.MusicBrainz.Entities.Collections;
-    using System;
     using System.Threading;
     using System.Threading.Tasks;
 
     /// <summary>
-    /// Prepare a browse request to the MusicBrainz webservice.
+    /// Prepare a browse request to the MusicBrainz web service.
     /// </summary>
     /// <typeparam name="T">Any supported MusicBrainz entity.</typeparam>
-    public class BrowseRequest<T>
+    public abstract class BrowseRequest<T>
     {
         private readonly MusicBrainzClient client;
 
@@ -83,7 +82,7 @@ public BrowseRequest<T> Offset(int offset)
         }
 
         /// <summary>
-        /// Set the type of release or release-group to browse.
+        /// Set the type of the release or release-group to browse.
         /// </summary>
         /// <param name="type">The release type (for example 'album').</param>
         /// <returns></returns>
@@ -97,7 +96,7 @@ public BrowseRequest<T> Type(string type)
         }
 
         /// <summary>
-        /// Set the status of release to browse.
+        /// Set the status of the release to browse.
         /// </summary>
         /// <param name="status">The release status (for example 'official').</param>
         /// <returns></returns>
@@ -123,10 +122,12 @@ public async Task<T> GetAsync(CancellationToken ct = default)
         /// <summary>
         /// Initiate the actual request.
         /// </summary>
-        protected virtual Task<T> BrowseAsync(MusicBrainzClient client, CancellationToken ct)
-        {
-            throw new NotImplementedException();
-        }
+        protected abstract Task<T> BrowseAsync(MusicBrainzClient client, CancellationToken ct);
+
+        /// <summary>
+        /// Returns the request path.
+        /// </summary>
+        public abstract override string ToString();
     }
 
     #region Helper classes
@@ -138,6 +139,7 @@ public ArtistBrowseRequest(MusicBrainzClient client, UrlBuilder builder, string
         {
         }
 
+        /// <inheritdoc />
         protected override async Task<ArtistList> BrowseAsync(MusicBrainzClient client, CancellationToken ct)
         {
             string url = builder.CreateBrowseUrl(EntityName, relatedEntity, id, limit, offset, include);
@@ -146,6 +148,12 @@ protected override async Task<ArtistList> BrowseAsync(MusicBrainzClient client,
 
             return new ArtistList() { Items = list.Items, Count = list.Count, Offset = list.Offset };
         }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return builder.CreateBrowseUrl(EntityName, relatedEntity, id, limit, offset, include);
+        }
     }
 
     class RecordingBrowseRequest : BrowseRequest<RecordingList>
@@ -155,6 +163,7 @@ public RecordingBrowseRequest(MusicBrainzClient client, UrlBuilder builder, stri
         {
         }
 
+        /// <inheritdoc />
         protected override async Task<RecordingList> BrowseAsync(MusicBrainzClient client, CancellationToken ct)
         {
             string url = builder.CreateBrowseUrl(EntityName, relatedEntity, id, limit, offset, include);
@@ -163,6 +172,12 @@ protected override async Task<RecordingList> BrowseAsync(MusicBrainzClient clien
 
             return new RecordingList() { Items = list.Items, Count = list.Count, Offset = list.Offset };
         }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return builder.CreateBrowseUrl(EntityName, relatedEntity, id, limit, offset, include);
+        }
     }
 
     class ReleaseGroupBrowseRequest : BrowseRequest<ReleaseGroupList>
@@ -172,6 +187,7 @@ public ReleaseGroupBrowseRequest(MusicBrainzClient client, UrlBuilder builder, s
         {
         }
 
+        /// <inheritdoc />
         protected override async Task<ReleaseGroupList> BrowseAsync(MusicBrainzClient client, CancellationToken ct)
         {
             string url = builder.CreateBrowseUrl(EntityName, relatedEntity, id, type, null, limit, offset, include);
@@ -180,6 +196,12 @@ protected override async Task<ReleaseGroupList> BrowseAsync(MusicBrainzClient cl
 
             return new ReleaseGroupList() { Items = list.Items, Count = list.Count, Offset = list.Offset };
         }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return builder.CreateBrowseUrl(EntityName, relatedEntity, id, type, null, limit, offset, include);
+        }
     }
 
     class ReleaseBrowseRequest : BrowseRequest<ReleaseList>
@@ -189,6 +211,7 @@ public ReleaseBrowseRequest(MusicBrainzClient client, UrlBuilder builder, string
         {
         }
 
+        /// <inheritdoc />
         protected override async Task<ReleaseList> BrowseAsync(MusicBrainzClient client, CancellationToken ct)
         {
             string url = builder.CreateBrowseUrl(EntityName, relatedEntity, id, type, status, limit, offset, include);
@@ -197,6 +220,12 @@ protected override async Task<ReleaseList> BrowseAsync(MusicBrainzClient client,
 
             return new ReleaseList() { Items = list.Items, Count = list.Count, Offset = list.Offset };
         }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return builder.CreateBrowseUrl(EntityName, relatedEntity, id, type, status, limit, offset, include);
+        }
     }
 
     #endregion

src/Hqub.MusicBrainz/Services/LookupRequest.cs

@@ -5,7 +5,7 @@
     using System.Threading.Tasks;
 
     /// <summary>
-    /// Prepare a lookup request to the MusicBrainz webservice.
+    /// Prepare a lookup request to the MusicBrainz web service.
     /// </summary>
     /// <typeparam name="T">Any supported MusicBrainz entity.</typeparam>
     public class LookupRequest<T>
@@ -54,5 +54,13 @@ public async Task<T> GetAsync(CancellationToken ct = default)
 
             return await client.GetAsync<T>(url, ct);
         }
+
+        /// <summary>
+        /// Returns the request path.
+        /// </summary>
+        public override string ToString()
+        {
+            return builder.CreateLookupUrl(EntityName, id, include);
+        }
     }
 }

src/Hqub.MusicBrainz/Services/SearchRequest.cs

@@ -5,7 +5,7 @@
     using System.Threading.Tasks;
 
     /// <summary>
-    /// Prepare a search request to the MusicBrainz webservice.
+    /// Prepare a search request to the MusicBrainz web service.
     /// </summary>
     /// <typeparam name="T">Any supported MusicBrainz entity.</typeparam>
     public class SearchRequest<T>
@@ -77,5 +77,13 @@ public async Task<T> GetAsync(CancellationToken ct = default)
 
             return await client.GetAsync<T>(url, ct);
         }
+
+        /// <summary>
+        /// Returns the request path.
+        /// </summary>
+        public override string ToString()
+        {
+            return builder.CreateSearchUrl(EntityName, query, limit, offset);
+        }
     }
 }