reddit_auto 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f5030b7d722f2eb99929cf9f48838e964e78840f89dd4e32bcc9da89cc12ff
-  data.tar.gz: cf1b9fc23e4f52539f2086545cb6229cc216d7ea6772aa669eb033859055c730
+  metadata.gz: a8530bc55139335bb9f9603ad8278a1dbaa74e2c717a0c2985bc56c0f77f28ca
+  data.tar.gz: '093d9c8195bc166b696d17e6f4e8b9d744c9eafd289eee66764d31133f735d2a'
 SHA512:
-  metadata.gz: f4631d0b5e13b58dd863e790bfb105ad2170df36c5c366ecc983be171c98187d4117d0cb7cb79872997447be8e99d5f17801e4db9f9f08259eb30a43480bf4f2
-  data.tar.gz: 4b7f7ed4b8f6dcc711da055174531a2bc626c65949d9196c9e0b07f1cc6e896c164861cf901611ade348c1c204ced577fbd5265cf7de200e5e067c1a9efde674
+  metadata.gz: a84f3cf0c2c7da251eb228235b39454fb4779f62f715ebc04c851373f7b1a90dbd12f8fef8cf41281e7c47ef13beda0b9bb9c8287b87fcd465884c740b3d79fa
+  data.tar.gz: 60783c3ed4bf30a6124b4d3e915fbebd87b35259492b87a00881c0e442cc2c71dadd956609260c6edcae656a4f87a35f05652457ed476c5899b151f23c68c742

data/lib/reddit_auto.rb

@@ -4,6 +4,16 @@ require 'watir'
 #Website: https://icaroaugusto.com
 #Github: https://github.com/IcaroAugusto
 
+NewSub = Struct.new(
+  :name,
+  :title,
+  :description,
+  :sidebar,
+  :subtext,
+  :type,
+  :content
+)
+
 class Reddit
 	PAGE_MAIN = 'https://old.reddit.com/'
 	PAGE_MAIN_NO_SLASH = 'https://old.reddit.com'
@@ -16,17 +26,40 @@ class Reddit
 	SUBREDDIT_SUBPAGES = ['hot', 'new', 'rising', 'top', 'gilded']
 	USER_SORTBYS = ['new', 'hot', 'top', 'controversial']
 
+  SUB_TYPES = {
+    'public' => 'type_public',
+    'restricted' => 'type_restricted',
+    'private' => 'type_private',
+    'premium only' => 'type_gold_only'
+  }
+
+  CONTENT_OPTIONS = {
+    'any' => 'link_type_any',
+    'links only' => 'link_type_link',
+    'text posts only' => 'link_type_self'
+  }
+
 	attr_accessor :browser
 	attr_accessor :username
 
+  # Checks if the class has a browser assigned
+  #
+  # @return [Boolean]
 	def has_browser
 		return @browser != nil
 	end
 
+  # Checks if a given account is logged in
+  #
+  # @param username [String] the account's username
+  # @return [Boolean] whether it is logged in or not
 	def is_logged_in(username)
 		return @browser.link(text: username).present?
 	end
 
+  # Waits for a successful loggin, raises an exception if it fails to login
+  #
+  # @param username [String] the account's username
 	def wait_login(username)
 		count = 0.0
 		while !is_logged_in(username)
@@ -38,6 +71,10 @@ class Reddit
 		end
 	end
 
+  # Logins the reddit website, raises an exception on failure
+  #
+  # @param username [String] the account's username
+  # @param password [String] the account's password
 	def login(username, password)
 		@username = username
 		@browser.goto PAGE_MAIN
@@ -48,6 +85,7 @@ class Reddit
 		wait_login(username)
 	end
 
+  # Waits for logout, raises an exception on failure
 	def wait_logout
 		count = 0.0
 		while is_logged_in(@username)
@@ -59,23 +97,32 @@ class Reddit
 		end
 	end
 
+  # Waits for logout, raises an exception on failure
 	def logout
 		@browser.link(text: 'logout').click
 		wait_logout
 	end
 
+  # Checks if reddit is asking if user is over 18 for nsfw content
+  #
+  # @return [Boolean] whether the prompt is present or not
 	def has_over_18
 		return @browser.button(name: 'over18').present?
 	end
 
+  # Skips the are you over 18 prompt
 	def skip_over_18
 		@browser.button(text: 'continue').click
 	end
 
+  # Checks if reddit is asking if user is over 18 for nsfw content, uses the new interface
+  #
+  # @return [Boolean] whether the prompt is present or not
 	def has_over_18_new
-		@browser.h3(text: 'You must be 18+ to view this community').present?
+		return @browser.h3(text: 'You must be 18+ to view this community').present?
 	end
 
+  # Skips the are you over 18 prompt, uses the new interface
 	def skip_over_18_new
 		@browser.link(text: 'Yes').click
 	end
@@ -84,26 +131,49 @@ class Reddit
 	#Messages handling
 	#---------------------------------------------------------------------------------
 
+  # Gets the type of a message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String] the message type
 	def get_message_type(div)
 		return div.attribute_value('data-type')
 	end
 
+  # Gets the post that a message belongs to
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String] a link to the post
 	def get_message_post(div)
 		return div.p(class: 'subject').link(class: 'title').href
 	end
 
+  # Gets the reddit user who posted the message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String] the username of the message's author
 	def get_message_author(div)
 		return div.attribute_value('data-author')
 	end
 
+  # Gets the subreddit which the message was posted in
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String] the subreddit
 	def get_message_subreddit(div)
 		return div.attribute_value('data-subreddit')
 	end
 
+  # Gets the content of the message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String] the message's content
 	def get_message_content(div)
 		return div.div(class: 'md').text
 	end
 
+  # Gets all message divs in the page
+  #
+  # @return [Array<Watir::Div>] an array containing all message divs in the page
 	def get_message_divs
 		all_divs = @browser.div(id: 'siteTable').divs
 		result = []
@@ -113,27 +183,48 @@ class Reddit
 		return result
 	end
 
-	def is_message_voted(div, type) #type is 'up' or 'down'
+  # Checks if a given message is voted by the logged in user
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @param type [String] the type of vote, can be 'up' or 'down'
+  # @return [Boolean] whether the message is voted in the given type
+	def is_message_voted(div, type)
 		return div.div(class: 'midcol').div(class: type + 'mod').present?
 	end
 
+  # Gets the type of vote the given message received from the logged in user
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [String, nil] returns 'up' or 'down' if voted or nil if not voted
 	def get_message_vote(div)
 		return 'up' if is_message_voted(div, 'up')
 		return 'down' if is_message_voted(div, 'down')
 		return nil
 	end
 
-	def vote_message(div, type) #type is 'up' or 'down'
+  # Votes the given message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @param type [String] the type of vote, can be 'up' or 'down'
+	def vote_message(div, type)
 		return if is_message_voted(div, type)
 		div.div(class: 'midcol').div(class: type).click
 	end
 
+  # Replies the given message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @param answer [String] answer, the content of the reply
 	def reply_message(div, answer)
 		div.li(text: 'reply').click
 		div.textarea.set answer
 		div.button(text: 'save').click
 	end
 
+  # Gets a hash object containing information about a given message
+  #
+  # @param div [Watir::Div] the div containing the message
+  # @return [Hash] a hash containing informaton about the given message
 	def get_message(div) #returns a hash with message data
 		result = {}
 		result['type'] = get_message_type(div)
@@ -145,18 +236,30 @@ class Reddit
 		return result
 	end
 
-	def message_move_page(direction) #directions: next for next page, prev for previous page
+  # Moves to the next or previous page in the message inbox
+  #
+  # @param direction [String] the direction to move, can be 'next' or 'prev'
+  # @return [Boolean] returns true if moved to the desired page or false if didn't because you're already in the last (move next) or first (move prev) page
+	def message_move_page(direction)
 		button = @browser.span(class: direction + '-button')
 		result = button.present?
 		button.click if result
 		return result
 	end
 
+  # Opens the messages subpage, raises an exception if an unknown subpage is given
+  #
+  # @param subpage [String] the subpage to open, can be: 'inbox', 'unread', 'messages', 'comments' or 'sent'
 	def open_messages_subpage(subpage)
 		raise 'Unknown message subpage: ' + subpage if !MESSAGE_SUBPAGES.include? subpage
 		@browser.goto PAGE_MESSAGES + subpage
 	end
 
+  # Gets all the messages in a given subpage, raises an exception if an unknown subpage is given
+  #
+  # @param subpage [String] the subpage to open, can be: 'inbox', 'unread', 'messages', 'comments' or 'sent'
+  # @param all_pages [Boolean] if true will check all pages, if false will check only the first page
+  # @return [Array] an array containing hashes with information about all pages 
 	def get_messages(subpage, all_pages = false)
 		open_messages_subpage(subpage)
 		result = []
@@ -172,14 +275,21 @@ class Reddit
 	#Submit handling
 	#---------------------------------------------------------------------------------
 
+  # Checks if there was an error when submiting to a subreddit, typically because of the 10 minute cooldown between posts enforced by reddit
+  #
+  # @return [Boolean] whether there as an error or not
 	def has_submit_error
-		return @browser.span(text: 'you are doing that too much. try again in 9 minutes.').present?
+		return @browser.span(text: 'you are doing that too much. try again in').present?
 	end
 
+  # Checks if the submit page is open
+  #
+  # @return [Boolean] whether the page is open or not
 	def is_submit_open
 		return @browser.textarea(name: 'title').present? || @browser.textarea(placeholder: 'Title').present?
 	end
 
+  # Waits for the submit page to open, raises an exception if it fails to open after 10 seconds
 	def wait_submit
 		count = 0.0
 		while is_submit_open
@@ -189,6 +299,11 @@ class Reddit
 		end
 	end
 
+  # Submits a link to the given subreddit, raises an exception on failure
+  #
+  # @param subreddit [String] the name of the subreddit to submit the link to
+  # @param url [String] the url to submit
+  # @param title [String] the title of the post
 	def submit_link(subreddit, url, title)
 		@browser.goto PAGE_SUBREDDIT + subreddit + '/submit'
 		skip_over_18 if has_over_18
@@ -198,10 +313,16 @@ class Reddit
 		wait_submit
 	end
 
+  # Checks if the subreddit has an option to add a flair to posts
+  #
+  # @return [Boolean] whether or not it has a flair option
 	def sub_has_flair
 		return !@browser.div('aria-label': 'Not available for this community').present?
 	end
 
+  # Sets the given flair to the post, does nothing if the subreddit has no flair option
+  #
+  # @param flair [String] the desired flair
 	def set_flair(flair)
 		return if !sub_has_flair
 		@browser.div('aria-label': 'Add flair').click
@@ -213,6 +334,12 @@ class Reddit
 		@browser.button(text: 'Apply').click
 	end
 
+  # Submits a link to the given subreddit using the new interface, raises an exception on failure
+  #
+  # @param subreddit [String] the name of the subreddit to submit the link to
+  # @param url [String] the url to submit
+  # @param title [String] the title of the post
+  # @param flair [String, nil] the flair to add, if nil will add no flair to the post
 	def submit_link_new(subreddit, url, title, flair = nil) #uses new reddit
 		@browser.goto 'https://www.reddit.com/r/' + subreddit + '/submit'
 		skip_over_18_new if has_over_18_new
@@ -225,6 +352,11 @@ class Reddit
 		wait_submit
 	end
 
+  # Submits a text post to the given subreddit, raises an exception on failure
+  #
+  # @param subreddit [String] the name of the subreddit to submit the link to
+  # @param title [String] the title of the post
+  # @param text [String] the text content of the post
 	def submit_text(subreddit, title, text)
 		@browser.goto PAGE_SUBREDDIT + subreddit + '/submit?selftext=true'
 		skip_over_18 if has_over_18
@@ -238,6 +370,10 @@ class Reddit
 	#Post handling
 	#---------------------------------------------------------------------------------
 
+  # Checks if the currently open post is voted by the logged in account, raises an exception if an unknown vote type is submitted
+  #
+  # @param type [String] the vote type, can be 'up' or 'down'
+  # @return [Boolean] whether or not the original post is voted in the given type
 	def is_original_post_voted(type)
 		div = @browser.div(id: 'siteTable').div(class: 'midcol')
 		case type
@@ -250,22 +386,35 @@ class Reddit
 		end
 	end
 
+  # Gets the type of the vote the logged in account voted the original post that is currently open
+  #
+  # @return [String, nil] returns the vote type, 'up' or 'down' or nil if not voted
 	def get_original_post_vote
 		return 'up' if is_original_post_voted('up')
 		return 'down' if is_original_post_voted('down')
 		return nil
 	end
 
+  # Votes the currently open original post, does nothing if already voted, raises an exception if an unknown vote type is submitted
+  #
+  # @param type [String] vote type: 'up' or 'down'
 	def vote_original_post(type)
 		return if is_original_post_voted(type)
 		div = @browser.div(id: 'siteTable').div(class: 'midcol')
 		div.div(class: type).click
 	end
 
+  # Forms the full post url given the post's link
+  #
+  # @param link [String] the post's link
+  # @return [String] the full post url
 	def form_post_url(link)
 		return PAGE_MAIN_NO_SLASH + link
 	end
 
+  # Opens the given post
+  #
+  # @param post [Hash, String] accepts either a post hash or the post's full url
 	def open_post(post)
     case post
     when Hash
@@ -278,24 +427,43 @@ class Reddit
     skip_over_18 if has_over_18
 	end
 
+  # Checks if the logged in account has already replied to the given post with the given answer
+  #
+  # @param answer [String] the answer to look for
+  # @return [Boolean] whether or not the logged in account replied to the post with the given answer
 	def has_reply(answer)
 		form = @browser.form(text: answer)
 		return form.present? && form.parent.parent.attribute_value('data-author') == @username
 	end
 
+  # Checks if there was an error when replying
+  #
+  # @return [Boolean] whether there was an error or not
 	def has_reply_error
 		return @browser.span(class: 'error', style: '').present?
 	end
 
+  # Gets the reason for the reply error
+  #
+  # @return [String] the reason
 	def get_reply_error
 		return @browser.span(class: 'error', style: '').split(" ")[1]
 	end
 
+  # Sleeps the given time then checks if there was an error when replying
+  #
+  # @param time [Integer] the number of seconds to sleep
+  # @return [Boolean] whether there was an error or not
 	def wait_reply(time = 2)
 		sleep time
 		return !has_reply_error
 	end
 
+  # Replies the given post
+  #
+  # @param post [Hash, String] the post to reply, can be a post hash or full url
+  # @param answer [String] the answer to the post
+  # @return [Boolean] if replying as successful
 	def reply_post(post, answer)
     open_post(post)
 		@browser.div(class: 'commentarea').textarea(name: 'text').set answer
@@ -303,26 +471,51 @@ class Reddit
 		return wait_reply
 	end
 
+  # Gets the number of replies the given comment received
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Integer] the number of replies
 	def get_comment_replies_count(div)
 		return div.attribute_value('data-replies').to_i
 	end
 
+  # Checks if a given comment has replies
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Boolean] if the comment has replies or not
 	def comment_has_replies(div)
 		return div.attribute_value('data-replies') != '0'
 	end
 
+  # Gets the author of the comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [String] the author's username
 	def get_comment_author(div)
 		return div.attribute_value('data-author')
 	end
 
+  # Gets the link of the comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [String] the link of the comment
 	def get_comment_link(div)
 		return div.attribute_value('data-permalink')
 	end
 
+  # Gets content of the comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [String] the content of the comment
 	def get_comment_content(div)
 		return div.div(class: 'usertext-body').text
 	end
 
+  # Gets the amount of karma the comment received, 'up', 'down' or overall
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @param vote [String, nil] 'up' for number of upvotes, 'down' for downvotes, nil for total
+  # @return [Integer] the number of votes/karma
 	def get_comment_karma(div, vote)
 		case vote
 		when 'up'
@@ -335,7 +528,12 @@ class Reddit
 		return div.p(class: 'tagline').spans(class: 'score')[ind].text.split(' ')[0].to_i
 	end
 
-	def is_comment_voted(div, type) #type is 'up' or 'down'
+  # Checks if the comment is voted by the logged in account, 'up' or 'down', raises an exception if an unknown vote type is submitted
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @param type [String] the vote type, 'up' or 'down'
+  # @return [Boolean] if the comment is voted
+	def is_comment_voted(div, type)
 		case type
 		when 'up'
 			buffer = 'likes'
@@ -347,16 +545,28 @@ class Reddit
 		return div.div(class: 'entry').attribute_value('class') == 'entry ' + buffer
 	end
 
+  # Gets the comment's vote by the logged in account
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [String, nil] 'up' if upvoted, 'down' if downvoted, nil if not voted
 	def get_comment_vote(div)
 		return 'up' if is_comment_voted(div, 'up')
 		return 'down' if is_comment_voted(div, 'down')
 		return nil
 	end
 
+  # Checks if the given comment has karma
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Boolean] whether the comment has karma or not
 	def comment_has_karma(div)
 		return div.span(class: 'score').present?
 	end
 
+  # Gets a hash containing information about a given comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Hash] a hash containing information about a given comment
 	def get_comment(div)
 		result = {}
 		result['author'] = get_comment_author(div)
@@ -367,6 +577,9 @@ class Reddit
 		return result
 	end
 
+  # Gets all the comments' divs in the open page
+  #
+  # @return [Array] an array containing all comments' divs in the open page
 	def get_comments_divs
 		divs = @browser.div(class: 'commentarea').div(class: 'sitetable nestedlisting').children
 		result = []
@@ -376,9 +589,13 @@ class Reddit
 		return result
 	end
 
+  # Gets all replies' divs to the given comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Array] an array containing all replies' divs to the given comment
 	def get_replies_divs(main_div)
 		divs = main_div.div(class: 'child').div.children
-		begin #calling length if the length is 0 causes an exception
+		begin
 			x = divs.length
 		rescue
 			return []
@@ -390,6 +607,10 @@ class Reddit
 		return result
 	end
 
+  # Parses all the comments divs and replies
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @return [Array] an array of hashes containing the comments and their replies
 	def parse_comments_divs(divs)
 		result = []
 		divs.each do |div|
@@ -401,6 +622,7 @@ class Reddit
 		return result
 	end
 
+  # Expands all comments in the open page
 	def expand_all_comments
 		while true
 			begin
@@ -412,18 +634,31 @@ class Reddit
 		end
 	end
 
+  # Gets all the comments in the given post
+  #
+  # @param post [String, Hash] a post hash or full url
+  # @param expand [Boolean] whether to expand all the comments first
+  # @return [Array] an array of hashes including information about all the comments and their replies
 	def get_comments(post, expand = false)
 		open_post(post)
 		expand_all_comments if expand
 		return parse_comments_divs(get_comments_divs)
 	end
 
-	def reply_comments(div, answer)
+  # Replies the given comment with the given anwer
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @param answer [String] the answer
+	def reply_comment(div, answer)
 		div.li(text: 'reply').click
 		div.textarea(name: 'text').set answer
 		div.button(class: 'save').click
 	end
 
+  # Votes the given comment
+  #
+  # @param div [Watir::Div] a div containing the comment
+  # @param type [String] the vote type can be 'up' or 'down'
 	def vote_comment(div, type)
 		return if is_comment_voted(div, type)
 		div.div(class: 'midcol').div(class: type).click
@@ -433,6 +668,9 @@ class Reddit
 	#Subreddit handling
 	#---------------------------------------------------------------------------------
 
+  # Gets all the posts' divs
+  #
+  # @return [Array] an array containing all posts' divs
 	def get_posts_divs
 		divs = @browser.div(id: 'siteTable').children
 		result = []
@@ -442,38 +680,75 @@ class Reddit
 		return result
 	end
 
+  # Gets the author of the post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [String] the author of the post
 	def get_post_author(div)
 		return div.attribute_value('data-author')
 	end
 
+  # Gets the link of the post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [String] the link of the post
 	def get_post_link(div)
 		return div.attribute_value('data-permalink')
 	end
 
+  # Gets the amount of karma of the post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [Integer] the amount of karma the post received
 	def get_post_karma(div)
 		return div.attribute_value('data-score').to_i
 	end
 
+  # Gets the title of the post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [String] the title of the post
 	def get_post_title(div)
 		return div.link(class: 'title').text
 	end
 
+  # Gets the number of comments in the post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [Integer] the number of comments in the post
 	def get_post_number_of_comments(div)
 		return div.attribute_value('data-comments-count').to_i
 	end
 
-	def isPostVoted(div, type)
+  # Checks if the post is voted in the given type
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @param type [String] the type of vote: 'up' or 'down'
+  # @return [Boolean] whether the post is voted or not in the given type
+	def is_post_voted(div, type)
 		return is_comment_voted(div, type)
 	end
 
+  # Gets the type of vote the post has
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [String, nil] the of vote, 'up', 'down' or nil if not voted
 	def get_post_vote(div)
 		return get_comment_vote(div)
 	end
 
+  # Votes the given post, 'up' or 'down', raises exception if unknown vote type is sumited
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @param type [String] the type of vote: 'up' or 'down'
 	def vote_post(div, type)
 		vote_comment(div, type)
 	end
 
+  # Gets a hash containing information about a given post
+  #
+  # @param div [Watir::Div] a div containing the post
+  # @return [Hash] a hash containing information about a given post
 	def get_post(div)
 		result = {}
 		result['author'] = get_post_author(div)
@@ -485,14 +760,27 @@ class Reddit
 		return result
 	end
 
+  # Moves to the next or previous page in the subreddit
+  #
+  # @param direction [String] the direction to move, can be 'next' or 'prev'
+  # @return [Boolean] returns true if moved to the desired page or false if didn't because you're already in the last (move next) or first (move prev) page
 	def subreddit_move_page(direction)
 		return message_move_page(direction)
 	end
 
+  # Forms the full subreddit url given the subreddit's name
+  #
+  # @param name [String] the subreddit's name
+  # @param subpage [String] the subreddit's subpage, defaults to 'hot'
+  # @return [String] the full subreddit url
   def form_subreddit_url(name, subpage = 'hot')
     return PAGE_SUBREDDIT + name + '/' + subpage
   end
 
+  # Opens the given subreddit in the given subpage, raises an exception if an unknown subpage is given, known subpages: 'hot', 'new', 'rising', 'top', 'gilded'
+  #
+  # @param subreddit [String, Hash] a subreddit's name or hash
+  # @param subpage [String] the subreddit's subpage, defaults to 'hot'
 	def open_subreddit(subreddit, subpage = 'hot')
 		raise 'Unknown subreddit subpage: ' + subpage if !SUBREDDIT_SUBPAGES.include? subpage
     case subreddit
@@ -510,8 +798,13 @@ class Reddit
 		skip_over_18 if has_over_18
 	end
 
+  # Gets all the posts in the given subreddit
+  #
+  # @param subreddit [String, Hash] a subreddit's name or hash
+  # @param subpage [String] the subreddit's subpage, defaults to 'hot'
+  # @param max_pages [Integer] maximum amount of pages to gather posts from
+  # @return [Array] an array containing hashes with information about the subreddit's posts
 	def get_posts(subreddit, subpage = 'hot', max_pages = 1)
-		raise 'Unknown subreddit subpage: ' + subpage if !SUBREDDIT_SUBPAGES.include? subpage
 		open_subreddit(subreddit, subpage)
 		result = []
 		count = 0
@@ -526,6 +819,10 @@ class Reddit
 		return result
 	end
 
+  # Forms the full url for the subreddit's moderator's page
+  #
+  # @param subreddit [String, Hash] a subreddit's name or hash
+  # @return [String] the full url for the subreddit's moderator's page
   def form_subreddit_mod_url(subreddit)
     case subreddit
     when Hash
@@ -535,7 +832,11 @@ class Reddit
     end
   end
 
-	def get_moderators(subreddit) #an array of user names, not user structs itself
+  # Gets an array including the usernames of the moderators of the given subreddit
+  #
+  # @param subreddit [String, Hash] a subreddit's name or hash
+  # @return [Array] an array including the usernames of the moderators of the given subreddit
+	def get_moderators(subreddit)
 		@browser.goto form_subreddit_mod_url(subreddit)
 		spans = @browser.div(class: 'moderator-table').spans(class: 'user')
 		result = []
@@ -545,18 +846,31 @@ class Reddit
 		return result
 	end
 
+  # Gets the number of subscribers the subreddit currently open has
+  #
+  # @return [Integer] the number of subscribers the subreddit currently open has 
 	def get_subscribers
 		return @browser.span(class: 'subscribers').span(class: 'number').text.gsub(',', '').to_i
 	end
 
+  # Gets the number of online users the subreddit currently open has
+  #
+  # @return [Integer] the number of online users the subreddit currently open has 
 	def get_users_online
 		return @browser.p(class: 'users-online').span(class: 'number').text.gsub(',', '').to_i
 	end
 
+  # Gets content of the subreddit currently open sidebar
+  #
+  # @return [String] the content of the subreddit's sidebar 
 	def get_side_bar
 		return @browser.div(class: 'usertext-body').text
 	end
 
+  # Gets a hash with information about the given subreddit
+  #
+  # @param subreddit [String] the subreddit's name
+  # @return [Hash] a hash with information about the given subreddit
 	def get_subreddit(subreddit)
 		result = {}
 		result['name'] = subreddit
@@ -568,10 +882,16 @@ class Reddit
 		return result
 	end
 
+  # Checks if the subreddit was successfully created
+  #
+  # @return [Boolean] whether the subreddit was successfully created 
 	def did_create_sub
 		return @browser.p(text: 'your subreddit has been created').present?
 	end
 
+  # Waits for the creation of the subreddit
+  #
+  # @return [Boolean] whether the subreddit was successfully created 
 	def wait_sub_creation
 		count = 0.0
 		while true
@@ -582,6 +902,10 @@ class Reddit
 		end
 	end
 
+  # Creates a subreddit with the given parameters
+  #
+  # @param subreddit [NewSub] A Struct containing the subreddit's parameters 
+  # @return [Boolean] whether the subreddit was successfully created 
 	def create_subreddit(subreddit)
 		@browser.goto CREATE_SUB_PAGE
 		@browser.text_field(id: 'name').set subreddit.name
@@ -599,18 +923,30 @@ class Reddit
 	#User handling
 	#---------------------------------------------------------------------------------
 
+  # Gets the currently open user's post karma
+  #
+  # @return [Integer] the currently open user's post karma
 	def get_user_post_karma
 		return @browser.span(class: 'karma').text.gsub(',', '').to_i
 	end
 
+  # Gets the currently open user's comment karma
+  #
+  # @return [Integer] the currently open user's comment karma
 	def get_user_comment_karma
 		return @browser.spans(class: 'karma')[1].text.gsub(',', '').to_i
 	end
 
+  # Checks if the currently open user is a moderator of any subreddit
+  #
+  # @return [Boolean] if the currently open user is a moderator of any subreddit
 	def is_moderator
 		return @browser.ul(id: 'side-mod-list').present?
 	end
 
+  # Gets the currently open user's moderating pages 
+  #
+  # @return [Array] an array of strings containing the names of the subreddits
 	def get_moderating
 		result = []
 		@browser.ul(id: 'side-mod-list').lis.each do |li|
@@ -619,25 +955,37 @@ class Reddit
 		return result
 	end
 
+  # Checks if the currently open user is a friend of the logged in account
+  #
+  # @return [Boolean] if the currently open user is a friend of the logged in account
 	def is_friend
 		return @browser.span(class: 'fancy-toggle-button').link(text: '- friends').attribute_value('class').include?('active')
 	end
 
+  # Adds the currently open user as a friend, does nothing if the user is already a friend
 	def add_friend
 		return if is_friend
 		@browser.link(text: '+ friends').click
 	end
 
+  # Removes the currently open user as a friend, does nothing if the user is not a friend
 	def remove_friend
 		return if !is_friend
 		@browser.link(text: '- friends').click
 	end
 
+  # Opens the page of the given username
+  #
+  # @param user [String] the username
 	def open_user_page(user)
 		@browser.goto PAGE_USER + user
 		skip_over_18 if has_over_18
 	end
 
+  # Gets a hash containing information about the given user
+  #
+  # @param user [String] the username
+  # @return [Hash] a hash containing information about the given user
 	def get_user(user)
 		open_user_page(user)
 		return nil if @browser.div(id: 'classy-error').present?
@@ -654,6 +1002,9 @@ class Reddit
 	#User Activity handling
 	#---------------------------------------------------------------------------------
 
+  # Gets all the ativity divs from the currently open user
+  #
+  # @return [Array] an array including the divs
 	def get_activity_divs
 		divs = @browser.div(id: 'siteTable').children
 		result = []
@@ -663,26 +1014,51 @@ class Reddit
 		return result
 	end
 
+  # Gets the type of the activity
+  #
+  # @param div [Watir::Div] the activity's div
+  # @return [String] the activity's type
 	def get_activity_type(div)
 		return div.attribute_value('data-type')
 	end
 
+  # Gets the link of the activity
+  #
+  # @param div [Watir::Div] the activity's div
+  # @return [String] the activity's link
 	def get_activity_link(div)
 		return div.attribute_value('data-permalink')
 	end
 
+  # Gets the subreddit of the activity
+  #
+  # @param div [Watir::Div] the activity's div
+  # @return [String] the activity's subreddit
 	def get_activity_subreddit(div)
 		return div.attribute_value('data-subreddit')
 	end
 
+  # Gets the title of the activity
+  #
+  # @param div [Watir::Div] the activity's div
+  # @return [String] the activity's title
 	def get_activity_title(div)
 		return div.link(class: 'title').text
 	end
 
+  # Gets the activity's content if it is a comment
+  #
+  # @param div [Watir::Div] the activity's div
+  # @return [String] the activity's text content
 	def get_activity_content(div) #only for comments
 		return div.div(class: 'usertext-body').text
 	end
 
+  # Gets the amount of karma the activity received, 'up', 'down' or overall
+  #
+  # @param div [Watir::Div] a div containing the activity
+  # @param vote [String, nil] 'up' for number of upvotes, 'down' for downvotes, nil for total
+  # @return [Integer] the number of votes/karma
 	def get_activity_karma(div, vote)
 		case get_activity_type(div)
 		when 'comment' 
@@ -701,18 +1077,35 @@ class Reddit
 		end
 	end
 
+  # Checks if the activity is voted by the logged in account, 'up' or 'down', raises an exception if an unknown vote type is submitted
+  #
+  # @param div [Watir::Div] a div containing the activity
+  # @param type [String] the vote type, 'up' or 'down'
+  # @return [Boolean] if the activity is voted
 	def is_activity_voted(div, type)
 		return is_comment_voted(div, type)
 	end
 
+  # Gets the activity's vote by the logged in account
+  #
+  # @param div [Watir::Div] a div containing the activity
+  # @return [String, nil] 'up' if upvoted, 'down' if downvoted, nil if not voted
 	def get_activity_vote(div)
 		return get_comment_vote(div)
 	end
 
+  # Votes the given activity
+  #
+  # @param div [Watir::Div] a div containing the activity
+  # @param [String] the vote type can be 'up' or 'down'
 	def vote_activity(div, type)
 		vote_message(div, type)
 	end
 
+  # Gets a hash containing information about the given activity
+  #
+  # @param div [Watir::Div] a div containing the activity
+  # @return a hash containing information about the given activity
 	def get_activity(div)
 		result = {}
 		result['type'] = get_activity_type(div)
@@ -725,10 +1118,20 @@ class Reddit
 		return result
 	end
 
+  # Moves to the next or previous page in the user's activity box
+  #
+  # @param direction [String] the direction to move, can be 'next' or 'prev'
+  # @return [Boolean] returns true if moved to the desired page or false if didn't because you're already in the last (move next) or first (move prev) page
 	def user_move_page(direction)
 		return message_move_page(direction)
 	end
 
+  # Gets all the user activities from the given user, raises exception if unknown sorting method is used
+  #
+  # @param user [String] the username
+  # @param sortby [String] sorting method, can be: 'new', 'hot', 'top', 'controversial'
+  # @param max_pages [Integer] maximum amounts of pages to get activies from
+  # @return [Array] an array containing all the activities hashes
 	def get_user_activities(user, sortby = 'new', max_pages = 1)
 		raise 'Unknown user sortby: ' + sortby if !USER_SORTBYS.include? sortby
 		@browser.goto PAGE_USER + user + '/?sort=' + sortby
@@ -749,6 +1152,9 @@ class Reddit
 	#Extra functions
 	#---------------------------------------------------------------------------------
 
+  # Gets all the subreddits the currently logged user is banned in
+  #
+  # @return [Array] an array of strings containing the subreddits the user is banned in
 	def get_banned_subreddits
 		msgs = get_messages('messages', true)
 		result = []
@@ -801,6 +1207,12 @@ class Reddit
 		return @browser.button(class: 'c-btn c-btn-primary subreddit-picker__subreddit-button').present? ? 'picksubs' : 'enterdata'
 	end
 
+  # Creates an account on reddit
+  #
+  # @param username [String] the account's username
+  # @param password [String] the account's password
+  # @param captcha_token [String] the google's captcha's token, it's up to you how to get it
+  # @return [Hash] a hash containing the account's username and password
 	def create_account(username, password, captcha_token) #if username is nil, selects username from reddit's suggestions
 		@browser.goto PAGE_MAIN
 		@browser.div(id: 'header-bottom-right').link(text: 'sign up').click
@@ -822,14 +1234,22 @@ class Reddit
 		return result
 	end
 
+  # Checks if the given user is banned
+  #
+  # @param user [String] the username
+  # @return [Boolean] whether the user is banned or not
 	def is_user_banned(user)
 		@browser.goto PAGE_USER + user
 		skip_over_18 if has_over_18
 		return @browser.div(id: 'classy-error').present? || @browser.h3(text: 'This account has been suspended').present?
 	end
 
-	def is_subreddit_banned(subr)
-		@browser.goto PAGE_SUBREDDIT + subr
+  # Checks if the given subreddit is banned
+  #
+  # @param subreddit [String] the subreddit's name
+  # @return [Boolean] whether the subreddit is banned or not
+	def is_subreddit_banned(subreddit)
+		@browser.goto PAGE_SUBREDDIT + subreddit
 		skip_over_18 if has_over_18
 		return @browser.h3(text: 'This community has been banned').present?
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reddit_auto
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ícaro Augusto