Gem Version Build Status Gem Downloads

Redd is a batteries-included API wrapper for reddit.

--- ### Features - Supports most of the reddit API, including live threads and the beta mod-mail. - Includes support for streaming new posts and comments. - Built-in rate limiting and error handling. - Automatic retrying of failed requests. ### Demo ```ruby require 'redd' session = Redd.it( user_agent: 'Redd:RandomBot:v1.0.0 (by /u/Mustermind)', client_id: 'PQgS0UaX9l70oQ', secret: 'PsF_kVZrW8nSVCG5kNsIgl-AaXE', username: 'RandomBot', password: 'hunter2' ) session.subreddit('all').comment_stream do |comment| if comment.body.include?('roll a dice') comment.reply("I just rolled a dice! It's a #{rand(1..6)}!") elsif comment.body.include?('flip a coin') comment.reply("I just flipped a coin! It's a #{%w(heads tails).sample}!") end end ``` ### FAQ #### Is that bot fully functional? **Yes**, that's all there is to it! You don't need to handle rate-limiting, refresh access tokens or protect against issues on reddit's end (like 5xx errors). #### Where can I find the documentation? [**Gem**](http://www.rubydoc.info/gems/redd/Redd/Models/Session) / [**GitHub**](http://www.rubydoc.info/github/avinashbot/redd/master/Redd/Models/Session) #### How do I request a feature / contribute? - The quickest way to get a feature into Redd is to raise a GitHub issue. - Pull requests are also appreciated! - Don't hesitate! There are no stupid questions! #### How can I contact you? [Reddit](https://www.reddit.com/message/compose/?to=Mustermind) / [GitHub](https://github.com/avinashbot/redd/issues/new) / [Email](mailto:avinash@dwarapu.me) ---
This project is available under the MIT License. See LICENSE.txt for more details.
The Redd logo uses the FARRAY font by Coquet Adrien.