redd 0.6.5 → 0.7.0

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

@@ -1,16 +0,0 @@
-module Redd
-  module Client
-    class OAuth2
-      # Methods to interact with the user logged-in via OAuth2
-      module Identity
-        # @return [Redd::Object::User] The logged-in user.
-        # @note This overrides the Authenticated class's method, since that
-        #   method doesn't apply here but does the same thing.
-        def me
-          response = get "/api/v1/me.json"
-          object_from_body kind: "t2", data: response
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/oauth2_script.rb

@@ -1,24 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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.rb

@@ -1,118 +0,0 @@
-require "faraday"
-require "redd/version"
-require "redd/rate_limit"
-require "redd/response/parse_json"
-require "redd/response/raise_error"
-
-module Redd
-  module Client
-    # The Client used to connect without needing login credentials.
-    class Unauthenticated
-      require "redd/client/unauthenticated/account"
-      require "redd/client/unauthenticated/captcha"
-      require "redd/client/unauthenticated/links_comments"
-      require "redd/client/unauthenticated/listing"
-      require "redd/client/unauthenticated/live"
-      require "redd/client/unauthenticated/moderation"
-      require "redd/client/unauthenticated/subreddits"
-      require "redd/client/unauthenticated/utilities"
-      require "redd/client/unauthenticated/users"
-      require "redd/client/unauthenticated/wiki"
-
-      include Redd::Client::Unauthenticated::Account
-      include Redd::Client::Unauthenticated::Captcha
-      include Redd::Client::Unauthenticated::LinksComments
-      include Redd::Client::Unauthenticated::Listing
-      include Redd::Client::Unauthenticated::Live
-      include Redd::Client::Unauthenticated::Moderation
-      include Redd::Client::Unauthenticated::Subreddits
-      include Redd::Client::Unauthenticated::Utilities
-      include Redd::Client::Unauthenticated::Users
-      include Redd::Client::Unauthenticated::Wiki
-
-      # @!attribute [r] api_endpoint
-      # @return [String] The site to connect to.
-      attr_accessor :api_endpoint
-
-      # @!attribute [r] user_agent
-      # @return [String] The user-agent used to communicate with reddit.
-      attr_accessor :user_agent
-
-      # @!attribute [r] rate_limit
-      # @return [#after_limit] The handler that takes care of rate limiting.
-      attr_accessor :rate_limit
-
-      # Set up an unauthenticated connection to reddit.
-      #
-      # @param [Hash] options A hash of options to connect using.
-      # @option options [#after_limit] :rate_limit The handler that takes care
-      #   of rate limiting.
-      # @option options [String] :user_agent The User-Agent string to use in the
-      #   header of every request.
-      # @option options [String] :api_endpoint The main domain to connect
-      #   to, in this case, the URL for reddit.
-      def initialize(options = {})
-        @rate_limit = options[:rate_limit] || Redd::RateLimit.new
-        @user_agent = options[:user_agent] || "Redd/Ruby, v#{Redd::VERSION}"
-        @api_endpoint = options[:api_endpoint] || "https://www.reddit.com/"
-      end
-
-      private
-
-      # @return [Hash] The headers that are sent with every request.
-      def headers
-        @headers ||= {"User-Agent" => @user_agent}
-      end
-
-      # Gets the Faraday connection or creates one if it doesn't exist yet.
-      #
-			# @return [Faraday] A new or existing Faraday connection.
-      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 = headers
-        end
-      end
-
-      # Send a request to the given path.
-      #
-      # @param [#to_sym] method The HTTP verb to use.
-      # @param [String] path The path under the api endpoint to request from.
-      # @param [Hash] params The additional parameters to send.
-			# @return [Faraday::Response] The faraday response.
-      def request(method, path, params = {})
-        rate_limit.after_limit do
-          connection.send(method.to_sym, path, params)
-        end
-      end
-
-      # Performs a GET request via {#request}.
-      # @see #request
-      def get(*args)
-        request(:get, *args).body
-      end
-
-      # Performs a POST request via {#request}.
-      # @see #request
-      def post(*args)
-        request(:post, *args).body
-      end
-
-      # Performs a PUT request via {#request}.
-      # @see #request
-      def put(*args)
-        request(:put, *args).body
-      end
-
-      # Performs a DELETE request via {#request}.
-      # @see #request
-      def delete(*args)
-        request(:delete, *args).body
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods for managing accounts.
-      module Account
-        # Login to the reddit account.
-        #
-        # @param username [String] The username.
-        # @param password [String] The password.
-        # @param remember [Boolean] Indicates whether you intend to use the
-        #   returned cookie for a long time.
-        # @param options [Hash] The options to create an instance of
-        #   {Redd::Client::Authenticated}.
-        def login(username, password, remember = false, options = {})
-          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], options
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods to get captchas.
-      # Many things like sending messages and posting links require captchas.
-      module Captcha
-        # @return [Boolean] Whether a captcha is required for some API methods.
-        def needs_captcha?
-          get "/api/needs_captcha.json"
-        end
-
-        # Create a new captcha identifier.
-        # @return [String] The identifier.
-        def new_captcha
-          response = post "/api/new_captcha", api_type: "json"
-          response[:json][:data][:iden]
-        end
-
-        # @param identifier [String] The captcha identifier.
-        # @return The url for the captcha image.
-        def captcha_url(identifier)
-          "http://www.reddit.com/captcha/#{identifier}.png"
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      module LinksComments
-        # @param params [Hash] A hash of parameters to send to reddit.
-        # @option params [String] :id The fullname of a thing.
-        # @option params [String] :url The url of a thing. If an id is also
-        #   provided, the id will take precedence.
-        # @return [Redd::Object::Listing] Listing of the object or objects.
-        #
-        # @note Reddit does accept a subreddit, but with fullnames and urls, I
-        #   assumed that was unnecessary.
-        def get_info(params = {})
-          object_from_response :get, "/api/info.json", params
-        end
-
-        # Get the comments for a submission.
-        #
-        # @param submission [String, Redd::Object::Submission] The submission
-        #   to get the comments for.
-        # @return [Redd::Object::Listing] A listing of comments.
-        def submission_comments(submission)
-          id = extract_id(submission)
-          comments_from_response :get, "/comments/#{id}.json"
-        end
-
-        # Get the replies for a comment.
-        #
-        # @param comment [String, Redd::Object::Submission] The comment to get
-        #   the replies for.
-        # @return [Redd::Object::Listing] A listing of comments.
-        def get_replies(comment)
-          replies = comment.attributes[:replies]
-          return [] unless replies.is_a?(Hash) && replies.key?(:kind)
-          object_from_body(replies)
-        end
-
-        def expand_morecomments(morecomments, submission = nil)
-          parent_id = morecomments.parent_id
-          link_id =
-            if submission
-              extract_fullname(submission)
-            elsif parent_id.start_with?("t3_")
-              parent_id
-            elsif parent_id.start_with?("t1_")
-              get_info(id: parent_id).first.link_id
-            end
-
-          response = post "/api/morechildren.json",
-                          api_type: "json",
-                          link_id: link_id,
-                          children: morecomments.children.join(",")
-          comments = response[:json][:data][:things]
-
-          object_from_body(kind: "Listing", data: {children: comments})
-        end
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods that return a listing
-      module Listing
-        # Get an object based on its id.
-        #
-        # @param fullname [String] The fullname of a thing.
-        # @return [Redd::Object] The object with the id.
-        def by_id(fullname)
-          object_from_response :get, "/by_id/#{fullname}.json"
-        end
-
-        # @!method get_hot
-        # @!method get_new
-        # @!method get_top
-        # @!method get_controversial
-        # @!method get_comments
-        #
-        # 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|
-          define_method :"get_#{sort}" do |subreddit = nil, params = {}|
-            get_listing(sort, subreddit, params)
-          end
-        end
-
-        private
-
-        # Get the front page of reddit or a subreddit sorted by type.
-        #
-        # @param type [:hot, :new, :random, :top, :controversial, :comments]
-        #   The type of listing to return 
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   query.
-        # @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.
-        # @option params [:hour, :day, :week, :month, :year, :all] :t The
-        #   time period to consider when sorting.
-        # @return [Redd::Object::Listing] A listing of submissions or comments.
-        #
-        # @note The option :t only applies to the top and controversial sorts.
-        def get_listing(type, subreddit = nil, params = {})
-          name = extract_attribute(subreddit, :display_name) if subreddit
-
-          path = "/#{type}.json"
-          path = path.prepend("/r/#{name}") if name
-
-          object_from_response :get, path, params
-        end
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods to interact with /r/live threads
-      module Live
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods that deal with subreddit styles
-      module Moderation
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   query.
-        # @return [String] The url for the subreddit's css stylesheet.
-        def stylesheet_url(subreddit = nil)
-          name = extract_attribute(subreddit, :display_name) if subreddit
-          path = "/stylesheet"
-          path = path.prepend("/r/#{name}") if subreddit
-
-					request(:get, path).headers[:location]
-        end
-
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   query.
-        # @return [String] The css stylesheet for the subreddit.
-        def stylesheet(subreddit = nil)
-          get stylesheet_url(subreddit)
-        end
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods that deal with subreddits
-      module Subreddits
-        # Return a Subreddit object from the title of a subreddit.
-        # @param title [String] The name of the subreddit.
-        # @return [Redd::Object::Subreddit]
-        def subreddit(title)
-          object_from_response :get, "/r/#{title}/about.json"
-        end
-
-        # Get a list of subreddits sorted by the given parameter.
-        # @param where [:popular, :new] The type of subreddits to look for.
-        # @param params [Hash] A hash of parameters 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 = :popular, params = {})
-          object_from_response :get, "/subreddits/#{where}.json", params
-        end
-
-        # Look for subreddits matching the given query.
-        #
-        # @param query [String] The search query.
-        # @param params [Hash] A hash of parameters 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 search_subreddits(query, params = {})
-          params[:q] = query
-          object_from_response :get, "/subreddits/search.json", params
-        end
-      end
-    end
-  end
-end