redd 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 737c5bb6b96b0507169cd88c0d2b6d7117241dc6
-  data.tar.gz: 277672cec830f047ffe1b17082325da5bf88fc46
+  metadata.gz: 9995a3135f22f152099ca5061fda02f8a28edc3d
+  data.tar.gz: 380b6410fe23d07d9d154e598d57cc0084160dca
 SHA512:
-  metadata.gz: ae62116a74fcb27b218e55024133082861d63ecc5b8cba99b1a46d86d94cdb9350e59104fef2ed2963d13f31d5e7dfcf5a83f4d501adb643bb86e245b37a554b
-  data.tar.gz: 3ae8c2e8870bcdcc0e2b3705073e1b4ae46aacc735ae662d9fedcdd07618351aa53982e911f371b5432e186dadfdab388867f248d798a57a2aa5c5ec11c6a174
+  metadata.gz: 1be5b63773da2565be7c503357ee562db3448519db4ba4d158a4f86e4cc9fecf6edfdff576dabf043b13a0535ffb6101aff6ae7b0b6667eb3d7889e635b8135e
+  data.tar.gz: c13ad09d5157a56e02fff9a5811cf30c5c8d017aeafb7fc026eda6996ef45a0807a8cd87fc0482bb68bc2deaea3e581157742a9c56265d966c88f19940bb1c1d

data/README.md

@@ -4,8 +4,7 @@
   <a href="https://gemnasium.com/avidw/redd"><img src="https://gemnasium.com/avidw/redd.svg" alt="Dependency Status"></a>
 </p>
 
-**redd** is an API wrapper for [reddit](http://reddit.com/dev/api) written in ruby that focuses on being *simple and extensible*.  
-**NOTE: Major features are not implemented yet!**
+**redd** is an API wrapper for [reddit](http://reddit.com/dev/api) written in ruby that focuses on being *simple and extensible*.
 
 ---
 
@@ -20,17 +19,40 @@
 ---
 
 ## Getting Started
-TODO: Elaborate.
+Ruby and redd make creating reddit bots accessible and fun. To demonstrate, let's create a simple bot in three steps that responds to "Hello?" with "World!". *Note: this is just a tutorial; although you're welcome to take it on a test drive on a testing subreddit, don't actually host this bot.*
 
-```ruby
-require "redd"
+1. **Installing**  
+   You can either install the gem directly by running `gem install redd` or by placing the gem into your `Gemfile` and running `bundle install`.
+   ```ruby
+   source "https://rubygems.org"
+   gem "redd"
+   
+   # or if you're feeling adventurous
+   gem "redd", github: "avidw/redd"
+   ```
 
-client = Redd.client
-redditdev = client.subreddit("redditdev")
+2. **Setting Up**  
+   Let's load up redd and create a client for us to work with. (The username and password aren't real!)
+   ```ruby
+   require "redd"
+   #=> true
+   
+   r = Redd.client "HelloWorldBot", "hunter2"
+   # => #<Redd::Client::Authenticated:0xY4D4y4D4y4dA ...
+   
+   # This is generally a good thing to do:
+   r.user_agent = "HelloWorldBot v1.0 (Redd), written by /u/Mustermind"
+   ```
 
-latest_post = redditdev.get_new.first
-puts latest_post.title
-```
+3. **Scouting**  
+   Redd has a really cool method similar to praw's `helpers.comment_stream` that "streams" comments to you while avoiding duplicates. You won't have to take care of rate-limiting either; Redd `sleep`s after requests to avoid ratelimit errors. If you want to write a rate limiting class yourself, take a look at `lib/redd/rate_limit.rb`
+   ```ruby
+   r.comment_stream "test" do |comment|
+     if comment.body =~ /^Hello\?$/i
+       comment.reply "World!"
+     end
+   end
+   ```
 
 ## Extending Redd
 Extending any ruby library, including redd is incredibly easy. Let's try this out by adding a gilding extension. Reddit provides an api to be able to gild posts and comments, given that you have "creddits".

data/lib/redd/client/authenticated/moderation.rb

@@ -23,7 +23,7 @@ module Redd
 
         def accept_moderator_invite(subreddit)
           name = extract_attribute(subreddit, :display_name)
-          post, "/r/#{name}/api/accept_moderator_invite", api_type: "json"
+          post "/r/#{name}/api/accept_moderator_invite", api_type: "json"
         end
 
         def leave_contributor_status(subreddit)

data/lib/redd/client/unauthenticated/account.rb

@@ -6,11 +6,11 @@ module Redd
           meth = :post
           path = "/api/login"
           params = {
-            api_type: "json", user: username,
-            passwd: password, rem: remember
+            
           }
-          response = send(meth, path, params)
-          data = response.body[:json][:data]
+          response = post "/api/login",
+            api_type: "json", user: username, passwd: password, rem: remember
+          data = response[:json][:data]
 
           require "redd/client/authenticated"
           Redd::Client::Authenticated.new(data[:cookie], data[:modhash])

data/lib/redd/client/unauthenticated/listing.rb

@@ -27,6 +27,10 @@ module Redd
           get_listing(:controversial, *args)
         end
 
+        def get_comments(*args)
+          get_listing(:comments, *args)
+        end
+
         private
 
         def get_listing(type, subreddit = nil, params = {})

data/lib/redd/client/unauthenticated/utilities.rb

@@ -11,6 +11,25 @@ module Redd
   module Client
     class Unauthenticated
       module Utilities
+        def comment_stream(*args, &block)
+          submission_stream(:comments, *args, &block)
+        end
+
+        def submission_stream(listing, subreddit = "all", params = {}, &block)
+          loop do
+            # Get the latest comments from the subreddit. By the way, this line
+            #   is the one where the sleeping/rate-limiting happens.
+            objects = get_listing(listing, subreddit, params)
+            unless objects.empty?
+              # Set the latest comment.
+              params[:before] = objects.first.fullname
+              # Run the loop for each of the new comments accessed.
+              # I should probably add it to some sort of Set to avoid duplicates.
+              objects.reverse_each { |object| block.call(object) }
+            end
+          end
+        end
+
         private
 
         def extract_attribute(object, attribute)

data/lib/redd/object/comment.rb

@@ -51,6 +51,10 @@ module Redd
       def gilded?
         gilded > 0
       end
+
+      def reply(text)
+        client.reply(self, text)
+      end
     end
   end
 end

data/lib/redd/response/raise_error.rb

@@ -10,8 +10,7 @@ module Redd
         @app.call(faraday).on_complete do |env|
           error = Redd::Error.from_response(env)
           if error
-            info = Redd::Error.parse_error(env[:body])
-            fail error, info
+            fail error, env
           end
         end
       end

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # The main Redd module.
 module Redd
   # The semantic version number for Redd.
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Avinash Dwarapu