redditkit 1.0.0

data/lib/redditkit/comment.rb

@@ -0,0 +1,54 @@
+require 'redditkit/thing'
+require 'redditkit/creatable'
+require 'redditkit/votable'
+
+module RedditKit
+
+  # A class representing a comment.
+  class Comment < RedditKit::Thing
+    include RedditKit::Creatable
+    include RedditKit::Votable
+
+    attr_reader :approved_by
+    attr_reader :author
+    attr_reader :author_flair_css_class
+    attr_reader :author_flair_text
+    attr_reader :author_id
+    attr_reader :banned_by
+    attr_reader :body
+    attr_reader :body_html
+    attr_reader :distinguished
+    attr_reader :edited
+    attr_reader :gilded
+    attr_reader :link_id
+    attr_reader :num_reports
+    attr_reader :score_hidden
+    attr_reader :subreddit
+    attr_reader :subreddit_id
+
+    alias text body
+    alias posted_at created_at
+
+    # Whether a comment has been deleted by its submitter or a moderator.
+    def deleted?
+      author == '[deleted]' and body == '[deleted]'
+    end
+
+    # The replies to a comment.
+    def replies
+      replies_listing = @attributes[:replies]
+      return Array.new if replies_listing.empty?
+
+      replies_array = replies_listing[:data][:children]
+
+      @comment_objects ||= replies_array.map do |comment|
+        RedditKit::Comment.new(comment) 
+      end
+    end
+
+    # Whether the comment has any replies.
+    def replies?
+      !replies.empty?
+    end
+  end
+end

data/lib/redditkit/creatable.rb

@@ -0,0 +1,17 @@
+require 'time'
+
+module RedditKit
+
+  # Methods which return the time of creation for objects.
+  module Creatable
+
+    # The time when the object was created on reddit.
+    #
+    # @return [Time]
+    def created_at
+      created = @attributes[:created_utc]
+      @created_at ||= Time.at(created) if created
+    end
+
+  end
+end

data/lib/redditkit/error.rb

@@ -0,0 +1,111 @@
+require 'json'
+
+module RedditKit
+  class Error < StandardError
+    class << self
+
+      def from_status_code_and_body(status_code, body)
+        error_value = extract_error_value body
+        return if status_code == 200 and error_value.nil?
+
+        case status_code
+        when 200
+          if error_value =~ /WRONG_PASSWORD/i
+            RedditKit::InvalidCredentials
+          elsif error_value =~ /BAD_CAPTCHA/i
+            RedditKit::InvalidCaptcha
+          elsif error_value =~ /RATELIMIT/i
+            RedditKit::RateLimited
+          elsif error_value =~ /BAD_CSS_NAME/i
+            RedditKit::InvalidClassName
+          elsif error_value =~ /TOO_OLD/i
+            RedditKit::Archived
+          elsif error_value =~ /TOO_MUCH_FLAIR_CSS/i
+            RedditKit::TooManyClassNames
+          elsif error_value =~ /USER_REQUIRED/i
+            RedditKit::AuthenticationRequired
+          end
+        when 400
+          if error_value =~ /BAD_MULTI_NAME/i
+            RedditKit::InvalidMultiredditName
+          end
+        when 403
+          if error_value =~ /USER_REQUIRED/i
+            RedditKit::AuthenticationRequired
+          else
+            RedditKit::PermissionDenied
+          end
+        when 409
+          RedditKit::Conflict
+        when 500
+          RedditKit::InternalServerError
+        when 502
+          RedditKit::BadGateway
+        when 503
+          RedditKit::ServiceUnavailable
+        when 504
+          RedditKit::TimedOut
+        end
+      end
+
+      private
+
+      def extract_error_value(body)
+        return nil unless body.instance_of? Hash
+
+        if body.key?(:json) and body[:json].key?(:errors)
+          body[:json][:errors].to_s
+        elsif body.key?(:jquery)
+          body[:jquery].to_s
+        end
+      end
+
+    end
+  end
+
+  # Raised when there should be an authenticated user, but there isn't.
+  class AuthenticationRequired < Error; end
+
+  # Raised when the user passes an invalid CAPTCHA identifier or value.
+  class InvalidCaptcha < Error; end
+
+  # Raised when reddit returns a 503 status code.
+  class BadGateway < Error; end
+
+  # Raised when the user attempts to create a multireddit with an invalid name.
+  class InvalidMultiredditName < Error; end
+  
+  # Raised when reddit returns a 409 status code.
+  class Conflict < Error; end
+
+  # Raised when reddit returns a 500 status code.
+  class InternalServerError < Error; end
+
+  # Raised when the user passes an invalid CSS class name.
+  class InvalidClassName < Error; end
+
+  # Raised when the user attempts to sign in with an incorrect username or password.
+  class InvalidCredentials < Error; end
+
+  # Raised when the user attempts to access a resource without the appropriate permissions.
+  class PermissionDenied < Error; end
+
+  # Raised when the user has been rate limited.
+  class RateLimited < Error; end
+
+  # Raised when RedditKit encounters an error with one of its own requests.
+  class RequestError < Error; end
+
+  # Raised when reddit is unavailable.
+  class ServiceUnavailable < Error; end
+
+  # Raised when too many CSS class names are passed.
+  class TooManyClassNames < Error; end
+
+  # Raised when the user attempts to interact with an item that has been archived.
+  class Archived < Error; end
+
+  # Raised when reddit's returns a 504 status code.
+  class TimedOut < Error; end
+
+end

data/lib/redditkit/link.rb

@@ -0,0 +1,140 @@
+require 'redditkit/thing'
+require 'redditkit/creatable'
+require 'redditkit/votable'
+
+module RedditKit
+
+  # A class representing a link.
+  class Link < RedditKit::Thing
+    include RedditKit::Creatable
+    include RedditKit::Votable
+
+    # The username of the moderator who approved this link, if it has been approved.
+    attr_reader :approved_by
+
+    # The username of the link's author.
+    attr_reader :author
+
+    # The author's flair CSS class, if they have flair assigned to them.
+    attr_reader :author_flair_css_class
+
+    # The author's flair text, if they have flair assigned to them.
+    attr_reader :author_flair_text
+
+    # The username of the moderator who banned this link, if it was banned.
+    attr_reader :banned_by
+
+    # The distinguished status of the link. This is either 'yes', 'no', 'admin' or 'special'.
+    attr_reader :distinguished
+
+    # The link's domain.
+    attr_reader :domain
+
+    # The time of the link's most recent edit, or nil if it has never been edited.
+    attr_reader :edited
+
+    # Whether the current user has hidden this link.
+    attr_reader :hidden
+
+    # Whether the link is a self post.
+    attr_reader :is_self
+
+    # The link's flair CSS class, if it has flair assigned to it.
+    attr_reader :link_flair_css_class
+
+    # The link's flair text, if it has flair assigned to it.
+    attr_reader :link_flair_text
+
+    # A hash containing further information about the link's media. For example, this could contain details about a YouTube video.
+    attr_reader :media
+
+    # A hash contains details for embedding the content in a web page.
+    attr_reader :media_embed
+
+    # The number of comments on the link.
+    attr_reader :num_comments
+
+    # The number of reports on the link.
+    attr_reader :num_reports
+
+    # Whether the link has been marked as NSFW.
+    attr_reader :over_18
+
+    # The link to the post on reddit.
+    attr_reader :permalink
+
+    # Whether the current user has saved this link.
+    attr_reader :saved
+
+    # The text for the link, if it is a self post, in Markdown.
+    attr_reader :selftext
+
+    # The text for the link, if it is a self post, in HTML.
+    attr_reader :selftext_html
+
+    # Whether the link has been marked as sticky.
+    attr_reader :stickied
+
+    # The name of the subreddit to which the link was posted.
+    attr_reader :subreddit
+
+    # The full name of the subreddit to which the link was posted.
+    attr_reader :subreddit_id
+
+    # The URL to the thumbnail for the link.
+    attr_reader :thumbnail
+
+    # The title of the link.
+    attr_reader :title
+
+    # The link's URL. This will be a link to the post on reddit if the link is a self post.
+    attr_reader :url
+
+    # Whether the link has been visited by the current user. Requires that the current user have reddit gold.
+    attr_reader :visited
+    
+    alias approved? approved_by
+    alias banned? banned_by
+    alias nsfw? over_18
+    alias self_post? is_self
+    alias sticky? stickied
+    alias subreddit_full_name subreddit_id
+    alias text selftext
+    alias text_html selftext_html
+    alias thumbnail_url thumbnail
+    alias total_comments num_comments
+    alias total_reports num_reports
+
+    # Determines whether a link is showing its score. reddit doesn't display scores for links less than two hours old.
+    #
+    # @return [Boolean]
+    def showing_link_score?
+      current_time = Time.now
+      submission_time = created_at
+
+      difference = (current_time - submission_time) / 60 / 60
+      difference >= 2
+    end
+
+    # Determines whether a link has an image URL.
+    #
+    # @return [Boolean]
+    def image_link?
+      extensions = %w(.png .jpg .jpeg .gif)
+      extensions.any?{ |extension| url.end_with? extension }
+    end
+
+    def permalink
+      @permalink ||= "http://reddit.com/" << @attributes[:permalink]
+    end
+
+    # Returns the short URL for a link.
+    #
+    # @return [String]
+    # @example http://redd.it/link-id.
+    def short_link
+      'http://redd.it/' << id
+    end
+
+  end
+end

data/lib/redditkit/moderator_action.rb

@@ -0,0 +1,19 @@
+module RedditKit
+
+  # A class representing actions taken by moderators of subreddits.
+  class ModeratorAction < RedditKit::Thing
+
+    attr_reader :action
+    attr_reader :details
+    attr_reader :mod
+    attr_reader :mod_id36
+    attr_reader :subreddit
+    attr_reader :sub_id36
+
+    alias moderator_username mod
+    alias moderator_identifier mod_id36
+    alias subreddit_name subreddit
+    alias subreddit_identifier sub_id36
+
+  end
+end

data/lib/redditkit/multireddit.rb

@@ -0,0 +1,32 @@
+require 'ostruct'
+require 'redditkit/creatable'
+
+module RedditKit
+
+  # A class representing a multireddit.
+  class Multireddit < RedditKit::Base
+    include RedditKit::Creatable
+
+    attr_reader :name
+    attr_reader :can_edit
+    attr_reader :visibility
+    attr_reader :path
+
+    alias editable? can_edit
+
+    # An array of subreddit display names.
+    #
+    # @return [Array<String>]
+    def subreddits
+      @subreddits ||= @attributes[:subreddits].collect { |subreddit| subreddit[:name] }
+    end
+
+    # The username of the multireddit's owner.
+    #
+    # @return [String] The owner's username.
+    def username
+      @username ||= path[/\/user\/(.*)\/m\//, 1]
+    end
+
+  end
+end

data/lib/redditkit/multireddit_description.rb

@@ -0,0 +1,14 @@
+require 'redditkit/base'
+
+module RedditKit
+
+  # A class representing a multireddit description.
+  class MultiredditDescription < RedditKit::Base
+    
+    attr_reader :body_html
+    attr_reader :body_md
+
+    alias text body_md
+
+  end
+end

data/lib/redditkit/paginated_response.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module RedditKit
+
+  # A response object for paginated requests, allowing users to access both results and pagination data.
+  class PaginatedResponse
+    extend Forwardable
+    include Enumerable
+    def_delegators :@results, :each, :length, :empty?
+
+    attr_reader :results
+    attr_reader :before
+    attr_reader :after
+
+    def initialize(before, after, results)
+      @before = before
+      @after = after
+      @results = results
+    end
+
+  end
+end

data/lib/redditkit/private_message.rb

@@ -0,0 +1,27 @@
+require 'redditkit/thing'
+require 'redditkit/creatable'
+
+module RedditKit
+
+  # A class representing a private message.
+  class PrivateMessage < RedditKit::Thing
+    include RedditKit::Creatable
+
+    attr_reader :author
+    attr_reader :body
+    attr_reader :body_html
+    attr_reader :context
+    attr_reader :dest
+    attr_reader :first_message
+    attr_reader :first_message_name
+    attr_reader :new
+    attr_reader :parent_id
+    attr_reader :replies
+    attr_reader :subject
+    attr_reader :subreddit
+    attr_reader :was_comment
+
+    alias unread? new
+    alias recipient dest
+  end
+end