Rubbit 0.2.1 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODRiMzU0YWQxNzRkNmM1MDUzNDJkMDQ0N2IwYTE0MGY0N2E1YWNlOQ==
+    NjljN2VjOTY3MGYwMjg4YzY5YWU3MTExNTc4MDE5NzEyYTI1OGY5OQ==
   data.tar.gz: !binary |-
-    MTI5YWEwNzYwYzY4ZDliMDkyZjlhMzNiMWM3NTAzODllMWY1NDgxMw==
+    ZWQ3MTc4YTY5MjQyYzcxMDk3YjViZjE1NTA3NDU3NDk0NDg0MDkwMQ==
 SHA512:
   metadata.gz: !binary |-
-    ZWMyOGI1NzQ2MWU0NDUyMzliYWNjYTUwZjk0OWM5NWUzMTI0YTQwNTAzNjE1
-    YmEzYTUxNzU3MDI2NjJjNzYwMzY2Y2E2YWRmMTdkNjJmMzBhYjM3N2Y4YTE3
-    ZWUxMzg2MWM0YWI0Yjg1MTY5ZDZkYmU5NmEwMjdmNGJjYWZjMDE=
+    N2JmNmRkMmJjOGIxZDc0MDY2NmU2OWVhZTE1YjlhZTEwYzA2NTE1ZTY5ZDVm
+    OGViM2ZkMjdiMzk5ZDk2M2I0MWVlNzc3ZWVhMzNhZWY3ZjI4M2VmMDgwOTVl
+    NTA1OTE5NmIzY2VlYTliMzI0ZjkxY2M5MWJlNzZkMzhjZjExYjk=
   data.tar.gz: !binary |-
-    ZTQ1YTJiNzIwZTA1ZDY0OGZmODI5ZjU2MjZkZmVkMjM1NGMxYmRmYWI2NTU4
-    MDFlNmIwOGZlMjgxMTNhZjAzMGE5NTk5ZGQxZGRlYjNlMDFjYmY1MTBlNzY4
-    N2Q0MzI1Yzg2MmYyZDllNjFiYTYxYTNkYzQ3NmNjNGUwNWQ4N2U=
+    NmM3ZGIyYWZlZGYwYjBkZWY4YmFmYmNmMWFjYWQ5ZDkzNDI4ZjcxM2VhY2Fl
+    MWE1MDYwMTBmMjJjYzk5MWJjMzRkYzNjNzcwYzExZDc4YmUwMjgzYTM3Mjg4
+    ZDk1MTI4MGFhMzBlMzJlOGU5NGIzMDk3NGFkNzZhMTFmNWE0NTk=

data/lib/Rubbit.rb

@@ -2,9 +2,20 @@ require 'Rubbit/Rubbit_Objects'
 require 'Rubbit/Rubbit_Construction_Layer'
 require 'io/console'
 
+# == Rubbit Client
+#
+# Contains highest level Rubbit functionality
+#
 class Rubbit
 	attr_accessor :client_name, :object_builder, :rubbit_poster, :me
 
+	# ==== Description
+	#
+	# Initialize the Rubbit client with an ID that's added to the user agent
+	#
+	# ==== Attributes
+	#
+	# * +name+ - Attribute that identifies the bot using Rubbit. Is added to the user-agent.
 	def initialize(name)
 		@client_name = name
 		@object_builder = Rubbit_Object_Builder.instance(name)
@@ -12,18 +23,49 @@ class Rubbit
 		@me = nil
 	end
 
+	# ==== Description
+	#
+	# Gets a Subreddit object, created by subreddit name
+	#
+	# ==== Attributes
+	#
+	# * +display_name+ - Display name of the subreddit a user wishes to create an object representation for
 	def get_subreddit(display_name)
 		return @object_builder.build_subreddit(display_name)
 	end
 
+	# ==== Description
+	#
+	# Gets a Redditor object, created by username
+	#
+	# ==== Attributes
+	#
+	# * +user+ - That Redditor's username
 	def get_redditor(user)
 		return @object_builder.build_user(user)
 	end
 
+	# ==== Description
+	#
+	# Gets a Subreddit object, created by subreddit name
+	#
+	# ==== Attributes
+	#
+	# * +display_name+ - Display name of the subreddit a user wishes to create an object representation for
 	def set_request_period(period)
 		@object_builder.set_request_period(period)
 	end
 
+	# ==== Description
+	#
+	# Login to Reddit and create a session.
+	# User and passwd are *not* required. This function will prompt the user for missing information at runtime.
+	#
+	# ==== Attributes
+	#
+	# * +user+ - Username that you wish to log in with
+	# * +passwd+ - Password required to log in with that user
+	#
 	def login(user=nil,passwd=nil)
 		if(user==nil)
 			print('Enter username: ')
@@ -38,17 +80,35 @@ class Rubbit
 		return @me
 	end
 
-	def clear_session(curpass=nil,uh=nil)
+	# ==== Description
+	#
+	# Clears the current session.
+	#
+	# ==== Attributes
+	#
+	# * +curpass+ - Password required to log in with that user
+	#
+	def clear_session(curpass=nil)
 		if(@me==nil)
 			print('Not logged in. No session to clear')
 		elsif(curpass==nil)
 			print('Enter password for '+user.to_s+': ')
 			passwd = STDIN.noecho(&:gets).chomp
 		end
-		return @rubbit_poster.clear_sessions(curpass,uh)
-	end
-
-	def delete_user(user=nil,passwd=nil,message="",uh=nil)
+		return @rubbit_poster.clear_sessions(curpass)
+	end
+
+	# ==== Description
+	#
+	# Deletes desired user. Requires auth info for that user.
+	#
+	# ==== Attributes
+	#
+	# * +user+ - Username of account you wish to delete.
+	# * +passwd+ - Password required to log in with that user
+	# * +message+ - Reason for deleting account.
+	#
+	def delete_user(user=nil,passwd=nil,message="")
 		confirm = nil
 		if(user==nil)
 			print('Enter username: ')
@@ -71,7 +131,7 @@ class Rubbit
 			end
 		end
 
-		return @rubbit_poster.delete_user(user,passwd,confirm,message,@me.uh)
+		return @rubbit_poster.delete_user(user,passwd,confirm,message)
 	end
 
 	def get_me()

data/lib/Rubbit/Reddit_Net_Wrapper.rb

@@ -29,6 +29,7 @@ class Reddit_Net_Wrapper
 
 	def set_reset_period(period=60)
 		if(period%2!=0 or period>60 or period<2)
+			print('Reset period must be an even integer between 2 and 60')
 			return false
 		else
 			@reset_timer = period

data/lib/Rubbit/Rubbit_Construction_Layer.rb

@@ -126,7 +126,7 @@ class Rubbit_Poster
 		return response.body
 	end
 
-	def delete_user(user,passwd,message,confirm)
+	def delete_user(user,passwd,message)
 		params = {}
 		params['api_type']='json'
 		params['user']=user

data/lib/Rubbit/Rubbit_Objects.rb

@@ -1,8 +1,10 @@
 require 'Rubbit/Reddit_Net_Wrapper'
 require 'Rubbit/Rubbit_Exceptions'
 
-# == Subreddit
+# == Rubbit Object
+#
 # Object Representing a Subreddit.
+#
 class Subreddit
 	def initialize(json)
 		if(json['kind']=='t5')
@@ -170,8 +172,8 @@ class Subreddit
 	#
 	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
 	#
-	def get_moderators(limit=100)
-		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/about/moderators.json',limit)
+	def get_moderators
+		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/about/moderators.json',nil)
 	end
 
 	
@@ -250,6 +252,12 @@ class Subreddit
 	end
 end
 
+# == Rubbit Object
+#
+# Object Representing a Redditor.
+# If the requested Redditor is logged in, this object also contains a modhash.
+# If obtained from a subreddit list, this object will need to be rebuilt using the rebuild function
+#
 class Redditor
 	def initialize(json)
 		if(json['kind']=='t2')
@@ -267,18 +275,49 @@ class Redditor
 		end
 	end
 
+	# ==== Description
+	#
+	# Function for getting user overview content from a profile, including both comments and posts
+	#
+	# ==== Attributes
+	#
+	# * +limit+ - Maximum entries that the ContentGenerator can contain
+	# * +sort+ - Sort order by which the content is returned
+	#
 	def get_overview(limit=100,sort='new')
 		return ContentGenerator.new('http://www.reddit.com/user/'+@name.to_s+'/.json?sort='+sort,limit)
 	end
 
+	# ==== Description
+	#
+	# Function for getting user comment from a profile
+	#
+	# ==== Attributes
+	#
+	# * +limit+ - Maximum entries that the ContentGenerator can contain
+	# * +sort+ - Sort order by which the content is returned
+	#
 	def get_comments(limit=100,sort='new')
 		return ContentGenerator.new('http://www.reddit.com/user/'+@name.to_s+'/comments.json?sort='+sort,limit)
 	end
 
+	# ==== Description
+	#
+	# Function for getting user posts from a profile
+	#
+	# ==== Attributes
+	#
+	# * +limit+ - Maximum entries that the ContentGenerator can contain
+	# * +sort+ - Sort order by which the content is returned
+	#
 	def get_submitted(limit=100,sort='new')
 		return ContentGenerator.new('http://www.reddit.com/user/'+@name.to_s+'/submitted.json?sort='+sort,limit)
 	end
 
+	# ==== Description
+	#
+	# Function for rebuilding user object using data from their profile page
+	#
 	def rebuild
 		rebuilt_user = Rubbit_Object_Builder.instance.build_user(@name)
 		rebuilt_user.instance_variables.each do |attr_name|
@@ -288,6 +327,10 @@ class Redditor
 	end
 end
 
+# == Rubbit Object
+#
+# Enumerable object that allows a user to iterate over data sets
+#
 class ContentGenerator
 	include Enumerable
 	@limit = nil
@@ -297,6 +340,18 @@ class ContentGenerator
 	@after = nil
 	@modhash = nil
 	@index
+	@limit_param
+
+	# ==== Description
+	#
+	# Initializes a ContentGenerator Object
+	#
+	# ==== Attributes
+	#
+	# * +source+ - *Required.* Link to the .json page for the content
+	# * +limit+ - Maximum number of entries the ContentGenerator will load. *nil* for no limit.
+	# * +after+ - ID of entry to load content after.
+	#
 	def initialize(source,limit=100,after='')
 		@source = source
 		@limit = limit
@@ -304,19 +359,28 @@ class ContentGenerator
 		@data = []
 		@after = after
 		@index = 0
+		if(@source.include?('?'))
+			@limit_param = '&limit='
+		else
+			@limit_param = '?limit='
+		end
 	end
 
+	# ==== Description
+	#
+	# Iterates over the content from a specific source until there is no content left or until a limit is reached
+	#
 	def each
 		if(@data.length==0)
 			if(@limit!=nil)
 				if(@limit-@count>0)
-					listing = Rubbit_Object_Builder.instance.build_listing(@source+'?limit='+[@limit-@count,100].min.to_s+"&after="+@after+"&count="+@count.to_s)
+					listing = Rubbit_Object_Builder.instance.build_listing(@source+@limit_param+[@limit-@count,100].min.to_s+"&after="+@after+"&count="+@count.to_s)
 					@after = listing.after
 					@data += listing.children
 					@count += listing.children.length
 				end
 			else
-				listing = Rubbit_Object_Builder.instance.build_listing(@source+'?limit='+100.to_s+"&after="+@after+"&count="+@count.to_s)
+				listing = Rubbit_Object_Builder.instance.build_listing(@source+@limit_param+100.to_s+"&after="+@after+"&count="+@count.to_s)
 				@after = listing.after
 				@data += listing.children
 				@count+= listing.children.length
@@ -332,14 +396,14 @@ class ContentGenerator
 				end
 				if(@limit!=nil)
 					if(@limit-@count>0)
-						listing = Rubbit_Object_Builder.instance.build_listing(@source+'?limit='+[@limit-@count,100].min.to_s+"&after="+@after+"&count="+@count.to_s)
+						listing = Rubbit_Object_Builder.instance.build_listing(@source+@limit_param+[@limit-@count,100].min.to_s+"&after="+@after+"&count="+@count.to_s)
 						@after = listing.after
 						@data += listing.children
 						@count += listing.children.length
 					end
 				else
-					listing = Rubbit_Object_Builder.instance.build_listing(@source+"?limit="+100.to_s+"&after="+@after+"&count="+@count.to_s)
-					puts(@source+"?limit="+100.to_s+"&after="+@after+"&count="+@count.to_s)
+					listing = Rubbit_Object_Builder.instance.build_listing(@source+@limit_param+100.to_s+"&after="+@after+"&count="+@count.to_s)
+					puts(@source+@limit_param+100.to_s+"&after="+@after+"&count="+@count.to_s)
 					@after = listing.after
 					@data += listing.children
 					@count += listing.children.length
@@ -348,10 +412,22 @@ class ContentGenerator
 		end
 	end
 
-	def [](i)
-		return @data[i]
+	# ==== Description
+	#
+	# Returns an object in the ContentGenerator at a particular index. Only works after it has been iterated through and loaded.
+	#
+	# ==== Attributes
+	#
+	# * +index+ - The index of the object in the ContentGenerator that will be returned.
+	#
+	def [](index)
+		return @data[index]
 	end
 
+	# ==== Description
+	#
+	# Returns the next object in the ContentGenerator. If none is loaded, it will try to load more, until a limit is reached.
+	#
 	def next
 		if(@index>=@data.length)
 			if(@limit!=nil)
@@ -376,6 +452,10 @@ class ContentGenerator
 		return to_return
 	end
 
+	# ==== Description
+	#
+	# Returns the previous object in the ContentGenerator. If the index is at 0, nil is returned
+	#
 	def prev
 		if(@index>1)
 			@index-=1
@@ -385,15 +465,31 @@ class ContentGenerator
 		end
 	end
 
-	def reset_generator(i=0)
-		@index=i
+	# ==== Description
+	#
+	# Resets the index of the current entry in ContentGenerator
+	#
+	# ==== Attributes
+	#
+	# * +index+ - The index that the ContentGenerator will be set to. Defaults to 0.
+	#
+	def reset_generator(index=0)
+		@index=index
 	end
 
+	# ==== Description
+	#
+	# Returns the length of data already loaded into the ContentGenerator.
+	#
 	def length
 		return @data.length
 	end
 end
 
+# == Rubbit Object
+#
+# Object that represents an individual comment
+#
 class Comment
 	def initialize(json)
 		if(json['kind']=='t1')
@@ -417,23 +513,51 @@ class Comment
 		end
 	end
 
+	# ==== Description
+	#
+	# Submits a reply to a comment.
+	#
+	# ==== Attributes
+	#
+	# * +text+ - The body of the response
+	#
 	def reply(text)
 		Rubbit_Poster.instance.comment(@name,text)
 	end
 
+	# ==== Description
+	#
+	# Deletes this comment. Only works if the comment was made by you.
+	#
 	def delete
 		Rubbit_Poster.instance.delete(@name)
 	end
 
+	# ==== Description
+	#
+	# Modifies the text of this comment. Only works if the comment was made by you.
+	#
+	# ==== Attributes
+	#
+	# * +text+ - The new comment body.
+	#
 	def edit(text)
 		Rubbit_Poster.instance.edit(@name,text)
 	end
 
+	# ==== Description
+	#
+	# No longer shows the comment to you on Reddit.
+	#
 	def hide
 		Rubbit_Poster.instance.hide(@name)
 	end
 end
 
+# == Rubbit Object
+#
+# Object representing a Reddit Post
+#
 class Post
 	@comments = nil
 	def initialize(json)
@@ -446,10 +570,23 @@ class Post
 			end
 		end
 	end
+
+	# ==== Description
+	#
+	# Makes a reply to a post
+	#
+	# ==== Attributes
+	#
+	# * +text+ - The new comment body.
+	#
 	def reply(text)
 		return Rubbit_Poster.instance.comment(@name,text)
 	end
 
+	# ==== Description
+	#
+	# Retrieves the comments of a post in a list tree.
+	#
 	def replies
 		if(@comments==nil)
 			@comments = Rubbit_Object_Builder.instance.get_comments('http://www.reddit.com'+@permalink).children
@@ -457,23 +594,47 @@ class Post
 		return @comments
 	end
 
+	# ==== Description
+	#
+	# Deletes this post. Only works if you made the post.
+	#
 	def delete
 		Rubbit_Poster.instance.delete(@name)
 	end
 
+	# ==== Description
+	#
+	# Modifies the text of this post. Only works if the post was made by you and is a self post.
+	#
+	# ==== Attributes
+	#
+	# * +text+ - The new post body.
+	#
 	def edit(text)
 		Rubbit_Poster.instance.edit(@name,text)
 	end
 
+	# ==== Description
+	#
+	# Hides the post and no longer displays it when retrieving Reddit data
+	#
 	def hide
 		Rubbit_Poster.instance.hide(@name)
 	end
 
+	# ==== Description
+	#
+	# Marks a post as NSFW. Only works if you made the post or are a moderator of the subreddit it is in.
+	#
 	def mark_nsfw
 		Rubbit_Poster.instance.mark_nsfw(@name)
 	end
 end
 
+# == Rubbit Object
+#
+# Object that represents a Personal Message
+#
 class Message
 	def initialize(json)
 		if(json['kind']=='t4')
@@ -485,6 +646,14 @@ class Message
 		end
 	end
 
+	# ==== Description
+	#
+	# Responds to an inbox message.
+	#
+	# ==== Attributes
+	#
+	# * +text+ - The new message body.
+	#
 	def reply(text)
 		Rubbit_Poster.instance.comment(text,@name)
 	end
@@ -493,7 +662,8 @@ end
 class Listing
 	@after = nil
 	def initialize(json)
-		if(json['kind']=='Listing')
+		if(json['kind']=='Listing' or json['kind']=='UserList')
+			@after = nil
 			data = json['data']
 			data.each_key do |k|
 				self.class.module_eval {attr_accessor(k)}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Rubbit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - /u/The1RGood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies: []
 description: A simple Ruby-based Reddit API Wrapper
 email: randy@kindofabigdeal.org