Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/guide/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,6 @@ Send a message to a group:
## Next Steps

- Learn about [attachments](/guide/attachments)
- Learn about [polls](/guide/polls)
- Explore [profile management](/guide/profiles)
- Check out [advanced examples](/examples/)
- Check out [advanced examples](/examples/)
19 changes: 19 additions & 0 deletions docs/guide/polls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Polls Management

Manage polls created by your bot or any other user.

## Creating a poll

<<< ./../../src/Signal.Bot.Example/Guide/Polls.cs#CreatingPoll{csharp}

## Closing a poll

<<< ./../../src/Signal.Bot.Example/Guide/Polls.cs#ClosingPoll{csharp}

## Voting in a poll

<<< ./../../src/Signal.Bot.Example/Guide/Polls.cs#VotingInPoll{csharp}

## Next Steps

- Check out [examples](/examples/)
36 changes: 19 additions & 17 deletions src/Directory.Packages.props
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
<Project>
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="R3" Version="[1.3.0,)"/>
<PackageVersion Include="WebSocket.Rx" Version="[0.1.8,)"/>
<!--- Testing -->
<PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.5.2"/>
<PackageVersion Include="NSubstitute" Version="5.3.0"/>
<PackageVersion Include="FakeItEasy" Version="9.0.1"/>
<PackageVersion Include="WireMock.Net" Version="1.25.0"/>
<PackageVersion Include="xunit.v3.mtp-v2" Version="3.2.2"/>
<!--- Example -->
<PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="10.4.0"/>
<PackageVersion Include="Serilog.AspNetCore" Version="10.0.0"/>
<PackageVersion Include="Aspire.Hosting.AppHost" Version="13.1.3"/>
</ItemGroup>
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Microsoft.DotNet.ILCompiler" Version="10.0.5" />
<PackageVersion Include="Microsoft.NET.ILLink.Tasks" Version="10.0.5" />
<PackageVersion Include="R3" Version="[1.3.0,)" />
<PackageVersion Include="WebSocket.Rx" Version="[0.1.8,)" />
<!--- Testing -->
<PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.5.2" />
<PackageVersion Include="NSubstitute" Version="5.3.0" />
<PackageVersion Include="FakeItEasy" Version="9.0.1" />
<PackageVersion Include="WireMock.Net" Version="2.2.0" />
<PackageVersion Include="xunit.v3.mtp-v2" Version="3.2.2" />
<!--- Example -->
<PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="10.4.0" />
<PackageVersion Include="Serilog.AspNetCore" Version="10.0.0" />
<PackageVersion Include="Aspire.Hosting.AppHost" Version="13.2.1" />
</ItemGroup>
</Project>
35 changes: 35 additions & 0 deletions src/Signal.Bot.Example/Guide/Polls.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
namespace Signal.Bot.Example.Guide;

public class Polls
{
private readonly SignalBotClient client = null!;

public async Task CreatingPoll()
{
#region CreatingPoll
await client.AddPollAsync(true,
new[] { "Option 1", "Option 2", "Option 3" },
"Question",
"+1111111111");
#endregion
}

public async Task ClosingPoll()
{
#region ClosingPoll
await client.ClosePollAsync( new DateTime(2026,04,06,12,00,00),
"+1111111111");
#endregion
}

public async Task VotingInPoll()
{
#region VotingInPoll

await client.VotePollAsync("+2222222222",
new DateTime(2026, 04, 06, 12, 00, 00),
"+1111111111",
[0, 1]);
#endregion
}
}
2 changes: 2 additions & 0 deletions src/Signal.Bot.Example/Signal.Bot.Example.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.DotNet.ILCompiler"/>
<PackageReference Include="Microsoft.NET.ILLink.Tasks"/>
<PackageReference Include="Microsoft.Extensions.Http.Resilience"/>
<PackageReference Include="Serilog.AspNetCore"/>
</ItemGroup>
Expand Down
180 changes: 180 additions & 0 deletions src/Signal.Bot.UnitTests/Extensions/PollTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
using NSubstitute;
using Signal.Bot.UnitTests.Utils;

namespace Signal.Bot.UnitTests.Extensions;

public class PollTests : BotTestBase
{
[Fact(Timeout = 5000)]
public async Task AddPollAsync_WithNoArguments_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(null, null, null, null, cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Theory(Timeout = 5000)]
[InlineData(true)]
[InlineData(false)]
public async Task AddPollAsync_WithMultipleSelections_CallsHttpClient(bool allowMultiple)
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(allowMultiple, null, null, null,
cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task AddPollAsync_WithAnswers_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(null, ["abc", "def", "ghi", "jkl"], null, null, cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task AddPollAsync_WithQuestion_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(null, null, "What?!", null, cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task AddPollAsync_WithRecipient_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(null, null, null, "123456789", cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task AddPollAsync_WithFullDataset_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.AddPollAsync(false, ["abc", "def", "ghi", "jkl"], "What?!", "123456789", cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task ClosePollAsync_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.ClosePollAsync(DateTime.Now, "123456789", cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Delete),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task VotePollAsync_WithRequiredArguments_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.VotePollAsync("987654321", DateTime.Now, "123456789", null, cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task VotePollAsync_WithSingleSelectedAnswer_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.VotePollAsync("987654321", DateTime.Now, "123456789", [1], cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}

[Fact(Timeout = 5000)]
public async Task VotePollAsync_WithMultipleSelectedAnswers_CallsHttpClient()
{
// Arrange
SetupResponse();

// Act
await Client.VotePollAsync("987654321", DateTime.Now, "123456789", [1, 3], cancellationToken: TestContext.Current.CancellationToken);

// Assert
await HttpClientMock
.Received(1)
.SendAsync(Arg.Is<HttpRequestMessage>(req =>
req.Method == HttpMethod.Post),
Arg.Any<CancellationToken>());
}
}
Loading
Loading