redd 0.1.0

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

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Wiki
+				
+      end
+    end
+  end
+end

data/lib/redd/client/oauth2.rb

@@ -0,0 +1,9 @@
+require "redd/client/authenticated"
+
+module Redd
+  module Client
+    # The client to connect using OAuth2.
+    class OAuth2 < Redd::Client::Authenticated
+    end
+  end
+end

data/lib/redd/client/unauthenticated.rb

@@ -0,0 +1,104 @@
+require "faraday"
+require "redd/version"
+require "redd/rate_limit"
+require "redd/response/parse_json"
+require "redd/response/raise_error"
+require "redd/client/unauthenticated/account"
+require "redd/client/unauthenticated/links_comments"
+require "redd/client/unauthenticated/listing"
+require "redd/client/unauthenticated/subreddits"
+require "redd/client/unauthenticated/utilities"
+require "redd/client/unauthenticated/wiki"
+
+module Redd
+  module Client
+    # The Client used to connect without needing login credentials.
+    class Unauthenticated
+      include Redd::Client::Unauthenticated::Account
+      include Redd::Client::Unauthenticated::LinksComments
+      include Redd::Client::Unauthenticated::Listing
+      include Redd::Client::Unauthenticated::Subreddits
+      include Redd::Client::Unauthenticated::Utilities
+      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] || "http://www.reddit.com/"
+      end
+
+      private
+
+      # Gets the Faraday connection or creates one if it doesn't exist yet.
+      #
+      # @return [Faraday] A new Faraday connection.
+      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.adapter Faraday.default_adapter
+
+          faraday.headers["User-Agent"] = user_agent
+        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 (defualt: {}).
+      # @return [Faraday::Response] A 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)
+      end
+
+      # Performs a POST request via {#request}.
+      # @see #request
+      def post(*args)
+        request(:post, *args)
+      end
+
+      # Performs a PUT request via {#request}.
+      # @see #request
+      def put(*args)
+        request(:put, *args)
+      end
+
+      # Performs a DELETE request via {#request}.
+      # @see #request
+      def delete(*args)
+        request(:delete, *args)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Redd
+  module Client
+    class Unauthenticated
+      module Account
+        def login(username, password, remember = false)
+          meth = :post
+          path = "/api/login"
+          params = {
+            api_type: "json", user: username,
+            passwd: password, rem: remember
+          }
+          response = send(meth, path, params)
+          data = response.body[:json][:data]
+
+          require "redd/client/authenticated"
+          Redd::Client::Authenticated.new(data[:cookie], data[:modhash])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Redd
+  module Client
+    class Unauthenticated
+      module LinksComments
+        # @note Reddit does accept a subreddit, but with fullnames and urls, I
+        #   assumed that was unnecessary.
+        def get_info(params = {})
+          meth = :get
+          path = "/api/info.json"
+          object_from_response(meth, path, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Redd
+  module Client
+    class Unauthenticated
+      module Listing
+        def by_id(*fullnames)
+          names = fullnames.join(",")
+
+          meth = :get
+          path = "/by_id/#{names}.json"
+          object_from_response(meth, path)
+        end
+
+        def get_hot(*args)
+          get_listing(:hot, *args)
+        end
+
+        def get_new(*args)
+          get_listing(:new, *args)
+        end
+
+        def get_random(*args)
+          get_listing(:random, *args)
+        end
+
+        def get_top(*args)
+          get_listing(:top, *args)
+        end
+
+        def get_controversial(*args)
+          get_listing(:controversial, *args)
+        end
+
+        private
+
+        def get_listing(type, subreddit = nil, params = {})
+          meth = :get
+          path = "/#{type}.json"
+          path = path.prepend("/r/#{subreddit}") if subreddit
+          object_from_response(meth, path, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Redd
+  module Client
+    class Unauthenticated
+      module Subreddits
+        def subreddit(name)
+          meth = :get
+          path = "/r/#{name}/about.json"
+          object_from_response(meth, path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require "redd/thing"
+require "redd/object/listing"
+require "redd/object/comment"
+require "redd/object/submission"
+require "redd/object/subreddit"
+
+module Redd
+  module Client
+    class Unauthenticated
+      module Utilities
+        private
+
+        def extract_fullname(object)
+          object.is_a?(String) ? object : extract_attribute(object, :fullname)
+        end
+
+        def extract_attribute(object, attribute)
+          object.send(attribute) if object.respond_to?(attribute)
+        end
+
+        # @todo "more"
+        def object_from_kind(kind) # rubocop:disable Style/MethodLength
+          case kind
+          when "Listing"
+            Redd::Object::Listing
+          when "t1"
+            Redd::Object::Comment
+          when "t3"
+            Redd::Object::Submission
+          when "t5"
+            Redd::Object::Subreddit
+          else
+            Redd::Thing
+          end
+        end
+
+        def objects_from_listing(thing)
+          thing[:data][:children].map do |child|
+            get_object_from_body(child)
+          end
+        end
+
+        def get_object_from_body(body)
+          object = object_from_kind(body[:kind])
+
+          if object == Redd::Object::Listing
+            things = objects_from_listing(body)
+            object.new(things)
+          else
+            object.new(self, body)
+          end
+        end
+
+        def object_from_response(*args)
+          body = request(*args).body
+          get_object_from_body(body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Unauthenticated
+      module Wiki
+				
+      end
+    end
+  end
+end

data/lib/redd/error.rb

@@ -0,0 +1,93 @@
+module Redd
+  class Error < StandardError
+    class << self
+      # @note I ripped off RedditKit.rb :|
+      def from_response(response) # rubocop:disable Style/CyclomaticComplexity Style/MethodLength
+        status = response[:status]
+        body = parse_error(response[:body])
+        case status
+        when 200
+          case body
+          when /WRONG_PASSWORD/i
+            InvalidCredentials
+          when /BAD_CAPTCHA/i
+            InvalidCaptcha
+          when /RATELIMIT/i
+            RateLimited
+          when /BAD_CSS_NAME/i
+            InvalidClassName
+          when /TOO_OLD/i
+            Archived
+          when /TOO_MUCH_FLAIR_CSS/i
+            TooManyClassNames
+          when /USER_REQUIRED/i
+            AuthenticationRequired
+          end
+        when 400
+          BadRequest
+        when 403
+          case body
+          when /USER_REQUIRED/i
+            AuthenticationRequired
+          else
+            PermissionDenied
+          end
+        when 404
+          NotFound
+        when 409
+          Conflict
+        when 500
+          InternalServerError
+        when 502
+          BadGateway
+        when 503
+          ServiceUnavailable
+        when 504
+          TimedOut
+        end
+      end
+
+      def parse_error(body)
+        return nil unless body.is_a?(Hash)
+
+        if body.key?(:json) && body[:json].key?(:errors)
+          body[:json][:errors].first
+        elsif body.key?(:jquery)
+          body[:jquery].to_s
+        end
+      end
+    end
+
+    class AuthenticationRequired < Error; end
+
+    class InvalidCaptcha < Error; end
+
+    class BadGateway < Error; end
+
+    class InvalidMultiredditName < Error; end
+
+    class Conflict < Error; end
+
+    class InternalServerError < Error; end
+
+    class InvalidClassName < Error; end
+
+    class InvalidCredentials < Error; end
+
+    class NotFound < Error; end
+
+    class PermissionDenied < Error; end
+
+    class RateLimited < Error; end
+
+    class RequestError < Error; end
+
+    class ServiceUnavailable < Error; end
+
+    class TooManyClassNames < Error; end
+
+    class Archived < Error; end
+
+    class TimedOut < Error; end
+  end
+end

data/lib/redd/object/comment.rb

@@ -0,0 +1,41 @@
+require "redd/thing"
+
+module Redd
+  module Object
+    # A comment made on links.
+    class Comment < Redd::Thing
+      # @!attribute [r] subreddit
+      # @return [String] The name of the subreddit this comment belongs to.
+      # @todo Convert to a Subreddit object?
+      attr_reader :subreddit
+
+      # @!attribute [r] parent_id
+      # @return [String] The id of the parent comment.
+      # @todo parent - get the parent comment directly.
+      attr_reader :parent_id
+
+      # @!attribute [r] body
+      # @return [String] The text of the comment in markdown.
+      attr_reader :body
+
+      # @!attribute [r] body_html
+      # @return [String] The text of the comment in html.
+      # @note Be warned: this isn't actual html, but escaped html. So all the
+      #   <'s and >'s are converted to &lt;'s and &gt;'s.
+      attr_reader :body_html
+
+      # @!attribute [r] author_flair_text
+      # @return [String] The user's flair.
+      attr_reader :author_flair_text
+
+      # @!attribute [r] author_flair_css_class
+      # @return [String] The CSS class of the user's flair.
+      attr_reader :author_flair_css_class
+
+      # @return [Boolean] Whether the comment is a root rather than a reply.
+      def root?
+        !parent_id || parent_id == fullname
+      end
+    end
+  end
+end

data/lib/redd/object/listing.rb

@@ -0,0 +1,24 @@
+require "forwardable"
+
+module Redd
+  module Object
+    # A listing of various reddit things.
+    # @see http://www.reddit.com/dev/api#listings
+    # @see http://stackoverflow.com/a/2080118
+    class Listing
+      include Enumerable
+      extend Forwardable
+      def_delegators :@things, :[], :length, :size, :each, :map, :empty?
+
+      # @!attribute [r] things
+      # @return [Array] A list of things in the listing.
+      attr_reader :things
+
+      # Create a new listing with the given things.
+      # @param [Array] things A list of things to generate a Listing out of.
+      def initialize(things)
+        @things = things
+      end
+    end
+  end
+end