zohoProjects 0.0.4

data/lib/projects/api/TimesheetsAPI.rb

@@ -0,0 +1,240 @@
+#  $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/TimesheetParser'
+
+
+		# * TimesheetAPI is used to:
+		#  
+		# * 	Get list of time logs.
+		#	  
+		# * 	Add new task log.
+		#	  
+		# * 	update the details of a task log.
+		#	  
+		# * 	Delete an existing task log.
+		#	  
+		# * 	Add new bug log.
+		#	  
+		# * 	Update the details of a bug log.
+		#	  
+		# * 	Delete an existing bug log.
+		#	  
+		# * 	Add new general log.
+		#	  
+		# * 	Update the details of a general log.
+		#	  
+		# * 	Delete an existing general log.
+
+		class TimesheetsAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# TimesheetParser is used to parse the JSON response into respective objects.
+
+			$timesheetParser = TimesheetParser.new	
+
+			# * Construct a new TimesheetsAPI 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 time logs for the project.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID 0f the project.
+			#  
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			#  
+			# ==== Returns
+			#
+			# * TimelogList object.
+
+			def getTimeLogs(projectId, queryMap)		
+				url = getBaseURL+"projects/"+String(projectId)+"/logs/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))
+				return $timesheetParser.getTimeLogs(response)
+			end
+
+			# * Add a new task log for the project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * tasklog:: - Tasklog object.
+			#  
+			# ==== Returns
+			#
+			# * Tasklog object.
+			
+			def addTasklog(projectId, tasklog)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(tasklog.getTaskId)+"/logs/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, tasklog.toParamMAP)		
+				return $timesheetParser.getTasklog(response)
+			end
+			
+			# * Update the details of a task log.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId ID of the project.
+			#  
+			# * tasklog:: - Tasklog object.
+			#  
+			# ==== Returns
+			#
+			# * Tasklog object.
+
+			def updateTasklog(projectId, tasklog)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(tasklog.getTaskId)+"/logs/"+String(tasklog.getId)+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, tasklog.toParamMAP)		
+				return $timesheetParser.getTasklog(response)
+			end
+
+			# * Delete an existing task log for the project.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID of the project.
+			#  
+			# * taskId:: - ID of the task.
+			#  
+			# * logId:: - ID of the log.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+			
+			def deleteTasklog(projectId, taskId, logId)
+				url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(taskId)+"/logs/"+String(logId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $timesheetParser.getResult(response)
+			end
+
+			# * Add a new bug log for the project.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID of the project.
+			#  
+			# * buglog:: - Buglog object.
+			#  
+			# ==== Returns
+			#
+		 	# * Buglog object.
+			
+			def addBuglog(projectId, buglog)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(buglog.getBugId)+"/logs/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, buglog.toParamMAP)		
+				return $timesheetParser.getBuglog(response)
+			end
+
+			# * Update the details of a bug log.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * buglog:: - Buglog object.
+			#  
+			# ==== Returns
+			#
+			# * Buglog object.
+			
+			def updateBuglog(projectId, buglog)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(buglog.getBugId)+"/logs/"+String(buglog.getId)+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, buglog.toParamMAP)		
+				return $timesheetParser.getBuglog(response)
+			end
+
+			# * Delete an existing bug log for the project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * bugId:: - ID of the bug.
+			#  
+			# * logId:: - ID of the log.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+			
+			def deleteBuglog(projectId, bugId, logId)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(bugId)+"/logs/"+String(logId)+"/"				
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $timesheetParser.getResult(response)
+			end
+
+			# * Add a new general log for the project.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID of the project.
+			#  
+			# * generallog:: - Generallog object.
+			#  
+			# ==== Returns
+			# 
+			# * Generallog object.
+			
+			def addGenerallog(projectId, generallog)
+				url = getBaseURL+"projects/"+String(projectId)+"/logs/"	
+				requestBody = generallog.toParamMAP		
+				requestBody["name"] = generallog.getName		
+				response = ZohoHTTPClient.post(url, getQueryMap, requestBody)		
+				return $timesheetParser.getGenerallog(response)
+			end
+
+			# * Update the details of a general log.
+			# 
+			# ==== Parameters
+			#  
+			# * projectId:: - ID of the project.
+			#  
+			# * generallog:: - Generallog object.
+			#  
+			# ==== Returns
+			#
+			# * Generallog object.
+			
+			def updateGenerallog(projectId, generallog)
+				url = getBaseURL+"projects/"+String(projectId)+"/logs/"+String(generallog.getId)+"/"		
+				requestBody = generallog.toParamMAP		
+				requestBody["name"] = generallog.getName
+				response = ZohoHTTPClient.post(url, getQueryMap, requestBody)		
+				return $timesheetParser.getGenerallog(response)
+			end
+			
+			# * Delete an existing general log for the project.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			#  
+			# * logId:: - ID of the log.
+			#  
+			# ==== Returns
+			#
+			# * String object.
+
+			def deleteGenerallog(projectId, logId)
+				url = getBaseURL+"projects/"+String(projectId)+"/logs/"+String(logId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $timesheetParser.getResult(response)
+			end
+		end
+	end
+end

data/lib/projects/api/UsersAPI.rb

@@ -0,0 +1,48 @@
+#  $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/UserParser'
+
+
+		# * UsersAPI is used to get list of users for the project.
+
+		class UsersAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# UserParser is used to parse the JSON response into respective objects.
+
+			$userParser =UserParser.new
+
+			# * Construct a new UsersAPI 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 users for the project.
+			# 
+			# ==== Parameters
+			#   
+			# * projectId:: - ID of the project.
+			#  
+			# ==== Returns
+			# 
+			# * List of User object.
+
+			def getUsers(projectId)
+				url = getBaseURL+"projects/"+String(projectId)+"/users/"		
+				response = ZohoHTTPClient.get(url, getQueryMap)		
+				return $userParser.getUsers(response)
+			end
+		end
+	end
+end

data/lib/projects/exception/ProjectsException.rb

@@ -0,0 +1,50 @@
+#  $Id$ 
+module Projects
+	module Pexception
+
+		 # * ProjectsException is used to throw a new projects exception with code and message.
+
+		class ProjectsException < Exception
+			
+			private
+				attr_accessor :code, :message
+
+			public
+
+				# * Construct a new ProjectsException by passing an error code and error message.
+				#
+				# ==== Parameters
+				# 
+				# * code:: - Error code.
+				#
+				# * message:: - Error message.
+
+				def initialize(code, message)
+					super(message)
+					@code = code		
+					@message = message
+				end
+
+				# * get the error code.
+				#
+				# ==== Returns
+				#	
+				# * Error code.
+
+				def getCode
+					return @code
+				end
+				
+				# * get the error message.
+				#
+				# ==== Returns
+				#
+				# * Error message.
+
+				def getMessage
+					return @message
+				end
+			
+		end
+	end
+end

data/lib/projects/model/Activity.rb

@@ -0,0 +1,173 @@
+#  $Id$ 
+module Projects
+	module Model
+		# * This class is used to make an object for Activity.
+
+		class Activity
+			private
+				attr_accessor :id, :name, :state, :activityBy, :timeLong, :displayTime, :time, :activityFor
+			
+			public
+			
+				# * Set the id of the activity.
+				# 
+				# ==== Parameters
+				#  
+				# * id:: - ID of the activity.
+
+				def setId(id)
+					@id = id
+				end
+
+				# * Get the activity id.
+				#
+				# ==== Returns
+				#
+				# * Activity id.
+			
+				def getId
+					return @id
+				end
+			
+				# * Set the name of the activity.
+				# 
+				# ==== Parameters
+				#
+				# * name:: - Name of the activity.
+
+				def setName(name)
+					@name = name
+				end
+
+				# * Get the activity name.
+				#
+				# ==== Returns
+				#
+				# * Activity name.
+			
+				def getName
+					return @name
+				end
+			
+				# * Set the state of the activity.
+				# 
+				# ==== Parameters
+				# 
+				# * state:: - State of the activity.
+			
+				def setState(state)
+					@state = state
+				end
+
+				# * Get the activity state.
+				#
+				# ==== Returns
+				#  
+				# * Activity state.
+			
+				def getState
+					return @state
+				end
+
+				# * Set who posted the activity.
+				# 
+				# ==== Parameters
+				#  
+				# * activityBy:: - User who posted the activity. 
+
+				def setActivityBy(activityBy)
+					@activityBy = activityBy
+				end
+
+				# * Get who posted the activity.
+				#
+				# ==== Returns
+				#  
+				# * User who posted the activity.
+			
+				def getActivityBy
+					return @activityBy
+				end
+			
+				# * Set the time long.
+				# 
+				# ==== Parameters
+				#  
+				# * timeLong:: - Time for the activity.
+
+				def setTimeLong(timeLong)
+					@timeLong = timeLong
+				end
+
+				# * Get the time long.
+				#
+				# ==== Returns
+				# 
+				# * Time for the activity.
+			
+				def getTimeLong
+					return timeLong
+				end
+			
+				# * Set the display time for the activity.
+				# 
+				# ==== Parameters
+				#  
+				# * displayTime:: - Display time for the activity.
+				
+				def setDisplayTime(displayTime)
+					@displayTime = displayTime
+				end
+
+				# * Get the display time for the activity.
+				#
+				# ==== Returns
+				#  
+				# * Display time for the activity.
+			
+				def getDisplayTime
+					return @displayTime
+				end
+			
+				# * Set the time for the activity done.
+				# 
+				# ==== Parameters
+				#  
+				# * time:: - Time for the activity done.
+				
+				def setTime(time)
+					@time = time
+				end
+			
+				# * Get the time for the activity done.
+				#
+				# ==== Returns
+				# 
+				# * Time for the activity done.
+				
+				def getTime
+					return @time
+				end
+			
+				# * Set the activity for which topic.
+				# 
+				# ==== Parameters
+				#  
+				# * activityFor:: - Topic fo the Activity.
+				
+				def setActivityFor(activityFor)
+					@activityFor = activityFor
+				end
+			
+				# * Get the activity for which topic.
+				#
+				# ==== Returns
+				#
+				# * Th topic of the activity.
+				
+				def getActivityFor
+					return @activityFor
+				end
+		end
+	end
+end