Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: [breaking] make WhatsApp 'from' mandatory #572

Merged
merged 2 commits into from
Mar 13, 2024
Merged

feat: [breaking] make WhatsApp 'from' mandatory #572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52daaf1
feat: make WhatsApp 'from' mandatory
Tr00d Mar 6, 2024
29a208a
Merge branch 'main' into breaking-verifyv2-mandatory-from
Tr00d Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion Vonage.Test/VerifyV2/StartVerification/Data/ShouldSerializeFallbackWorkflows-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
},
{
"channel": "whatsapp",
"to": "447700900000"
"to": "447700900000",
"from": "447700900001"
},
{
"channel": "voice",
Expand Down
3 changes: 2 additions & 1 deletion Vonage.Test/VerifyV2/StartVerification/Data/ShouldSerializeWhatsAppWorkflow-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"workflow": [
{
"channel": "whatsapp",
"to": "447700900000"
"to": "447700900000",
"from": "447700900001"
}
]
}
5 changes: 3 additions & 2 deletions Vonage.Test/VerifyV2/StartVerification/E2ETest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public async Task StartVerificationWithFallbackWorkflows()
.Build()
.WithBrand("ACME, Inc")
.WithWorkflow(WhatsAppInteractiveWorkflow.Parse("447700900000"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("447700900000"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("447700900000", "447700900001"))
.WithFallbackWorkflow(VoiceWorkflow.Parse("447700900000"))
.Create());
VerifyResponseBody(result);
Expand All @@ -89,7 +89,8 @@ public async Task StartWhatsAppInteractiveVerification()
public async Task StartWhatsAppVerification()
{
this.InitializeWireMock(nameof(SerializationTest.ShouldSerializeWhatsAppWorkflow));
var result = await this.StartVerificationAsyncWithWorkflow(WhatsAppWorkflow.Parse("447700900000"));
var result =
await this.StartVerificationAsyncWithWorkflow(WhatsAppWorkflow.Parse("447700900000", "447700900001"));
VerifyResponseBody(result);
}

Expand Down
6 changes: 3 additions & 3 deletions Vonage.Test/VerifyV2/StartVerification/RequestBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public void Create_ShouldReturnFailure_GivenCodeLengthIsLowerThanMinimum() =>
public void Create_ShouldReturnFailure_GivenOneFallbackWorkflowIsFailure() =>
BuildBaseRequest()
.WithWorkflow(WhatsAppInteractiveWorkflow.Parse("123456789"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("123456789"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("123456789", "123456789"))
.WithFallbackWorkflow(
Result<VoiceWorkflow>.FromFailure(ResultFailure.FromErrorMessage("Random message.")))
.Create()
Expand Down Expand Up @@ -143,7 +143,7 @@ public void Create_ShouldSetCodeLength(int value) =>
public void Create_ShouldSetFallbackWorkflows() =>
BuildBaseRequest()
.WithWorkflow(WhatsAppInteractiveWorkflow.Parse("123456789"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("123456789"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("123456789", "123456780"))
.WithFallbackWorkflow(VoiceWorkflow.Parse("123456789"))
.Create()
.Map(request => request.Workflows)
Expand All @@ -157,7 +157,7 @@ public void Create_ShouldSetFallbackWorkflows() =>
var fallbackWorkflowOne = workflows[1] as WhatsAppWorkflow? ?? default;
fallbackWorkflowOne.Channel.Should().Be("whatsapp");
fallbackWorkflowOne.To.Number.Should().Be("123456789");
fallbackWorkflowOne.From.Should().BeNone();
fallbackWorkflowOne.From.Number.Should().Be("123456780");
var fallbackWorkflowTwo = workflows[2] as VoiceWorkflow? ?? default;
fallbackWorkflowTwo.Channel.Should().Be("voice");
fallbackWorkflowTwo.To.Number.Should().Be("123456789");
Expand Down
4 changes: 2 additions & 2 deletions Vonage.Test/VerifyV2/StartVerification/SerializationTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public void ShouldSerializeFallbackWorkflows() =>
StartVerificationRequest.Build()
.WithBrand("ACME, Inc")
.WithWorkflow(WhatsAppInteractiveWorkflow.Parse("447700900000"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("447700900000"))
.WithFallbackWorkflow(WhatsAppWorkflow.Parse("447700900000", "447700900001"))
.WithFallbackWorkflow(VoiceWorkflow.Parse("447700900000"))
.Create()
.GetStringContent()
Expand Down Expand Up @@ -145,7 +145,7 @@ public void ShouldSerializeWhatsAppInteractiveWorkflow() =>
public void ShouldSerializeWhatsAppWorkflow() =>
StartVerificationRequest.Build()
.WithBrand("ACME, Inc")
.WithWorkflow(WhatsAppWorkflow.Parse("447700900000"))
.WithWorkflow(WhatsAppWorkflow.Parse("447700900000", "447700900001"))
.Create()
.GetStringContent()
.Should()
Expand Down
18 changes: 4 additions & 14 deletions Vonage.Test/VerifyV2/StartVerification/Workflows/WhatsAppWorkflowTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ public class WhatsAppWorkflowTest
[Theory]
[InlineData("")]
[InlineData(" ")]
public void Parse_ShouldReturnFailure_GivenFromIsProvidedButEmpty(string value) =>
[InlineData(null)]
public void Parse_ShouldReturnFailure_GivenFromIsNullOrWhitespace(string value) =>
WhatsAppWorkflow.Parse(ValidToNumber, value)
.Should()
.BeFailure(ResultFailure.FromErrorMessage("Number cannot be null or whitespace."));
Expand All @@ -26,29 +27,18 @@ public void Parse_ShouldReturnFailure_GivenFromIsProvidedButEmpty(string value)
[InlineData(" ")]
[InlineData(null)]
public void Parse_ShouldReturnFailure_GivenToIsNullOrWhitespace(string value) =>
WhatsAppWorkflow.Parse(value)
WhatsAppWorkflow.Parse(value, ValidFromNumber)
.Should()
.BeFailure(ResultFailure.FromErrorMessage("Number cannot be null or whitespace."));

[Fact]
public void Parse_ShouldSetWhatsAppWorkflow() =>
WhatsAppWorkflow.Parse(ValidToNumber)
.Should()
.BeSuccess(workflow =>
{
workflow.Channel.Should().Be(ExpectedChannel);
workflow.To.Number.Should().Be(ValidToNumber);
workflow.From.Should().BeNone();
});

[Fact]
public void Parse_ShouldSetWhatsAppWorkflowWithFrom() =>
WhatsAppWorkflow.Parse(ValidToNumber, ValidFromNumber)
.Should()
.BeSuccess(workflow =>
{
workflow.Channel.Should().Be(ExpectedChannel);
workflow.To.Number.Should().Be(ValidToNumber);
workflow.From.Map(from => from.Number).Should().BeSome(ValidFromNumber);
workflow.From.Number.Should().Be(ValidFromNumber);
});
}
21 changes: 6 additions & 15 deletions Vonage/VerifyV2/StartVerification/WhatsApp/WhatsAppWorkflow.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace Vonage.VerifyV2.StartVerification.WhatsApp;
/// </summary>
public readonly struct WhatsAppWorkflow : IVerificationWorkflow
{
private WhatsAppWorkflow(PhoneNumber to, Maybe<PhoneNumber> from)
private WhatsAppWorkflow(PhoneNumber to, PhoneNumber from)
{
this.To = to;
this.From = from;
Expand All @@ -24,10 +24,9 @@ private WhatsAppWorkflow(PhoneNumber to, Maybe<PhoneNumber> from)
/// An optional sender number, in the E.164 format. Don't use a leading + or 00 when entering a phone number, start
/// with the country code, for example, 447700900000.
/// </summary>
[JsonConverter(typeof(MaybeJsonConverter<PhoneNumber>))]
[JsonPropertyOrder(3)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<PhoneNumber> From { get; }
[JsonPropertyOrder(2)]
[JsonConverter(typeof(PhoneNumberJsonConverter))]
public PhoneNumber From { get; }

/// <summary>
/// The phone number to contact, in the E.164 format. Don't use a leading + or 00 when entering a phone number, start
Expand All @@ -37,23 +36,15 @@ private WhatsAppWorkflow(PhoneNumber to, Maybe<PhoneNumber> from)
[JsonConverter(typeof(PhoneNumberJsonConverter))]
public PhoneNumber To { get; }

/// <summary>
/// Parses the input into a WhatsAppWorkflow.
/// </summary>
/// <param name="to">The phone number to contact.</param>
/// <returns>Success or failure.</returns>
public static Result<WhatsAppWorkflow> Parse(string to) =>
PhoneNumber.Parse(to).Map(phoneNumber => new WhatsAppWorkflow(phoneNumber, Maybe<PhoneNumber>.None));

/// <summary>
/// Parses the input into a WhatsAppWorkflow.
/// </summary>
/// <param name="to">The phone number to contact.</param>
/// <param name="from">The sender number.</param>
/// <returns>Success or failure.</returns>
public static Result<WhatsAppWorkflow> Parse(string to, string from) =>
PhoneNumber.Parse(to)
.Merge(PhoneNumber.Parse(from), (toNumber, fromNumber) => new WhatsAppWorkflow(toNumber, fromNumber));
PhoneNumber.Parse(to).Merge(PhoneNumber.Parse(from),
(toNumber, fromNumber) => new WhatsAppWorkflow(toNumber, fromNumber));

/// <inheritdoc />
public string Serialize(IJsonSerializer serializer) => serializer.SerializeObject(this);
Expand Down