DEPRECATED

Due to my own motivation and recent occurences at Reddit, I'm not longer going to be maintaining this repository. If someone has interest in taking this over, feel free to contact me ([email protected])

---

This is a hard fork.

Due to the project being abandoned and the previous owner's refusal to transfer the repository to someone else to maintain it, I've created this fork to continue on support for the project.

See CONTRIBUTING.MD for instructions for development

RedditSharp

A partial implementation of the Reddit API. Includes support for many API endpoints, as well as LINQ-style paging of results.

Reddit rate limits requests by "user". Users can be either the script itself, or a specific user's login info/token. To handle multiple users and their different rate limits, the best solution is to use a "pool" of connections to track it.

RefreshTokenWebAgentPool supplies methods to store and retrieve IWebAgents for users by implementing a cache of RefreshTokenWebAgents that automatically get a new access token when the current one expires.

Recently used IWebAgents are stored in an in-memory cache that uses a GUID as a key, and the IWebAgent as the object. The default is to have a sliding expiration set so that if a user isn't actively being used, it will expire the IWebAgent out of memory, but still have the details it needs to re-create it when it is next needed.

All details to create a new IWebAgent that isn't in the cache, but has been used before, are stored in a private array for the pool so it can easily recreate WebAgents as needed.

It can likely be used in a standard .NET application so long as you use a static variable to store the refernce, but below is the recommended method of usage in a .NET CORE application.

public class Startup {
	...
	public void ConfigureServices( IServiceCollection services ){
		...
		//Configuration object should be defined and loaded already
		var webAgentPool = new RedditSharp.RefreshTokenWebAgentPool(Configuration["RedditClientID"], Configuration["RedditClientSecret"], Configuration["RedditRedirectURI"])
            {
                DefaultRateLimitMode = RedditSharp.RateLimitMode.Burst,
                DefaultUserAgent = "SnooNotes (by Meepster23)"
            };
		services.AddSingleton(webAgentPool); //Important to add as Singleton so multiple instances aren't created
	}
}

public class SomeController {
	private RedditSharp.RefreshTokenWebAgentPool agentPool;
	
	public void SomeController( RedditSharp.RefreshTokenWebAgentPool webAgentPool){
		agentPool = webAgentPool;
	}
	
	public async Task DoSomething(string username){
		var webAgent =  await agentPool.GetOrCreateWebAgentAsync(user.BannedBy, (uname, uagent, rlimit) =>
            {
				//string refreshToken = await usermanager call to get identity and retrieve refresh token;
				//uname = username for webagent being created
				//uagent = default useragent for webagent being created
				//rlimit = default rate limit mode for webagent being created
				return Task.FromResult<RedditSharp.RefreshTokenPoolEntry>(new RedditSharp.RefreshTokenPoolEntry(uname, refreshToken, rlimit, uagent));
            }
		);
		var reddit = new RedditSharp.Reddit(webAgent, true);
		//use reddit to make calls as user
	}
}

A BotWebAgent uses a "script" type app and automatically renew access tokens using a username and password

var webAgent = new BotWebAgent("BotUsername", "BotPass", "ClientID", "ClientSecret", "RedirectUri");
//This will check if the access token is about to expire before each request and automatically request a new one for you
//"false" means that it will NOT load the logged in user profile so reddit.User will be null
var reddit = new Reddit(webAgent, false);
var subreddit = reddit.GetSubreddit("/r/example");
await subreddit.SubscribeAsync();
await reddit.RSlashAll.New.Take(2).ForEachAsync(page => {
  foreach(var post in page) {
    if (post.Title == "What is my karma?")
    {
        // Note: This is an example. Bots are not permitted to cast votes automatically.
        post.Upvote();
        var comment = post.Comment(string.Format("You have {0} link karma!", post.Author.LinkKarma));
        comment.Distinguish(DistinguishType.Moderator);
    }
  }
});

Important note: Make sure you use .Take(int) when working with pagable content. For example, don't do this:

await reddit.RSlashAll.New.ForEachAsync(page => { // BAD
  foreach(var post in page) {
    // ...
  }
});

This will cause you to page through everything that has ever been posted on Reddit. Better:

await reddit.RSlashAll.New.Take(2).ForEachAsync(page => {
  foreach(var post in page) {
    // ...
  }
});

Using ListingStreams

Use ListingStreams to infinitely yield new Things posted to reddit

Example:

// Create the stream
ListingStream<Post> postStream = subreddit.GetPosts(Subreddit.Sort.New).Stream();
// Note: Don't set the max in the GetPosts() method, otherwise the stream will
// stop working as soon as you reach this value.
// The handling method that will be call on each new post
postStream.Subscribe(post => logger.LogDebug($"Post : [{post.Title} at {post.CreatedUTC}]"));
// Start listening
await postStream.Enumerate(cancellationToken);

// Any properties that returns a Listing<T> has its stream version, another example, new modmail.
ListingStream<PrivateMessage> modMailStream = reddit.User.GetModMail().Stream();
modMailStream.Subscribe(message => logger.LogDebug($"ModMail : {message.Subject}"));
await modMailStream.Enumerate(cancellationToken);

// Need more than one stream at a time ?
ListingStream<Post> postStream = subreddit.GetPosts(Subreddit.Sort.New).Stream();
postStream.Subscribe(post => logger.LogDebug($"Post : [{post.Title} at {post.CreatedUTC}]"));
ListingStream<PrivateMessage> modMailStream = reddit.User.GetModMail().Stream();
modMailStream.Subscribe(message => logger.LogDebug($"ModMail : {message.Subject}"));

await Task.WhenAll({
  postStream.Enumerate(cancellationToken),
  modMailStream.Enumerate(cancellationToken)
});

Development

RedditSharp is developed with the following workflow:

1. Nothing happens for weeks/months/years
2. Someone needs it to do something it doesn't already do
3. That person implements that something and submits a pull request
4. Repeat

If it doesn't have a feature that you want it to have, add it! The code isn't that scary.