Merge pull request #205 from jkrejcha/feature-partial-user

Implement a PartialUser class for user listings (PR)

Author: CrustyJew

RedditSharp/Moderator Actions/ModeratorUser.cs

@@ -1,45 +1,23 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using RedditSharp.Things.User;
 
 namespace RedditSharp
 {
     /// <summary>
     /// Represents a moderator.
     /// </summary>
-    public class ModeratorUser
+    public class ModeratorUser : RelatedUser
     {
-        /// <summary>
-        /// Create ModeratorUser from given JSON
-        /// </summary>
-        /// <param name="json"></param>
-        public ModeratorUser(JToken json)
+        public ModeratorUser(IWebAgent agent, JToken json) : base(agent, json)
         {
-            Helpers.PopulateObject(json, this);
         }
 
-        /// <summary>
-        /// Moderator username.
-        /// </summary>
-        [JsonProperty("name")]
-        public string Name { get; private set; }
-
-        /// <summary>
-        /// base36 Id of the moderator.
-        /// </summary>
-        [JsonProperty("id")]
-        public string Id { get; private set; }
-
         /// <summary>
         /// Permissions the moderator has in the subreddit.
         /// </summary>
         [JsonProperty("mod_permissions")]
         [JsonConverter(typeof (ModeratorPermissionConverter))]
         public ModeratorPermission Permissions { get; private set; }
-
-        /// <inheritdoc/>
-        public override string ToString()
-        {
-            return Name;
-        }
     }
 }

RedditSharp/Things/BannedUser.cs

@@ -1,51 +1,29 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
-using RedditSharp.Extensions;
+using RedditSharp.Things.User;
 using System;
 
 namespace RedditSharp.Things
 {
     /// <summary>
     /// A user that is banned in a subreddit.
     /// </summary>
-    public class BannedUser : RedditUser
+    public class BannedUser : NotedUser
     {
         /// <inheritdoc />
         public BannedUser(IWebAgent agent, JToken json) : base(agent, json) {
-            var data = json["name"] == null ? json["data"] : json;
-            base.Name = data["name"].ValueOrDefault<string>();
-            var id = data["id"].ValueOrDefault<string>();
-            if (id.Contains("_"))
-            {
-                base.Kind = "t2";
-                base.Id = id.Split('_')[1];
-                base.FullName = id;
-            }
         }
 
         /// <summary>
         /// Date the user was banned.
         /// </summary>
-        [JsonProperty("date")]
-        [JsonConverter(typeof(UnixTimestampConverter))]
-        public DateTime? BanDate { get; private set; }
+        [Obsolete("User RelUser.Date")]
+        public DateTime? BanDate { get => DateUTC; private set => DateUTC = value; }
 
         /// <summary>
         /// Ban note.
         /// </summary>
         [JsonProperty("note")]
         public string Note { get; private set; }
-
-        /// <summary>
-        /// This will always return 0 for BannedUsers
-        /// </summary>
-        [JsonIgnore]
-        public new int CommentKarma => 0;
-
-        /// <summary>
-        /// This will always return 0 for BannedUsers
-        /// </summary>
-        [JsonIgnore]
-        public new int LinkKarma => 0;
     }
 }

RedditSharp/Things/Comment.cs

@@ -164,8 +164,8 @@ private void ParseComments(JToken data, Thing sender)
         [JsonIgnore]
         public Thing Parent { get; internal set; }
 
-		/// <inheritdoc/>
-		public override string Shortlink => Permalink.ToString();
+        /// <inheritdoc/>
+        public override string Shortlink => Permalink.ToString();
 
         /// <summary>
         /// Reply to this comment.

RedditSharp/Things/Contributor.cs

@@ -1,50 +1,23 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
-using RedditSharp.Extensions;
+using RedditSharp.Things.User;
 using System;
 
 namespace RedditSharp.Things
 {
     /// <summary>
     /// A contributor to a subreddit.
     /// </summary>
-    public class Contributor : RedditUser
+    public class Contributor : RelatedUser
     {
         /// <inheritdoc />
         public Contributor(IWebAgent agent, JToken json) : base(agent, json) {
-            var data = json["name"] == null ? json["data"] : json;
-            base.Name = data["name"].ValueOrDefault<string>();
-            var id = data["id"].ValueOrDefault<string>();
-            if (id.Contains("_"))
-            {
-                base.Id = id.Split('_')[1];
-                base.FullName = id;
-            }
         }
 
-        /// <summary>
-        /// Contributor name.
-        /// </summary>
-        [JsonProperty("name")]
-        public new string Name { get; private set; }
-
         /// <summary>
         /// Date contributor was added.
         /// </summary>
-        [JsonProperty("date")]
-        [JsonConverter(typeof(UnixTimestampConverter))]
-        public DateTime DateAdded { get; private set; }
-
-        /// <summary>
-        /// This will always return 0 for Contributors
-        /// </summary>
-        [JsonIgnore]
-        public new int CommentKarma => 0;
-
-        /// <summary>
-        /// This will always return 0 for Contributors
-        /// </summary>
-        [JsonIgnore]
-        public new int LinkKarma => 0;
+        [Obsolete("User RelUser.Date")]
+        public DateTime? DateAdded { get => DateUTC; private set => DateUTC = value; }
     }
 }

RedditSharp/Things/RedditUser.cs

@@ -1,5 +1,6 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using RedditSharp.Things.User;
 using System;
 using System.Threading.Tasks;
 
@@ -8,7 +9,7 @@ namespace RedditSharp.Things
     /// <summary>
     /// A reddit user.
     /// </summary>
-    public class RedditUser : CreatedThing
+    public class RedditUser : PartialUser
     {
         /// <inheritdoc />
         public RedditUser(IWebAgent agent, JToken json) : base(agent, json)
@@ -30,10 +31,13 @@ public RedditUser(IWebAgent agent, JToken json) : base(agent, json)
         internal override JToken GetJsonData(JToken json) => json["name"] == null ? json["data"] : json;
 
         /// <summary>
-        /// Reddit username.
+        /// This method returns itself as the full <see cref="RedditUser"/> is
+        /// already initalized so no more further initialization needs to
+        /// be done.
         /// </summary>
-        [JsonProperty("name")]
-        public string Name { get; internal set; }
+        /// <returns>This same <see cref="RedditUser"/>.</returns>
+        /// <seealso cref="PartialUser.GetFullUserAsync"/>
+        public override Task<RedditUser> GetFullUserAsync() => Task.FromResult(this);
 
         /// <summary>
         /// Returns true if the user has reddit gold.
@@ -106,43 +110,8 @@ public RedditUser(IWebAgent agent, JToken json) : base(agent, json)
         [JsonProperty("pref_show_snoovatar")]
         public bool ShowSnoovatar { get; private set; }
 
-        /// <summary>
-        /// Prefix for fullname. Includes trailing underscore
-        /// </summary>
-        public static string KindPrefix { get { return "t2_"; } }
-
         #endregion
 
-        /// <summary>
-        /// Return the users overview.
-        /// </summary>
-        public Listing<VotableThing> GetOverview(int max = -1) => Listing<VotableThing>.Create(WebAgent, OverviewUrl, max, 100);
-
-        /// <summary>
-        /// Return a <see cref="Listing{T}"/> of posts liked by the logged in user.
-        /// </summary>
-        public Listing<Post> GetLikedPosts(int max = -1) => Listing<Post>.Create(WebAgent, LikedUrl, max, 100);
-
-        /// <summary>
-        /// Return a <see cref="Listing{T}"/> of posts disliked by the logged in user.
-        /// </summary>
-        public Listing<Post> GetDislikedPosts(int max = -1) => Listing<Post>.Create(WebAgent, DislikedUrl, max, 100);
-
-        /// <summary>
-        /// Return a <see cref="Listing{T}"/> of comments made by the user.
-        /// </summary>
-        public Listing<Comment> GetComments(int max = -1) => Listing<Comment>.Create(WebAgent, CommentsUrl, max, 100);
-
-        /// <summary>
-        /// Return a <see cref="Listing{T}"/> of posts made by the user.
-        /// </summary>
-        public Listing<Post> GetPosts(int max = -1) => Listing<Post>.Create(WebAgent, LinksUrl, max, 100);
-
-        /// <summary>
-        /// Return a list of subscribed subreddits for the logged in user.
-        /// </summary>
-        public Listing<Subreddit> GetSubscribedSubreddits(int max = -1) => Listing<Subreddit>.Create(WebAgent, SubscribedSubredditsUrl, max, 100);
-
         static string QueryString(Sort sort, int limit, FromTime time) =>
           $"?sort={sort.ToString("g")}&limit={limit}&t={time.ToString("g")}";
 
@@ -151,77 +120,6 @@ static void CheckRange(int limit, int max_limit)
             if ((limit < 1) || (limit > max_limit))
                 throw new ArgumentOutOfRangeException(nameof(limit), $"Valid range: [1, {max_limit}]");
         }
-        /// <summary>
-        /// Returns a <see cref="RedditUser"/> by username
-        /// </summary>
-        /// <param name="agent">WebAgent to perform search</param>
-        /// <param name="username">Username of user to return</param>
-        /// <returns></returns>
-        public static async Task<RedditUser> GetUserAsync(IWebAgent agent, string username)
-        {
-            var json = await agent.Get(string.Format(UserInfoUrl, username)).ConfigureAwait(false);
-            return new RedditUser(agent, json);
-        }
-
-        /// <summary>
-        /// Get a listing of comments and posts from the user sorted by <paramref name="sorting"/>, from time <paramref name="fromTime"/>
-        /// and limited to <paramref name="limit"/>.
-        /// </summary>
-        /// <param name="sorting">How to sort the comments (hot, new, top, controversial).</param>
-        /// <param name="limit">How many comments to fetch per request. Max is 100.</param>
-        /// <param name="fromTime">What time frame of comments to show (hour, day, week, month, year, all).</param>
-        /// <returns>The listing of comments requested.</returns>
-        public Listing<VotableThing> GetOverview(Sort sorting = Sort.New, int limit = 25, FromTime fromTime = FromTime.All)
-        {
-            CheckRange(limit, MAX_LIMIT);
-            string overviewUrl = OverviewUrl + QueryString(sorting, limit, fromTime);
-            return new Listing<VotableThing>(WebAgent, overviewUrl);
-        }
-
-        /// <summary>
-        /// Get a listing of comments from the user sorted by <paramref name="sorting"/>, from time <paramref name="fromTime"/>
-        /// and limited to <paramref name="limit"/>.
-        /// </summary>
-        /// <param name="sorting">How to sort the comments (hot, new, top, controversial).</param>
-        /// <param name="limit">How many comments to fetch per request. Max is 100.</param>
-        /// <param name="fromTime">What time frame of comments to show (hour, day, week, month, year, all).</param>
-        /// <returns>The listing of comments requested.</returns>
-        public Listing<Comment> GetComments(Sort sorting = Sort.New, int limit = 25, FromTime fromTime = FromTime.All)
-        {
-            CheckRange(limit, MAX_LIMIT);
-            string commentsUrl = CommentsUrl + QueryString(sorting, limit, fromTime);
-            return new Listing<Comment>(WebAgent, commentsUrl);
-        }
-
-        /// <summary>
-        /// Get a listing of posts from the user sorted by <paramref name="sorting"/>, from time <paramref name="fromTime"/>
-        /// and limited to <paramref name="limit"/>.
-        /// </summary>
-        /// <param name="sorting">How to sort the posts (hot, new, top, controversial).</param>
-        /// <param name="limit">How many posts to fetch per request. Max is 100.</param>
-        /// <param name="fromTime">What time frame of posts to show (hour, day, week, month, year, all).</param>
-        /// <returns>The listing of posts requested.</returns>
-        public Listing<Post> GetPosts(Sort sorting = Sort.New, int limit = 25, FromTime fromTime = FromTime.All)
-        {
-            CheckRange(limit, 100);
-            string linksUrl = LinksUrl + QueryString(sorting, limit, fromTime);
-            return new Listing<Post>(WebAgent, linksUrl);
-        }
-
-        /// <summary>
-        /// Get a listing of comments and posts saved by the user sorted by <paramref name="sorting"/>, from time <paramref name="fromTime"/>
-        /// and limited to <paramref name="limit"/>.
-        /// </summary>
-        /// <param name="sorting">How to sort the comments (hot, new, top, controversial).</param>
-        /// <param name="limit">How many comments to fetch per request. Max is 100.</param>
-        /// <param name="fromTime">What time frame of comments to show (hour, day, week, month, year, all).</param>
-        /// <returns>The listing of posts and/or comments requested that the user saved.</returns>
-        public Listing<VotableThing> GetSaved(Sort sorting = Sort.New, int limit = 25, FromTime fromTime = FromTime.All)
-        {
-            CheckRange(limit, 100);
-            string savedUrl = SavedUrl + QueryString(sorting, limit, fromTime);
-            return new Listing<VotableThing>(WebAgent, savedUrl);
-        }
 
         /// <inheritdoc/>
         public override string ToString() => Name;

RedditSharp/Things/Subreddit.cs

@@ -950,7 +950,7 @@ public static async Task<IEnumerable<ModeratorUser>> GetModeratorsAsync(IWebAgen
             var mods = data["children"].ToArray();
             var result = new ModeratorUser[mods.Length];
             for(var i = 0; i < mods.Length; i++) {
-                var mod = new ModeratorUser(mods[i]);
+                var mod = new ModeratorUser(agent, mods[i]);
                 result[i] = mod;
             }
             return result;

RedditSharp/Things/User/NotedUser.cs

@@ -0,0 +1,16 @@
+using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace RedditSharp.Things.User
+{
+    public class NotedUser : RelatedUser
+    {
+        public NotedUser(IWebAgent agent, JToken json) : base(agent, json)
+        {
+        }
+
+        [JsonProperty("note")]
+        public String Note { get; internal set; }
+    }
+}