redd 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d5b672f674cc48bf220c0a76b7074de9c509e13
-  data.tar.gz: 3fb2b44e36f0ed4f38c3633a4134c4cf85b0e48b
+  metadata.gz: b44594ffd55f136e44b2ec3ee48fa04b2d69c611
+  data.tar.gz: ed0efe9a7f3cf79b22aae8a3a8942cf1b6fc8699
 SHA512:
-  metadata.gz: 884382cf0fa1c690f9743e30992fc58b09bc7310660057034505b8c66ccea813c8442dde09e610ca610a6a21122c62cde61fdb5f33abfcc81a15efc2fa63d366
-  data.tar.gz: a7db6250cbdf1a3e3b5613af36245d5fcb44eb824d340cfa025b920caea59d3d99d2cfdc30052762ac2c594a955eb710e9baecd5116a2a5a8e5cff91ebc63820
+  metadata.gz: b7903c63b7044e3f4abb504d9c9ec93f1360622e744c4e88ec282d9bdf4438a448ed8b2c4810ee7861a45b32b2a6eef3f81e74b51e17885aac0c1f977bf97381
+  data.tar.gz: 5f4142ff913b834502cbb0fe5d114c19a69c2cba1e7de735383baac3923040c4bc9e51302b5f183ef91532d7681d740968e346e9f51f846a30324ecb6f05a7cd

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

@@ -43,6 +43,34 @@ module Redd
           object_from_response(:get, path, params)
         end
 
+        # Get users related to the subreddit.
+        #
+        # @param where [:banned, :wikibanned, :contributors, :wikicontributors,
+        #   :moderators] The order of users to return.
+        # @param subreddit [Redd::Object::Subreddit, String] The subreddit.
+        #   The order of subreddits to return.
+        # @param params [Hash] A list of params to send with the request.
+        # @option params [String] :after Return results after the given
+        #   fullname.
+        # @option params [String] :before Return results before the given
+        #   fullname.
+        # @option params [Integer] :count (0) The number of items already seen
+        #   in the listing.
+        # @option params [1..100] :limit (25) The maximum number of things to
+        #   return.
+        # @return [Redd::Object::Listing] A listing of users.
+        # @note On reddit's end, this is actually a UserList, which is slightly
+        #   different to a real listing, since it only provides names and ids.
+        def get_special_users(where, subreddit, params = {})
+          name = extract_attribute(subreddit, :display_name)
+          response = get "/r/#{name}/about/#{where}.json", params
+
+          things = response[:data][:children].map! do |user|
+            object_from_body(kind: "t2", data: user)
+          end
+          Redd::Object::Listing.new(data: {children: things})
+        end
+
         private
 
         # Subscribe or unsubscribe to a subreddit.

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

@@ -38,8 +38,10 @@ module Redd
         # @param code [String] The code that was sent in the GET request.
         # @param set_access [Boolean] Whether to automatically use this token
         #   for all future requests with this client.
-        # @return [Redd::OAuth2Access] A package of the necessary information
-        #   to access the user's information.
+        # @return [Redd::OAuth2Access, nil] A package of the necessary
+        #   information to access the user's information or nil if there was
+        #   an error.
+        # @todo Custom Errors for OAuth2
         def request_access(code, set_access = true)
           response = auth_connection.post "/api/v1/access_token",
                                           grant_type: "authorization_code",
@@ -76,6 +78,30 @@ module Redd
             new_access
           end
         end
+
+        # Dispose of an access or refresh token when you're done with it.
+        #
+        # @param access [Redd::OAuth2Access, String] The token to revoke.
+        # @param remove_refresh_token [Boolean] Whether you intend to revoke a
+        #   refresh token.
+        def revoke_access(access, remove_refresh_token = nil)
+          token = 
+          if remove_refresh_token
+            extract_attribute(access, :refresh_token)
+          else
+            extract_attribute(access, :access_token)
+          end
+
+          params = {token: token}
+
+          if remove_refresh_token
+            params[:token_type_hint] = true
+          elsif remove_refresh_token == false
+            params[:token_type_hint] = false
+          end
+
+          auth_connection.post "/api/v1/revoke_token", params
+        end
       end
     end
   end

data/lib/redd/error.rb

@@ -19,6 +19,20 @@ module Redd
         case status
         when 200
           case body
+          when /ACCESS_DENIED/i
+            Redd::Error::OAuth2AccessDenied
+          when /UNSUPPORTED_RESPONSE_TYPE/i
+            Redd::Error::InvalidResponseType
+          when /UNSUPPORTED_GRANT_TYPE/i
+            Redd::Error::InvalidGrantType
+          when /INVALID_SCOPE/i
+            Redd::Error::InvalidScope
+          when /INVALID_REQUEST/i
+            Redd::Error::InvalidRequest
+          when /NO_TEXT/i
+            Redd::Error::NoTokenGiven
+          when /INVALID_GRANT/i
+            Redd::Error::ExpiredCode
           when /WRONG_PASSWORD/i
             Redd::Error::InvalidCredentials
           when /BAD_CAPTCHA/i
@@ -36,6 +50,8 @@ module Redd
           end
         when 400
           Redd::Error::BadRequest
+        when 401
+          Redd::Error::InvalidOAuth2Credentials
         when 403
           case body
           when /USER_REQUIRED/i
@@ -66,16 +82,38 @@ module Redd
           body[:json][:errors].first
         elsif body.key?(:jquery)
           body[:jquery]
+        elsif body.key?(:error)
+          body[:error]
+        elsif body.key?(:code) && body[:code] == "NO_TEXT"
+          "NO_TEXT"
         end
       end
     end
 
+    class NoTokenGiven < Error; end
+
+    class ExpiredCode < Error; end
+
+    class InvalidGrantType < Error; end
+
+    class InvalidOAuth2Credentials < Error; end
+
+    class OAuth2AccessDenied < Error; end
+
+    class InvalidResponseType < Error; end
+
+    class InvalidScope < Error; end
+
+    class InvalidRequest < Error; end
+
     class AuthenticationRequired < Error; end
 
     class InvalidCaptcha < Error; end
 
     class BadGateway < Error; end
 
+    class BadRequest < Error; end
+
     class InvalidMultiredditName < Error; end
 
     class Conflict < Error; end

data/lib/redd/object/listing.rb

@@ -19,7 +19,7 @@ module Redd
       attr_reader :before
 
       def initialize(listing)
-        @kind = listing[:kind]
+        @kind = "Listing"
         @things = listing[:data][:children]
         @after = listing[:data][:after]
         @before = listing[:data][:before]

data/lib/redd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler