Merge pull request #8 from TechNobre/develop

Deploy nuget version 1.2.0

Author: NelsonBN

CHANGELOG.md

@@ -3,13 +3,40 @@
 
 
 
+## [1.2.0] - 2022-03-02
+[Full Changelog](https://github.com/TechNobre/PowerUtils.Net.Primitives/compare/v1.1.1...v1.2.0)
+
+
+### New Features
+
+- Added constant for Status Code I'm a teapot 418;
+- Added constant for Status Code Too Early 425;
+- Added constant for Status Code Precondition Required 428;
+- Added constant for Status Code Too Many Requests 429;
+- Added constant for Status Code Request Header Fields Too Large 431;
+- Added constant for Status Code Unavailable For Legal Reasons 451;
+- Added constant for Status Code Variant Also Negotiates 506;
+- Added constant for Status Code Insufficient Storage 507;
+- Added constant for Status Code Loop Detected 508;
+- Added constant for Status Code Not Extended 510;
+- Added constant for Status Code Network Authentication Required 511;
+- Added utils `int.GetStatusCodeLinkOrDefault()`;
+
+
+### Fixed
+
+- Fixed methods documentation;
+
+
+
+
 ## [1.1.1] - 2022-02-25
 [Full Changelog](https://github.com/TechNobre/PowerUtils.Net.Primitives/compare/v1.1.0...v1.1.1)
 
 
-### New Features
+### Fixed
 
-- Fixed link for status code UNPROCESSABLE_ENTITY  422;
+- Fixed link for status code Unprocessable Entity 422;
 
 
 
@@ -20,7 +47,7 @@
 
 ### New Features
 
-- Added constant for Status Code UNPROCESSABLE ENTITY 422;
+- Added constant for Status Code Unprocessable Entity 422;
 
 
 ### Enhancements

README.md

@@ -72,18 +72,30 @@ dotnet add package PowerUtils.Net.Primitives
   - `StatusCodeLink.UNSUPPORTED_MEDIA_TYPE`;
   - `StatusCodeLink.REQUESTED_RANGE_NOT_SATISFIABLE`;
   - `StatusCodeLink.EXPECTATION_FAILED`;
+  - `StatusCodeLink.I_AM_A_TEAPOT`;
   - `StatusCodeLink.UNPROCESSABLE_ENTITY`;
+  - `StatusCodeLink.TOO_EARLY`;
   - `StatusCodeLink.UPGRADE_REQUIRED`;
+  - `StatusCodeLink.PRECONDITION_REQUIRED`;
+  - `StatusCodeLink.TOO_MANY_REQUESTS`;
+  - `StatusCodeLink.REQUEST_HEADER_FIELDS_TOO_LARGE`;
+  - `StatusCodeLink.UNAVAILABLE_FOR_LEGAL_REASONS`;
   - `StatusCodeLink.INTERNAL_SERVER_ERROR`;
   - `StatusCodeLink.NOT_IMPLEMENTED`;
   - `StatusCodeLink.BAD_GATEWAY`;
   - `StatusCodeLink.SERVICE_UNAVAILABLE`;
   - `StatusCodeLink.GATEWAY_TIMEOUT`;
   - `StatusCodeLink.HTTP_VERSION_NOT_SUPPORTED`;
+  - `StatusCodeLink.VARIANT_ALSO_NEGOTIATES`;
+  - `StatusCodeLink.INSUFFICIENT_STORAGE`;
+  - `StatusCodeLink.LOOP_DETECTED`;
+  - `StatusCodeLink.NOT_EXTENDED`;
+  - `StatusCodeLink.NETWORK_AUTHENTICATION_REQUIRED`;
 
 - **Methods:**
   - `StatusCodeLink.GetStatusCodeLink(this int statuCode)`: Get documentation link by status code;
   - `StatusCodeLink.GetStatusCodeLink(this int? statuCode)`: Get documentation link by status code;
+  - `StatusCodeLink.GetStatusCodeLinkOrDefault(this int statuCode)`: Get documentation link by status code;
 
 
 

src/1.PowerUtils.Net.Primitives.csproj

@@ -13,7 +13,7 @@
     <PackageId>PowerUtils.Net.Primitives</PackageId>
     <title>PowerUtils.Net.Primitives</title>
     <Product>PowerUtils.Net.Primitives</Product>
-    <Version>1.1.1</Version>
+    <Version>1.2.0</Version>
 
     <Authors>Nelson Nobre</Authors>
     <Company>TechNobre</Company>
@@ -24,7 +24,9 @@
 
     <Description>Provides additional types and constants for network-based libraries.</Description>
     <PackageReleaseNotes>
-      Fixed link for status code UNPROCESSABLE_ENTITY  422
+      - Added new constants for status codes;
+      - Added utils `int.GetStatusCodeLinkOrDefault()`;
+      - Fixed link for status code Unprocessable Entity 422;
     </PackageReleaseNotes>
     <Description>Provides additional types and constants for network-based libraries.</Description>
     <PackageTags>PowerUtils;Utils;Net;Primitives;Types;Constants;Web</PackageTags>

src/Constants/StatusCodeLink.cs

@@ -1,52 +1,70 @@
-using System;
+#region License
+// https://github.com/ofpinewood/http-exceptions/blob/main/LICENSE
+//
+// The latest version of this file can be found at https://github.com/ofpinewood/http-exceptions/blob/main/src/Opw.HttpExceptions/ResponseStatusCodeLink.cs
+#endregion
+
+
+using System;
 
 namespace PowerUtils.Net.Constants
 {
-    // Reference: https://github.com/ofpinewood/http-exceptions/blob/main/src/Opw.HttpExceptions/ResponseStatusCodeLink.cs
+    // Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#information_responses
 
     /// <summary>
     /// Status code information links to https://tools.ietf.org/html/rfc7231.
     /// </summary>
     public static class StatusCodeLink
     {
-        private const string BASE_URL = "https://tools.ietf.org/";
+        private const string BASE_URL = "https://tools.ietf.org/html/";
 
-        public const string STATUS_CODES = BASE_URL + "html/rfc7231#section-6";
+        public const string STATUS_CODES = BASE_URL + "rfc7231#section-6";
+
+        public const string BAD_REQUEST = BASE_URL + "rfc7231#section-6.5.1";
+        public const string UNAUTHORIZED = BASE_URL + "rfc7235#section-3.1";
+        public const string PAYMENT_REQUIRED = BASE_URL + "rfc7231#section-6.5.2";
+        public const string FORBIDDEN = BASE_URL + "rfc7231#section-6.5.3";
+        public const string NOT_FOUND = BASE_URL + "rfc7231#section-6.5.4";
+        public const string METHOD_NOT_ALLOWED = BASE_URL + "rfc7231#section-6.5.5";
+        public const string NOT_ACCEPTABLE = BASE_URL + "rfc7231#section-6.5.6";
+        public const string PROXY_AUTHENTICATION_REQUIRED = BASE_URL + "rfc7235#section-3.2";
+        public const string REQUEST_TIMEOUT = BASE_URL + "rfc7231#section-6.5.7";
+        public const string CONFLICT = BASE_URL + "rfc7231#section-6.5.8";
+        public const string GONE = BASE_URL + "rfc7231#section-6.5.9";
+        public const string LENGTH_REQUIRED = BASE_URL + "rfc7231#section-6.5.10";
+        public const string PRECONDITION_FAILED = BASE_URL + "rfc7232#section-4.2";
+        public const string REQUEST_ENTITY_TOO_LARGE = BASE_URL + "rfc7231#section-6.5.11";
+        public const string REQUEST_URI_TOO_LONG = BASE_URL + "rfc7231#section-6.5.12";
+        public const string UNSUPPORTED_MEDIA_TYPE = BASE_URL + "rfc7231#section-6.5.13";
+        public const string REQUESTED_RANGE_NOT_SATISFIABLE = BASE_URL + "rfc7233#section-4.4";
+        public const string EXPECTATION_FAILED = BASE_URL + "rfc7231#section-6.5.14";
+        public const string I_AM_A_TEAPOT = BASE_URL + "rfc2324#section-2.3.2";
+        public const string UNPROCESSABLE_ENTITY = BASE_URL + "rfc4918#section-11.2";
+        public const string TOO_EARLY = "https://httpwg.org/specs/rfc8470.html#status";
+        public const string UPGRADE_REQUIRED = BASE_URL + "rfc7231#section-6.5.15";
+        public const string PRECONDITION_REQUIRED = BASE_URL + "rfc6585#section-3";
+        public const string TOO_MANY_REQUESTS = BASE_URL + "rfc6585#section-4";
+        public const string REQUEST_HEADER_FIELDS_TOO_LARGE = BASE_URL + "rfc6585#section-5";
+        public const string UNAVAILABLE_FOR_LEGAL_REASONS = "https://httpwg.org/specs/rfc7725.html#n-451-unavailable-for-legal-reasons";
+        public const string INTERNAL_SERVER_ERROR = BASE_URL + "rfc7231#section-6.6.1";
+        public const string NOT_IMPLEMENTED = BASE_URL + "rfc7231#section-6.6.2";
+        public const string BAD_GATEWAY = BASE_URL + "rfc7231#section-6.6.3";
+        public const string SERVICE_UNAVAILABLE = BASE_URL + "rfc7231#section-6.6.4";
+        public const string GATEWAY_TIMEOUT = BASE_URL + "rfc7231#section-6.6.5";
+        public const string HTTP_VERSION_NOT_SUPPORTED = BASE_URL + "rfc7231#section-6.6.6";
+        public const string VARIANT_ALSO_NEGOTIATES = BASE_URL + "rfc2295#section-8.1";
+        public const string INSUFFICIENT_STORAGE = BASE_URL + "rfc4918#section-11.5";
+        public const string LOOP_DETECTED = BASE_URL + "rfc5842#section-7.2";
+        public const string NOT_EXTENDED = BASE_URL + "rfc2774#section-7";
+        public const string NETWORK_AUTHENTICATION_REQUIRED = BASE_URL + "rfc6585#section-6";
 
-        public const string BAD_REQUEST = BASE_URL + "html/rfc7231#section-6.5.1";
-        public const string UNAUTHORIZED = BASE_URL + "html/rfc7235#section-3.1";
-        public const string PAYMENT_REQUIRED = BASE_URL + "html/rfc7231#section-6.5.2";
-        public const string FORBIDDEN = BASE_URL + "html/rfc7231#section-6.5.3";
-        public const string NOT_FOUND = BASE_URL + "html/rfc7231#section-6.5.4";
-        public const string METHOD_NOT_ALLOWED = BASE_URL + "html/rfc7231#section-6.5.5";
-        public const string NOT_ACCEPTABLE = BASE_URL + "html/rfc7231#section-6.5.6";
-        public const string PROXY_AUTHENTICATION_REQUIRED = BASE_URL + "html/rfc7235#section-3.2";
-        public const string REQUEST_TIMEOUT = BASE_URL + "html/rfc7231#section-6.5.7";
-        public const string CONFLICT = BASE_URL + "html/rfc7231#section-6.5.8";
-        public const string GONE = BASE_URL + "html/rfc7231#section-6.5.9";
-        public const string LENGTH_REQUIRED = BASE_URL + "html/rfc7231#section-6.5.10";
-        public const string PRECONDITION_FAILED = BASE_URL + "html/rfc7232#section-4.2";
-        public const string REQUEST_ENTITY_TOO_LARGE = BASE_URL + "html/rfc7231#section-6.5.11";
-        public const string REQUEST_URI_TOO_LONG = BASE_URL + "html/rfc7231#section-6.5.12";
-        public const string UNSUPPORTED_MEDIA_TYPE = BASE_URL + "html/rfc7231#section-6.5.13";
-        public const string REQUESTED_RANGE_NOT_SATISFIABLE = BASE_URL + "html/rfc7233#section-4.4";
-        public const string EXPECTATION_FAILED = BASE_URL + "html/rfc7231#section-6.5.14";
-        public const string UNPROCESSABLE_ENTITY = BASE_URL + "html/rfc4918#section-11.2";
-        public const string UPGRADE_REQUIRED = BASE_URL + "html/rfc7231#section-6.5.15";
-        public const string INTERNAL_SERVER_ERROR = BASE_URL + "html/rfc7231#section-6.6.1";
-        public const string NOT_IMPLEMENTED = BASE_URL + "html/rfc7231#section-6.6.2";
-        public const string BAD_GATEWAY = BASE_URL + "html/rfc7231#section-6.6.3";
-        public const string SERVICE_UNAVAILABLE = BASE_URL + "html/rfc7231#section-6.6.4";
-        public const string GATEWAY_TIMEOUT = BASE_URL + "html/rfc7231#section-6.6.5";
-        public const string HTTP_VERSION_NOT_SUPPORTED = BASE_URL + "html/rfc7231#section-6.6.6";
 
         /// <summary>
         /// Get documentation link by status code
         /// </summary>
-        /// <param name="statuCode">Http statu code</param>
-        /// <exception cref="ArgumentException">The <paramref name="statuCode">info</paramref> parameter does not exist.</exception>
-        /// <returns>Documentation link</returns>
-        public static string GetStatusCodeLink(this int statuCode)
+        /// <param name="statuCode">Http status code</param>
+        /// <returns>Documentation link. If the status code does not exists return NULL</returns>
+        public static string GetStatusCodeLinkOrDefault(this int statuCode)
             => statuCode switch
             {
                 // 4XX
@@ -68,8 +86,14 @@ public static string GetStatusCodeLink(this int statuCode)
                 415 => UNSUPPORTED_MEDIA_TYPE,
                 416 => REQUESTED_RANGE_NOT_SATISFIABLE,
                 417 => EXPECTATION_FAILED,
+                418 => I_AM_A_TEAPOT,
                 422 => UNPROCESSABLE_ENTITY,
+                425 => TOO_EARLY,
                 426 => UPGRADE_REQUIRED,
+                428 => PRECONDITION_REQUIRED,
+                429 => TOO_MANY_REQUESTS,
+                431 => REQUEST_HEADER_FIELDS_TOO_LARGE,
+                451 => UNAVAILABLE_FOR_LEGAL_REASONS,
 
                 // 5XX
                 500 => INTERNAL_SERVER_ERROR,
@@ -78,14 +102,28 @@ public static string GetStatusCodeLink(this int statuCode)
                 503 => SERVICE_UNAVAILABLE,
                 504 => GATEWAY_TIMEOUT,
                 505 => HTTP_VERSION_NOT_SUPPORTED,
+                506 => VARIANT_ALSO_NEGOTIATES,
+                507 => INSUFFICIENT_STORAGE,
+                508 => LOOP_DETECTED,
+                510 => NOT_EXTENDED,
+                511 => NETWORK_AUTHENTICATION_REQUIRED,
 
-                _ => throw new ArgumentException($"Unknown status code: '{statuCode}'"),
+                _ => null,
             };
 
         /// <summary>
         /// Get documentation link by status code
         /// </summary>
-        /// <param name="statuCode">Http statu code</param>
+        /// <param name="statuCode">Http status code</param>
+        /// <exception cref="ArgumentException">The <paramref name="statuCode">info</paramref> parameter does not exist.</exception>
+        /// <returns>Documentation link</returns>
+        public static string GetStatusCodeLink(this int statuCode)
+            => statuCode.GetStatusCodeLinkOrDefault() ?? throw new ArgumentException($"Unknown status code: '{statuCode}'");
+
+        /// <summary>
+        /// Get documentation link by status code
+        /// </summary>
+        /// <param name="statuCode">Http status code</param>
         /// <exception cref="ArgumentException">The <paramref name="statuCode">info</paramref> parameter does not exist.</exception>
         /// <returns>Documentation link</returns>
         public static string GetStatusCodeLink(this int? statuCode)

tests/PowerUtils.Net.Primitives.Tests/ConstantsTests/StatusCodeLinksTests.cs

@@ -28,30 +28,67 @@ public class StatusCodeLinksTests
     [InlineData(415, StatusCodeLink.UNSUPPORTED_MEDIA_TYPE)]
     [InlineData(416, StatusCodeLink.REQUESTED_RANGE_NOT_SATISFIABLE)]
     [InlineData(417, StatusCodeLink.EXPECTATION_FAILED)]
+    [InlineData(418, StatusCodeLink.I_AM_A_TEAPOT)]
     [InlineData(422, StatusCodeLink.UNPROCESSABLE_ENTITY)]
+    [InlineData(425, StatusCodeLink.TOO_EARLY)]
     [InlineData(426, StatusCodeLink.UPGRADE_REQUIRED)]
+    [InlineData(428, StatusCodeLink.PRECONDITION_REQUIRED)]
+    [InlineData(429, StatusCodeLink.TOO_MANY_REQUESTS)]
+    [InlineData(431, StatusCodeLink.REQUEST_HEADER_FIELDS_TOO_LARGE)]
+    [InlineData(451, StatusCodeLink.UNAVAILABLE_FOR_LEGAL_REASONS)]
     [InlineData(500, StatusCodeLink.INTERNAL_SERVER_ERROR)]
     [InlineData(501, StatusCodeLink.NOT_IMPLEMENTED)]
     [InlineData(502, StatusCodeLink.BAD_GATEWAY)]
     [InlineData(503, StatusCodeLink.SERVICE_UNAVAILABLE)]
     [InlineData(504, StatusCodeLink.GATEWAY_TIMEOUT)]
     [InlineData(505, StatusCodeLink.HTTP_VERSION_NOT_SUPPORTED)]
+    [InlineData(506, StatusCodeLink.VARIANT_ALSO_NEGOTIATES)]
+    [InlineData(507, StatusCodeLink.INSUFFICIENT_STORAGE)]
+    [InlineData(508, StatusCodeLink.LOOP_DETECTED)]
+    [InlineData(510, StatusCodeLink.NOT_EXTENDED)]
+    [InlineData(511, StatusCodeLink.NETWORK_AUTHENTICATION_REQUIRED)]
     public void GetStatusCodeLink_StatusCodes_ReturnLinks(int? statusCode, string statusCodeLink)
     {
         // Arrange & Act
         var act = statusCode.GetStatusCodeLink();
 
         // Assert
-        act.Should().Be(statusCodeLink);
+        act.Should()
+            .Be(statusCodeLink);
     }
 
-    [Fact(DisplayName = "Http status codes invalid - Should return an exception")]
+    [Fact(DisplayName = "Http status codes non-existent - Should return an exception")]
     public void GetStatusCodeLink_InvalidStatusCode_ReturnLinks()
     {
         // Arrange & Act
         var act = () => 666.GetStatusCodeLink();
 
         // Assert
-        act.Should().Throw<ArgumentException>();
+        act.Should()
+            .Throw<ArgumentException>();
+    }
+
+    [Fact(DisplayName = "Http status codes non-existent - Should return null")]
+    public void GetStatusCodeLinkOrDefault_NonExistent_Null()
+    {
+        // Arrange & Act
+        var act = 666.GetStatusCodeLinkOrDefault();
+
+
+        // Assert
+        act.Should()
+            .BeNull();
+    }
+
+    [Fact(DisplayName = "Http status codes existent - Should return the link")]
+    public void GetStatusCodeLinkOrDefault_Existent_Link()
+    {
+        // Arrange & Act
+        var act = 510.GetStatusCodeLinkOrDefault();
+
+
+        // Assert
+        act.Should()
+            .NotBeNull();
     }
 }