Code refactoring

Author: exileDev

Nop.Plugin.Shipping.USPS/Domain/TransitDaysAPI.cs

@@ -0,0 +1,8 @@
+namespace Nop.Plugin.Shipping.USPS.Domain;
+
+public enum TransitDaysAPI
+{
+    PriorityMail,
+    FirstClassMail,
+    ExpressMailCommitment
+}

Nop.Plugin.Shipping.USPS/Domain/TransitResponse.cs

@@ -1,25 +1,11 @@
-using Nop.Plugin.Shipping.USPS.Domain.Extensions;
-
-using System.Xml.Linq;
+using System.Xml.Linq;
+using Nop.Plugin.Shipping.USPS.Domain.Extensions;
 
 namespace Nop.Plugin.Shipping.USPS.Domain;
 
 public class TransitResponse
 {
-    public string OriginZip { get; set; }
-
-    public string DestinationZip { get; set; }
-
-    public int? Days { get; set; }
-
-    public string IsGuaranteed { get; set; }
-
-    public string Message { get; set; }
-
-    public string EffectiveAcceptanceDate { get; set; }
-
-    public string ScheduledDeliveryDate { get; set; }
-
+    #region Ctor
 
     public TransitResponse() { }
 
@@ -37,6 +23,8 @@ public TransitResponse(XElement transit)
         ScheduledDeliveryDate = transit.GetValueOfXMLElement("ScheduledDeliveryDate");
     }
 
+    #endregion
+
     #region Methods
 
     /// <summary>
@@ -67,4 +55,16 @@ public static async Task<TransitResponse> LoadAsync(Stream stream)
     }
 
     #endregion
+
+    #region Properties
+
+    public string OriginZip { get; set; }
+    public string DestinationZip { get; set; }
+    public int? Days { get; set; }
+    public string IsGuaranteed { get; set; }
+    public string Message { get; set; }
+    public string EffectiveAcceptanceDate { get; set; }
+    public string ScheduledDeliveryDate { get; set; }
+
+    #endregion
 }

Nop.Plugin.Shipping.USPS/Services/USPSHttpClient.cs

@@ -1,5 +1,5 @@
-using Microsoft.Net.Http.Headers;
-
+using Microsoft.AspNetCore.DataProtection.KeyManagement;
+using Microsoft.Net.Http.Headers;
 using Nop.Core;
 using Nop.Plugin.Shipping.USPS.Domain;
 
@@ -12,13 +12,6 @@ public class USPSHttpClient
     private const string RATES_API_KEY_INTERNATIONAL = "IntlRateV2";
     private const string RATES_API_KEY_DOMESTIC = "RateV4";
 
-    public enum TransitDaysAPI
-    {
-        PriorityMail,
-        FirstClassMail,
-        ExpressMailCommitment
-    }
-
     #endregion
 
     #region Fields
@@ -59,14 +52,9 @@ public async Task<RateResponse> GetRatesAsync(string requestString, bool isDomes
         return await RateResponse.LoadAsync(responseStream, isDomestic);
     }
 
-    public async Task<TransitResponse> GetTransitTimeAsync(TransitDaysAPI postageApiType, string originPostalCode, string destinationPostalCode, string username)
+    public async Task<TransitResponse> GetTransitTimeAsync(TransitDaysAPI api, string requestString)
     {
-        var responseStream = await _httpClient.GetStreamAsync($"?API={postageApiType}&XML=" +
-             $"<{postageApiType}Request USERID=\"{username}\">" +
-             $"<OriginZip>{originPostalCode}</OriginZip>" +
-             $"<DestinationZip>{destinationPostalCode}</DestinationZip>" +
-             $"</{postageApiType}Request>");
-
+        var responseStream = await _httpClient.GetStreamAsync($"?API={api}&XML={requestString}");
         return await TransitResponse.LoadAsync(responseStream);
     }
 

Nop.Plugin.Shipping.USPS/Services/USPSService.cs

@@ -1,5 +1,4 @@
 using System.Xml.Linq;
-
 using Nop.Core;
 using Nop.Core.Domain.Shipping;
 using Nop.Plugin.Shipping.USPS.Domain;
@@ -306,6 +305,17 @@ private string CreateTrackRequest(string trackingNumber)
         return document.ToString(SaveOptions.DisableFormatting);
     }
 
+    private string CreateTransitTimeRequest(TransitDaysAPI postageApiType, string originPostalCode, string destinationPostalCode)
+    {
+        var document = new XDocument(
+            new XElement($"{postageApiType}Request", new XAttribute("USERID", _uspsSettings.Username),
+                new XElement("OriginZip", originPostalCode), 
+                new XElement("DestinationZip", destinationPostalCode))
+        );
+
+        return document.ToString(SaveOptions.DisableFormatting);
+    }
+
     /// <summary>
     /// USPS country hacks
     /// The USPS wants the NAME of the country for international shipments rather than one of the ISO codes
@@ -400,7 +410,7 @@ private async Task<int> GetWeightAsync(GetShippingOptionRequest shippingOptionRe
             //get rate response
             var rateResponse = await _uspsHttpClient.GetRatesAsync(requestString, isDomestic);
 
-            return await ParseResponse(rateResponse, shippingOptionRequest);
+            return await ParseResponseAsync(rateResponse, shippingOptionRequest);
         }
         catch (Exception ex)
         {
@@ -440,7 +450,7 @@ private async Task<bool> IsDomesticRequestAsync(GetShippingOptionRequest getShip
         return false;
     }
 
-    private async Task<(IList<ShippingOption> shippingOptions, IList<string> errors)> ParseResponse(RateResponse response, GetShippingOptionRequest request)
+    private async Task<(IList<ShippingOption> shippingOptions, IList<string> errors)> ParseResponseAsync(RateResponse response, GetShippingOptionRequest request)
     {
         var shippingOptions = new List<ShippingOption>();
 
@@ -485,50 +495,33 @@ bool isPostageOffered(Postage p)
         async Task<int?> getTransitDaysAsync(string service)
         {
             //parse out service to make request to correct API and fill Rool Element name
-            var mailType = default(USPSHttpClient.TransitDaysAPI?);
+            var mailType = default(TransitDaysAPI?);
+
             if (service.Contains("priority", StringComparison.InvariantCultureIgnoreCase))
-            {
-                mailType = USPSHttpClient.TransitDaysAPI.PriorityMail;
-            }
-            else if (service.Contains("firstclass", StringComparison.InvariantCultureIgnoreCase) ||
-                service.Contains("first class", StringComparison.InvariantCultureIgnoreCase))
-            {
-                mailType = USPSHttpClient.TransitDaysAPI.FirstClassMail;
-            }
-            else if (service.Contains("express", StringComparison.InvariantCultureIgnoreCase))
-            {
-                mailType = USPSHttpClient.TransitDaysAPI.ExpressMailCommitment;
-            }
+                mailType = TransitDaysAPI.PriorityMail;
 
-            if (mailType.HasValue)
-            {
-                var transitResponse = await _uspsHttpClient.GetTransitTimeAsync(mailType.Value,
-                    CommonHelper.EnsureMaximumLength(CommonHelper.EnsureNumericOnly(request.ZipPostalCodeFrom), 5),
-                    CommonHelper.EnsureMaximumLength(CommonHelper.EnsureNumericOnly(request.ShippingAddress.ZipPostalCode), 5), _uspsSettings.Username);
-                if (transitResponse != null &&
-                    transitResponse.Days.HasValue)
-                {
-                    var transitDays = transitResponse.Days.Value + 1; //add a day to process order.
+            if (service.Contains("firstclass", StringComparison.InvariantCultureIgnoreCase) || service.Contains("first class", StringComparison.InvariantCultureIgnoreCase))
+                mailType = TransitDaysAPI.FirstClassMail;
 
-                    var today = DateTime.UtcNow.ToLocalTime();
-                    //assuming 5-day work week here and weekend order will not be shipped until monday at earliest, may want to add options to configuration to provide most accurate estimate.
-                    while (today.DayOfWeek == DayOfWeek.Friday ||
-                        today.DayOfWeek == DayOfWeek.Saturday ||
-                        today.DayOfWeek == DayOfWeek.Sunday)
-                    {
-                        today = today.AddDays(1);
-                        transitDays += 1;
-                    }
+            if (service.Contains("express", StringComparison.InvariantCultureIgnoreCase))
+                mailType = TransitDaysAPI.ExpressMailCommitment;
 
-                    return transitDays;
-                }
-            }
+            if (mailType is null)
+                return null;
+
+            static string formatZip(string zipCode) => CommonHelper.EnsureMaximumLength(CommonHelper.EnsureNumericOnly(zipCode), 5);
 
-            return null;
+            var requestString = CreateTransitTimeRequest(
+                mailType.Value,
+                formatZip(request.ZipPostalCodeFrom),
+                formatZip(request.ShippingAddress.ZipPostalCode));
+
+            var transitResponse = await _uspsHttpClient.GetTransitTimeAsync(mailType.Value, requestString);
+
+            return transitResponse?.Days;
         }
     }
 
-
     private async Task<IList<ShipmentStatusEvent>> TrackAsync(string requestString)
     {
         var response = await _uspsHttpClient.GetTrackEventsAsync(requestString);