Added Rate limited exception

craftersmine.SteamGridDB.Net.SampleClient/craftersmine.SteamGridDB.Net.SampleClient.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="craftersmine.SteamGridDB.Net" Version="1.1.2" />
+    <ProjectReference Include="..\craftersmine.SteamGridDB.Net\craftersmine.SteamGridDB.Net.csproj" />
   </ItemGroup>
 
 </Project>

craftersmine.SteamGridDB.Net/Exceptions/SteamGridDbException.cs

@@ -76,6 +76,10 @@ public enum ExceptionType
         /// </summary>
         Forbidden = 403,
         /// <summary>
+        /// When you are rate limited on the server
+        /// </summary>
+        RateLimited = 429,
+        /// <summary>
         /// When unknown error occurred
         /// </summary>
         Unknown = 0

craftersmine.SteamGridDB.Net/Exceptions/SteamGridDbRateLimitedException.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+using System.Text;
+
+namespace craftersmine.SteamGridDBNet.Exceptions
+{
+    /// <summary>
+    /// The exception that is thrown when you are being rate-limited on server
+    /// </summary>
+    [Serializable]
+    public class SteamGridDbRateLimitedException : SteamGridDbException
+    {
+        public TimeSpan RetryAfter { get; private set; }
+
+        /// <inheritdoc cref="SteamGridDbException"/>
+        public SteamGridDbRateLimitedException(TimeSpan retryAfter)
+        {
+            RetryAfter = retryAfter;
+        }
+
+        /// <inheritdoc cref="SteamGridDbException"/>
+        public SteamGridDbRateLimitedException(string message, TimeSpan retryAfter) : base(message)
+        {
+            RetryAfter = retryAfter;
+        }
+
+        /// <inheritdoc cref="SteamGridDbException"/>
+        public SteamGridDbRateLimitedException(string message, TimeSpan retryAfter, Exception inner) : base(message, inner)
+        {
+            RetryAfter = retryAfter;
+        }
+
+        /// <inheritdoc cref="SteamGridDbException"/>
+        protected SteamGridDbRateLimitedException(
+            SerializationInfo info,
+            StreamingContext context) : base(info, context)
+        {
+        }
+    }
+}

craftersmine.SteamGridDB.Net/Resources/Resources.resx

@@ -150,6 +150,9 @@
   <data name="Exception.NotFound" xml:space="preserve">
     <value>Requested grid/hero/icon/logo/game not found on SteamGridDB.</value>
   </data>
+  <data name="Exception.RateLimited" xml:space="preserve">
+    <value>You are rate limited by the server! Retry after: {0}</value>
+  </data>
   <data name="Exception.Unauthorized" xml:space="preserve">
     <value>Unauthorized request to SteamGridDB. Probably due to missing or invalid API key.</value>
   </data>

craftersmine.SteamGridDB.Net/SteamGridDbObject.cs

@@ -108,6 +108,7 @@ public class SteamGridDbObject
         /// <returns></returns>
         /// <exception cref="SteamGridDbException">When unknown exception occurred</exception>
         /// <exception cref="SteamGridDbImageException">When error occurred while downloading image</exception>
+        /// <exception cref="SteamGridDbRateLimitedException">When you've been rate limited by the server</exception>
         /// <exception cref="ArgumentNullException">When image URL is null</exception>
         public async Task<Stream> GetImageAsStreamAsync(bool thumbnail)
         {
@@ -131,6 +132,13 @@ public async Task<Stream> GetImageAsStreamAsync(bool thumbnail)
                     if (respObj is null)
                         throw new SteamGridDbImageException(ExceptionType.Unknown,
                             Resources.Resources.Exception_UnknownImageException);
+
+                    if (!(resp.Headers.RetryAfter is null) && resp.Headers.RetryAfter.Delta.HasValue)
+                    {
+                        throw new SteamGridDbRateLimitedException(
+                            string.Format(Resources.Resources.Exception_RateLimited,
+                                resp.Headers.RetryAfter.Delta.ToString()), resp.Headers.RetryAfter.Delta.Value) {ExceptionType = ExceptionType.RateLimited };
+                    }
 
                     switch (resp.StatusCode)
                     {
@@ -162,6 +170,9 @@ public async Task<Stream> GetImageAsStreamAsync(bool thumbnail)
         /// Downloads full image to specified file
         /// </summary>
         /// <param name="filePath">Full path of file to download</param>
+        /// <exception cref="SteamGridDbException">When unknown exception occurred</exception>
+        /// <exception cref="SteamGridDbImageException">When error occurred while downloading image</exception>
+        /// <exception cref="SteamGridDbRateLimitedException">When you've been rate limited by the server</exception>
         /// <exception cref="UnauthorizedAccessException">When access to file is forbidden</exception>
         /// <exception cref="ArgumentException">When path is empty, null, has only whitespaces or has invalid characters</exception>
         /// <exception cref="ArgumentNullException">When path is empty, null or has only whitespaces</exception>
@@ -181,6 +192,9 @@ public async void DownloadToFileAsync(string filePath)
         /// Downloads thumbnail image to specified file
         /// </summary>
         /// <param name="filePath">Full path of file to download</param>
+        /// <exception cref="SteamGridDbException">When unknown exception occurred</exception>
+        /// <exception cref="SteamGridDbImageException">When error occurred while downloading image</exception>
+        /// <exception cref="SteamGridDbRateLimitedException">When you've been rate limited by the server</exception>
         /// <exception cref="UnauthorizedAccessException">When access to file is forbidden</exception>
         /// <exception cref="ArgumentException">When path is empty, null, has only whitespaces or has invalid characters</exception>
         /// <exception cref="ArgumentNullException">When path is empty, null or has only whitespaces</exception>
@@ -204,6 +218,7 @@ public async void DownloadThumbnailToFileAsync(string filePath)
         /// <exception cref="SteamGridDbUnauthorizedException">When your API key is invalid, not set, or you've reset it on API preferences page and use old one</exception>
         /// <exception cref="SteamGridDbBadRequestException">When library makes invalid request to server due to invalid URI generated</exception>
         /// <exception cref="SteamGridDbForbiddenException">When you don't have permissions to perform action on item, probably because you don't own item</exception>
+        /// <exception cref="SteamGridDbRateLimitedException">When you've been rate limited by the server</exception>
         /// <exception cref="SteamGridDbException">When unknown exception occurred in request</exception>
         public async Task<bool> DeleteFromServerAsync()
         {

craftersmine.SteamGridDB.Net/craftersmine.SteamGridDB.Net.csproj

@@ -5,7 +5,7 @@
 	  <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <RootNamespace>craftersmine.SteamGridDBNet</RootNamespace>
-    <Version>1.1.3</Version>
+    <Version>1.1.4</Version>
     <Authors>craftersmine</Authors>
     <Description>A .NET implementation of SteamGridDB API</Description>
     <Copyright>Copyright © craftersmine 2022</Copyright>
@@ -18,8 +18,7 @@
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
     <IncludeSymbols>True</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-	  <DebugSymbols>True</DebugSymbols>
-	  <DebugType>full</DebugType>
+      <DebugType>portable</DebugType>
   </PropertyGroup>
 
 	<ItemGroup>