Add collection support

.gitignore

@@ -9,6 +9,7 @@ TestResults/
 *.mdf
 *.psess
 *.vsp
+.idea/
 
 /**/project.lock.json
 
@@ -18,4 +19,4 @@ StyleCop.Cache
 /.vs
 /packages
 /RedditSharpTests/secrets.json
-/RedditSharpTests/private.config
+/RedditSharpTests/private.json

CONTRIBUTING.md

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

RedditSharp/Data/Collections/AddOrRemovePostsFromCollectionParams.cs

@@ -0,0 +1,17 @@
+namespace RedditSharp.Data.Collections
+{
+    internal class AddOrRemovePostsFromCollectionParams
+    {
+        /// <summary>
+        /// UUID of a collection
+        /// </summary>
+        [RedditAPIName("collection_id")]
+        internal string CollectionId { get; set; }
+
+        /// <summary>
+        /// Full name of link, e.g. t3_xyz
+        /// </summary>
+        [RedditAPIName("link_fullname")]
+        internal string LinkFullName { get; set; }
+    }
+}

RedditSharp/Data/Collections/CollectionCreationParams.cs

@@ -0,0 +1,23 @@
+namespace RedditSharp.Data.Collections
+{
+    internal class CollectionCreationParams
+    {
+        /// <summary>
+        /// Title of the submission. Maximum 300 characters.
+        /// </summary>
+        [RedditAPIName("title")]
+        internal string Title { get; set; }
+
+        /// <summary>
+        /// Description of the collection. Maximum of 500 characters.
+        /// </summary>
+        [RedditAPIName("description")]
+        internal string Description { get; set; }
+
+        /// <summary>
+        /// Name of the subreddit to which you are submitting.
+        /// </summary>
+        [RedditAPIName("sr_fullname")]
+        internal string Subreddit { get; set; }
+    }
+}

RedditSharp/Data/Collections/GetCollectionParams.cs

@@ -0,0 +1,20 @@
+namespace RedditSharp.Data.Collections
+{
+    internal class CollectionBaseParams
+    {
+        /// <summary>
+        /// UUID of a collection
+        /// </summary>
+        [RedditAPIName("collection_id")]
+        internal string CollectionId { get; set; }
+    }
+
+    internal class GetCollectionParams : CollectionBaseParams
+    {
+        /// <summary>
+        /// Should include all the links
+        /// </summary>
+        [RedditAPIName("include_links")]
+        internal bool IncludeLinks { get; set; }
+    }
+}

RedditSharp/Data/Urls.cs

@@ -0,0 +1,15 @@
+namespace RedditSharp.Data
+{
+    internal static class Urls
+    {
+        internal static class Collections
+        {
+            internal const string AddPost = "/api/v1/collections/add_post_to_collection";
+            internal static string Get(string collectionId, bool includeLinks) => $"/api/v1/collections/collection.json?collection_id={collectionId}&include_links={includeLinks}";
+            internal const string CreateCollectionUrl = "/api/v1/collections/create_collection";
+            internal const string Delete = "/api/v1/collections/delete_collection";
+            internal const string RemovePost = "/api/v1/collections/remove_post_in_collection";
+            internal static string SubredditCollectionsUrl(string fullName) => $"/api/v1/collections/subreddit_collections.json?sr_fullname={fullName}";
+        } 
+    }
+}

RedditSharp/Exceptions/RedditException.cs

@@ -1,4 +1,5 @@
 using System;
+using Newtonsoft.Json.Linq;
 
 namespace RedditSharp
 {
@@ -8,6 +9,8 @@ namespace RedditSharp
     [Serializable]
     public class RedditException : Exception
     {
+        public JArray Errors { get; }
+
         /// <summary>
         /// Initializes a new instance of the RedditException class.
         /// </summary>
@@ -26,6 +29,17 @@ public RedditException(string message)
 
         }
 
+        /// <summary>
+        /// Initializes a new instance of the RedditException class with a specified error message and a JArray of errors
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        /// <param name="errors">List of errors.</param>
+        public RedditException(string message, JArray errors)
+            : base(message)
+        {
+            Errors = errors;
+        }
+
         /// <summary>
         /// Initializes a new instance of the RedditException class with a specified error message and
         /// a referenced inner exception that is the cause of this exception.

RedditSharp/Extensions/JTokenExtensions/JTokenExtensions.cs

@@ -0,0 +1,33 @@
+using Newtonsoft.Json.Linq;
+
+namespace RedditSharp.Extensions.JTokenExtensions
+{
+    public static class JTokenExtensions
+    {
+        public static void ThrowIfHasErrors(this JToken json, string message)
+        {
+            if (json["errors"].IsNonEmptyArray(out var errors))
+            {
+                throw new RedditException($"{message} {errors}", errors);
+            }
+        }
+
+        public static bool IsNonEmptyArray(this JToken json, out JArray array)
+        {
+            var isArray = _IsArray(json, out array);
+            return isArray && array.Count > 0;
+        }
+
+        private static bool _IsArray(JToken json, out JArray array)
+        {
+            if (json != null && json.Type == JTokenType.Array)
+            {
+                array = (JArray)json;
+                return true;
+            }
+            array = default;
+            return false;
+
+        }
+    }
+}

RedditSharp/Helpers/Helpers.PopulateObjects.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Newtonsoft.Json.Linq;
+using RedditSharp.Interfaces;
+
+namespace RedditSharp
+{
+    public partial class Helpers
+    {
+        internal static List<T> PopulateObjects<T>(JToken json, IWebAgent webAgent)
+            where T : ISettableWebAgent, new()
+        {
+            if (json.Type != JTokenType.Array)
+                throw new ArgumentException("must be of type array", nameof(json));
+
+            var objects = new List<T>();
+
+            for (var i = 0; i < json.Count(); i++)
+            {
+                var item = new T();
+                PopulateObject(json[i], item);
+                item.WebAgent = webAgent;
+                objects.Add(item);
+            }
+
+            return objects;
+        }
+    }
+}

RedditSharp/Interfaces/ISettableWebAgent.cs

@@ -0,0 +1,10 @@
+using Newtonsoft.Json;
+
+namespace RedditSharp.Interfaces
+{
+    internal interface ISettableWebAgent
+    {
+        [JsonIgnore]
+        IWebAgent WebAgent { set; }
+    }
+}

RedditSharp/Reddit.cs

@@ -5,6 +5,9 @@
 using System.Linq.Expressions;
 using System.Security.Authentication;
 using System.Threading.Tasks;
+using RedditSharp.Data;
+using RedditSharp.Data.Collections;
+using RedditSharp.Extensions.JTokenExtensions;
 using DefaultWebAgent = RedditSharp.WebAgent;
 
 namespace RedditSharp
@@ -477,5 +480,23 @@ public Listing<T> GetListing<T>(string url, int maxLimit = -1, int limitPerReque
         {
             return new Listing<T>(this.WebAgent, url, maxLimit, limitPerRequest);
         }
+
+        public async Task<Collection> GetCollectionAsync(string collectionId, bool includePostsContent = true)
+        {
+            var json = await WebAgent.Get(Urls.Collections.Get(collectionId, includePostsContent));
+            json.ThrowIfHasErrors("Could not retrieve the collection.");
+            return new Collection(json, WebAgent);
+        }
+
+        /// <summary>
+        /// Deletes the specified collection. Must be a mod of the subreddit to delete.
+        /// </summary>
+        /// <param name="collectionId"></param>
+        /// <returns></returns>
+        public async Task DeleteCollectionAsync(string collectionId)
+        {
+            var json = await WebAgent.Post(Urls.Collections.Delete, new CollectionBaseParams { CollectionId = collectionId });
+            json.ThrowIfHasErrors("Could not delete the collection.");
+        }
     }
 }

RedditSharp/RedditSharp.csproj

@@ -12,12 +12,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="1.1.2" />
     <PackageReference Include="Newtonsoft.Json" Version="10.0.3" />
     <PackageReference Include="System.Net.Http" Version="4.3.3" />
     <PackageReference Include="System.Net.Security" Version="4.3.2" />
     <PackageReference Include="System.Reflection.TypeExtensions" Version="4.4.0" />
-	  <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
+    <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
     <PackageReference Include="System.Threading.Thread" Version="4.3.0" />
     <PackageReference Include="System.Reactive.Linq" Version="3.1.1" />
     <PackageReference Include="System.Interactive.Async" Version="3.1.1" />

RedditSharp/Things/Collection.cs

@@ -0,0 +1,109 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using RedditSharp.Data;
+using RedditSharp.Data.Collections;
+using RedditSharp.Extensions.JTokenExtensions;
+using RedditSharp.Interfaces;
+
+namespace RedditSharp.Things
+{
+    public class Collection : ISettableWebAgent
+    {
+        [JsonProperty("subreddit_id")]
+        public string SubredditId { get; internal set; }
+
+        [JsonProperty("description")]
+        public string Description { get; internal set; }
+
+        [JsonProperty("author_name")]
+        public string AuthorName { get; internal set; }
+
+        [JsonProperty("collection_id")]
+        public string CollectionId { get; internal set; }
+
+        [JsonProperty("display_layout")]
+        public string DisplayLayout { get; internal set; }
+
+        [JsonProperty("permalink")]
+        public string Permalink { get; internal set; }
+
+        [JsonProperty("link_ids")]
+        public string[] LinkIds { get; internal set; }
+
+        [JsonProperty("title")]
+        public string Title { get; internal set; }
+
+        [JsonProperty("created_at_utc"), JsonConverter(typeof(UnixTimestampConverter))]
+        public DateTime CreatedAtUtc { get; internal set; }
+
+        [JsonProperty("author_id")]
+        public string AuthorId { get; internal set; }
+
+        [JsonProperty("last_update_utc"), JsonConverter(typeof(UnixTimestampConverter))]
+        public DateTime LastUpdateUtc { get; internal set; }
+
+        public Post[] Posts { get; }
+
+        public IWebAgent WebAgent { private get; set; }
+
+        public Collection()
+        {
+        }
+
+        public Collection(JToken json, IWebAgent agent)
+        {
+            WebAgent = agent;
+
+            Helpers.PopulateObject(json, this);
+
+            var posts = new List<Post>();
+            var children = json.SelectToken("sorted_links.data.children");
+            if (children != null && children.Type == JTokenType.Array)
+            {
+                posts.AddRange(children.Select(item => new Post(WebAgent, item)));
+            }
+
+            Posts = posts.ToArray();
+        }
+
+        /// <summary>
+        /// Adds a post to the collection
+        /// </summary>
+        /// <param name="linkFullName">Full name of link, e.g. t3_xyz</param>
+        public async Task AddPostAsync(string linkFullName)
+        {
+            var data = new AddOrRemovePostsFromCollectionParams
+            {
+                CollectionId = CollectionId,
+                LinkFullName = linkFullName,
+            };
+            var json = await WebAgent.Post(Urls.Collections.AddPost, data);
+            json.ThrowIfHasErrors("Could not add post to collection.");
+        }
+
+        /// <summary>
+        /// Removes a post from the collection
+        /// </summary>
+        /// <param name="linkFullName">Full name of link, e.g. t3_xyz</param>
+        public async Task RemovePostAsync(string linkFullName)
+        {
+            var data = new AddOrRemovePostsFromCollectionParams
+            {
+                CollectionId = CollectionId,
+                LinkFullName = linkFullName,
+            };
+            var json = await WebAgent.Post(Urls.Collections.RemovePost, data);
+            json.ThrowIfHasErrors("Could not remove post from collection.");
+        }
+
+        public async Task DeleteAsync()
+        {
+            var json = await WebAgent.Post(Urls.Collections.Delete, null);
+            json.ThrowIfHasErrors("Could not remove collection.");
+        }
+    }
+}