zohoProjects 0.0.4

data/lib/projects/api/EventsAPI.rb

@@ -0,0 +1,115 @@
+#  $Id$ 
+module Projects
+	module Api
+
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/api/API'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/util/ZohoHTTPClient'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/parser/EventParser'
+
+
+		# * EventsAPI is used to:
+		# 
+		# * Get list of events.
+		#	 
+		# * Add an event.
+		#	 
+		# * Update the details of an event.
+		#	 
+		# * Delete an existing event.
+		 
+
+		class EventsAPI < API	
+			include Projects::Parser
+			include Projects::Util	
+			# * EventParser is used to parse the JSON response into respective objects.
+
+			$eventParser = EventParser.new
+
+			# * Construct a new EventsAPI using User's authToken and portalId.
+			# 
+			# ==== Parameters
+			#
+			# * authToken:: - User's authToken.
+			# 
+			# * portalId:: - User's portalId.
+
+			def initialize(authToken,portalId)
+				super(authToken,portalId)
+			end
+			
+			# * Get list of events for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			# 
+			# ==== Returns
+			#
+			# * List of Event object.
+
+
+			def getEvents(projectId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/events/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))	
+				return $eventParser.getEvents(response)
+			end
+			
+			# * Add an event for the project.
+			#
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			# 
+			# * event:: - Event object.
+			# 
+			# ==== Returns
+			#
+			# * Event object.
+
+
+			def add(projectId, event)
+				url = getBaseURL+"projects/"+String(projectId)+"/events/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)		
+				return $eventParser.getEvent(response)
+			end
+			
+			# * Update the details of an event.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * event:: - Event object.
+			# 
+			# ==== Returns
+			#
+			# * Event object.
+
+			def update(projectId, event)
+				url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(event.getId)+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)		
+				return $eventParser.getEvent(response)
+			end
+			
+			# * Delete an existing event for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * eventId:: - ID of the event.
+			# 
+			# ==== Returns
+			#
+			# * String object.
+
+			def delete(projectId, eventId)
+				url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(eventId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)
+				return $eventParser.getResult(response)
+			end
+		end
+	end
+end

data/lib/projects/api/FoldersAPI.rb

@@ -0,0 +1,111 @@
+#  $Id$ 
+module Projects
+	module Api
+
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/api/API'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/util/ZohoHTTPClient'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/parser/FolderParser'
+
+
+		# * FoldersAPI is used to:
+		# 
+		# * Get list of folder.
+		#	 
+		# * Add a folder.
+		#	  
+		# * Update the details of a folder.
+		#	 
+		# * Delete an existing folder.
+
+
+		class FoldersAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# * FolderParser is used to parse the JSON response into respective objects.
+			
+			$folderParser = FolderParser.new
+
+			# * Construct a new FoldersAPI using User's authToken and portalId.
+			# 
+			# ==== Parameters
+			#
+			# * authToken:: - User's authToken.
+			# 
+			# * portalId:: - User's portalId.
+
+			def initialize(authToken,portalId)
+				super(authToken,portalId)
+			end
+
+			# * Get list of folders for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# ===== Returns
+			#
+			# * List of Folder object.
+			
+			def getFolders(projectId)
+				url = getBaseURL+"projects/"+String(projectId)+"/folders/"		
+				response = ZohoHTTPClient.get(url, getQueryMap)	
+				return $folderParser.getFolders(response)
+			end
+
+			# * Add a folder for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * folder:: - Folder object.
+			# 
+			# ===== Returns
+			#
+			# * Folder object.
+			
+			def addFolder(projectId, folder)
+				url = getBaseURL+"projects/"+String(projectId)+"/folders/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, folder.toParamMAP)		
+				return $folderParser.getFolder(response)
+			end
+
+			# * Update the details of a folder.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * folder:: - Folder object.
+			# 
+			# ===== Returns
+			#
+			# * Folder object.
+			
+			def updateFolder(projectId, folder)
+				url = getBaseURL+"projects/"+String(projectId)+"/folders/"+String(folder.getId)+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, folder.toParamMAP)	
+				return $folderParser.getFolder(response)
+			end
+			
+			# * Delete an existing folder for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+		 	# * folderId:: - ID of the folder.
+		 	# 
+		 	# ==== Returns
+		 	#
+			# * String object.
+
+			def deleteFolder(projectId, folderId)
+				url = getBaseURL+"projects/"+String(projectId)+"/folders/"+String(folderId)+"/"	
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $folderParser.getResult(response)
+			end
+		end
+	end
+end

data/lib/projects/api/ForumsAPI.rb

@@ -0,0 +1,198 @@
+#  $Id$ 
+module Projects
+	module Api
+
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/api/API'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/util/ZohoHTTPClient'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/parser/ForumParser'
+
+		# * ForumsAPI is used to:
+		# 
+		# * Get list of forums.
+		#	  
+		# * Add a forum.
+		#	  
+		# * Update the details of a forum.
+		#	  
+		# * Delete an existing forum.
+		#	  
+		# * Get list of categories.
+		#	 
+		# * Add a category.
+		#	  
+		# * Get list of comments.
+		#	 
+		# * Add a comment.
+
+		class ForumsAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# * ForumParser is used to parse the JSON response into respective objects.
+			
+			$forumParser = ForumParser.new
+
+			# * Construct a new FoumsAPI using User's authToken and portalId.
+			# 
+			# ==== Parameters
+			#
+			# * authToken:: - User's authToken.
+			#
+			# * portalId:: - User's prtalId.
+
+			def initialize(authToken,portalId)
+				super(authToken,portalId)
+			end	
+
+			# * Get list of forum for the project.
+			# 
+			# ==== Parameters
+			# * projectId:: - ID of the project.
+			# 
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			# 
+			# ==== Returns
+			#
+			# * List of Forum object.
+
+
+			def getForums(projectId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))	
+				return $forumParser.getForums(response)
+			end
+			
+			# * Add a forum for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * forum:: - Forum object.
+			# 
+			# ==== Returns
+			#
+			# * Forum object.
+			 
+
+			def add(projectId, forum)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"		
+				fileBody = Hash.new		
+				fileBody["uploadfile"] = forum.getUploadfile		
+				response = ZohoHTTPClient.post(url, getQueryMap, forum.toParamMAP, fileBody)	
+				return $forumParser.getForum(response)
+			end
+			
+			# * update the details of a forum.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * forum:: - Forum object.
+			# 
+			# ==== Returns
+			#
+			# * Forum object.
+
+			def update(projectId, forum)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"+String(forum.getId)+"/"
+				fileBody = Hash.new 
+				fileBody["uploadfile"] = forum.getUploadfile		
+				response = ZohoHTTPClient.post(url, getQueryMap, forum.toParamMAP, fileBody)
+				return $forumParser.getForum(response)
+			end
+
+			# * Delete an existing forum for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * forumId:: - ID of the forum.
+			# 
+			# ==== Returns
+			#
+			# * String object.
+			
+			def delete(projectId, forumId)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"+String(forumId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $forumParser.getResult(response)
+			end
+			
+			# * Get list of categories for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# ==== Returns
+			#
+			# * List of Category object.
+
+			def getCategories(projectId)
+				url = getBaseURL+"projects/"+String(projectId)+"/categories/"			
+				response = ZohoHTTPClient.get(url, getQueryMap)
+				return $forumParser.getCategories(response)
+			end
+
+			# * Add a category for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * category:: - Category object.
+			# 
+			# ==== Returns
+			#
+			# * Category object.
+
+			def addCategory(projectId, category)
+				url = getBaseURL+"projects/"+String(projectId)+"/categories/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, category.toParamMAP)		
+				return $forumParser.getCategory(response)
+			end
+
+			# * Get list of Comment for the forum.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * forumId:: - ID of the forum.
+			# 
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			# 
+			# ==== Returns
+			#
+			# * List of Comment object.
+			
+			def getComments(projectId, forumId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"+String(forumId)+"/comments/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))		
+				return $forumParser.getComments(response)
+			end
+
+			# * Add comment for the forum.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * forumId:: - ID of the forum.
+			# 
+			# * comment:: - Comment object.
+			# 
+			# ==== Returns
+			#
+			# * Comment object.
+			
+			def addComment(projectId, forumId, comment)
+				url = getBaseURL+"projects/"+String(projectId)+"/forums/"+String(forumId)+"/comments/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, comment.toParamMAP)		
+				return $forumParser.getComment(response)
+			end
+		end
+	end
+end

data/lib/projects/api/MilestonesAPI.rb

@@ -0,0 +1,159 @@
+#  $Id$ 
+module Projects
+	module Api
+
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/api/API'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/util/ZohoHTTPClient'
+		require File.dirname(__FILE__).chomp("/projects/api") + '/projects/parser/MilestonesParser'
+
+
+		# * MilestonesAPI is used to:
+		# 
+		# * 	Get list of milestones.
+		#	 
+		# * 	Get the details of a milestone.
+		#	 
+		# * 	Create a new milestone.
+		#	 
+		# * 	Update the details of a milestone.
+		#	 
+		# * 	Update the status of a milestone.
+		#	 
+		# * 	Delete an existing milestone.
+
+
+		class MilestonesAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# MilestoneParser is used to parse the JSON response into respective objects.
+
+			$milestonesParser = MilestonesParser.new
+
+			# * Construct a new MilestonesAPI using User's authToken and portalId.
+			# 
+			# ==== Parameters
+			#
+			# * authToken:: - User's authToken.
+		 	#
+			# * portalId:: - User's portalId.
+
+			def initialize(authToken,portalId)
+				super(authToken,portalId)
+			end
+
+			# * Get list of milestones for the project.
+		 	#
+		 	# ==== Parameters
+		 	#
+			# * projectId:: - ID of the project.
+		 	#
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+		 	#
+		 	# ==== Returns
+		 	#
+			# * List of Milestone object.
+
+			def getMilestones(projectId, * queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"
+				if queryMap.length == 0
+					response = ZohoHTTPClient.get(url, getQueryMap)
+				else
+					response = ZohoHTTPClient.get(url, getQueryMap(queryMap))
+				end
+				return $milestonesParser.getMilestones(response)
+			end
+
+			# * Get the details of a milestone.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * milestoneId:: - ID of the milestone.
+			# 
+			#  ==== Returns
+			#
+			# * Milestone object.
+
+			def get(projectId,milestoneId)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/"
+				response = ZohoHTTPClient.get(url, getQueryMap)
+				return $milestonesParser.getMilestone(response)
+			end
+
+			# * Create a milestone for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * milestone:: - Milestone object.
+			# 
+			# ==== Returns
+			# * Milestone object.
+
+			def create(projectId,milestone)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"
+				response = ZohoHTTPClient.post(url, getQueryMap, milestone.toParamMAP())
+				return $milestonesParser.getMilestone(response)
+			end
+
+			# * Update the details of a milestone.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * milestone:: - Milestone object.
+			#  
+			# ==== Returns
+			# * Milestone object.
+
+			def update(projectId,milestone)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestone.getId)+"/"
+				response = ZohoHTTPClient.post(url, getQueryMap, milestone.toParamMAP())
+				return $milestonesParser.getMilestone(response)
+			end
+
+			# * Update the status of a milestone.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * milestoneId:: - ID of the milestone.
+			#  
+			# * status:: - Status of the milestone.
+			#  
+			# ==== Returns
+			#
+			# * Milestone object.
+			
+			def updateStatus(projectId,milestoneId,status)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/status/"
+				requestBody = Hash.new()
+				requestBody["status"] = status
+				response = ZohoHTTPClient.post(url, getQueryMap, requestBody)
+				return $milestonesParser.getMilestone(response)
+			end
+
+			# * Delete an existing milestone for the project.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * milestoneId:: - ID of the milestone.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+			
+			def delete(projectId,milestoneId)
+				url = getBaseURL+"projects/"+String(projectId)+"/milestones/"+String(milestoneId)+"/"
+				response = ZohoHTTPClient.delete(url, getQueryMap)
+				return $milestonesParser.getResult(response)
+			end
+		end
+	end
+end