Organization membership preview API changes - Review user permission

Octokit.Reactive/Clients/IObservableRepoCollaboratorsClient.cs

@@ -78,6 +78,29 @@ public interface IObservableRepoCollaboratorsClient
         /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
         IObservable<bool> IsCollaborator(long repositoryId, string user);
 
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<CollaboratorPermission> ReviewPermission(string owner, string name, string user);
+
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repositoryId">The id of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<CollaboratorPermission> ReviewPermission(long repositoryId, string user);
+
         /// <summary>
         /// Adds a new collaborator to the repository.
         /// </summary>

Octokit.Reactive/Clients/ObservableRepoCollaboratorsClient.cs

@@ -128,6 +128,41 @@ public IObservable<bool> IsCollaborator(long repositoryId, string user)
             return _client.IsCollaborator(repositoryId, user).ToObservable();
         }
 
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        public IObservable<CollaboratorPermission> ReviewPermission(string owner, string name, string user)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+            Ensure.ArgumentNotNullOrEmptyString(name, "name");
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
+
+            return _client.ReviewPermission(owner, name, user).ToObservable();
+        }
+
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repositoryId">The id of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        public IObservable<CollaboratorPermission> ReviewPermission(long repositoryId, string user)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
+
+            return _client.ReviewPermission(repositoryId, user).ToObservable();
+        }
+
         /// <summary>
         /// Adds a new collaborator to the repository.
         /// </summary>

Octokit/Clients/IRepoCollaboratorsClient.cs

@@ -78,6 +78,29 @@ public interface IRepoCollaboratorsClient
         /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
         Task<bool> IsCollaborator(long repositoryId, string user);
 
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        Task<CollaboratorPermission> ReviewPermission(string owner, string name, string user);
+
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repositoryId">The id of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        Task<CollaboratorPermission> ReviewPermission(long repositoryId, string user);
+
         /// <summary>
         /// Adds a new collaborator to the repository.
         /// </summary>

Octokit/Clients/RepoCollaboratorsClient.cs

@@ -136,6 +136,43 @@ public async Task<bool> IsCollaborator(long repositoryId, string user)
             }
         }
 
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        public Task<CollaboratorPermission> ReviewPermission(string owner, string name, string user)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+            Ensure.ArgumentNotNullOrEmptyString(name, "name");
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
+
+            return ApiConnection
+                .Get<CollaboratorPermission>(ApiUrls.RepoCollaboratorPermission(owner, name, user), null, AcceptHeaders.OrganizationMembershipPreview);
+        }
+
+        /// <summary>
+        /// Review a user's permission level in a repository
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repositoryId">The id of the repository</param>
+        /// <param name="user">Username of the collaborator to check permission for</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        public Task<CollaboratorPermission> ReviewPermission(long repositoryId, string user)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
+
+            return ApiConnection
+                .Get<CollaboratorPermission>(ApiUrls.RepoCollaboratorPermission(repositoryId, user), null, AcceptHeaders.OrganizationMembershipPreview);
+        }
+
         /// <summary>
         /// Adds a new collaborator to the repository.
         /// </summary>

Octokit/Helpers/AcceptHeaders.cs

@@ -46,5 +46,8 @@ public static class AcceptHeaders
         public const string PullRequestReviewsApiPreview = "application/vnd.github.black-cat-preview+json";
 
         public const string ProjectsApiPreview = "application/vnd.github.inertia-preview+json";
+
+        public const string OrganizationMembershipPreview = "application/vnd.github.korra-preview+json";
+
     }
 }

Octokit/Helpers/ApiUrls.cs

@@ -1507,6 +1507,23 @@ public static Uri RepoCollaborator(string owner, string repo, string user)
             return "repos/{0}/{1}/collaborators/{2}".FormatUri(owner, repo, user);
         }
 
+        /// <summary>
+        /// Returns the <see cref="Uri"/> to review the collaborators permission
+        /// </summary>
+        /// <param name="owner">The owner of the repo</param>
+        /// <param name="repo">The name of the repo</param>
+        /// <param name="user">The name of the user</param>
+        /// <returns>The <see cref="Uri"/> to review the collaborators permission</returns>
+        public static Uri RepoCollaboratorPermission(string owner, string repo, string user)
+        {
+            return "repos/{0}/{1}/collaborators/{2}/permission".FormatUri(owner, repo, user);
+        }
+
+        public static Uri RepoCollaboratorPermission(long repositoryId, string user)
+        {
+            return "repos/{0}/collaborators/{1}".FormatUri(repositoryId, user);
+        }
+
         /// <summary>
         /// Returns the <see cref="Uri"/> to check user is collaborator
         /// </summary>

Octokit/Models/Response/CollaboratorPermission.cs

@@ -0,0 +1,13 @@
+using System.Diagnostics;
+
+namespace Octokit
+{
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class CollaboratorPermission
+    {
+        public StringEnum<CollaboratorPermissions> Permission { get; protected set; }
+        public User User { get; protected set; }
+
+        internal string DebuggerDisplay => $"User: {User.Id} Permission: {Permission}";
+    }
+}

Octokit/Models/Response/CollaboratorPermissions.cs

@@ -0,0 +1,16 @@
+using Octokit.Internal;
+
+namespace Octokit
+{
+    public enum CollaboratorPermissions
+    {
+        [Parameter(Value = "admin")]
+        Admin,
+        [Parameter(Value = "write")]
+        Write,
+        [Parameter(Value = "read")]
+        Read,
+        [Parameter(Value = "none")]
+        None
+    }
+}