redd 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9995a3135f22f152099ca5061fda02f8a28edc3d
-  data.tar.gz: 380b6410fe23d07d9d154e598d57cc0084160dca
+  metadata.gz: a5a75930163e7a981bfd393651e20addf1f12c81
+  data.tar.gz: e96ea4f4250086a5ef52a37cc1e822a2ddf49819
 SHA512:
-  metadata.gz: 1be5b63773da2565be7c503357ee562db3448519db4ba4d158a4f86e4cc9fecf6edfdff576dabf043b13a0535ffb6101aff6ae7b0b6667eb3d7889e635b8135e
-  data.tar.gz: c13ad09d5157a56e02fff9a5811cf30c5c8d017aeafb7fc026eda6996ef45a0807a8cd87fc0482bb68bc2deaea3e581157742a9c56265d966c88f19940bb1c1d
+  metadata.gz: dac14d6136bb95431162a8f4e73639fc52e4f958c6b25df9a451bd880480c8e7d3437ba079d5a1135a3896cd76dd6eca89b205e57e64d5709facc8ab4ac61413
+  data.tar.gz: 556829db6d338e259e1123d1b52cc3193df565e82026131fd1caf827e99b035405b4f16c272a02517c852e984f67b1bad232c6637a1028f618cdc1bb73278a2b

data/README.md

@@ -11,7 +11,6 @@
 <p align="center">
   <a href="#getting-started">Getting Started</a> |
   <a href="#extending-redd">Extending Redd</a> |
-  <a href="#conventions">Conventions</a> |
   <a href="#supported-rubies">Supported Rubies</a> |
   <a href="#copyright">Copyright</a>
 </p>
@@ -19,7 +18,7 @@
 ---
 
 ## Getting Started
-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 and redd make creating reddit bots accessible and fun. To demonstrate, let's create a simple bot in four 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.*
 
 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`.
@@ -54,6 +53,25 @@ Ruby and redd make creating reddit bots accessible and fun. To demonstrate, let'
    end
    ```
 
+4. **Just in Case**  
+   It's also a good idea to escape some common errors from reddit in case they happen:
+   ```ruby
+   begin
+     r.comment_stream "test" do |comment|
+       if comment.body =~ /^Hello\?$/i
+         comment.reply "World!"
+       end
+     end
+   rescue Redd::Error::RateLimited => e
+     time_left = e.time
+     sleep(time_left)
+   rescue Redd::Error => e
+     status = e.message.status
+     # 5-something errors are usually errors on reddit's end.
+     raise e unless status.to_s.start_with? "5"
+   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".
 
@@ -101,30 +119,13 @@ Extending any ruby library, including redd is incredibly easy. Let's try this ou
    Redd::Object::Comment.include(Gildable)
    ```
 
-## Conventions
-### Method Names
-- A method that returns a Redd::Object directly is called that in lowercase. For example, a method that returns a single `Redd::Object::Subreddit` is called `subreddit`
-- Any method that return a listing is in the format `get_[thing]s`. For example, a method that returns a listing of subreddits is named `get_subreddits`.
-- An **internal** method that edits an existing object is **usually** named `edit_[thing]`. Some exeptions to this rule are `vote` that edit a user's vote.
-- Any method that returns something specific to the user must have "my" in the middle. For example, a method that returns a users subscribed subreddits is named `get_my_subscriptions`.
-
-### Methods
-- Most methods that use an http request should usually follow this convention. I haven't had time to check the methods to see if they follow this, but this should be the case
-  ```ruby
-  def subreddit(thing, options = {})
-    fullname = extract_fullname(thing)
-
-    meth = :get
-    path = "/r/ruby/about.json"
-    params = options << {additional: "options"}
-
-    object_from_response(meth, path, params)
-  end
-  ```
-
 ## Supported Rubies
 TODO: Travis CI
 
 ## Copyright
 Copyright (c) [Avinash Dwarapu](http://github.com/avidw) under the MIT License. See LICENSE.md for more details.  
 Some code has been used from [RedditKit.rb](http://github.com/samsymons/RedditKit.rb). See RedditKit.LICENSE.md for more details.
+
+---
+
+Redd not your cup of tea? Check out [RedditKit.rb](http://github.com/samsymons/RedditKit.rb)!

data/lib/redd/client/authenticated.rb

@@ -74,8 +74,8 @@ module Redd
       def connection
         @connection ||= Faraday.new(url: api_endpoint) do |faraday|
           faraday.use Faraday::Request::UrlEncoded
-          faraday.use Redd::Response::ParseJson
           faraday.use Redd::Response::RaiseError
+          faraday.use Redd::Response::ParseJson
           faraday.adapter Faraday.default_adapter
 
           faraday.headers["User-Agent"] = user_agent

data/lib/redd/client/unauthenticated.rb

@@ -63,8 +63,8 @@ module Redd
       def connection
         @connection ||= Faraday.new(url: api_endpoint) do |faraday|
           faraday.use Faraday::Request::UrlEncoded
-          faraday.use Redd::Response::ParseJson
           faraday.use Redd::Response::RaiseError
+          faraday.use Redd::Response::ParseJson
           faraday.adapter Faraday.default_adapter
 
           faraday.headers["User-Agent"] = user_agent

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

@@ -15,17 +15,17 @@ module Redd
           submission_stream(:comments, *args, &block)
         end
 
-        def submission_stream(listing, subreddit = "all", params = {}, &block)
+        def submission_stream(listing, subreddit = nil, 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) }
+              # Set the latest comment.
+              params[:before] = objects.first.fullname
             end
           end
         end

data/lib/redd/error.rb

@@ -4,7 +4,7 @@ module Redd
       # @note I ripped off RedditKit.rb :|
       def from_response(response) # rubocop:disable Style/CyclomaticComplexity Style/MethodLength
         status = response[:status]
-        body = parse_error(response[:body])
+        body = parse_error(response[:body]).to_s
         case status
         when 200
           case body
@@ -53,7 +53,7 @@ module Redd
         if body.key?(:json) && body[:json].key?(:errors)
           body[:json][:errors].first
         elsif body.key?(:jquery)
-          body[:jquery].to_s
+          body[:jquery]
         end
       end
     end
@@ -78,7 +78,12 @@ module Redd
 
     class PermissionDenied < Error; end
 
-    class RateLimited < Error; end
+    class RateLimited < Error
+      attr_reader :time
+      def initialize(time = 0)
+        @time = time
+      end
+    end
 
     class RequestError < Error; end
 

data/lib/redd/response/raise_error.rb

@@ -10,7 +10,12 @@ module Redd
         @app.call(faraday).on_complete do |env|
           error = Redd::Error.from_response(env)
           if error
-            fail error, env
+            if error == Redd::Error::RateLimited
+              seconds = env[:body][:json][:ratelimit]
+              fail error.new(seconds), env
+            else
+              fail error, env
+            end
           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.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,7 +167,6 @@ files:
 - README.md
 - Rakefile
 - RedditKit.LICENSE.md
-- TODO.md
 - github/redd.png
 - lib/redd.rb
 - lib/redd/base.rb
@@ -211,7 +210,6 @@ files:
 - redd.gemspec
 - spec/redd_spec.rb
 - spec/spec_helper.rb
-- test.rb
 homepage: ''
 licenses:
 - MIT

data/TODO.md

@@ -1,45 +0,0 @@
-## TODO.md
-
-#### Redd::Client
-- [ ] Unauthenticated
-  - [ ] Account
-  - [ ] Links & Comments
-  - [ ] Listing
-  - [ ] Live
-  - [ ] Subreddit
-  - [ ] Utilities
-  - [ ] Wiki
-- [ ] Authenticated
-  - [ ] Account
-  - [ ] Apps
-  - [ ] Flair
-  - [ ] Gold
-  - [ ] Links & Comments
-  - [ ] Live
-  - [ ] Moderation
-  - [ ] Multis
-  - [ ] Private Messages
-  - [ ] Subreddits
-  - [ ] Users
-  - [ ] Wiki
-- [ ] OAuth2
-
-#### Redd::Thing
-- [ ] Creatable
-- [ ] Editable
-- [ ] Hideable
-- [ ] Inboxable
-- [ ] Messageable
-- [ ] Moderatable
-- [ ] Reportable
-- [ ] Saveable
-- [ ] Voteable
-
-#### Redd::Object
-- [ ] `listing` **Listing**
-- [ ] `more` **MoreComments**
-- [ ] `t1_` **Comment**
-- [ ] `t2_` **User**
-- [ ] `t3_` **Submission**
-- [ ] `t4_` **PrivateMessage**
-- [ ] `t5_` **Subreddit**

data/test.rb

@@ -1,6 +0,0 @@
-require "redd"
-
-c = Redd.client
-s = c.get_info(id: "t3_2cfy08")
-
-puts c.get_comments(s)