zohoProjects 0.0.4

data/lib/projects/api/PortalAPI.rb

@@ -0,0 +1,41 @@
+#  $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/PortalParser'
+		require File.dirname(__FILE__).chomp("/projects/api") +'/projects/exception/ProjectsException'
+
+
+		# * PortalsAPI is used to get list of portals.
+
+		class PortalAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# * Construct a new PortalsAPI using User's authTken.
+			# 
+			# ==== Parameters
+			#
+			# * authToken:: - User's authToken.
+
+			def initialize(authToken)
+				super(authToken,"")
+			end
+
+			# * Parse the JSON response into respective objects.
+			#
+			# * Get list of portals.
+			# 
+			# ==== Returns
+			#
+			# * List of Portal object.
+
+			def getPortals
+				portalParser = PortalParser.new
+				url = @@baseURL+'portals/'
+				return portalParser.getPortals(ZohoHTTPClient.get(url,getQueryMap))
+			end
+		end
+	end
+end

data/lib/projects/api/ProjectsAPI.rb

@@ -0,0 +1,203 @@
+#  $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/ProjectParser'
+		#require_relative 'API'
+
+		# * ProjectsAPI is used to:
+		#	 
+		# * 	Get list of projects.
+		#	 
+		# * 	Get the details of a project.
+		#	 
+		# * 	Create a new project.
+		#	 
+		# * 	Update the details of a project.
+		#	  
+		# * 	Delete an existing project.
+
+		class ProjectsAPI < API
+			include Projects::Parser
+			include Projects::Util
+
+			# Parse the JSON response into respective objects.
+
+			$projectParser = ProjectParser.new
+
+			# * Construct a new ProjectsAPI using User's authToken and portalId.
+			# 
+			# ==== Parameters
+			# 
+			# * authToken:: - User's authToken.
+			#  
+			# * portalId:: - User's portalId.
+
+			def initialize(authToken,portalId)
+				super(authToken,portalId)
+			end
+
+			# * Get the genearal url for getting all Projects.
+			#
+			# ==== Returns
+			#
+			# String Object
+
+			def getProjectsUrl
+				return getBaseURL+'projects/'
+			end
+
+			# * Get specific Project url by specifying the projectId.
+			#
+			# ==== Returns
+			#
+			# String Object
+
+			def getProjectUrl(projectId)
+				return getBaseURL+'projects/'+String(projectId)+'/'
+			end
+
+			# * Get list of projects.
+			#  
+			# ==== Parameters
+			#
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			#  
+			# ==== Returns
+			#
+			# * List of Project object.
+
+
+			def getProjects(queryMap=nil)
+				if queryMap == nil
+					return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap)) 
+				else
+					return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap(queryMap)))
+				end
+			end
+
+			# * Create a new project.
+			# 
+			# ==== Parameters
+			#
+			# * project:: - Project object.
+			#  
+			# ==== Returns
+			#
+			# * Project object.
+
+			def createProject(project)
+				createProject = ZohoHTTPClient.post(getProjectsUrl,getQueryMap, project.toParamMAP)
+				return $projectParser.getProject(createProject)
+			end
+
+			# * Get the details of a project.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# ==== Returns
+			#
+			# * Project object.
+
+			def get(projectId)
+				response = ZohoHTTPClient.get(getProjectUrl(projectId),getQueryMap)
+				return $projectParser.getProject(response)
+			end
+
+			# * Update the details of a project.
+			#  
+			# ==== Parameters
+			#
+			# * project:: - Project object.
+			#  
+			# ==== Returns
+			#
+			# * Project object.
+
+			def updateProject(project)
+				updateProject = ZohoHTTPClient.post(getProjectUrl(project.getId),getQueryMap, project.toParamMAP)
+				return $projectParser.getProject(updateProject)
+			end
+
+			# * Delete an existing project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+ 
+			def deleteProject(projectId)
+				response = ZohoHTTPClient.delete(getProjectUrl(projectId),getQueryMap)
+				return $projectParser.getResult(response)
+			end
+
+			# * Get list of project activities.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			#  
+			# ==== Returns
+			#
+			# * List of Activity object.
+
+			def getProjectActivities(projectId, queryMap=nil)
+				url = getProjectUrl(projectId)+"activities/"
+				if queryMap == nil
+					return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap))
+				else
+					return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap(queryMap)))
+				end
+			end
+
+			# * Get list of project statuses.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			#  
+			# ==== Returns
+			#
+			# * List of Status object.
+
+			def getProjectStatuses(projectId,queryMap=nil)
+				url = getProjectUrl(projectId)+"statuses/"
+				if queryMap == nil
+					return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap))
+				else
+					return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap(queryMap)))
+				end
+			end
+
+			# * Add the status for the project.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * status:: - Status object.
+			#  
+			# ==== Returns
+			#
+			# * Status object.
+
+			def addProjectStatus(projectId,status)
+				url = getProjectUrl(projectId)+"statuses/"
+				return $projectParser.getStatus(ZohoHTTPClient.post(url, getQueryMap, status.toParamMAP));
+			end
+
+		end
+	end
+end

data/lib/projects/api/TasklistsAPI.rb

@@ -0,0 +1,113 @@
+#  $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/TasklistParser'
+
+		# * TasklistsAPI is used to:
+		#  
+		# * 	Get list of tasklists.
+		#	  
+		# * 	Create a new tasklist.
+		#	  
+		# * 	Update the details of a tasklist.
+		#	  
+		# * 	Delete an existing tasklist.
+
+
+		class TasklistsAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# TasklistParser is used to parse the JSON response into respective objects.
+
+			$tasklistParser = TasklistParser.new
+
+			# * Construct a new TasklistsAPI 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 tasklists 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 Tasklist object.
+
+			def getTasklists(projectId,queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasklists/"
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))
+				return $tasklistParser.getTasklists(response)
+			end
+
+			# * Create a new tasklist for the project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * tasklist:: - tasklist object.
+			#  
+			# ==== Returns
+			#
+			# * Tasklist object.
+			
+			def create(projectId,tasklist)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasklists/"
+				response = ZohoHTTPClient.post(url, getQueryMap, tasklist.toParamMAP)
+				return $tasklistParser.getTasklist(response)
+			end
+
+			# * Update the details of a tasklist.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * tasklist:: - Tasklist object.
+			#  
+			# ==== Returns
+			#
+			# * Tasklist object.
+			
+			def update(projectId,tasklist)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasklists/"+String(tasklist.getId)+"/"
+				response = ZohoHTTPClient.post(url, getQueryMap, tasklist.toParamMAP)
+				return $tasklistParser.getTasklist(response)
+			end
+			
+			# * Delete an existing tasklist for the project.
+			#  
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#  
+			# * tasklistId:: - ID of the tasklist.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+
+			def delete(projectId, tasklistId)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasklists/"+String(tasklistId)+"/"
+				response = ZohoHTTPClient.delete(url, getQueryMap)
+				return $tasklistParser.getResult(response)
+			end
+		end
+	end
+end

data/lib/projects/api/TasksAPI.rb

@@ -0,0 +1,153 @@
+#  $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/TaskParser'
+
+		# * TasksAPI is used to:
+		#	  
+		# * 	Get list of tasks.
+		#	 
+		# * 	Get list of task for the tasklist.
+		#	  
+		# * 	Get the details of a task.
+		#	  
+		# * 	Create a new task.
+		#	  
+		# * 	Update the details of a task.
+		#	  
+		# * 	Delete an existing task.
+
+		class TasksAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# TaskParser is used to parse the JSON response into respective objects.
+
+			$taskParser = Projects::Parser::TaskParser.new
+
+			# * Construct a new TasksAPI 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 tasks 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 Task object.
+
+			def getTasks(projectId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))
+				return $taskParser.getTasks(response)
+			end
+			
+			# * Get list of tasks for the task list.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * tasklistId:: - ID of the tasklist.
+			#  
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			#  
+			# ==== Returns
+			#
+			# * List Task object.
+
+			def getTasklistTasks(projectId, tasklistId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasklists/"+String(tasklistId)+"/tasks/"
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))		
+				return $taskParser.getTasks(response)
+			end
+
+			# * Get the details of a task.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			# 
+			# * taskId:: - ID of the task.
+			#  
+			# ==== Returns
+			#
+			# * Task object.
+			
+			def get(projectId, taskId)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(taskId)+"/"
+				response = ZohoHTTPClient.get(url, getQueryMap)		
+				return $taskParser.getTask(response)
+			end
+
+			# * Create a new task for the project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * task:: - Task object.
+			#  
+			# ==== Returns
+			#
+			# * Task object.
+			
+			def create(projectId, task)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, task.toParamMAP)		
+				return $taskParser.getTask(response)
+			end
+			
+			# * Update the details of a task.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * task:: - Task object.
+			#  
+			# ==== Returns
+			#
+			# * Task object.
+
+			def update(projectId, task)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(task.getId())+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, task.toParamMAP)		
+				return $taskParser.getTask(response)
+			end
+			
+			# * Delete an existing task.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID of the project.
+			#  
+			# * taskId:: - ID of the task.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+
+			def delete(projectId, taskId)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(taskId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)
+				return $taskParser.getResult(response)
+			end
+		end
+	end
+end