Merge pull request #466 from kzu/GetMembers

Get members

Octokit.Reactive/Clients/IObservableTeamsClient.cs

@@ -31,6 +31,17 @@ public interface IObservableTeamsClient
         /// <returns>A list of the orgs's teams <see cref="Team"/>s.</returns>
         IObservable<Team> GetAll(string org);
 
+        /// <summary>
+        /// Returns all members of the given team. 
+        /// </summary>
+        /// <param name="id">The team identifier</param>
+        /// <remarks>
+        /// https://developer.github.com/v3/orgs/teams/#list-team-members
+        /// </remarks>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A list of the team's member <see cref="User"/>s.</returns>
+        IObservable<User> GetMembers(int id);
+
         /// <summary>
         /// Returns newly created <see cref="Team" /> for the current org.
         /// </summary>

Octokit.Reactive/Clients/ObservableTeamsClient.cs

@@ -51,6 +51,20 @@ public IObservable<Team> GetAll(string org)
             return _connection.GetAndFlattenAllPages<Team>(ApiUrls.OrganizationTeams(org));
         }
 
+        /// <summary>
+        /// Returns all members of the given team. 
+        /// </summary>
+        /// <param name="id">The team identifier</param>
+        /// <remarks>
+        /// https://developer.github.com/v3/orgs/teams/#list-team-members
+        /// </remarks>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A list of the team's member <see cref="User"/>s.</returns>
+        public IObservable<User> GetMembers(int id)
+        {
+            return _connection.GetAndFlattenAllPages<User>(ApiUrls.TeamMembers(id));
+        }
+
         /// <summary>
         /// Returns newly created <see cref="Team" /> for the current org.
         /// </summary>

Octokit.Tests.Integration/Clients/TeamsClientTests.cs

@@ -120,4 +120,29 @@ public async Task GetsIsMemberFalseForNonMemberWhenAuthenticated()
             Assert.False(isMember);
         }
     }
+
+    public class TheGetMembersMethod
+    {
+        readonly Team team;
+
+        public TheGetMembersMethod()
+        {
+            var github = new GitHubClient(new ProductHeaderValue("OctokitTests")) { Credentials = Helper.Credentials };
+
+            team = github.Organization.Team.GetAll(Helper.Organization).Result.First();
+        }
+
+        [OrganizationTest]
+        public async Task GetsAllMembersWhenAuthenticated()
+        {
+            var github = new GitHubClient(new ProductHeaderValue("OctokitTests"))
+            {
+                Credentials = Helper.Credentials
+            };
+
+            var members = await github.Organization.Team.GetMembers(team.Id);
+
+            Assert.Contains(Helper.UserName, members.Select(u => u.Login));
+        }
+    }
 }

Octokit.Tests.Integration/Octokit.Tests.Integration.csproj

@@ -92,6 +92,7 @@
     <Compile Include="Helper.cs" />
     <Compile Include="Clients\UsersClientTests.cs" />
     <Compile Include="Reactive\ObservableUserEmailsClientTests.cs" />
+    <Compile Include="Reactive\ObservableTeamsClientTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Octokit.Reactive\Octokit.Reactive.csproj">
@@ -123,4 +124,4 @@
   <Target Name="AfterBuild">
   </Target>
   -->
-</Project>
+</Project>

Octokit.Tests.Integration/Reactive/ObservableTeamsClientTests.cs

@@ -0,0 +1,43 @@
+using System.Linq;
+using System.Net;
+using System.Reactive.Linq;
+using System.Threading.Tasks;
+using Octokit;
+using Octokit.Internal;
+using Octokit.Tests.Helpers;
+using Octokit.Tests.Integration;
+using Xunit;
+using System;
+using System.Collections.Generic;
+using Xunit.Sdk;
+using Octokit.Reactive;
+
+public class ObservableTeamsClientTests
+{
+    public class TheGetMembersMethod
+    {
+        readonly Team team;
+
+        public TheGetMembersMethod()
+        {
+            var github = new GitHubClient(new ProductHeaderValue("OctokitTests")) { Credentials = Helper.Credentials };
+
+            team = github.Organization.Team.GetAll(Helper.Organization).Result.First();
+        }
+
+        [OrganizationTest]
+        public async Task GetsAllMembersWhenAuthenticated()
+        {
+            var github = new GitHubClient(new ProductHeaderValue("OctokitTests"))
+            {
+                Credentials = Helper.Credentials
+            };
+
+            var client = new ObservableTeamsClient(github);
+
+            var member = await client.GetMembers(team.Id);
+
+            Assert.Equal(Helper.UserName, member.Login);
+        }
+    }
+}

Octokit.Tests/Clients/TeamsClientTests.cs

@@ -43,6 +43,20 @@ public void EnsuresNonNullArguments()
             }
         }
 
+        public class TheGetMembersMethod
+        {
+            [Fact]
+            public void RequestsTheCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new TeamsClient(connection);
+
+                client.GetMembers(1);
+
+                connection.Received().GetAll<User>(Arg.Is<Uri>(u => u.ToString() == "teams/1/members"));
+            }
+        }
+
         public class TheCreateTeamMethod
         {
             [Fact]

Octokit/Clients/ITeamsClient.cs

@@ -33,6 +33,16 @@ public interface ITeamsClient
         /// <returns>A list of the orgs's teams <see cref="Team"/>s.</returns>
         Task<IReadOnlyList<Team>> GetAll(string org);
 
+        /// <summary>
+        /// Returns all members of the given team. 
+        /// </summary>
+        /// <param name="id">The team identifier</param>
+        /// <remarks>
+        /// https://developer.github.com/v3/orgs/teams/#list-team-members
+        /// </remarks>
+        /// <returns>A list of the team's member <see cref="User"/>s.</returns>
+        Task<IReadOnlyList<User>> GetMembers(int id);
+
         /// <summary>
         /// Returns newly created <see cref="Team" /> for the current org.
         /// </summary>

Octokit/Clients/TeamsClient.cs

@@ -52,6 +52,20 @@ public Task<IReadOnlyList<Team>> GetAll(string org)
             return ApiConnection.GetAll<Team>(endpoint);
         }
 
+        /// <summary>
+        /// Returns all members of the given team. 
+        /// </summary>
+        /// <param name="id">The team identifier</param>
+        /// <remarks>
+        /// https://developer.github.com/v3/orgs/teams/#list-team-members
+        /// </remarks>
+        /// <returns>A list of the team's member <see cref="User"/>s.</returns>
+        public Task<IReadOnlyList<User>> GetMembers(int id)
+        {
+            var endpoint = ApiUrls.TeamMembers(id);
+
+            return ApiConnection.GetAll<User>(endpoint);
+        }
 
         /// <summary>
         /// Returns newly created <see cref="Team" /> for the current org.

Octokit/Helpers/ApiUrls.cs

@@ -946,7 +946,7 @@ public static Uri Teams(int id)
         }
 
         /// <summary>
-        /// returns the <see cref="Uri"/> for team members
+        /// returns the <see cref="Uri"/> for team member
         /// </summary>
         /// <param name="id">The team id</param>
         /// <param name="login">The user login.</param>
@@ -955,6 +955,15 @@ public static Uri TeamMember(int id, string login)
             return "teams/{0}/members/{1}".FormatUri(id, login);
         }
 
+        /// <summary>
+        /// returns the <see cref="Uri"/> for team members list
+        /// </summary>
+        /// <param name="id">The team id</param>
+        public static Uri TeamMembers(int id)
+        {
+            return "teams/{0}/members".FormatUri(id);
+        }
+
         /// <summary>
         /// returns the <see cref="Uri"/> for teams
         /// use for update or deleting a team