Merge pull request #21 from cake-contrib/feature/18/ensure-success-code

EnsureStatusCode Extension Method Changes #18
cake-contrib · Apr 25, 2017 · e5145ca · e5145ca
2 parents adc650a + 68f4623
commit e5145ca
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/src/Cake.Http.Tests/Unit/HttpSettingsExtensionsTests.cs b/src/Cake.Http.Tests/Unit/HttpSettingsExtensionsTests.cs
@@ -246,6 +246,37 @@ public void Should_Add_Authorization_Header()
             }
         }
 
+        public sealed class TheEnsureSuccessCodeMethod
+        {
+            [Fact]
+            [Trait(Traits.TestCategory, TestCategories.Unit)]
+            public void Should_Throw_On_Null_Settings_Parameter()
+            {
+                //Given                
+                HttpSettings settings = null;
+
+                //When
+                var nullRecord = Record.Exception(() => HttpSettingsExtensions.EnsureSuccessStatusCode(settings));
+
+                //Then
+                CakeAssert.IsArgumentNullException(nullRecord, "settings");
+            }
+
+            [Fact]
+            [Trait(Traits.TestCategory, TestCategories.Unit)]
+            public void Should_Set_EnsureSuccesscCode_Property_To_True()
+            {
+                //Given
+                HttpSettings settings = new HttpSettings();
+
+                //When
+                settings.EnsureSuccessStatusCode();
+
+                //Then
+                Assert.True(settings.EnsureSuccessStatusCode);
+            }
+        }
+
         public sealed class TheUseBasicAuthorizationMethod
         {
             [Fact]

diff --git a/src/Cake.Http/HttpSettingsExtensions.cs b/src/Cake.Http/HttpSettingsExtensions.cs
@@ -264,6 +264,22 @@ public static HttpSettings SetJsonRequestBody<T>(this HttpSettings settings, T d
             return settings;
         }
 
+
+        /// <summary>
+        /// Sets the EnsureSuccessStatusCode to true. This makes the httpclient throw an error if it does not return a 200 range status.
+        /// </summary>
+        /// <param name="settings">The settings.</param>
+        /// <returns>The same <see cref="HttpSettings"/> instance so that multiple calls can be chained.</returns>
+        public static HttpSettings EnsureSuccessStatusCode(this HttpSettings settings)
+        {
+            if (settings == null)
+                throw new ArgumentNullException(nameof(settings));
+
+            settings.EnsureSuccessStatusCode = true;
+
+            return settings;
+        }
+
         private static void VerifyParameters(HttpSettings settings, string name, string value)
         {
             if (settings == null)