Rubbit 0.1.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjZhZDFkZTc4NTQ0NDJlNTY4NmYxNTcxMTJlMTBjNzNiOWFjODQ5MQ==
+    ODRiMzU0YWQxNzRkNmM1MDUzNDJkMDQ0N2IwYTE0MGY0N2E1YWNlOQ==
   data.tar.gz: !binary |-
-    ODc5YmQzYzFhMjExNzVjODlmZWNjMTg4MjhmYzdjMTk5MTJmZjRkYg==
+    MTI5YWEwNzYwYzY4ZDliMDkyZjlhMzNiMWM3NTAzODllMWY1NDgxMw==
 SHA512:
   metadata.gz: !binary |-
-    MGY0ODVjZTkxNTkzOGI3YjQ4ZGQzNTY2ZGI5YzA5MjkzYmY2ZDk0NjJiYzZh
-    NDQwMWNjOWNkMGZkY2U4Yjk3Y2NjZDY4OGYwM2E2YTA1N2Y3ZmFmMTg5YzIw
-    ODAxZDJhYWVmMDQ4MWI1MDkyYTg4MmFkNDFiN2E2YzI1MmMwOTE=
+    ZWMyOGI1NzQ2MWU0NDUyMzliYWNjYTUwZjk0OWM5NWUzMTI0YTQwNTAzNjE1
+    YmEzYTUxNzU3MDI2NjJjNzYwMzY2Y2E2YWRmMTdkNjJmMzBhYjM3N2Y4YTE3
+    ZWUxMzg2MWM0YWI0Yjg1MTY5ZDZkYmU5NmEwMjdmNGJjYWZjMDE=
   data.tar.gz: !binary |-
-    MDZhODM0YTJiYjQ4ZTQ2NmE4NDIzMWVhYmQ4YjMxMWUyZWI4NDM3MTZkZDE0
-    YTQ2ZDY2MmQ1ZWQ2NzM5NzVkMDNlMzVlOGYzNDM3MzM2ODY0ODRiNTBjMDQw
-    NzkzMGQ3NjVjNWY3MDdhZDE0OWJjOWQxZWVjNzhiNGMxNTA4YjY=
+    ZTQ1YTJiNzIwZTA1ZDY0OGZmODI5ZjU2MjZkZmVkMjM1NGMxYmRmYWI2NTU4
+    MDFlNmIwOGZlMjgxMTNhZjAzMGE5NTk5ZGQxZGRlYjNlMDFjYmY1MTBlNzY4
+    N2Q0MzI1Yzg2MmYyZDllNjFiYTYxYTNkYzQ3NmNjNGUwNWQ4N2U=

data/lib/Rubbit/Rubbit_Construction_Layer.rb

@@ -28,7 +28,6 @@ class Rubbit_Object_Builder
 
 	def build_subreddit(display_name)
 		response = Reddit_Net_Wrapper.instance.make_request('get','http://www.reddit.com/r/'+display_name.to_s+"/about.json",{})
-		puts response.code
 		if(response.code=='200')
 			return Subreddit.new(JSON.parse(response.body))
 		elsif(response.code=='403')
@@ -278,7 +277,6 @@ class Rubbit_Poster
 	def get_modhash
 		response = Reddit_Net_Wrapper.instance.make_request('get','http://www.reddit.com/user/'+@logged_in_user+'/about.json',{})
 		data = JSON.parse(response.body)
-		puts data
 		return data['data']['modhash']
 	end
 

data/lib/Rubbit/Rubbit_Objects.rb

@@ -1,6 +1,8 @@
 require 'Rubbit/Reddit_Net_Wrapper'
 require 'Rubbit/Rubbit_Exceptions'
 
+# == Subreddit
+# Object Representing a Subreddit.
 class Subreddit
 	def initialize(json)
 		if(json['kind']=='t5')
@@ -12,74 +14,237 @@ class Subreddit
 		end
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the new queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_new(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/new.json',limit)
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the hot queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_hot(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/hot.json',limit)
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the top queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_top(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/top.json',limit)
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the gilded queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_gilded(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/gilded.json',limit)
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the rising queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_rising(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/rising.json',limit)
 	end
 
+	# ==== Description
+	# 
+	# Returns enumerable ContentGenerator object representing the controversial queue
+	# 
+	# ==== Attributes
+	# 
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_controversial(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/controversial.json',limit)
 	end
 
+	
+	# ==== Description
+	#
+	# General function for submitting content to a subreddit
+	#
+	# ==== Attributes
+	#
+	# * +title+ - *REQUIRED.* Title for post. Cannot be empty or the function will not work.
+	# * +url+ - The url for the post. Will only be used if kind is "link"
+	# * +text+ - The text for the post. Will only be used if kind is "self"
+	# * +kind+ - Determines type of post. Either link or self.
+	# * +resubmit+ - If true, will make post to subreddit regardless if it is a repost
+	# * +save+ - Will save the post in user's "saved" links if true
+	# * +sendreplies+ - Will send replies to post to user's inbox by default, unless this is set to false
+	#
 	def submit(title,url=nil,text=nil,kind='self',resubmit=false,save=false,sendreplies=true)
 		return Rubbit_Poster.instance.submit(@display_name,title,url,text,kind,resubmit,save,sendreplies)
 	end
 
-	def submit_text(title,text=nil,save=false,sendreplies=true)
+	# ==== Description
+	#
+	# Function for submitting self posts to a subreddit.
+	#
+	# ==== Attributes
+	#
+	# * +title+ - *REQUIRED.* Title for post. Cannot be empty or the function will not work.
+	# * +text+ - The text for the post.
+	# * +save+ - Will save the post in user's "saved" links if true
+	# * +sendreplies+ - Will send replies to post to user's inbox by default, unless this is set to false
+	#
+	def submit_self(title,text=nil,save=false,sendreplies=true)
 		return submit(title,nil,text,'self',false,save,sendreplies)
 	end
 
-	def submit_link(title,url,save=false,sendreplies=true)
-		return submit(title,url,nil,'link',false,save,sendreplies)
-	end
-
+	# ==== Description
+	#
+	# Function for submitting link posts to a subreddit.
+	#
+	# ==== Attributes
+	#
+	# * +title+ - *REQUIRED.* Title for post. Cannot be empty or the function will not work.
+	# * +url+ - The url for the post.
+	# * +resubmit+ - If true, will make post to subreddit regardless if it is a repost
+	# * +save+ - Will save the post in user's "saved" links if true
+	# * +sendreplies+ - Will send replies to post to user's inbox by default, unless this is set to false
+	#
+	def submit_link(title,url,resubmit=false,save=false,sendreplies=true)
+		return submit(title,url,nil,'link',resubmit,save,sendreplies)
+	end
+
+	# ==== Description
+	#
+	# Returns enumerable ContentGenerator object representing approved contributors to a subreddit
+	#
+	# ==== Attributes
+	#
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_contributors(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/about/contributors.json',limit)
 	end
 
+	
+	# ==== Description
+	#
+	# Returns enumerable ContentGenerator object representing banned users of a subreddit. Will only work if subreddit moderator.
+	#
+	# ==== Attributes
+	#
+	# * +limit+ - Maximum entries that the returned ContentGenerator will hold. For no limit, use *nil*
+	#
 	def get_banned(limit=100)
 		return ContentGenerator.new('http://www.reddit.com/r/'+@display_name.to_s+'/about/banned.json',limit)
 	end
 
+	
+	# ==== Description
+	#
+	# Returns enumerable ContentGenerator object representing moderators of a subreddit. Will only work if subreddit is viewable.
+	#
+	# ==== Attributes
+	#
+	# * +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)
 	end
 
+	
+	# ==== Description
+	#
+	# Function for adding moderator to a subreddit. Only works if subreddit moderator.
+	#
+	# ==== Attributes
+	#
+	# * +name+ - name of user to add as a moderator
+	# * +permissions+ - string containing permissions to give this user
+	#
 	def add_moderator(name,permissions)
 		return Rubbit_Poster.instance.friend('moderator_invite',name,@display_name,permissions)
 	end
 
+	# ==== Description
+	#
+	# Function for adding contributor to a subreddit. Only works if subreddit moderator.
+	# ==== Attributes
+	#
+	# * +name+ - name of user to add as a contributor
+	#
 	def add_contributor(name)
 		return Rubbit_Poster.instance.friend('contributor',name,@display_name)
 	end
 
+	# ==== Description
+	#
+	# Function for banning a user from a subreddit. Only works if subreddit moderator.
+	#
+	# ==== Attributes
+	#
+	# * +name+ - name of user to ban
+	# * +note+ - note for the ban
+	# * +duration+ - length of period they are banned for, in days. Send *nil* for permanent
+	#
 	def ban(name,note,duration)
 		return Rubbit_Poster.instance.friend('banned',name,@display_name,note,duration)
 	end
 
+	# ==== Description
+	#
+	# Function for removing a moderator from a subreddit. Only works if subreddit moderator and has higher permissions than mod to remove.
+	#
+	# ==== Attributes
+	#
+	# * +name+ - name of moderator to remove
+	#
 	def remove_moderator(name)
 		return Rubbit_Poster.instance.unfriend('moderator',name,@display_name)
 	end
 
+	# ==== Description
+	#
+	# Function for removing a contributor from a subreddit. Only works if subreddit moderator.
+	#
+	# ==== Attributes
+	#
+	# * +name+ - name of contributor to remove
+	#
 	def remove_contributor(name)
 		return Rubbit_Poster.instance.unfriend('contributor',name,@display_name)
 	end
 
+	# ==== Description
+	#
+	# Function for unbanning a user from a subreddit. Only works if subreddit moderator.
+	#
+	# ==== Attributes
+	#
+	# * +name+ - name of user to unban
+	#
 	def unban(name)
 		return Rubbit_Poster.instance.unfriend('ban',name,@display_name)
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Rubbit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - /u/The1RGood