Add carbon offset functionality (#304)

- Add CarbonOffset class
- Add carbon offset property to Rate class
- Add carbon offset parameter to Shipment create, buy and re-rate functions
- Update local styling to auto-organize JSON properties alphabetically, apply styling to CarbonOffset.cs, Rate.cs and Shipment.cs

Author: nwithan8

CHANGELOG.md

@@ -1,7 +1,10 @@
 # CHANGELOG
 
-## NEXT RELEASE
-
+## Next Release
+- Adds the ability to create a shipment with carbon offset
+- Adds the ability to buy a shipment with carbon offset
+- Adds the ability to one-call-buy a shipment with carbon offset
+- Adds the ability to re-rate a shipment with carbon offset
 - Removes the unusable `carrier` param from the `verify` function on an Address
 
 ## v3.3.0 (2022-07-18)

EasyPost.Tests/Fixture.cs

@@ -393,7 +393,7 @@ public static Dictionary<string, object> BasicPickup
         {
             get
             {
-                const string pickupDate = "2022-06-4";
+                const string pickupDate = "2022-08-01";
                 return new Dictionary<string, object>
                 {
                     {
@@ -626,5 +626,85 @@ public static Dictionary<string, object> RmaFormOptions
                 };
             }
         }
+
+        public static Dictionary<string, object> BasicCarbonOffsetShipment
+        {
+            get
+            {
+                return new Dictionary<string, object>
+                {
+                    { "to_address", PickupAddress },
+                    {"from_address", BasicAddress },
+                    {"parcel", BasicParcel },
+                };
+            }
+        }
+
+        public static Dictionary<string, object> FullCarbonOffsetShipment
+        {
+            get
+            {
+                return new Dictionary<string, object>
+                {
+                    {
+                        "to_address", PickupAddress
+                    },
+                    {
+                        "from_address", BasicAddress
+                    },
+                    {
+                        "parcel", BasicParcel
+                    },
+                    {
+                        "customs_info", BasicCustomsInfo
+                    },
+                    {
+                        "options", new Dictionary<string, object>
+                        {
+                            {
+                                "label_format", "PNG" // Must be PNG so we can convert to ZPL later
+                            },
+                            {
+                                "invoice_number", "123"
+                            }
+                        }
+                    },
+                    {
+                        "reference", "123"
+                    }
+                };
+            }
+        }
+
+        public static Dictionary<string, object> OneCallBuyCarbonOffsetShipment
+        {
+            get
+            {
+                return new Dictionary<string, object>
+                {
+                    {
+                        "to_address", PickupAddress
+                    },
+                    {
+                        "from_address", BasicAddress
+                    },
+                    {
+                        "parcel", BasicParcel
+                    },
+                    {
+                        "service", UspsService
+                    },
+                    {
+                        "carrier_accounts", new List<string>
+                        {
+                            UspsCarrierAccountId
+                        }
+                    },
+                    {
+                        "carrier", Usps
+                    }
+                };
+            }
+        }
     }
 }

EasyPost.Tests/ShipmentTest.cs

@@ -87,7 +87,6 @@ public async Task TestBuy()
         {
             _vcr.SetUpTest("buy");
 
-
             Shipment shipment = await CreateFullShipment();
 
             await shipment.Buy(shipment.LowestRate());
@@ -278,8 +277,8 @@ public async Task TestInstanceLowestSmartrate()
 
             // test lowest smartrate with valid filters
             Smartrate lowestSmartrate = await shipment.LowestSmartrate(1, SmartrateAccuracy.Percentile90);
-            Assert.AreEqual("First", lowestSmartrate.service);
-            Assert.AreEqual(5.49, lowestSmartrate.rate);
+            Assert.AreEqual("Express", lowestSmartrate.service);
+            Assert.AreEqual(23.75, lowestSmartrate.rate);
             Assert.AreEqual("USPS", lowestSmartrate.carrier);
 
             // test lowest smartrate with invalid filters (should error due to strict delivery_days)
@@ -330,8 +329,8 @@ public async Task TestStaticLowestSmartrate()
             // test lowest smartrate with valid filters
             List<Smartrate> smartrates = await shipment.GetSmartrates();
             Smartrate lowestSmartrate = Shipment.GetLowestSmartrate(smartrates, 1, SmartrateAccuracy.Percentile90);
-            Assert.AreEqual("First", lowestSmartrate.service);
-            Assert.AreEqual(5.49, lowestSmartrate.rate);
+            Assert.AreEqual("Express", lowestSmartrate.service);
+            Assert.AreEqual(23.75, lowestSmartrate.rate);
             Assert.AreEqual("USPS", lowestSmartrate.carrier);
 
             // test lowest smartrate with invalid filters (should error due to strict delivery_days)
@@ -358,5 +357,65 @@ public async Task TestGenerateForm()
             Assert.AreEqual(formType, form.form_type);
             Assert.IsTrue(form.form_url != null);
         }
+
+        [TestMethod]
+        public async Task TestCreateShipmentWithCarbonOffset()
+        {
+            _vcr.SetUpTest("create_shipment_with_carbon_offset");
+
+            Shipment shipment = await Shipment.Create(Fixture.BasicCarbonOffsetShipment, true);
+
+            Assert.IsInstanceOfType(shipment, typeof(Shipment));
+
+            Rate rate = shipment.LowestRate();
+            CarbonOffset carbonOffset = rate.carbon_offset;
+
+            Assert.IsNotNull(carbonOffset);
+            Assert.IsNotNull(carbonOffset.price);
+        }
+
+        [TestMethod]
+        public async Task TestBuyShipmentWithCarbonOffset()
+        {
+            _vcr.SetUpTest("buy_shipment_with_carbon_offset");
+
+            Shipment shipment = await Shipment.Create(Fixture.FullCarbonOffsetShipment);
+
+            await shipment.Buy(shipment.LowestRate(), withCarbonOffset: true);
+
+            Assert.IsNotNull(shipment.fees);
+            bool carbonOffsetIncluded = shipment.fees.Any(fee => fee.type == "CarbonOffsetFee");
+            Assert.IsTrue(carbonOffsetIncluded);
+        }
+
+        [TestMethod]
+        public async Task TestOneCallBuyShipmentWithCarbonOffset()
+        {
+            _vcr.SetUpTest("one_call_buy_shipment_with_carbon_offset");
+
+            Shipment shipment = await Shipment.Create(Fixture.OneCallBuyCarbonOffsetShipment, true);
+
+            Assert.IsNotNull(shipment.fees);
+            bool carbonOffsetIncluded = shipment.fees.Any(fee => fee.type == "CarbonOffsetFee");
+            Assert.IsTrue(carbonOffsetIncluded);
+        }
+
+        [TestMethod]
+        public async Task TestRegenerateRatesWithCarbonOffset()
+        {
+            _vcr.SetUpTest("regenerate_rates_with_carbon_offset");
+
+            Shipment shipment = await Shipment.Create(Fixture.OneCallBuyCarbonOffsetShipment);
+            List<Rate> baseRates = shipment.rates;
+
+            await shipment.RegenerateRates(withCarbonOffset: true);
+            List<Rate> newRatesWithCarbon = shipment.rates;
+
+            Rate baseRate = baseRates.First();
+            Rate newRateWithCarbon = newRatesWithCarbon.First();
+
+            Assert.IsNull(baseRate.carbon_offset);
+            Assert.IsNotNull(newRateWithCarbon.carbon_offset);
+        }
     }
 }