zohoProjects 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWU1ZWNhYWY5OGQ3ODU1YTk3N2FhMThjNjk2YzU4Mzg5YjMzYmEyYg==
+  data.tar.gz: !binary |-
+    YmVhOTk3MGY5YjIyMmVjMTdjMzU2NDdkNjAyZWQ4MWY3NmI2NGNiYQ==
+SHA512:
+  metadata.gz: !binary |-
+    MWZkNGRmZWQzMzRlNWY4OWE3NmQxMzkwOWQ0YmRlYzA4ZTJkZWRiYWI2ZmRh
+    ZmVmOTdkOGI1MjA0ZDE3MDg1ZDVjMzQzOWM4MjgyMDllYTlhZTM2MGU5MDA4
+    ZjVkM2EyNDRjYjE2YmFlODE5YzQ0NDc0YmFlMDg2MmE2NWRmNGE=
+  data.tar.gz: !binary |-
+    MzgwMTc3ZjU5YzNmMGRlMDIxYjA5MmZkYzk2NjU1ZDg4ZmM0ODE5NGM5MDMz
+    ZTcwMDZmOTg2MzE2YWFlODQ4MjczZTBhZDE4Nzc3ZGFiODFkN2IxM2NjNDk5
+    ZTJiNTE4MjY0YzAwZGFkOTk0OGE5YzUyMTRhOTU5NmM2YjM0ZWE=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zohoProjects.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    zohoProjects (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.3.2)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  zohoProjects!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+# ZohoProjects
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zohoProjects'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zohoProjects
+
+## Documentation
+
+[API Documentation](http://cms.zohocorp.com/export/zoho/projects/help/rest-api/portals-api.html)
+
+## Usage
+
+If you want to use all our zoho projects services API you should have a valid Zoho username, password and a valid authtoken.
+
+How to generate your authtoken? [Refer Here](http://cms.zohocorp.com/export/zoho/projects/help/rest-api/get-tickets-api.html)
+
+If you have a valid authtoken, you are able to access our Zoho projects API wrappers.
+
+How to access our wrapper classes? Here is a sample example code for accessing Zoho Projects.
+
+You have to add our gem file:
+
+	require "zohoProjects"
+
+Pass your authToken to create an instance for PortalsAPI.
+
+You have two ways to create an instance for PortalsAPI. Here is the example code,
+
+1) Pass your authToken and create a PortalsAPI instance:
+
+			portalsAPI = PortalsAPI.new("{auth_token}")
+			
+2) Pass your authToken and portalId to create an instance for ZohoProjects and then get the instance for PortalsAPI:
+
+			zohoProject = ZohoProject.new("{auth_token}", "{portal_id}")
+			
+			portalsAPI = zohoProject.getPortalsAPI
+			
+	
+			queryMap = Hash.new
+			
+			queryMap["status"] = "open"
+			
+			begin
+			
+## Get the list of portals:
+
+- - -
+			
+If you want to get all your portals, you need to call the 'getPortals' method. It returns the List of Portal object.
+
+				portals = portalsAPI.getPortals
+			
+If you want to parse the portal id from the List of Portal object then you need to write your code as mentioned below:
+
+				portalId = portals[0].getId
+			
+## Get the list of projects:
+
+- - -
+
+If you want to get all the projects from the portal, you need to call the 'getProjects' method by passing query string parameters.
+
+				projects = projectsAPI.getProjects(queryMap)
+			
+If you want to parse the project id from the List of Project object then you need to write your code as mentioned below:
+
+				projectId = String(projects[0].getId)
+			
+## Get the details of a project:
+
+- - -
+
+If you want to get the details of project, you need to call the 'get' method by passing projectId.
+
+				get = projectsAPI.get(projectId)
+			
+## Create a new project:
+
+- - -
+
+If you want to create a new project for the portal, you need to call the 'create' method by passing the Project object.
+
+				project = Project.new
+			
+				project.setName("Test")
+				project.setDescription("Test project")
+
+				create = projectsAPI.create(project)
+			
+## Update the details of a project:
+
+- - - 
+
+If you want to update the project details of a portal, you need to fetch the project details by calling the 'get' method.
+
+If you want update the name of the project then you need to write your code as mentioned below:
+
+				get = projectsAPI.get(projectId)
+			
+				get.setName("API")
+
+				update = projectsAPI.update(get)
+			
+			
+## Delete an existing project:
+
+- - - 
+
+If you want to delete an existing project for the portal, you need to call the `delete()` method by passing projectId.
+
+				delete = projectsAPI.delete(projectId)
+		
+			
+## Catch the exception:
+
+- - -
+
+When calling Zoho Projects API wrappers if there is any error then the respective class throws the ProjectsException. You need to catch the ProjectsException as mentioned below:
+			
+			rescue ProjectsException => pe
+				puts "Code: " + String(pe.getCode)
+  				puts "Message: " + pe.getMessage
+			end
+	
+See [Here](../../tree/master/lib/test) for full examples.
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zohoProjects/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/projects/api/API.rb

@@ -0,0 +1,57 @@
+#  $Id$ 
+module Projects
+	module Api
+		# * API is used to maintain the base URL and makes a query map using User's authToken and filters.
+
+		class API
+
+			public
+			@@baseURL = "https://projectsapi.zoho.com/restapi/";
+			protected
+			  	attr_accessor :authToken, :portalId
+			  	
+			public
+
+				# * Construct a new API using User's authToken and portalId.
+				#
+				# ==== Parameters
+				# 
+				# * authToken:: - User's authToken. 
+				#
+				# * portalId:: - User's portalId.
+
+			  	def initialize(authToken, portalId)
+			    	@authToken = authToken
+			    	@portalId = portalId
+			  	end
+			
+			public
+
+				# * Get the base URL of the service.
+				#
+				# ==== Returns
+				#
+				# * Base URL.
+
+			 	def getBaseURL
+		  			return @@baseURL+"portal/"+String(portalId)+"/";
+		  		end
+
+				# * Creates a query map using User's authToken and filters.
+				# ==== Returns
+				# 
+				# * HashMap.	
+
+		  		def getQueryMap(queryMap=nil)
+		  			if queryMap != nil
+			  			queryMap1 = queryMap
+			  			queryMap1["authtoken"] = authToken
+			  		else
+			  			queryMap1 = Hash.new
+		  				queryMap1["authtoken"] = authToken
+			  		end
+		  		return queryMap1
+		  		end
+		end
+	end
+end

data/lib/projects/api/BugsAPI.rb

@@ -0,0 +1,135 @@
+#  $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/BugParser'
+
+		# * BugsAPI is used to:
+		#
+		# * Get list of bugs.
+		# 
+		# * Get the details of a bug.
+		# 
+		# * Creates a bug.
+		# 
+		# * Update the details of a bug.
+		# 
+		# * Delete an existing bug.
+
+		class BugsAPI < API 
+			include Projects::Parser
+			include Projects::Util
+			# * BugParser is used to parse the JSON response into respective objects.
+
+			$bugParser = BugParser.new
+
+			# * Construct a BugsAPI 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 bugs 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 Bug object.
+
+			
+			def getBugs(projectId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))	
+				return $bugParser.getBugs(response)
+			end
+
+			# * Get the details of a bug.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * bugId:: - ID of the bug.
+			# 
+			# ==== Return
+			#
+			# * Bug object.
+
+			
+			def get(projectId, bugId)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(bugId)+"/"		
+				response = ZohoHTTPClient.get(url, getQueryMap)		
+				return $bugParser.getBug(response)
+			end
+
+			# * Create a Bug for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * bug:: - Bug object.
+			# 
+			# ==== Returns
+			#
+			# * Bug object.
+
+			
+			def create(projectId, bug)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, bug.toParamMAP)		
+				return $bugParser.getBug(response)
+			end
+
+			# * Update the details of a bug.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			# 
+			# * bug:: - Bug object.
+			#
+			# ==== Returns
+			#
+			# * Bug object.
+			
+			def update(projectId, bug)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(bug.getId)+"/"		
+				response = ZohoHTTPClient.post(url, getQueryMap, bug.toParamMAP)		
+				return $bugParser.getBug(response)
+			end
+
+			# * Delete an existing bug for the project.
+			# 
+			# ==== Parameters
+			#
+			# * projectId:: - ID of the project.
+			#
+			# * bugId:: - ID of the bug.
+			# 
+			# ==== Returns
+			#
+			# * String containg result of delete.
+
+			def delete(projectId, bugId)
+				url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(bugId)+"/"		
+				response = ZohoHTTPClient.delete(url, getQueryMap)		
+				return $bugParser.getResult(response)
+			end
+		end
+	end
+end

data/lib/projects/api/DocumentsAPI.rb

@@ -0,0 +1,145 @@
+#  $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/DocumentParser'
+
+		# * DocumentsAPI is used to:
+		# 
+		# * Get list of documents.
+		#	 
+		# * Get the details of a document.
+		#	 
+		# * Add a document.
+		#	 
+		# * Update the details of a document.
+		#	 
+		# * Delete an existing document.
+
+
+		class DocumentsAPI < API
+			include Projects::Parser
+			include Projects::Util
+			# * DocumentParser is used to parse the JSON response into respective objects.
+			
+			$documentParser = DocumentParser.new
+
+			# * Construct a new DocumentsAPI 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 documents 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 Document object.
+
+			
+			def getDocuments(projectId, queryMap)		
+				url = getBaseURL+"projects/"+String(projectId)+"/documents/"		
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))		
+				return $documentParser.getDocuments(response)
+			end
+
+			# * Get the details of a document.
+			# 
+			# ==== Parameters
+			# 
+			# * projectId:: - ID of the project.
+			# 
+			# * documentId:: - ID of the document.
+			# 
+			# * queryMap:: - This queryMap contains the filters in the form of key-value pair.
+			# 
+			# ==== Returns
+			#
+			# * Document object.
+
+			
+			def get(projectId, documentId, queryMap)
+				url = getBaseURL+"projects/"+String(projectId)+"/documents/"+String(documentId)+"/"
+				response = ZohoHTTPClient.get(url, getQueryMap(queryMap))		
+				return $documentParser.getDocument(response)
+			end
+
+			# * Add a document for the project.
+			#
+			# ==== Parameters
+			#  
+			# * projectId:: - Id of the project.
+			# 
+		 	# * document:: - Document object.
+		 	# 
+		 	# ==== Returns
+		 	#
+			# * Document object.
+			
+			def add(projectId, document)
+				url = getBaseURL+"projects/"+String(projectId)+"/documents/"
+				fileBody = Hash.new
+				fileBody["uploaddoc"] = document.getUploaddoc
+				response = ZohoHTTPClient.post(url, getQueryMap, document.toParamMAP, fileBody)		
+				return $documentParser.getDocument(response)
+			end
+
+			# * Update the details of a document.
+			# 
+			# ==== Attributes
+			# 
+			# * projectId:: - ID of the project.
+			# 
+			# * document:: - Document object.
+			# 
+			# ==== Returns
+			#
+			# * Document object.
+
+			
+			def update(projectId, document)
+				url = getBaseURL+"projects/"+String(projectId)+"/documents/"+String(document.getId)+"/"
+				fileBody = Hash.new 
+				fileBody["uploaddoc"] = document.getUploaddoc
+				response = ZohoHTTPClient.post(url, getQueryMap, document.toParamMAP, fileBody)		
+				return $documentParser.getDocument(response)
+			end
+
+
+			# * Delete an existing document for the project.
+			# 
+			# ==== Attributes
+			# 
+		 	# * projectId:: - ID of the project.
+		 	# 
+			# * documentId:: - ID of the document.
+			# 
+			# ==== Returns
+			#
+			# * return Returns the String object.
+
+			
+			def delete(projectId, documentId)
+				url = getBaseURL+"projects/"+String(projectId)+"/documents/"+String(documentId)+"/"
+				response = Projects::Util::ZohoHTTPClient.delete(url, getQueryMap)		
+				return $documentParser.getResult(response)
+			end
+		end
+	end
+end