redd 0.6.5 → 0.7.0

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

@@ -1,9 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with multis (groups of subreddits).
-      module Multis
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods for sending and reading private messages
-      module PrivateMessages
-        # Block the sender of the message from sending any more.
-        #
-        # @param message [Redd::Object::PrivateMessage, String] The message
-        #   whose sender to block.
-        def block_message(message)
-          fullname = extract_fullname(message)
-          post "/api/block", id: fullname
-        end
-
-        # Compose a message to a person or the moderators of a subreddit.
-        #
-        # @param to [Redd::Object::User, Redd::Object::Subreddit, String] The
-        #   thing to send a message to.
-        # @param subject [String] The subject of the message.
-        # @param text [String] The message text.
-        # @param captcha [String] A possible captcha result to send if one
-        #   is required.
-        # @param identifier [String] The identifier for the captcha if one
-        #   is required.
-        def compose_message(to, subject, text, captcha = nil, identifier = nil)
-          params = {api_type: "json", subject: subject, text: text}
-          params << {captcha: captcha, iden: identifier} if captcha
-          params[:to] = extract_attribute(to, :name) ||
-                        extract_attribute(to, :display_name)
-
-          post "/api/compose", params
-        end
-
-        # Mark a message as read.
-        #
-        # @param message [Redd::Object::PrivateMessage, String] The message
-        #   to mark as read.
-        def mark_as_read(message)
-          fullname = extract_fullname(message)
-          post "/api/read_message", id: fullname
-        end
-
-        # Mark a message as unread.
-        #
-        # @param message [Redd::Object::PrivateMessage, String] The message
-        #   to mark as unread.
-        def mark_as_unread(message)
-          fullname = extract_fullname(message)
-          post "/api/unread_message", id: fullname
-        end
-
-        # Return a list of a user's private messages.
-        #
-        # @param category [String] The category of messages to view.
-        # @param mark [Boolean] Whether to remove the orangered from the
-        #   user's inbox. 
-        # @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.
-        def messages(category = "inbox", mark = false, params = {})
-          params[:mark] = mark
-          object_from_response :get, "/message/#{category}.json", params
-        end
-      end
-    end
-  end
-end

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

@@ -1,172 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with subreddits
-      module Subreddits
-        # Subscribe to a subreddit.
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   subscribe to.
-        def subscribe(subreddit)
-          edit_subscription(:sub, subreddit)
-        end
-
-        # Unsubscribe from a subreddit.
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   unsubscribe from.
-        def unsubscribe(subreddit)
-          edit_subscription(:unsub, subreddit)
-        end
-
-        # Get a listing of subreddits.
-        #
-        # @param where [:popular, :new, :subscriber, :contributor, :moderator]
-        #   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 subreddits.
-        def get_subreddits(where = :subscriber, params = {})
-          path =
-            if [:popular, :new].include?(where)
-              "/subreddits/#{where}.json"
-            elsif [:subscriber, :contributor, :moderator].include?(where)
-              "/subreddits/mine/#{where}.json"
-            end
-          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
-
-        # Edit Subreddit's stylesheet
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   submit.
-        # @param contents [String] css
-        # @param reason [String]
-        # @note https://www.reddit.com/r/***/about/stylesheet/ is good place
-        #   to test if  you have an error
-        def edit_stylesheet(subreddit, contents, reason = nil)
-          name = extract_attribute(subreddit, :display_name)
-          path = "/r/#{name}/api/subreddit_stylesheet"
-          params = {
-            api_type: "json",
-            op: "save",
-            stylesheet_contents: contents
-          }
-          params[:reason] = reason if reason
-          post path, params
-        end
-
-        # Edit Subreddit's settings
-        #
-        # @param attrs [Hash] Settings for subrredit
-        # @note these links might useful: https://www.reddit.com/dev/api and
-        #   https://github.com/alaycock/MeetCal-bot/blob/master/serverInfo.conf
-        def site_admin(attrs)
-          path = "/api/site_admin"
-          params = {
-            allow_top: nil,                 # boolean
-            api_type: "json",               # always "json"
-            collapse_deleted_comments: nil, # boolean
-            comment_score_hide_mins: nil,   # int 0..1440 def: 0
-            css_on_cname: nil,              # boolean
-            description: nil,               # markdown string
-            exclude_banned_modqueue: nil,   # boolean
-            lang: nil,                      # valid IETF lang tag, eg: en
-            link_type: nil,                 # string [any, link, self]
-            name: nil,                      # string subreddit name
-            over_18: nil,                   # boolean
-            public_description: nil,        # markdown string
-            public_traffic: nil,            # boolean
-            show_cname_sidebar: nil,        # boolean
-            show_media: nil,                # boolean
-            spam_comments: nil,             # string [low, high, all]
-            spam_links: nil,                # string [low, high, all]
-            spam_selfposts: nil,            # string [low, high, all]
-            sr: nil,                        # string, for subreddit it should start like "t5_"
-            submit_link_label: nil,         # string max 60 chars
-            submit_text: nil,               # markdown string
-            submit_text_label: nil,         # string max 60 chars
-            title: nil,                     # string max 100 chars
-            type: nil,                      # string [public, private, restricted, gold_restricted, archived]
-            wiki_edit_age: nil,             # int 0+, def: 0
-            wiki_edit_karma: nil,           # int 0+, def: 0
-            wikimode: nil                   # string [disabled, modonly, anyone]
-          }
-          params["header-title"] = ''       # string max 500 chars
-
-          params.keys.each{|key|
-            if !attrs[key].nil?
-              params[key] = attrs[key]
-            end
-          }
-
-          empties = params.map{ |obj|
-            obj.last.nil? ? obj.first.to_s : nil
-          }
-          empties = empties.reject!{ |elm| elm.nil? }
-          if !empties.empty?
-            raise "The following item should not be nil => [" + empties.join(', ') + ']'
-          end
-
-          post path, params
-        end
-
-        # Get the current settings of a subreddit.
-        #
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   submit.
-        def about_edit(subreddit)
-          name = extract_attribute(subreddit, :display_name)
-          object_from_response :get, "/r/#{name}/about/edit.json"
-        end
-
-        private
-
-        # Subscribe or unsubscribe to a subreddit.
-        #
-        # @param action [:sub, :unsub] The type of action to perform.
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   perform the action on.
-        def edit_subscription(action, subreddit)
-          fullname = extract_fullname(subreddit)
-          post "/api/subscribe", action: action, sr: fullname
-        end
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with other users
-      module Users
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Redd
-  module Client
-    class Authenticated
-      # Methods to interact with wiki pages
-      module Wiki
-      end
-    end
-  end
-end

data/lib/redd/client/oauth2.rb

@@ -1,71 +0,0 @@
-require "redd/client/authenticated"
-
-module Redd
-  module Client
-    # The client to connect using OAuth2.
-    class OAuth2 < Redd::Client::Authenticated
-      require "redd/client/oauth2/authorization"
-      require "redd/client/oauth2/identity"
-
-      include Redd::Client::OAuth2::Authorization
-      include Redd::Client::OAuth2::Identity
-
-      # @!attribute [r] auth_endpoint
-      # @return [String] The site to connect to authenticate with.
-      attr_accessor :auth_endpoint
-
-      # @!attribute [r] client_id
-      # @return [String] The client_id of the oauth application.
-      attr_reader :client_id
-
-      # @!attribute [r] redirect_uri
-      # @return [String] The exact redirect_uri of the oauth application.
-      attr_reader :redirect_uri
-
-      # @!attribute [rw] access
-      # @return [String] The access info used to make requests.
-      attr_accessor :access
-
-      def initialize(client_id, secret, redirect_uri, options = {})
-        @client_id = client_id
-        @secret = secret
-        @redirect_uri = redirect_uri
-
-        @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
-
-      def with_access(access)
-        new_instance = dup
-        new_instance.access = access
-        yield new_instance
-      end
-
-      private
-
-      def connection
-        @connection ||= Faraday.new(url: api_endpoint) do |faraday|
-          faraday.use Faraday::Request::UrlEncoded
-          faraday.use Redd::Response::RaiseError
-          faraday.use Redd::Response::ParseJson
-          faraday.adapter Faraday.default_adapter
-
-          faraday.headers["Authorization"] = "bearer #{@access.access_token}"
-          faraday.headers["User-Agent"] = "Redd/Ruby, v#{Redd::VERSION}"
-        end
-      end
-
-      def auth_connection
-        @auth_connection ||= Faraday.new(url: auth_endpoint) do |faraday|
-          faraday.use Faraday::Request::UrlEncoded
-          faraday.use Redd::Response::RaiseError
-          faraday.use Redd::Response::ParseJson
-          faraday.adapter Faraday.default_adapter
-
-          faraday.basic_auth(@client_id, @secret)
-        end
-      end
-    end
-  end
-end

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

@@ -1,108 +0,0 @@
-require "redd/oauth2_access"
-
-module Redd
-  module Client
-    class OAuth2
-      # Methods for obtaining an access token
-      module Authorization
-        # Build an authorization url to redirect the user to.
-        #
-        # @param scopes [Array<String>] The access scopes to request from the
-        #   user.
-        # @param duration [:temporary, :permanent] The duration of your access
-        #   to the user's account.
-        # @param state [String] A random string to check later.
-        # @return [String] The url.
-        #
-        # @note The access tokens from both duration last only an hour, but you
-        #   also get a refresh token when the duration is permanent.
-        # @note You may be tempted to let the state remain "x", but seriously,
-        #   use this; it helps prevent against CSRF attacks.
-        def auth_url(scopes = ["identity"], duration = :temporary, state = "x")
-          path = "https://ssl.reddit.com/api/v1/authorize"
-          scope = scopes.is_a?(Array) ? scopes.join(",") : scopes
-          query = {
-            client_id: @client_id,
-            redirect_uri: @redirect_uri,
-            response_type: "code",
-            state: state,
-            scope: scope,
-            duration: duration
-          }
-          string_query = query.map { |key, value| "#{key}=#{value}" }.join("&")
-          "#{path}?#{string_query}"
-        end
-
-        # Request an access token from the code that is sent with the redirect.
-        #
-        # @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, 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",
-                                          code: code,
-                                          redirect_uri: @redirect_uri
-
-          access = Redd::OAuth2Access.new(response.body)
-          @access = access if set_access
-          access
-        end
-
-        # Obtain a new access token using a refresh token.
-        #
-        # @param token [Redd::OAuth2Access, String, nil] The refresh token or
-        #   OAuth2Access. If none is provided, it'll refresh the one the client
-        #   is currently using.
-        # @param set_access [Boolean] Whether to automatically use this token
-        #   for all future requests with this client.
-        # @return [Redd::OAuth2Access] The refreshed information.
-        def refresh_access(token = nil, set_access = true)
-          refresh_token = extract_attribute(token, :refresh_token)
-          response = auth_connection.post "/api/v1/access_token",
-                                          grant_type: "refresh_token",
-                                          refresh_token: refresh_token
-
-          case token
-          when nil
-            access.refresh(response.body)
-          when Redd::OAuth2Access
-            token.refresh(response.body)
-          when ::String
-            new_access = Redd::OAuth2Access.new(response.body)
-            @access = new_access if set_access
-            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] = :refresh_token
-          elsif remove_refresh_token == false
-            params[:token_type_hint] = :access_token
-          end
-
-          auth_connection.post "/api/v1/revoke_token", params
-        end
-      end
-    end
-  end
-end