Added RoomMembershipApi and corresponding tests. Also added some some high level comments to other apis.

Author: jpfigueiras

src/SymphonyOSS.RestApiClient/Api/AgentApi/UtilApi.cs

@@ -34,6 +34,14 @@ public class UtilApi
 
         private readonly IApiExecutor _apiExecutor;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UtilApi" /> class.
+        /// See <see cref="Factories.PodApiFactory"/> for conveniently constructing
+        /// an instance.
+        /// </summary>
+        /// <param name="authTokens">Authentication tokens.</param>
+        /// <param name="configuration">Api configuration.</param>
+        /// <param name="apiExecutor">Execution strategy.</param>
         public UtilApi(IAuthTokens authTokens, Configuration configuration, IApiExecutor apiExecutor)
         {
             _datafeedApi = new Generated.OpenApi.AgentApi.Api.UtilApi(configuration);

src/SymphonyOSS.RestApiClient/Api/PodApi/RoomMembershipApi.cs

@@ -0,0 +1,106 @@
+// Licensed to the Symphony Software Foundation (SSF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SSF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+namespace SymphonyOSS.RestApiClient.Api.PodApi
+{
+    using Authentication;
+    using Generated.OpenApi.PodApi.Client;
+    using Generated.OpenApi.PodApi.Model;
+
+    /// <summary>
+    /// Provides methods for operating over multy party chats
+    /// and chat rooms, by encapsulating <see cref="Generated.OpenApi.PodApi.Api.RoomMembershipApi"/>,
+    /// adding authentication token management and a custom execution strategy.
+    /// </summary>
+    public class RoomMembershipApi
+    {
+        private readonly Generated.OpenApi.PodApi.Api.IRoomMembershipApi _roomMembershipApi;
+
+        private readonly IAuthTokens _authTokens;
+
+        private readonly IApiExecutor _apiExecutor;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RoomMembershipApi" /> class.
+        /// See <see cref="Factories.PodApiFactory"/> for conveniently constructing
+        /// an instance.
+        /// </summary>
+        /// <param name="authTokens">Authentication tokens.</param>
+        /// <param name="configuration">Api configuration.</param>
+        /// <param name="apiExecutor">Execution strategy.</param>
+        public RoomMembershipApi(IAuthTokens authTokens, Configuration configuration, IApiExecutor apiExecutor)
+        {
+            _roomMembershipApi = new Generated.OpenApi.PodApi.Api.RoomMembershipApi(configuration);
+            _authTokens = authTokens;
+            _apiExecutor = apiExecutor;
+        }
+
+        /// <summary>
+        /// Adds a member to an existing room.
+        /// </summary>
+        /// <param name="roomId">The id of the room.</param>
+        /// <param name="userId">The id of the user to add to the room.</param>
+        /// <returns></returns>
+        public SuccessResponse AddMemberToRoom(string roomId, long? userId)
+        {
+            return _apiExecutor.Execute(_roomMembershipApi.V1RoomIdMembershipAddPost, roomId, new UserId(userId), _authTokens.SessionToken);
+        }
+
+        /// <summary>
+        /// Removes a member from an existing room.
+        /// </summary>
+        /// <param name="roomId">The id of the room.</param>
+        /// <param name="userId">The id of the user to add to the room.</param>
+        /// <returns></returns>
+        public SuccessResponse RemoveMemberFromRoom(string roomId, long? userId)
+        {
+            return _apiExecutor.Execute(_roomMembershipApi.V1RoomIdMembershipRemovePost, roomId, new UserId(userId), _authTokens.SessionToken);
+        }
+
+        /// <summary>
+        /// Promotes a user to owner of the room.
+        /// </summary>
+        /// <param name="roomId">The id of the room.</param>
+        /// <param name="userId">The id of the user to add to the room.</param>
+        /// <returns></returns>
+        public SuccessResponse PromoteUserToRoomOwner(string roomId, long? userId)
+        {
+            return _apiExecutor.Execute(_roomMembershipApi.V1RoomIdMembershipPromoteOwnerPost, roomId, new UserId(userId), _authTokens.SessionToken);
+        }
+
+        /// <summary>
+        /// Demotes a user from owner of a room.
+        /// </summary>
+        /// <param name="roomId">The id of the room.</param>
+        /// <param name="userId">The id of the user to add to the room.</param>
+        /// <returns></returns>
+        public SuccessResponse DemoteRoomOwner(string roomId, long? userId)
+        {
+            return _apiExecutor.Execute(_roomMembershipApi.V1RoomIdMembershipDemoteOwnerPost, roomId, new UserId(userId), _authTokens.SessionToken);
+        }
+
+        /// <summary>
+        /// Gets the members of a room.
+        /// </summary>
+        /// <param name="roomId">The id of the room.</param>
+        /// <returns></returns>
+        public MembershipList GetRoomMembers(string roomId)
+        {
+            return _apiExecutor.Execute(_roomMembershipApi.V1RoomIdMembershipListGet, roomId, _authTokens.SessionToken);
+        }
+    }
+}

src/SymphonyOSS.RestApiClient/Factories/AgentApiFactory.cs

@@ -75,6 +75,14 @@ public MessagesApi CreateMessagesApi(ISessionManager sessionManager, IApiExecuto
             return Create<MessagesApi>(sessionManager, apiExecutor);
         }
 
+        /// <summary>
+        /// Constructs a UtilApi instance using the provided session manager
+        /// for authentication.
+        /// </summary>
+        /// <param name="sessionManager">Session manager used for authentication.</param>
+        /// <param name="apiExecutor">The executor, if none is provided <see cref="RetryStrategyApiExecutor"/>
+        /// with a <see cref="RefreshTokensRetryStrategy"/> will be used.</param>
+        /// <returns>The UtilApi instance.</returns>
         public UtilApi CreateUtilApi(ISessionManager sessionManager, IApiExecutor apiExecutor = null)
         {
             return Create<UtilApi>(sessionManager, apiExecutor);

src/SymphonyOSS.RestApiClient/Factories/PodApiFactory.cs

@@ -114,6 +114,18 @@ public UsersApi CreateUsersApi(ISessionManager sessionManager, IApiExecutor apiE
             return Create<UsersApi>(sessionManager, apiExecutor);
         }
 
+        /// <summary>
+        /// Construcs a RoomMembershipApi using the procided session manager for authentication.
+        /// </summary>
+        /// <param name="sessionManager">Session manager used for authentication.</param>
+        /// <param name="apiExecutor">The executor, if none is provided <see cref="RetryStrategyApiExecutor"/>
+        /// with a <see cref="RefreshTokensRetryStrategy"/> will be used.</param>
+        /// <returns>The RoomMembershipApi instance.</returns>
+        public RoomMembershipApi CreateRoomMembershipApi(ISessionManager sessionManager, IApiExecutor apiExecutor = null)
+        {
+            return Create<RoomMembershipApi>(sessionManager, apiExecutor);
+        }
+
         private T Create<T>(ISessionManager sessionManager, IApiExecutor apiExecutor = null)
         {
             var apiClient = new ApiClient(_baseUrl)

test/SymphonyOSS.RestApiClient.Tests/AgentApiFactoryTest.cs

@@ -56,6 +56,14 @@ public void EnsureConstructs_a_MessagesApi_instance()
             var result = agentApiFactory.CreateMessagesApi(_sessionManager);
             Assert.NotNull(result);
         }
+
+        [Fact]
+        public void EnsureConstructs_a_UtilApi_instance()
+        {
+            var agentApiFactory = new AgentApiFactory("https://agent");
+            var result = agentApiFactory.CreateUtilApi(_sessionManager);
+            Assert.NotNull(result);
+        }
     }
 
 }

test/SymphonyOSS.RestApiClient.Tests/PodApiFactoryTest.cs

@@ -81,5 +81,13 @@ public void EnsureConstructs_a_UsersApi_instance()
             var result = podApiFactory.CreateUsersApi(_sessionManager);
             Assert.NotNull(result);
         }
+
+        [Fact]
+        public void EnsureConstructs_a_RoomMembershipApi_instance()
+        {
+            var podApiFactory = new PodApiFactory("https://pod");
+            var result = podApiFactory.CreateRoomMembershipApi(_sessionManager);
+            Assert.NotNull(result);
+        }
     }
 }

test/SymphonyOSS.RestApiClient.Tests/RoomMembershipApiTest.cs

@@ -0,0 +1,74 @@
+namespace SymphonyOSS.RestApiClient.Tests
+{
+    using System;
+    using Api;
+    using Api.PodApi;
+    using Authentication;
+    using Generated.OpenApi.PodApi.Client;
+    using Generated.OpenApi.PodApi.Model;
+    using Moq;
+    using Xunit;
+
+    /// <summary>
+    /// Summary description for RoomMembershipApiTest
+    /// </summary>
+    public class RoomMembershipApiTest
+    {
+        private readonly RoomMembershipApi _roomMembershipApi;
+
+        private readonly Mock<IApiExecutor> _apiExecutorMock;
+
+        public RoomMembershipApiTest()
+        {
+            var sessionManagerMock = new Mock<IAuthTokens>();
+            sessionManagerMock.Setup(obj => obj.SessionToken).Returns("sessionToken");
+            var configuration = new Configuration();
+            _apiExecutorMock = new Mock<IApiExecutor>();
+            _roomMembershipApi = new RoomMembershipApi(sessionManagerMock.Object, configuration, _apiExecutorMock.Object);
+        }
+
+        [Fact]
+        public void EnsureAddMemberToRoom_uses_retry_strategy()
+        {
+            var roomId = "some_room";
+            long? userId = 123456789;
+            _roomMembershipApi.AddMemberToRoom(roomId, userId);
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, long?, string, SuccessResponse>>(), roomId, userId, "sessionToken"));
+        }
+
+        [Fact]
+        public void EnsureRemoveMemberFromRoom_uses_retry_strategy()
+        {
+            var roomId = "some_room";
+            long? userId = 123456789;
+            _roomMembershipApi.RemoveMemberFromRoom(roomId, userId);
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, long?, string, SuccessResponse>>(), roomId, userId, "sessionToken"));
+        }
+
+        [Fact]
+        public void EnsurePromoteUserToRoomOwner_uses_retry_strategy()
+        {
+            var roomId = "some_room";
+            long? userId = 123456789;
+            _roomMembershipApi.PromoteUserToRoomOwner(roomId, userId);
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, long?, string, SuccessResponse>>(), roomId, userId, "sessionToken"));
+        }
+
+        [Fact]
+        public void EnsureDemoteRoomOwner_uses_retry_strategy()
+        {
+            var roomId = "some_room";
+            long? userId = 123456789;
+            _roomMembershipApi.DemoteRoomOwner(roomId, userId);
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, long?, string, SuccessResponse>>(), roomId, userId, "sessionToken"));
+        }
+
+        [Fact]
+        public void EnsureGetRoomMembers_uses_retry_strategy()
+        {
+            var roomId = "some_room";
+            _roomMembershipApi.GetRoomMembers(roomId);
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, string, SuccessResponse>>(), roomId, "sessionToken"));
+        }
+    }
+}

test/SymphonyOSS.RestApiClient.Tests/SymphonyOSS.RestApiClient.Tests.csproj

@@ -98,6 +98,7 @@
     <Compile Include="StreamsApiTest.cs" />
     <Compile Include="SystemApiTest.cs" />
     <Compile Include="UsersApiTest.cs" />
+    <Compile Include="UtilApiTest.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\src\SymphonyOSS.RestApiClient.Generated\SymphonyOSS.RestApiClient.Generated.csproj">

test/SymphonyOSS.RestApiClient.Tests/UtilApiTest.cs

@@ -36,15 +36,15 @@ public void EnsureEcho_uses_retry_strategy()
         {
             const string msg = "Hello!";
             _utilApi.Echo(msg);
-            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, SimpleMessage>>(), msg));
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, string, string, SimpleMessage>>(), "sessionToken", "keyManagerToken", msg));
         }
 
         [Fact]
         public void EnsureObsolete_uses_retry_strategy()
         {
             const string msg = "Obsolete!";
             _utilApi.Obsolete(msg);
-            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, SimpleMessage>>(), msg));
+            _apiExecutorMock.Verify(obj => obj.Execute(It.IsAny<Func<string, string, string, SimpleMessage>>(), "sessionToken", "keyManagerToken", msg));
         }
     }
 }