Skip to content

Commit ee9c260

Browse files
nwithan8nwithan8
authored
- Add parameter sets for classes S-Z (ScanForm - Webhook) (#419)
- Add overload methods for classes S-Z to accept parameters - Add unit tests, cassettes to test method overloads - Bump coverage to 90%
1 parent 79727a0 commit ee9c260

File tree

78 files changed

+6532
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+6532
-16
lines changed

‎EasyPost.Tests/BetaFeaturesTests/ModelsTests/ShipmentTest.cs

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
using System.Collections.Generic;
2+
using System.Linq;
3+
using System.Threading.Tasks;
4+
using EasyPost.Models.API;
5+
using EasyPost.Tests._Utilities;
6+
using EasyPost.Tests._Utilities.Attributes;
7+
using EasyPost.Utilities.Internal.Attributes;
8+
using Xunit;
9+
10+
namespace EasyPost.Tests.BetaFeaturesTests.ModelsTests
11+
{
12+
public class ShipmentTests : UnitTest
13+
{
14+
public ShipmentTests() : base("shipment_with_parameters")
15+
{
16+
}
17+
18+
#region Tests
19+
20+
#region Test CRUD Operations
21+
22+
// If the shipment was purchased with a USPS rate, it must have had its insurance set to `0` when bought
23+
// so that USPS doesn't automatically insure it so we could manually insure it here.
24+
[Fact]
25+
[CrudOperations.Create]
26+
[Testing.Function]
27+
public async Task TestInsure()
28+
{
29+
UseVCR("insure");
30+
31+
Dictionary<string, object> shipmentData = Fixtures.OneCallBuyShipment;
32+
// Set to 0 so USPS doesn't insure this automatically and we can insure the shipment manually
33+
shipmentData["insurance"] = 0;
34+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
35+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
36+
37+
BetaFeatures.Parameters.Shipments.Insure insureParameters = new BetaFeatures.Parameters.Shipments.Insure
38+
{
39+
Amount = "100",
40+
};
41+
42+
shipment = await shipment.Insure(insureParameters);
43+
44+
Assert.Equal("100.00", shipment.Insurance);
45+
}
46+
47+
[Fact]
48+
[CrudOperations.Update]
49+
[Testing.Function]
50+
public async Task TestBuy()
51+
{
52+
UseVCR("buy");
53+
54+
Dictionary<string, object> shipmentData = Fixtures.FullShipment;
55+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
56+
57+
// buy with rate ID
58+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
59+
Rate rate = shipment.LowestRate();
60+
61+
BetaFeatures.Parameters.Shipments.Buy buyParameters = new BetaFeatures.Parameters.Shipments.Buy(rate.Id);
62+
await shipment.Buy(buyParameters);
63+
64+
Assert.NotNull(shipment.PostageLabel);
65+
66+
// buy with rate
67+
shipment = await Client.Shipment.Create(shipmentParameters);
68+
rate = shipment.LowestRate();
69+
70+
buyParameters = new BetaFeatures.Parameters.Shipments.Buy(rate);
71+
await shipment.Buy(buyParameters);
72+
73+
Assert.NotNull(shipment.PostageLabel);
74+
}
75+
76+
[Fact]
77+
[CrudOperations.Update]
78+
[Testing.Parameters]
79+
public async Task TestBuyWithCarbonOffset()
80+
{
81+
UseVCR("buy_with_carbon_offset");
82+
83+
Dictionary<string, object> shipmentData = Fixtures.FullShipment;
84+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
85+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
86+
Rate rate = shipment.LowestRate();
87+
88+
BetaFeatures.Parameters.Shipments.Buy buyParameters = new BetaFeatures.Parameters.Shipments.Buy(rate)
89+
{
90+
CarbonOffset = true,
91+
};
92+
93+
await shipment.Buy(buyParameters);
94+
95+
Assert.NotNull(shipment.Fees);
96+
bool carbonOffsetIncluded = shipment.Fees.Any(fee => fee.Type == "CarbonOffsetFee");
97+
Assert.True(carbonOffsetIncluded);
98+
}
99+
100+
[Fact]
101+
[CrudOperations.Update]
102+
[Testing.Parameters]
103+
public async Task TestBuyWithEndShipper()
104+
{
105+
UseVCR("buy_with_end_shipper");
106+
107+
Dictionary<string, object> endShipperData = Fixtures.CaAddress1;
108+
BetaFeatures.Parameters.EndShippers.Create endShipperParameters = Fixtures.Parameters.EndShippers.Create(endShipperData);
109+
EndShipper endShipper = await Client.EndShipper.Create(endShipperParameters);
110+
111+
Dictionary<string, object> shipmentData = Fixtures.FullShipment;
112+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
113+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
114+
Rate rate = shipment.LowestRate();
115+
116+
BetaFeatures.Parameters.Shipments.Buy buyParameters = new BetaFeatures.Parameters.Shipments.Buy(rate)
117+
{
118+
EndShipperId = endShipper.Id,
119+
};
120+
121+
await shipment.Buy(buyParameters);
122+
123+
Assert.NotNull(shipment.PostageLabel);
124+
}
125+
126+
[Fact]
127+
[CrudOperations.Update]
128+
[Testing.Function]
129+
public async Task TestGenerateLabel()
130+
{
131+
UseVCR("generate_label");
132+
133+
Dictionary<string, object> shipmentData = Fixtures.OneCallBuyShipment;
134+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
135+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
136+
137+
BetaFeatures.Parameters.Shipments.GenerateLabel generateLabelParameters = new BetaFeatures.Parameters.Shipments.GenerateLabel
138+
{
139+
FileFormat = "ZPL",
140+
};
141+
142+
shipment = await shipment.GenerateLabel(generateLabelParameters);
143+
144+
Assert.NotNull(shipment.PostageLabel.LabelZplUrl);
145+
}
146+
147+
[Fact]
148+
[CrudOperations.Update]
149+
[Testing.Function]
150+
public async Task TestRegenerateRates()
151+
{
152+
UseVCR("regenerate_rates");
153+
154+
Dictionary<string, object> shipmentData = Fixtures.FullShipment;
155+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
156+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
157+
158+
BetaFeatures.Parameters.Shipments.RegenerateRates regenerateRatesParameters = new BetaFeatures.Parameters.Shipments.RegenerateRates();
159+
160+
await shipment.RegenerateRates(regenerateRatesParameters);
161+
162+
List<Rate> rates = shipment.Rates;
163+
164+
Assert.NotNull(rates);
165+
foreach (Rate rate in rates)
166+
{
167+
Assert.IsType<Rate>(rate);
168+
}
169+
}
170+
171+
[Fact]
172+
[CrudOperations.Update]
173+
[Testing.Parameters]
174+
public async Task TestRegenerateRatesWithCarbonOffset()
175+
{
176+
UseVCR("regenerate_rates_with_carbon_offset");
177+
178+
Dictionary<string, object> shipmentData = Fixtures.OneCallBuyShipment;
179+
BetaFeatures.Parameters.Shipments.Create shipmentParameters = Fixtures.Parameters.Shipments.Create(shipmentData);
180+
Shipment shipment = await Client.Shipment.Create(shipmentParameters);
181+
List<Rate> baseRates = shipment.Rates;
182+
183+
BetaFeatures.Parameters.Shipments.RegenerateRates regenerateRatesParameters = new BetaFeatures.Parameters.Shipments.RegenerateRates
184+
{
185+
CarbonOffset = true,
186+
};
187+
await shipment.RegenerateRates(regenerateRatesParameters);
188+
189+
List<Rate> newRatesWithCarbon = shipment.Rates;
190+
191+
Rate baseRate = baseRates!.First();
192+
Rate newRateWithCarbon = newRatesWithCarbon!.First();
193+
194+
Assert.Null(baseRate.CarbonOffset);
195+
Assert.NotNull(newRateWithCarbon.CarbonOffset);
196+
}
197+
198+
#endregion
199+
200+
#endregion
201+
}
202+
}

‎EasyPost.Tests/BetaFeaturesTests/ModelsTests/TrackerTest.cs

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using System.Threading.Tasks;
2+
using EasyPost.Tests._Utilities;
3+
using EasyPost.Tests._Utilities.Attributes;
4+
using Xunit;
5+
6+
namespace EasyPost.Tests.BetaFeaturesTests.ModelsTests
7+
{
8+
public class TrackerTests : UnitTest
9+
{
10+
public TrackerTests() : base("tracker_with_parameters")
11+
{
12+
}
13+
14+
[Fact]
15+
[Testing.Properties]
16+
#pragma warning disable CS1998
17+
public async Task TestTrackerCarrierDetails()
18+
#pragma warning restore CS1998
19+
{
20+
// Details can be (and most likely will be) missing or incomplete, so we can't reliably test them.
21+
}
22+
}
23+
}

‎EasyPost.Tests/BetaFeaturesTests/ModelsTests/UserTest.cs

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
using System.Threading.Tasks;
2+
using EasyPost.Models.API;
3+
using EasyPost.Tests._Utilities;
4+
using EasyPost.Tests._Utilities.Attributes;
5+
using EasyPost.Utilities.Internal.Attributes;
6+
using Xunit;
7+
8+
namespace EasyPost.Tests.BetaFeaturesTests.ModelsTests
9+
{
10+
public class UserTests : UnitTest
11+
{
12+
public UserTests() : base("user_with_parameters", TestUtils.ApiKey.Production) =>
13+
CleanupFunction = async id =>
14+
{
15+
try
16+
{
17+
User retrievedUser = await Client.User.Retrieve(id);
18+
await retrievedUser.Delete();
19+
return true;
20+
}
21+
catch
22+
{
23+
// trying to delete something that doesn't exist, pass
24+
return false;
25+
}
26+
};
27+
28+
#region Tests
29+
30+
#region Test CRUD Operations
31+
32+
[Fact]
33+
[CrudOperations.Create]
34+
[Testing.Function]
35+
public async Task TestUpdateBrand()
36+
{
37+
UseVCR("update_brand");
38+
39+
BetaFeatures.Parameters.Users.CreateChild userParameters = new()
40+
{
41+
Name = "Test User",
42+
};
43+
User user = await Client.User.CreateChild(userParameters);
44+
CleanUpAfterTest(user.Id);
45+
46+
const string color = "#123456";
47+
BetaFeatures.Parameters.Users.UpdateBrand brandParameters = new()
48+
{
49+
ColorHexCode = color,
50+
};
51+
52+
Brand brand = await user.UpdateBrand(brandParameters);
53+
54+
Assert.IsType<Brand>(brand);
55+
Assert.StartsWith("brd_", brand.Id);
56+
Assert.Equal(color, brand.Color);
57+
}
58+
59+
60+
61+
[Fact]
62+
[CrudOperations.Update]
63+
[Testing.Function]
64+
public async Task TestUpdate()
65+
{
66+
UseVCR("update");
67+
68+
BetaFeatures.Parameters.Users.CreateChild userParameters = new()
69+
{
70+
Name = "Test User",
71+
};
72+
User user = await Client.User.CreateChild(userParameters);
73+
CleanUpAfterTest(user.Id);
74+
75+
const string testName = "New Name";
76+
BetaFeatures.Parameters.Users.Update userUpdateParameters = new()
77+
{
78+
Name = testName,
79+
};
80+
81+
user = await user.Update(userUpdateParameters);
82+
83+
Assert.IsType<User>(user);
84+
Assert.StartsWith("user_", user.Id);
85+
Assert.Equal(testName, user.Name);
86+
}
87+
88+
#endregion
89+
90+
#endregion
91+
}
92+
}

‎EasyPost.Tests/BetaFeaturesTests/ModelsTests/WebhookTest.cs

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
using System.Threading.Tasks;
2+
using EasyPost.Models.API;
3+
using EasyPost.Tests._Utilities;
4+
using EasyPost.Tests._Utilities.Attributes;
5+
using EasyPost.Utilities.Internal.Attributes;
6+
using Xunit;
7+
8+
namespace EasyPost.Tests.BetaFeaturesTests.ModelsTests
9+
{
10+
public class WebhookTests : UnitTest
11+
{
12+
// NOTE: Because the API does not allow two webhooks with the same URL,
13+
// and these tests run in parallel, each test needs to have a unique URL.
14+
15+
public WebhookTests() : base("webhook_with_parameters") =>
16+
CleanupFunction = async id =>
17+
{
18+
try
19+
{
20+
Webhook retrievedWebhook = await Client.Webhook.Retrieve(id);
21+
await retrievedWebhook.Delete();
22+
return true;
23+
}
24+
catch
25+
{
26+
// trying to delete something that doesn't exist, pass
27+
return false;
28+
}
29+
};
30+
31+
#region Tests
32+
33+
#region Test CRUD Operations
34+
35+
[Fact]
36+
[CrudOperations.Update]
37+
[Testing.Function]
38+
public async Task TestUpdate()
39+
{
40+
UseVCR("update");
41+
42+
const string url = "https://example.com/update";
43+
BetaFeatures.Parameters.Webhooks.Create webhookParameters = new()
44+
{
45+
Url = url,
46+
};
47+
Webhook webhook = await Client.Webhook.Create(webhookParameters);
48+
CleanUpAfterTest(webhook.Id);
49+
50+
BetaFeatures.Parameters.Webhooks.Update updateParameters = new()
51+
{
52+
};
53+
// Sending an empty payload will toggle the active status of the webhook silently.
54+
webhook = await webhook.Update(updateParameters);
55+
56+
// We can only update the secret, but that's not returned as part of the Webhook object, so we have no property to check to see if it was updated.
57+
Assert.IsType<Webhook>(webhook);
58+
Assert.StartsWith("hook_", webhook.Id);
59+
}
60+
61+
#endregion
62+
63+
#endregion
64+
}
65+
}

0 commit comments

Comments
 (0)