[chore] Linting + docstrings (#539)

- Added docstrings - Fix style issues - Update examples submodule - Use switch case for SmartRateAccuracy - Re-record cassettes as needed
EasyPost · Jan 2, 2024 · 8ffd509 · 8ffd509
1 parent ec528c4
commit 8ffd509
Show file tree

Hide file tree

Showing 209 changed files with 4,364 additions and 2,921 deletions.
diff --git a/EasyPost.Integration/Basics.cs b/EasyPost.Integration/Basics.cs
@@ -13,6 +13,7 @@ public class Basics
     [Fact, Testing.Access, Testing.Compile]
     public void UserCanLocallyConstructResponseObject()
     {
+        // ReSharper disable once UnusedVariable
         var address = new Address();
         var addressCollection = new AddressCollection();
         var apiKey = new ApiKey();

diff --git a/EasyPost.Integration/Synchronous.cs b/EasyPost.Integration/Synchronous.cs
@@ -9,6 +9,7 @@ namespace EasyPost.Integration;
 
 public class Synchronous
 {
+    // ReSharper disable once RedundantArgumentDefaultValue
     private Utils.VCR Vcr { get; } = new("synchronous", Utils.ApiKey.Test);
 
     /// <summary>

diff --git a/EasyPost.Integration/TestUtils.cs b/EasyPost.Integration/TestUtils.cs
@@ -1,3 +1,4 @@
+// ReSharper disable once RedundantUsingDirective
 using System.Net.Http;
 using System.Runtime.CompilerServices;
 using EasyVCR;
@@ -9,8 +10,8 @@ public class Utils
     {
         internal const string ApiKeyFailedToPull = "couldnotpullapikey";
 
-        private static readonly List<string> BodyCensors = new()
-        {
+        private static readonly List<string> BodyCensors =
+        [
             "api_keys",
             "children",
             "client_ip",
@@ -20,20 +21,20 @@ public class Utils
             "keys",
             "phone_number",
             "phone",
-            "test_credentials",
-        };
+            "test_credentials"
+        ];
 
-        private static readonly List<string> HeaderCensors = new()
-        {
+        private static readonly List<string> HeaderCensors =
+        [
             "Authorization",
-            "User-Agent",
-        };
+            "User-Agent"
+        ];
 
-        private static readonly List<string> QueryCensors = new()
-        {
+        private static readonly List<string> QueryCensors =
+        [
             "card[number]",
             "card[cvc]"
-        };
+        ];
 
         public enum ApiKey
         {
@@ -79,6 +80,8 @@ internal static string NetVersion
         {
             get
             {
+                // ReSharper disable once RedundantAssignment
+                // ReSharper disable once ConvertToConstant.Local
                 string netVersion = "net";
 #if NET462
                 netVersion = "netstandard";
@@ -88,6 +91,7 @@ internal static string NetVersion
             }
         }
 
+        // ReSharper disable once InconsistentNaming
         public class VCR
         {
             // Cassettes folder will always been in the same directory as this TestUtils.cs file

diff --git a/EasyPost.Integration/Utilities/Attributes/TestType.cs b/EasyPost.Integration/Utilities/Attributes/TestType.cs
@@ -10,24 +10,18 @@ internal static class Testing
         ///     Marks an integration test that is testing access levels (test that users can/cannot access a function or property as expected)
         /// </summary>
         [AttributeUsage(AttributeTargets.Method, Inherited = false)]
-        internal sealed class Access : BaseCustomAttribute
-        {
-        }
+        internal sealed class Access : BaseCustomAttribute;
 
         /// <summary>
         ///     Marks an integration test that is testing compile-time behavior (test that code as written will compile)
         /// </summary>
         [AttributeUsage(AttributeTargets.Method, Inherited = false)]
-        internal sealed class Compile : BaseCustomAttribute
-        {
-        }
+        internal sealed class Compile : BaseCustomAttribute;
 
         /// <summary>
         ///     Marks an integration test that is testing run-time behavior (test that code as written will run)
         /// </summary>
         [AttributeUsage(AttributeTargets.Method, Inherited = false)]
-        internal sealed class Run : BaseCustomAttribute
-        {
-        }
+        internal sealed class Run : BaseCustomAttribute;
     }
 }
diff --git a/EasyPost.Tests/ClientTest.cs b/EasyPost.Tests/ClientTest.cs
@@ -2,6 +2,7 @@
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
+using EasyPost._base;
 using EasyPost.Exceptions.API;
 using EasyPost.Tests._Utilities;
 using EasyPost.Tests._Utilities.Attributes;
@@ -50,8 +51,6 @@ public void TestThreadSafety()
             Client client2 = new(new ClientConfiguration(key2));
             Client client3 = new(new ClientConfiguration(key3));
 
-            static void Thread(Client client, string keyToMatch) => Assert.Equal(keyToMatch, client.ApiKeyInUse);
-
             Thread thread1 = new(() => Thread(client1, key1));
             Thread thread2 = new(() => Thread(client2, key2));
             Thread thread3 = new(() => Thread(client3, key3));
@@ -60,6 +59,9 @@ public void TestThreadSafety()
             thread2.Start();
             thread3.Start();
             thread1.Start();
+            return;
+
+            static void Thread(EasyPostClient client, string keyToMatch) => Assert.Equal(keyToMatch, client.ApiKeyInUse);
         }
 
         #endregion
@@ -116,14 +118,14 @@ public async Task TestRequestHooks()
 
             Hooks hooks = new()
             {
-                OnRequestExecuting = (sender, args) =>
+                OnRequestExecuting = (_, args) =>
                 {
                     // Modifying the HttpRequestMessage in this action does not impact the HttpRequestMessage being executed (passed by value, not reference)
                     preRequestCallbackCallCount++;
                     Assert.True(args.RequestTimestamp > 0);
                     requestGuid = args.Id;
                 },
-                OnRequestResponseReceived = (sender, args) =>
+                OnRequestResponseReceived = (_, args) =>
                 {
                     postRequestCallbackCallCount++;
                     Assert.True(args.RequestTimestamp > 0);
@@ -133,7 +135,7 @@ public async Task TestRequestHooks()
                 },
             };
 
-            UseVCRWithCustomClient("request_hooks", (apiKey, httpClient) =>
+            UseVCRWithCustomClient("request_hooks", (_, httpClient) =>
                 new Client(new ClientConfiguration(FakeApikey)
                 {
                     CustomHttpClient = httpClient,
@@ -160,12 +162,12 @@ public async Task TestMultipleRequestHookCallbacks()
             bool postRequestCallback2Called = false;
 
             Hooks hooks = new();
-            hooks.OnRequestExecuting += (sender, args) => preRequestCallback1Called = true;
-            hooks.OnRequestExecuting += (sender, args) => preRequestCallback2Called = true;
-            hooks.OnRequestResponseReceived += (sender, args) => postRequestCallback1Called = true;
-            hooks.OnRequestResponseReceived += (sender, args) => postRequestCallback2Called = true;
+            hooks.OnRequestExecuting += (_, _) => preRequestCallback1Called = true;
+            hooks.OnRequestExecuting += (_, _) => preRequestCallback2Called = true;
+            hooks.OnRequestResponseReceived += (_, _) => postRequestCallback1Called = true;
+            hooks.OnRequestResponseReceived += (_, _) => postRequestCallback2Called = true;
 
-            UseVCRWithCustomClient("multiple_request_hooks", (apiKey, httpClient) =>
+            UseVCRWithCustomClient("multiple_request_hooks", (_, httpClient) =>
                 new Client(new ClientConfiguration(FakeApikey)
                 {
                     CustomHttpClient = httpClient,
@@ -231,14 +233,14 @@ public async Task TestCancellationToken()
 
             Hooks hooks = new()
             {
-                OnRequestExecuting = (sender, args) =>
+                OnRequestExecuting = (_, _) =>
                 {
                     // Use the cancellation token to cancel the request
                     cancelTokenSource.Cancel();
                 },
             };
 
-            UseVCRWithCustomClient("cancellation_token", (apiKey, httpClient) =>
+            UseVCRWithCustomClient("cancellation_token", (_, httpClient) =>
                 new Client(new ClientConfiguration(FakeApikey)
                 {
                     CustomHttpClient = httpClient,

diff --git a/EasyPost.Tests/ExceptionsTests/ExceptionsTest.cs b/EasyPost.Tests/ExceptionsTests/ExceptionsTest.cs
@@ -63,14 +63,14 @@ public async Task TestApiExceptionPrettyPrint()
 
             // Now test with some error-related JSON inside the response with sub-errors
             errorMessageStringJson = "{\"error\": {\"code\": \"ERROR_CODE\", \"message\": \"ERROR_MESSAGE\", \"errors\": [{\"field\": \"SUB_ERROR_FIELD\", \"message\": \"SUB_ERROR_MESSAGE\"}]}}";
-            List<Error> subErrors = new()
-            {
+            List<Error> subErrors =
+            [
                 new Error
                 {
                     Field = "SUB_ERROR_FIELD",
                     RawMessage = "SUB_ERROR_MESSAGE"
                 }
-            };
+            ];
 
             // Generate a dummy HttpResponseMessage with the given status code to parse
             httpStatusCode = (HttpStatusCode)Enum.Parse(typeof(HttpStatusCode), statusCode.ToString(CultureInfo.InvariantCulture));
@@ -365,6 +365,7 @@ public async Task TestKnownApiExceptionGeneration()
 
         [Fact]
         [Testing.Exception]
+        // ReSharper disable once InconsistentNaming
         public async Task TestUnknownApiException1xxGeneration()
         {
             // library does not have a specific exception for this status code
@@ -385,6 +386,7 @@ public async Task TestUnknownApiException1xxGeneration()
 
         [Fact]
         [Testing.Exception]
+        // ReSharper disable once InconsistentNaming
         public async Task TestUnknownApiException3xxGeneration()
         {
             // library does not have a specific exception for this status code
@@ -405,6 +407,7 @@ public async Task TestUnknownApiException3xxGeneration()
 
         [Fact]
         [Testing.Exception]
+        // ReSharper disable once InconsistentNaming
         public async Task TestUnknownApiException4xxGeneration()
         {
             // library does not have a specific exception for this status code
@@ -425,6 +428,7 @@ public async Task TestUnknownApiException4xxGeneration()
 
         [Fact]
         [Testing.Exception]
+        // ReSharper disable once InconsistentNaming
         public async Task TestUnknownApiException5xxGeneration()
         {
             // library does not have a specific exception for this status code
@@ -445,6 +449,7 @@ public async Task TestUnknownApiException5xxGeneration()
 
         [Fact]
         [Testing.Exception]
+        // ReSharper disable once InconsistentNaming
         public async Task TestHTTPTimeoutFriendlyException()
         {
             // create a new client with a very short timeout

diff --git a/EasyPost.Tests/Fixture.cs b/EasyPost.Tests/Fixture.cs
@@ -54,7 +54,7 @@ public static byte[] EventBody
             {
                 Dictionary<string, object> fixture = GetFixtureStructure().Pickups.Basic;
 
-                const string pickupDate = "2023-12-01";
+                const string pickupDate = "2023-12-25";
 
                 fixture!.AddOrUpdate("min_datetime", pickupDate);
                 fixture!.AddOrUpdate("max_datetime", pickupDate);
@@ -89,7 +89,7 @@ public static byte[] EventBody
 
         internal static string PickupService => GetFixtureStructure().ServiceNames.Usps.PickupService;
 
-        internal static string PlannedShipDate => "2023-12-01";
+        internal static string PlannedShipDate => "2023-12-25";
 
         internal static Dictionary<string, object> ReferralCustomer => GetFixtureStructure().Users.Referral;
 

diff --git a/EasyPost.Tests/ModelsTests/TrackerTest.cs b/EasyPost.Tests/ModelsTests/TrackerTest.cs
@@ -6,12 +6,8 @@
 
 namespace EasyPost.Tests.ModelsTests
 {
-    public class TrackerTests : UnitTest
+    public class TrackerTests() : UnitTest("tracker")
     {
-        public TrackerTests() : base("tracker")
-        {
-        }
-
         [Fact]
         [Testing.Properties]
 #pragma warning disable CS1998

diff --git a/EasyPost.Tests/ParametersTests/ParametersTest.cs b/EasyPost.Tests/ParametersTests/ParametersTest.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using EasyPost._base;
 using EasyPost.Models.API;
@@ -227,27 +228,33 @@ public void TestRequiredAndOptionalParameterValidation()
         private sealed class ParameterSetWithRequiredAndOptionalParameters : Parameters.BaseParameters<EasyPostObject>
         {
             [TopLevelRequestParameter(Necessity.Required, "test", "required")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? RequiredParameter { get; set; }
 
             [TopLevelRequestParameter(Necessity.Optional, "test", "optional")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? OptionalParameter { get; set; }
         }
 
         private sealed class ParameterSetWithCompetingParameters : Parameters.BaseParameters<EasyPostObject>
         {
             [TopLevelRequestParameter(Necessity.Optional, "location")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? AParam { get; set; }
 
             [TopLevelRequestParameter(Necessity.Optional, "location")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? BParam { get; set; }
         }
 
         private sealed class ParameterSetWithCompetingParametersNonAlphabetic : Parameters.BaseParameters<EasyPostObject>
         {
             [TopLevelRequestParameter(Necessity.Optional, "location")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? BParam { get; set; }
 
             [TopLevelRequestParameter(Necessity.Optional, "location")]
+            // ReSharper disable once UnusedAutoPropertyAccessor.Local
             public string? AParam { get; set; }
         }
 
@@ -420,6 +427,7 @@ public void TestParameterMatchOverrideFunction()
     }
 
 #pragma warning disable CA1852 // Can be sealed
+    [SuppressMessage("ReSharper", "UnusedMember.Local")]
     internal class ExampleDecoratorParameters : Parameters.BaseParameters<EasyPostObject>
     {
         // Default values set to guarantee any property won't be skipped for serialization due to a null value