Add new Moderator Permissions

Fixes #183
Fixes #182

Author: CrustyJew

.gitignore

@@ -18,3 +18,4 @@ StyleCop.Cache
 /.vs
 /packages
 /RedditSharpTests/secrets.json
+/RedditSharpTests/private.config

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Development
 
-Use a private config or Secret Manager to pull in config for tests. The required format is as follows
+Use a private.config file to pull in config for tests. The required format is as follows
 
 ```json
 {

RedditSharp/Moderator Actions/ModeratorPermission.cs

@@ -14,7 +14,7 @@ public enum ModeratorPermission
         /// <summary>
         /// No permissions.
         /// </summary>
-        None   = 0x00,
+        None = 0x00,
         /// <summary>
         /// access permissions.
         /// </summary>
@@ -26,23 +26,35 @@ public enum ModeratorPermission
         /// <summary>
         /// Flair management.
         /// </summary>
-        Flair  = 0x04,
+        Flair = 0x04,
         /// <summary>
         /// Modmail.
         /// </summary>
-        Mail   = 0x08,
+        Mail = 0x08,
         /// <summary>
         /// Moderate posts.
         /// </summary>
-        Posts  = 0x10,
+        Posts = 0x10,
         /// <summary>
         /// Edit / view protected wiki paes.
         /// </summary>
-        Wiki   = 0x20,
+        Wiki = 0x20,
+        /// <summary>
+        /// Configure chat groups
+        /// </summary>
+        ChatConfig = 0x40,
+        /// <summary>
+        /// Moderate users in subreddit chatrooms
+        /// </summary>
+        ChatOperator = 0x80,
+        /// <summary>
+        /// Has the "all" permission / super user status in sub
+        /// </summary>
+        SuperUser = 0x1000000 | All, //give some padding for other permissions
         /// <summary>
         /// All permissions.
         /// </summary>
-        All    = Access | Config | Flair | Mail | Posts | Wiki
+        All = Access | Config | Flair | Mail | Posts | Wiki | ChatConfig | ChatOperator
     }
 
     internal class ModeratorPermissionConverter : JsonConverter
@@ -54,12 +66,58 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
 
         public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
         {
-            var data = string.Join(",", JArray.Load(reader).Select(t => t.ToString()));
-            ModeratorPermission result;
-            var valid = Enum.TryParse(data, true, out result);
-
-            if (!valid)
-                result = ModeratorPermission.None;
+            var perms = JArray.Load(reader).Select(t => t.ToString());
+            ModeratorPermission result = ModeratorPermission.None;
+            foreach (var perm in perms)
+            {
+                switch (perm.ToLower())
+                {
+                    case "all":
+                        {
+                            return ModeratorPermission.SuperUser;
+                        }
+                    case "access":
+                        {
+                            result = result | ModeratorPermission.Access;
+                            break;
+                        }
+                    case "config":
+                        {
+                            result = result | ModeratorPermission.Config;
+                            break;
+                        }
+                    case "flair":
+                        {
+                            result = result | ModeratorPermission.Flair;
+                            break;
+                        }
+                    case "mail":
+                        {
+                            result = result | ModeratorPermission.Mail;
+                            break;
+                        }
+                    case "posts":
+                        {
+                            result = result | ModeratorPermission.Posts;
+                            break;
+                        }
+                    case "wiki":
+                        {
+                            result = result | ModeratorPermission.Wiki;
+                            break;
+                        }
+                    case "chat_config":
+                        {
+                            result = result | ModeratorPermission.ChatConfig;
+                            break;
+                        }
+                    case "chat_operator":
+                        {
+                            result = result | ModeratorPermission.ChatOperator;
+                            break;
+                        }
+                }
+            }
 
             return result;
         }
@@ -68,7 +126,7 @@ public override bool CanConvert(Type objectType)
         {
             // NOTE: Not sure if this is what is supposed to be returned
             // This method wasn't called in my (Sharparam) tests so unsure what it does
-            return objectType == typeof (ModeratorPermission);
+            return objectType == typeof(ModeratorPermission);
         }
     }
 }

RedditSharpTests/AuthenticatedTestsFixture.cs

@@ -12,7 +12,7 @@ public class AuthenticatedTestsFixture
         public AuthenticatedTestsFixture()
         {
             ConfigurationBuilder builder = new ConfigurationBuilder();
-            builder.AddUserSecrets<AuthenticatedTestsFixture>()
+            builder.AddJsonFile("private.config")
             .AddEnvironmentVariables();
             Config = builder.Build();
             WebAgent = new RedditSharp.BotWebAgent(Config["TestUserName"], Config["TestUserPassword"], Config["RedditClientID"], Config["RedditClientSecret"], Config["RedditRedirectURI"]);

RedditSharpTests/RedditSharpTests.csproj

@@ -36,6 +36,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="private.config">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="secrets.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

RedditSharpTests/Things/SubredditTests.cs

@@ -25,21 +25,33 @@ public async Task GetContributors()
             Assert.NotEmpty(contribs);
             Assert.Contains<string>(authFixture.TestUserName.ToLower(), contribs.Select(c => c.Name.ToLower()));
         }
-        
+
+        [Fact]
+        public async Task GetModerators()
+        {
+            RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
+            RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent);
+            var sub = await reddit.GetSubredditAsync(authFixture.Config["TestSubreddit"]);
+            var mods = await sub.GetModeratorsAsync();
+
+            Assert.NotEmpty(mods);
+            Assert.NotEmpty(mods.Where(m => m.Permissions != RedditSharp.ModeratorPermission.None));
+        }
+
         [Fact]
         public async Task SubmitPost()
         {
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
-            RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent,true);
+            RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent, true);
 
             var sub = await reddit.GetSubredditAsync(authFixture.Config["TestSubreddit"]);
-            var post = await sub.SubmitPostAsync("ThisIsASubmittedPost", "https://github.com/CrustyJew/RedditSharp/issues/76", resubmit:true);
+            var post = await sub.SubmitPostAsync("ThisIsASubmittedPost", "https://github.com/CrustyJew/RedditSharp/issues/76", resubmit: true);
             Assert.NotNull(post);
             await post.DelAsync();
         }
 
         [Fact]
-        public async Task GetRALLComments() 
+        public async Task GetRALLComments()
         {
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
             RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent, true);
@@ -49,14 +61,15 @@ public async Task GetRALLComments()
         }
 
         [Fact]
-        public async Task PageComments() {
+        public async Task PageComments()
+        {
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
             RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent, true);
 
             var comments = await reddit.RSlashAll.GetComments().Take(55).ToList();
 
             Assert.Equal(55, comments.Count);
-            
+
         }
 
         [Fact]