Skip to content

Commit

Permalink
Merge pull request #335 from PinguApps/311-task-teams-update-membership
Browse files Browse the repository at this point in the history
Implemented update membership
  • Loading branch information
pingu2k4 authored Oct 20, 2024
2 parents d21f7a0 + 74296e2 commit 2a0fcf1
Show file tree
Hide file tree
Showing 8 changed files with 241 additions and 20 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,11 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(

## ⌛ Progress
<!-- `red` for first third, `gold` for second third, `forestgreen` for final third, `blue` for 100% -->
![Server & Client - 118 / 318](https://img.shields.io/badge/Server_&_Client-118%20%2F%20318-gold?style=for-the-badge)
![Server & Client - 120 / 318](https://img.shields.io/badge/Server_&_Client-120%20%2F%20318-gold?style=for-the-badge)

![Server - 62 / 225](https://img.shields.io/badge/Server-62%20%2F%20225-red?style=for-the-badge)
![Server - 63 / 225](https://img.shields.io/badge/Server-63%20%2F%20225-red?style=for-the-badge)

![Client - 56 / 93](https://img.shields.io/badge/Client-56%20%2F%2093-gold?style=for-the-badge)
![Client - 57 / 93](https://img.shields.io/badge/Client-57%20%2F%2093-gold?style=for-the-badge)

### 🔑 Key
| Icon | Definition |
Expand Down Expand Up @@ -256,7 +256,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
| [Update Phone Verification](https://appwrite.io/docs/references/1.6.x/server-rest/users#updatePhoneVerification) |||

### Teams
![Teams - 18 / 26](https://img.shields.io/badge/Teams-18%20%2F%2026-gold?style=for-the-badge)
![Teams - 20 / 26](https://img.shields.io/badge/Teams-18%20%2F%2026-gold?style=for-the-badge)

| Endpoint | Client | Server |
|:-:|:-:|:-:|
Expand All @@ -268,7 +268,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
| [List Team Memberships](https://appwrite.io/docs/references/1.6.x/client-rest/teams#listMemberships) |||
| [Create Team Membership](https://appwrite.io/docs/references/1.6.x/client-rest/teams#createMembership) |||
| [Get Team Membership](https://appwrite.io/docs/references/1.6.x/client-rest/teams#getMembership) |||
| [Update Membership](https://appwrite.io/docs/references/1.6.x/client-rest/teams#updateMembership) | | |
| [Update Membership](https://appwrite.io/docs/references/1.6.x/client-rest/teams#updateMembership) | | |
| [Delete Team Membership](https://appwrite.io/docs/references/1.6.x/client-rest/teams#deleteMembership) |||
| [Update Team Membership Status](https://appwrite.io/docs/references/1.6.x/client-rest/teams#updateMembershipStatus) |||
| [Get Team Memberships](https://appwrite.io/docs/references/1.6.x/client-rest/teams#getPrefs) |||
Expand Down
8 changes: 7 additions & 1 deletion src/PinguApps.Appwrite.Client/Clients/ITeamsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ public interface ITeamsClient
/// <param name="request">The request content</param>
/// <returns>The membership</returns>
Task<AppwriteResult<Membership>> GetTeamMembership(GetTeamMembershipRequest request);
[Obsolete("This method hasn't yet been implemented!")]

/// <summary>
/// Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about <see href="https://appwrite.io/docs/permissions">roles and permissions</see>.
/// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/teams#updateMembership">Appwrite Docs</see></para>
/// </summary>
/// <param name="request">The request content</param>
/// <returns>The membership</returns>
Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request);
[Obsolete("This method hasn't yet been implemented!")]
Task<AppwriteResult<Membership>> UpdateTeamMembershipStatus(UpdateTeamMembershipStatusRequest request);
Expand Down
17 changes: 15 additions & 2 deletions src/PinguApps.Appwrite.Client/Clients/TeamsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,22 @@ public async Task<AppwriteResult<Membership>> GetTeamMembership(GetTeamMembershi
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
public Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request) => throw new NotImplementedException();
public async Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request)
{
try
{
request.Validate(true);

var result = await _teamsApi.UpdateMembership(GetCurrentSessionOrThrow(), request.TeamId, request.MembershipId, request);

return result.GetApiResponse();
}
catch (Exception e)
{
return e.GetExceptionResponse<Membership>();
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
Expand Down
18 changes: 9 additions & 9 deletions src/PinguApps.Appwrite.Playground/App.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,23 @@ public async Task Run(string[] args)
{
_client.SetSession(_session);

var request = new CreateTeamMembershipRequest()
var request = new UpdateMembershipRequest()
{
TeamId = "67142b78001c379958cb",
Email = "[email protected]",
Name = "Pingu"
MembershipId = "671515e5bf4d9b8849c8",
Roles = ["server"]
};

var clientResponse = await _client.Teams.CreateTeamMembership(request);
//var clientResponse = await _client.Teams.UpdateMembership(request);

Console.WriteLine(clientResponse.Result.Match(
result => result.ToString(),
appwriteError => appwriteError.Message,
internalError => internalError.Message));
//Console.WriteLine(clientResponse.Result.Match(
// result => result.ToString(),
// appwriteError => appwriteError.Message,
// internalError => internalError.Message));

Console.WriteLine("############################################################################");

var serverResponse = await _server.Teams.CreateTeamMembership(request);
var serverResponse = await _server.Teams.UpdateMembership(request);

Console.WriteLine(serverResponse.Result.Match(
result => result.ToString(),
Expand Down
8 changes: 7 additions & 1 deletion src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ public interface ITeamsClient
/// <param name="request">The request content</param>
/// <returns>The membership</returns>
Task<AppwriteResult<Membership>> GetTeamMembership(GetTeamMembershipRequest request);
[Obsolete("This method hasn't yet been implemented!")]

/// <summary>
/// Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about <see href="https://appwrite.io/docs/permissions">roles and permissions</see>.
/// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/teams#updateMembership">Appwrite Docs</see></para>
/// </summary>
/// <param name="request">The request content</param>
/// <returns>The membership</returns>
Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request);
[Obsolete("This method hasn't yet been implemented!")]
Task<AppwriteResult<Membership>> UpdateTeamMembershipStatus(UpdateTeamMembershipStatusRequest request);
Expand Down
17 changes: 15 additions & 2 deletions src/PinguApps.Appwrite.Server/Clients/TeamsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,22 @@ public async Task<AppwriteResult<Membership>> GetTeamMembership(GetTeamMembershi
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
public Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request) => throw new NotImplementedException();
public async Task<AppwriteResult<Membership>> UpdateMembership(UpdateMembershipRequest request)
{
try
{
request.Validate(true);

var result = await _teamsApi.UpdateMembership(request.TeamId, request.MembershipId, request);

return result.GetApiResponse();
}
catch (Exception e)
{
return e.GetExceptionResponse<Membership>();
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
using System.Net;
using PinguApps.Appwrite.Client.Clients;
using PinguApps.Appwrite.Shared.Requests.Teams;
using PinguApps.Appwrite.Shared.Tests;
using PinguApps.Appwrite.Shared.Utils;
using RichardSzalay.MockHttp;

namespace PinguApps.Appwrite.Client.Tests.Clients.Teams;
public partial class TeamsClientTests
{
[Fact]
public async Task UpdateMembership_ShouldReturnSuccess_WhenApiCallSucceeds()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders(true)
.Respond(TestConstants.AppJson, TestConstants.MembershipResponse);

_appwriteClient.SetSession(TestConstants.Session);

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.True(result.Success);
}

[Fact]
public async Task UpdateMembership_ShouldReturnError_WhenSessionIsNull()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.True(result.IsError);
Assert.True(result.IsInternalError);
Assert.Equal(ISessionAware.SessionExceptionMessage, result.Result.AsT2.Message);
}

[Fact]
public async Task UpdateMembership_ShouldHandleException_WhenApiCallFails()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders(true)
.Respond(HttpStatusCode.BadRequest, TestConstants.AppJson, TestConstants.AppwriteError);

_appwriteClient.SetSession(TestConstants.Session);

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.True(result.IsError);
Assert.True(result.IsAppwriteError);
}

[Fact]
public async Task UpdateMembership_ShouldReturnErrorResponse_WhenExceptionOccurs()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders(true)
.Throw(new HttpRequestException("An error occurred"));

_appwriteClient.SetSession(TestConstants.Session);

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.False(result.Success);
Assert.True(result.IsInternalError);
Assert.Equal("An error occurred", result.Result.AsT2.Message);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
using System.Net;
using PinguApps.Appwrite.Shared.Requests.Teams;
using PinguApps.Appwrite.Shared.Tests;
using PinguApps.Appwrite.Shared.Utils;
using RichardSzalay.MockHttp;

namespace PinguApps.Appwrite.Server.Tests.Clients.Teams;
public partial class TeamsClientTests
{
[Fact]
public async Task UpdateMembership_ShouldReturnSuccess_WhenApiCallSucceeds()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders()
.Respond(TestConstants.AppJson, TestConstants.MembershipResponse);

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.True(result.Success);
}

[Fact]
public async Task UpdateMembership_ShouldHandleException_WhenApiCallFails()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders()
.Respond(HttpStatusCode.BadRequest, TestConstants.AppJson, TestConstants.AppwriteError);

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.True(result.IsError);
Assert.True(result.IsAppwriteError);
}

[Fact]
public async Task UpdateMembership_ShouldReturnErrorResponse_WhenExceptionOccurs()
{
// Arrange
var request = new UpdateMembershipRequest
{
TeamId = IdUtils.GenerateUniqueId(),
MembershipId = IdUtils.GenerateUniqueId(),
// Add other necessary fields for the request
};

_mockHttp.Expect(HttpMethod.Patch, $"{TestConstants.Endpoint}/teams/{request.TeamId}/memberships/{request.MembershipId}")
.ExpectedHeaders()
.Throw(new HttpRequestException("An error occurred"));

// Act
var result = await _appwriteClient.Teams.UpdateMembership(request);

// Assert
Assert.False(result.Success);
Assert.True(result.IsInternalError);
Assert.Equal("An error occurred", result.Result.AsT2.Message);
}
}

0 comments on commit 2a0fcf1

Please sign in to comment.