zohoProjects 0.0.4

data/lib/projects/parser/UserParser.rb

@@ -0,0 +1,63 @@
+#  $Id$ 
+module Projects
+	module Parser
+
+		require 'json'
+		require File.dirname(__FILE__).chomp("/projects/parser") + '/projects/model/User'
+
+		# * Parse the JSON response into respective objects.
+
+		class UserParser 
+			include Projects::Model
+			
+			# * Parse the JSON response and make it into List of User object.
+			#
+			# ==== Parameters
+			#  
+			# * response:: - This JSON response contains the details of users.
+			#
+			# ==== Returns
+			#  
+			# * List of User object.
+
+			def getUsers(response)
+				users_all_json = JSON.parse response
+				users_all_array = users_all_json["users"]
+				users_class_array = Array.new
+				for i in 0...users_all_array.length
+					users_class_array.push(jsonToUser(users_all_array[i]))
+				end
+				return users_class_array
+			end
+
+			# * Parse the JSONObject into User object.
+			#
+			# ==== Parameters
+			#   
+			# * response:: - JSONObject contains the details of a user.
+			#
+			# ==== Returns
+			#  
+			# * User object.
+
+			def jsonToUser(jsonObject)
+				user = User.new
+
+				if jsonObject.has_key?("id")
+					user.setId(jsonObject["id"])
+				end
+				if jsonObject.has_key?("name")
+					user.setName(jsonObject["name"])
+				end
+				if jsonObject.has_key?("email")
+					user.setEmail(jsonObject["email"])
+				end
+				if jsonObject.has_key?("role")
+					user.setRole(jsonObject["role"])
+				end
+				
+				return user
+			end
+		end
+	end
+end

data/lib/projects/service/ZohoProject.rb

@@ -0,0 +1,174 @@
+#  $Id$ 
+module Projects
+	module Service
+
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/PortalAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/ProjectsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/MilestonesAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/TasklistsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/TasksAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/TimesheetsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/FoldersAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/DocumentsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/EventsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/BugsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/ForumsAPI'
+		require File.dirname(__FILE__).chomp("/projects/service") + '/projects/api/UsersAPI'
+
+		# * ZohoProjects is used to provide all API instances for the Zoho Project services.
+
+		class ZohoProject
+			include Projects::Api
+
+			private
+				attr_accessor :authToken, :portalId
+
+			public
+			
+				# * Initialize ZhoProjects using user's authToken and portalId.
+				#
+				# ==== Parameters
+				# 
+				# * authToken:: - User's authToken.
+			 	#
+				# * portalId:: - User's portalId.
+
+				def initialize(authToken,portalId)
+					@authToken = authToken
+					@portalId = portalId
+				end
+				
+				# * Get an instance of portals API.
+				#
+				# ==== Returns
+				#  
+				# * PortalsAPI object.
+
+				def getPortalsAPI
+					portalsAPI = PortalAPI.new(authToken)		
+					return portalsAPI
+				end
+			
+				# * Get an instance of projects API.
+				#
+				# ==== Returns
+				# 
+				# * ProjectsAPI object.
+
+				def getProjectsAPI
+					projectsAPI = ProjectsAPI.new(authToken, portalId)		
+					return projectsAPI
+				end
+			
+				# * Get an instance of milestones API.
+				#
+				# ==== Returns
+				#
+				# * MilestonesAPI object.
+
+				def getMilestonesAPI
+					milestonesAPI = MilestonesAPI.new(authToken, portalId)	
+					return milestonesAPI
+				end
+			
+				# * Get an instance of task lists API.
+				#
+				# ==== Returns
+				#  
+				# * TasklistsAPI object.
+
+				def getTasklistsAPI
+					tasklistsAPI = TasklistsAPI.new(authToken, portalId)		
+					return tasklistsAPI
+				end
+			
+				# * Get an instance of tasks API.
+				#
+				# ==== Returns
+				#  
+				# * TasksAPI object.
+
+				def getTasksAPI
+					tasksAPI = TasksAPI.new(authToken, portalId)	
+					return tasksAPI
+				end
+			
+				# * Get an instance of events API.
+				#
+				# ==== Returns
+				#  
+				# * EventsAPI object.
+
+				def getEventsAPI
+					eventsAPI = EventsAPI.new(authToken, portalId)		
+					return eventsAPI
+				end
+			
+				# * Get an instance of folder API.
+				#
+				# ==== Returns
+				#  
+				# * FoldersAPI object.
+
+				def getFoldersAPI
+					foldersAPI = FoldersAPI.new(authToken, portalId)	
+					return foldersAPI
+				end
+				
+				# * Get an instance of documents API.
+				#
+				# ==== Returns
+				#  
+				# * DocumentsAPI object.
+
+				def getDocumentsAPI
+					documentsAPI = DocumentsAPI.new(authToken, portalId)		
+					return documentsAPI
+				end
+			
+				# * Get an instance of forums API.
+				#
+				# ==== Returns
+				#  
+				# * ForumsAPI object.
+
+				def getForumsAPI
+					forumsAPI = ForumsAPI.new(authToken, portalId)		
+					return forumsAPI
+				end
+			
+				# * Get an instance of users API.
+				#
+				# ==== Returns
+				#  
+				# * UsersAPI object.
+
+				def getUsersAPI
+					usersAPI = UsersAPI.new(authToken, portalId)		
+					return usersAPI
+				end
+			
+				# * Get an instance of bugs API.
+				#
+				# ==== Returns
+				#  
+				# * BugsAPI object.
+
+				def getBugsAPI
+					bugsAPI = BugsAPI.new(authToken, portalId)		
+					return bugsAPI
+				end
+			
+				# * Get an instance of time sheets API.
+				#
+				# ==== Returns
+				#  
+				# * TimesheetsAPI object.
+
+				def getTimesheetsAPI
+					timesheetsAPI = TimesheetsAPI.new(authToken, portalId)		
+					return timesheetsAPI
+				end
+		end
+	end
+end

data/lib/projects/util/ZohoHTTPClient.rb

@@ -0,0 +1,205 @@
+#  $Id$ 
+module Projects
+	module Util
+
+		require "net/http"
+		require "uri"
+		require File.dirname(__FILE__).chomp("/projects/util") + '/projects/exception/ProjectsException'
+
+		# * ZohoHTTPClient is used to make a HTTP request execution for GET, POST, PUT and DELETE requests.
+
+		class ZohoHTTPClient
+			include Projects::Pexception
+
+			# * Returns the url string for making the request.
+			#
+			# ==== Parameters
+			# 
+			# * url:: - Service URL passed by the user.
+			#
+			# * queryMap:: - This queryMap contains the query string parameters in the form of key, value pair.
+			#
+			# ==== Returns
+			#
+			# * Url in String.
+
+			def self.getUrl(url,queryMap)
+				url = url + '?'
+				i = 0
+				queryMap.each do |key, value|
+					if i == 0
+						url = url+key+'='+String(value)
+						i=i+1
+					else
+						url = url+'&'+key+'='+String(value)
+					end
+				end
+				return url
+			end
+
+			# * Returns the http and uri objects for making request and response
+			#
+			# ==== Parameters
+			#
+			# * http:: - Object of NET::HTTP
+			#
+			# * uri:: - Object of URI which parses the url of the request
+
+			def self.getHttpUri(url)
+				uri = URI.parse(url)
+				http = Net::HTTP.new(uri.host, uri.port)
+				http.use_ssl = true
+				http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+				http.open_timeout = 60
+				http.read_timeout = 80
+				return [http, uri]
+			end
+
+			# * Raises ProjectsException when this method is called
+			#
+			# ==== Parameters
+			#
+			# * message:: - Response message of the request
+
+			def self.throwsException(message)
+				error_json = JSON.parse message
+				error_array = error_json["error"]
+				raise ProjectsException.new(error_array["code"],error_array["message"])
+			end
+
+			#
+			# ==== Returns
+			#
+			# * header for the http request
+
+			def self.getHeader
+				header = Hash.new
+				header["Accept"] = "application/json"
+				header["Content-Type"] = "application/x-www-form-urlencoded"
+				header["Accept-Charset"] = "UTF-8"
+				header["User-Agent"] = "ZohoProjects-Ruby-Wrappers/0.0.4"
+				return header
+			end
+
+			# * Evaluates the response
+			#
+			# ==== Parameters
+			#
+			# * response:: - The response of the HTTP request
+			#
+			# * Returns response body is success or terminates the program
+
+			def self.getResult(response)
+				if response.code.to_i == 200 || response.code.to_i == 201
+					return response.body
+				elsif response.code.to_i == 204
+					abort("No Result for the specified request")
+				else
+					throwsException(response.body)
+				end
+			end
+
+			# * Make a GET request and fetch the response for the given URL and a query string.
+			#
+			# * Calls getResult to return the JSON response String.
+			#
+			# ==== Parameters
+			#
+			# * url:: - Service URL passed by the user.
+			#
+			# * queryMap:: - This queryMap contains the query string parameters in the form of key, value pair.
+			
+
+			def self.get(url,queryMap)
+				url = getUrl(url, queryMap)
+				http,uri= getHttpUri(url)
+				request = Net::HTTP::Get.new(uri.request_uri, initheader = getHeader)
+				response = http.request(request)
+				getResult(response)
+			end
+
+			# * Make a POST request and create a resource for the given URL and a MultiPart form data.
+			#
+			# * Calls getResult to return the JSON response String.
+			#
+			# ==== Parameters
+			#
+			# * url:: - Service URL passed by the user.
+			#
+			# * queryMap:: - This queryMap contains the query string parameters in the form of key, value pair.
+			#
+			# * requestBody:: - This requestBody contains the form data for the POST request.
+			#
+			# * fileBody:: - This fileBody contains the attachment files for the POST request.
+
+			def self.post(url, queryMap, paramMap, fileBody=nil)
+				if fileBody == nil
+					url = getUrl(url, queryMap)
+					http,uri= getHttpUri(url)
+					request = Net::HTTP::Post.new(uri.request_uri, initheader = getHeader)
+					request.set_form_data(paramMap)
+					response = http.request(request)
+					getResult(response)
+				else
+					begin
+						url = getUrl(url, queryMap)
+						@BOUNDARY = "AaB03x"
+						header = Hash.new
+						header["Accept"] = "application/json"
+						header["Content-Type"] = "multipart/form-data; boundary="+ @BOUNDARY
+						header["Accept-Charset"] = "UTF-8"
+						header["User-Agent"] = "ZohoBooks-Java-Wrappers/1.0"
+						http,uri= getHttpUri(url)
+						request = Net::HTTP::Post.new(uri.request_uri, initheader = header)
+						post_body = []
+						paramMap.each do |key, val|
+							post_body << "--#{@BOUNDARY}\r\n"
+							post_body << "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n#{val}\r\n"	
+						end
+						fileBody.each do |key, val|
+							for i in 0...val.length
+								post_body << "--#{@BOUNDARY}\r\n"
+								post_body << "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{File.basename(val[i].path)}\"\r\n"
+								post_body << "Content-Type: application/octet-stream\r\n"
+								post_body << "\r\n"
+								post_body << File.read(val[i].path)
+								post_body << "\r\n"
+							end
+						end
+						post_body << "--#{@BOUNDARY}--\r\n"
+						request.body = post_body.join
+						response = http.request(request)
+						getResult(response)
+					ensure 
+						fileBody.each do |key, val|
+							for i in 0...val.length
+								if !val[i].closed?
+									val[i].close
+								end
+							end
+						end
+					end
+				end
+			end
+
+			# * Make a DELETE request for the given URL and a query string.
+			#
+			# * Calls getResult to return the JSON response String.
+			#
+			# ==== Parameters
+			#
+			# * url:: - Service URL passed by the user.
+			#
+			# * queryMap:: - This queryMap contains the query string parameters in the form of key, value pair.
+
+
+			def self.delete(url,queryMap)
+				url = getUrl(url, queryMap)
+				http,uri= getHttpUri(url)
+				request = Net::HTTP::Delete.new(uri.request_uri, initheader = getHeader)
+				response = http.request(request)
+				getResult(response)
+			end
+		end
+	end
+end

data/lib/test/ProjectsTest.rb

@@ -0,0 +1,321 @@
+#  $Id$ 
+require "zohoProjects"
+
+begin
+
+	portalsAPI = PortalAPI.new("{auth_token}")
+	portals = portalsAPI.getPortals
+
+	portal_id = portals[0].getId
+
+
+	zohoProjects = ZohoProjects.new("{auth_token}",portal_id)
+
+	projectAPI = zohoProjects.getProjectsAPI
+
+	milestoneAPI = zohoProjects.getMilestonesAPI
+
+	tasklistAPI = zohoProjects.getTasklistsAPI
+
+	tasksAPI = zohoProjects.getTasklistsAPI
+
+	eventsAPI = zohoProjects.getEventsAPI
+
+	foldersAPI = zohoProjects.getFoldersAPI
+
+	documentsAPI = zohoProjects.getDocumentsAPI
+
+	forumsAPI = zohoProjects.getForumsAPI
+
+	usersAPI = zohoProjects.getUsersAPI
+
+	bugsAPI = zohoProjects.getBugsAPI
+			
+	forumsAPI = zohoProjects.getForumsAPI
+			
+	timesheetsAPI = zohoProjects.getTimesheetsAPI
+
+	projectAPI = ProjectsAPI.new("{auth_token}",portal_id)
+
+	projectAll = projectAPI1.getProjects
+
+	queryMap = Hash.new
+	queryMap["status"] = "active"
+
+	project = projectAPI.getProjects(queryMap)
+
+	project_id = projectAll[0].getId
+
+	project_ownerId = projectAll[0].getOwnerId
+
+	project = Project.new
+	project.setName("Test Project")
+	project.setDescription("This is a Test Project")
+	
+	create = projectAPI.createProject(project)
+	
+	get = projectAPI.get(projectAll[0].getId)
+	
+	get.setName("Test Project");
+	get.setDescription("This is a Test Project")
+	get.setStatus("active")
+	update = projectAPI.updateProject(get)
+	
+	activity = projectAPI.getProjectActivities(project_id)
+	
+	status = projectAPI.getProjectStatuses(project_id)
+	
+	status1 = Status.new
+	status1.setContent("New Status Added")
+	status2 = projectAPI.addProjectStatus(project_id, status1)
+
+	milestonesAPI = MilestonesAPI.new("{auth_token}",portal_id)
+
+	milestone = milestonesAPI.getMilestones(project_id)
+
+	milestone_id = milestone.getId
+	
+	milestone1 = milestonesAPI.get(project_id,milestone_id)
+	
+	result = milestonesAPI.delete(project_id,milestone_id)
+
+	milestone = Milestone.new
+	milestone.setName("My first Updated Milestone")
+	milestone.setStartDate("07-01-2014")
+	milestone.setEndDate("07-20-2014")
+	milestone.setOwnerId(project_ownerId.to_i)
+	milestone.setFlag("internal")
+
+	milestone1 = milestonesAPI.create(project_id, milestone)
+	
+	milestone =  milestonesAPI.update(project_id, milestone1)
+
+	puts milestonesAPI.updateStatus(project_id, milestone_id, 1)
+
+	tasklistsAPI = TasklistsAPI.new("{auth_token}",portal_id)
+
+	queryMap = Hash.new
+	queryMap["flag"] = "internal"
+
+	tasklists = tasklistsAPI.getTasklists(project_id, queryMap)
+
+	result = tasklistsAPI.delete(project_id, tasklists[0].getId)
+
+	tasklist = Tasklist.new()
+	tasklist.setName("Model")
+	tasklist.setFlag("internal")
+	
+	milestone1 = Milestone.new()
+	milestone1.setId(milestone_id)
+	tasklist.setMilestone(milestone1)
+	
+	createTasklist = tasklistsAPI.create(project_id, tasklist)
+
+	tasklists[0].setName("Model 1")
+	tasklists[0].setFlag("internal")
+	tasklists[0].setStatus("completed")
+
+	tasklist = tasklistsAPI.update(project_id, tasklists[0])
+
+	queryMap = Hash.new
+	queryMap["range"] = 1
+	
+	tasksAPI = TasksAPI.new("{auth_token}",portal_id)
+	
+	tasks = tasksAPI.getTasks(project_id, queryMap)
+	
+	tasklistId = tasks[0].getTasklist.getId
+	
+	tasklistTasks = tasksAPI.getTasklistTasks(project_id, tasklistId, nil)
+	
+	taskId = tasklistTasks[0].getId
+	getTask = tasksAPI.get(project_id, taskId)
+	
+	task = tasks[0]
+	puts task.getName
+
+	owner1 = task.getOwners
+
+	owners = Array.new
+	owner = Owner.new
+	owner.setId(owner1.getId)
+	owners.push(owner)
+	
+	task.setOwners(owners)
+	task.setName("complete TasksAPI 1")
+	task.setStartDate("06-23-2014")
+	task.setEndDate("06-30-2014")
+	
+	createTask = tasksAPI.create(project_id, task)
+	
+	updateTask = tasksAPI.update(project_id, task)
+	
+	deleteTask = tasksAPI.delete(project_id, String(task.getId))
+
+	queryMap = Hash.new
+	queryMap["user_list"] = "all"
+	queryMap["view_type"] = "month"
+	queryMap["date"] = "06-23-2014"
+	queryMap["bill_status"] = "Billable"
+	queryMap["component_type"] = "task"
+
+	timesheetsAPI = TimesheetsAPI.new("{auth_token}",portal_id)
+	
+	timeLogs = timesheetsAPI.getTimeLogs(project_id, queryMap)
+	
+	tasklog = timeLogs[0].getTasklogs
+	
+	tasklog[0].setDate("07-02-2014")
+					
+	addTasklog = timesheetsAPI.addTasklog(project_id, tasklog[0])
+						
+	updateTasklog = timesheetsAPI.updateTasklog(project_id, tasklog[0])
+					
+	deleteTasklog = timesheetsAPI.deleteTasklog(project_id, String(tasklog[0].getTaskId), String(tasklog[0].getId))
+						
+	buglog = timeLogs[0].getBuglogs[0]
+				
+	buglog.setDate("06-28-2014")
+	buglog.setBillStatus("Billable")
+	buglog.setHours("02:02")
+					
+	addBuglog = timesheetsAPI.addBuglog(project_id, buglog)
+					
+	updateBuglog = timesheetsAPI.updateBuglog(project_id, buglog)
+				
+	deleteBuglog = timesheetsAPI.deleteBuglog(project_id, String(buglog.getBugId), String(buglog.getId))
+					
+	generallog = timeLogs[0].getGenerallogs[0]	
+	generallog.setDate("06-25-2014")
+	generallog.setBillStatus("Billable")
+	generallog.setName("Complete API files New")
+	generallog.setHours(1)
+	generallog.setNotes("ss")
+					
+	addGenerallog = timesheetsAPI.addGenerallog(project_id, generallog)
+	
+	updateGenerallog = timesheetsAPI.updateGenerallog(project_id, generallog)
+						
+	deleteGenerallog = timesheetsAPI.deleteGenerallog(project_id, String(generallog.getId))
+	
+	bugsAPI = BugsAPI.new("{auth_token}",portal_id)
+
+	bugs = bugsAPI.getBugs(project_id, nil)
+	bugId = String(bugs[0].getId)
+	getBug = bugsAPI.get(project_id, bugId)
+
+	getBug.setTitle("Every thing is ok")
+	getBug.setDescription("This is a bug")
+	getBug.setDueDate("06-26-2014")
+					
+	createBug = bugsAPI.create(project_id, getBug)
+					
+	updateBug = bugsAPI.update(project_id, getBug)
+					
+	deleteBug = bugsAPI.delete(project_id, bugId)
+
+	queryMap = Hash.new
+	queryMap["status"] = "open"
+	
+	eventsAPI = EventsAPI.new("{auth_token}",portal_id)
+	events = eventsAPI.getEvents(project_id, queryMap)
+	puts events[0].getParticipants
+					
+	event = events[0]
+					
+	event.setTitle("Wrapper publish")
+	event.setHour("2")
+	event.setMinutes("30")
+	event.setAMPM("pm")
+	event.setScheduledOn("06-24-2014")
+				
+	add = eventsAPI.add(project_id, event)
+			
+	updateEvent = eventsAPI.update(project_id, event)
+	
+	deleteEvent = eventsAPI.delete(project_id, String(event.getId))
+	
+	foldersAPI = FoldersAPI.new("{auth_token}",portal_id)
+	folders = foldersAPI.getFolders(project_id)				
+	folderId = folders[0].getId				
+	folder = folders[0]
+	folder.setName("Sample Updated")
+				
+	addFolder = foldersAPI.addFolder(project_id, folder);
+	
+	updateFolder = foldersAPI.updateFolder(project_id, folder)
+
+	deleteFolder = foldersAPI.deleteFolder(project_id, String(updateFolder.getId))
+	
+	documentsAPI = DocumentsAPI.new("{auth_token}",portal_id)
+
+	documents = documentsAPI.getDocuments(project_id, nil)
+	
+	documentId = String(documents[0].getId)
+				
+	getDocument = documentsAPI.get(project_id, documentId, nil)
+	
+	folderId = documents[0].getFolder.getId
+						
+	uploaddoc = Array.new
+	file = File.new("File url")
+	uploaddoc.push(file)
+	uploaddoc.push(file)				
+
+	getDocument.setFolderId(folderId)
+	getDocument.setDescription("File Updated !!!")
+	getDocument.setUploaddoc(uploaddoc)
+
+	addDocument = documentsAPI.add(project_id, getDocument)
+						
+	updateDocument = documentsAPI.update(project_id, getDocument)
+						
+	deleteDocument = documentsAPI.delete(project_id, documentId)
+
+	forumsAPI = ForumsAPI.new("{auth_token}",portal_id)
+
+	categories = forumsAPI.getCategories(project_id)
+	categoryId = categories[0].getId
+
+	forums = forumsAPI.getForums(project_id, nil)
+		
+	forumId = forums[0].getId
+
+	forum = Forum.new				
+	uploadFile = Array.new
+					
+	file1 = File.new("File url")
+	uploadFile.push(file1);
+	uploadFile.push(file1);
+					
+	forum.setName("API Discussion New")
+	forum.setContent("Discuss about projects API wrappers")
+	forum.setUploadfile(uploadFile)
+	forum.setCategoryId(categoryId)
+					
+	addForum = forumsAPI.add(project_id, forum)
+				
+	updateForum = forumsAPI.update(project_id, forum)
+					
+	deleteForum = forumsAPI.delete(project_id, String(addForum.getId))
+				
+	category.setName("API")
+					
+	addCategory = forumsAPI.addCategory(projectId, category)
+					
+	comments = forumsAPI.getComments(project_id, forumId,nil);
+					
+	comment = comments[0]
+
+	comment=Comment.new				
+	comment.setContent("URL changes not added in the document.")
+					
+	addComment = forumsAPI.addComment(project_id, forumId, comment)
+
+	usersAPI = UsersAPI.new("{auth_token}",portal_id)
+	users = usersAPI.getUsers(project_id)
+
+rescue ProjectsException => pe
+  puts "Code: " + String(pe.getCode)
+  puts "Message: " + pe.getMessage
+end