redd 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0369bfc4c491d26f3330c1644d9f5724d9ad583a
-  data.tar.gz: 3b3507c642e26bc6b7817965c1fcdfb1f4fde177
+  metadata.gz: 7d9b725f4c257d4b0ce3119e81c7395253399290
+  data.tar.gz: d6078a42f2bca04fae6497d8cfa935085e581cc8
 SHA512:
-  metadata.gz: 5bcc787430010a207c9375df1d7a3be3f9689e3bd116cadb7aa4123141776271b3db74ede823c484e502128cfc75fdd53a428dc7286c8815f73e579b40673844
-  data.tar.gz: 117dbdf5f5e4fc0fa5d93055a3bde0136d7bbc6e29dcc2aa1d972bb9c496911671e03eb8eab1833137f18346b48c1d73cd07741dc4375ac20a8b3d00c86a8b03
+  metadata.gz: 08ed7d7fb94496d5307df3cd54d1eca7bf2211773353c51ecddce04234f6fb898e63016feb4c85e10ead5d75bf86eda72d720a3350bc79fb599a78ff027167c6
+  data.tar.gz: 29015295ac9d449230f2c4785e450c66dd1bbe7cd86aea3dc29763be51cc61385151d4eb60383817c5fb0ce72b26aa396b3a6d72fde253834a6a2def8a3c6b1b

data/README.md

@@ -48,7 +48,7 @@ Ruby and redd make creating reddit bots accessible and fun. To demonstrate, let'
    ```
 
 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`](https://github.com/avidw/redd/blob/master/lib/redd/rate_limit.rb#L2-L23)
+   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 less blocking rate limiting class, take a look at [`lib/redd/rate_limit.rb`](https://github.com/avidw/redd/blob/master/lib/redd/rate_limit.rb#L2-L23)
 
    ```ruby
    r.comment_stream "test" do |comment|
@@ -75,7 +75,9 @@ Ruby and redd make creating reddit bots accessible and fun. To demonstrate, let'
    ```
 
 ## OAuth2
-Redd also provides a wrapper to connect to reddit via OAuth2. The client's methods are similar to the authenticated client, given that you have the required scopes. Refer to [reddit's api](https://www.reddit.com/dev/api/oauth) for the various scopes. Getting it running is really simple and can even be used to integrate reddit's features into a [**Rails**](https://github.com/rails/rails) application. Another plus is that logging in via OAuth2 lets you make twice as many requests without hitting a rate limit (1/second). Let's try logging into reddit with [**sinatra**](http://www.sinatrarb.com/).
+Redd also provides a wrapper to connect to reddit via OAuth2 for both the `authorization_code` and `password` grants with the `Redd::Client::OAuth2` and `Redd::Client::OAuth2Script` clients. The clients' methods are similar to the authenticated client, given that you have the required scopes. Refer to [reddit's api](https://www.reddit.com/dev/api/oauth) for the various scopes. Getting OAuth2 running is easy and can even be used to integrate reddit's features into a [**Rails**](https://github.com/rails/rails) application. Another plus is that logging in via OAuth2 lets you make twice as many requests without hitting a rate limit (1/second). Let's try logging into reddit with [**sinatra**](http://www.sinatrarb.com/).
+
+*If you're using the `OAuth2Script` client, you don't have to do all this work. For the `password` grant, you can just jump straight to `request_access` without having to get a code, which is pretty sweet.*
 
 The first thing you need to do is to create an OAuth2 application in reddit [**here**](https://ssl.reddit.com/prefs/apps). For more information, refer to [**"Getting Started"**](https://github.com/reddit/reddit/wiki/OAuth2#getting-started) on reddit's wiki. 
 

data/lib/redd.rb

@@ -1,3 +1,4 @@
 require "redd/client/unauthenticated"
 require "redd/client/authenticated"
 require "redd/client/oauth2"
+require "redd/client/oauth2_script"

data/lib/redd/client/authenticated.rb

@@ -1,3 +1,5 @@
+require "redd/client/unauthenticated"
+
 module Redd
   module Client
     # The class that handles requests when authenticated using a username and

data/lib/redd/client/oauth2_script.rb

@@ -0,0 +1,24 @@
+require "redd/client/oauth2"
+
+module Redd
+  module Client
+    class OAuth2Script < Redd::Client::OAuth2
+      require "redd/client/oauth2_script/authorization"
+
+      include Redd::Client::OAuth2Script::Authorization
+
+      attr_reader :username
+
+      def initialize(client_id, secret, username, password, options = {})
+        @client_id = client_id
+        @secret = secret
+        @username = username
+        @password = password
+
+        @rate_limit = options[:rate_limit] || Redd::RateLimit.new(1)
+        @api_endpoint = options[:api_endpoint] || "https://oauth.reddit.com/"
+        @auth_endpoint = options[:auth_endpoint] || "https://ssl.reddit.com/"
+      end
+    end
+  end
+end

data/lib/redd/client/oauth2_script/authorization.rb

@@ -0,0 +1,21 @@
+require "redd/oauth2_access"
+
+module Redd
+  module Client
+    class OAuth2Script
+      # Methods for obtaining an access token
+      module Authorization
+        def request_access(set_access = true)
+          response = auth_connection.post "/api/v1/access_token",
+                                          grant_type: "password",
+                                          username: @username,
+                                          password: @password
+
+          access = Redd::OAuth2Access.new(response.body)
+          @access = access if set_access
+          access
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,7 @@ module Redd
         # Get the appropriate listing.
         # @param subreddit [Redd::Object::Subreddit] The subreddit to query.
         # @param params [Hash] A list of params to send with the request.
+        # @return [Redd::Object::Listing]
         #
         # @see #get_listing
         %w(hot new top controversial comments).each do |sort|

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

@@ -22,6 +22,7 @@ module Redd
         # Get the appropriate listing.
         # @param user [Redd::Object::User] The user to query.
         # @param params [Hash] A list of params to send with the request.
+        # @return [Redd::Object::Listing]
         #
         # @see #get_user_listing
         %w(

data/lib/redd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,8 @@ files:
 - lib/redd/client/oauth2.rb
 - lib/redd/client/oauth2/authorization.rb
 - lib/redd/client/oauth2/identity.rb
+- lib/redd/client/oauth2_script.rb
+- lib/redd/client/oauth2_script/authorization.rb
 - lib/redd/client/unauthenticated.rb
 - lib/redd/client/unauthenticated/account.rb
 - lib/redd/client/unauthenticated/captcha.rb