zohoProjects 0.0.5 → 0.0.6

data/README.md

@@ -1,141 +1,175 @@
-# ZohoProjects
+# ZohoProjects Ruby Client Library
 
-The ruby library for integrating with ZohoProjects.
+
+The Ruby library for integrating with the Zoho Projects API. Use this object-based Ruby wrapper to easily integrate Zoho Projects modules like portals, projects, milestones, tasklists, events etc. into your application.
 
 ## Installation
 
-Add this line to your application's Gemfile:
 
-    gem 'zohoProjects'
+There are a couple of ways of installing ZohoProjects:
+
+Install 1:
+
+Start by adding this line to your application's Gemfile: 
 
-And then execute:
+      gem 'zohoProjects'
 
-    $ bundle
+And follow it with executing this command:
+ 
+      $ bundle
 
-Or install it yourself as:
+Install 2:
 
-    $ gem install zohoProjects
+To fully install the Projects wrapper yourself, just execute this command:
+
+      $ gem install zohoProjects
 
 ## Documentation
 
-[API Documentation](http://cms.zohocorp.com/export/zoho/projects/help/rest-api/portals-api.html)
+
+[API Reference](https://www.zoho.com/projects/help/rest-api/zohoprojectsapi.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)
+In order to access the Zoho Projects APIs, users need to have a valid Zoho account and a valid Auth Token.
 
-If you have a valid authtoken, you are able to access our Zoho projects API wrappers.
+### Sign up for a Zoho Account:
 
-How to access our wrapper classes? Here is a sample example code for accessing Zoho Projects.
+- - -
 
-You have to add our gem file:
+For setting up a Zoho account, access the Zoho Projects [Sign Up](https://www.zoho.com/projects/zp-signup.html) page and enter the requisite details - email address and password.
 
-	require "zohoProjects"
+### Generate Auth Token:
 
-Pass your authToken to create an instance for PortalsAPI.
+- - -
+ 
+To generate the Auth Token, you need to send an authentication request to Zoho Accounts in a prescribed URL format. [Refer here](https://www.zoho.com/projects/help/rest-api/get-tickets-api.html)
 
-You have two ways to create an instance for PortalsAPI. Here is the example code,
 
-1) Pass your authToken and create a PortalsAPI instance:
+## Ruby Wrappers - Sample
 
-			portalsAPI = PortalsAPI.new("{auth_token}")
-			
-2) Pass your authToken and portalId to create an instance for ZohoProjects and then get the instance for PortalsAPI:
+### How to access the Zoho Projects APIs through Ruby wrapper classes?
 
-			zohoProject = ZohoProject.new("{auth_token}", "{portal_id}")
-			
-			portalsAPI = zohoProject.getPortalsAPI
-			
+- - -
+
+To access the Projects APIs, add this gem file in your application:
+	
+	require "zohoProjects"
 	
-			queryMap = Hash.new
-			
-			queryMap["status"] = "open"
-			
-			begin
-			
-## Get the list of portals:
+### Create PortalsAPI instance:
 
 - - -
-			
-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:
+Now there are two ways of creating an instance of PortalsAPI.
 
-				portalId = portals[0].getId
-			
-## Get the list of projects:
+Pass the AuthToken and create a PortalsAPI instance. 
 
-- - -
+Sample code:
 
-If you want to get all the projects from the portal, you need to call the 'getProjects' method by passing query string parameters.
+        portalsAPI = PortalsAPI.new("{auth_token}")
 
-				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:
+Pass the AuthToken and PortalId to first create an instance of ZohoProjects, and then proceed to get the instance of PortalsAPI. 
 
-				projectId = String(projects[0].getId)
-			
-## Get the details of a project:
+Sample code:
+       	
+       	zohoProject = ZohoProject.new("{auth_token}", "{portal_id}")
+ 
+        portalsAPI = zohoProject.getPortalsAPI
+ 
+ 
+        queryMap = Hash.new
+ 
+        queryMap["status"] = "open"
+ 
+        begin
+ 
+ 
+### List all Portals:
 
 - - -
 
-If you want to get the details of project, you need to call the 'get' method by passing projectId.
+If you wish to get the list of all your Zoho Projects portals, you need to call the `getPortals()` method by passing query string parameters in the format below:
+
+            portals = portalsAPI.getPortals
+ 
+It returns the List of Portal object as a response.
 
-				get = projectsAPI.get(projectId)
-			
-## Create a new project:
+Similarly, if you wish to parse the portal id from the List of Portal objects, you need to send a request in the prescribed format below:
+
+            portalId = portals.get[0].getId
+ 
+### List all Projects:
 
 - - -
 
-If you want to create a new project for the portal, you need to call the 'create' method by passing the Project object.
+If you wish to get the list of all projects from the portal, you need to call the `getProjects()` method by passing query string parameters in the format below:
 
-				project = Project.new
-			
-				project.setName("Test")
-				project.setDescription("Test project")
+            projects = projectsAPI.getProjects(queryMap)
+ 
+It returns the List of Project object as a response.
+ 
+Similarly, if you wish to parse the project id from the List of Portal objects, you need to send a request in the format below:
 
-				create = projectsAPI.create(project)
-			
-## Update the details of a project:
+            projectId = String.valueOf(projects[0].getId)
+ 
+### Get Project details:
 
 - - - 
+ 
+In order to get the details of a project, you need to call the `get()` method by passing a projectId.
+ 
+            get = projectsAPI.get(projectId)
+ 
+### Create a new Project:
 
-If you want to update the project details of a portal, you need to fetch the project details by calling the 'get' method.
+- - - 
+ 
+To create a new project for the specific portal, you need to call the `create()` method by passing the Project object.
 
-If you want update the name of the project then you need to write your code as mentioned below:
+            project = Project.new
+ 
+            project.setName("Test")
+            project.setDescription("Test project")
+ 
+            create = projectsAPI.create(project)
 
-				get = projectsAPI.get(projectId)
-			
-				get.setName("API")
+### Update Project details:
 
-				update = projectsAPI.update(get)
-			
-			
-## Delete an existing project:
+- - - 
+ 
+To update the project details of a particular portal, you need to first fetch the project info. This can be achieved by calling the `get()` method. You can then proceed to update the name of the project (for example) with the help of a sample code below:
+
+            get = projectsAPI.get(projectId)
+ 
+            get.setName("API")
+ 
+            update = projectsAPI.update(get)
+
+### Delete a Project:
 
 - - - 
+ 
+To delete an existing project of a particular portal, you need to call the `delete()` method and pass the projectid.
 
-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)
+ 
+       
 
-				delete = projectsAPI.delete(projectId)
-		
-			
-## Catch the exception:
+### Catch Exceptions:
 
 - - -
 
-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/test) for full examples.
+If there is any error encountered while calling the Ruby Wrappers of Zoho Projects API, the respective class will throw the ProjectsException. Use the below mentioned code to catch the ProjectsException:
+
+               rescue ProjectsException => pe
+                puts "Code: " + String(pe.getCode)
+                puts "Message: " + pe.getMessage
+           end
+ 
+ 
+For a full set of examples, click [here](../../tree/master/test).
+
 ## Contributing
 
 1. Fork it

data/lib/projects/model/Project.rb

@@ -5,8 +5,8 @@ module Projects
 
 		class Project
 			private
-			attr_accessor :id, :name, :status, :createdDate, :createdDateFormat, :createdDateLong, :description, :ownerName, :ownerId, :openTaskCount, :closedTaskCount, :openMilestoneCount, :closedMilestoneCount, :openBugCount, :closedBugCount, :URL, :activityURL, :milestoneURL, :tasklistURL, :taskURL, :bugURL, :timesheetURL, :statusURL, :eventURL, :documentURL, :folderURL, :forumURL, :userURL 
-
+			attr_accessor :id, :name, :templateId, :status, :createdDate, :createdDateFormat, :createdDateLong, :description, :ownerName, :ownerId, :openTaskCount, :closedTaskCount, :openMilestoneCount, :closedMilestoneCount, :openBugCount, :closedBugCount, :URL, :activityURL, :milestoneURL, :tasklistURL, :taskURL, :bugURL, :timesheetURL, :statusURL, :eventURL, :documentURL, :folderURL, :forumURL, :userURL;
+			
 			public
 
 				# * Set the project id.
@@ -48,6 +48,30 @@ module Projects
 				def getName
 					return @name
 				end
+				
+				# * Set the template id of the project.
+				#
+				# ==== Parameters
+				#
+				# * templateId:: - ID of the template.
+				
+				def setTemplateId(templateId)
+				
+					@templateId = templateId
+				
+				end
+				
+				# * Get the template id of the project.
+				#
+				# ==== Returns
+				#
+				# * Returns the template id.
+				
+				def getTemplateId
+				
+					return @templateId
+					
+				end
 
 				# * Set the status of the project.
 				# 
@@ -586,8 +610,11 @@ module Projects
 					if status != nil
 						requestBody["status"] = status
 					end
+					if templateId != nil
+						requestBody["template_id"] = templateId
+					end
 					return requestBody
 				end
 		end
 	end
-end
+end

data/lib/projects/util/ZohoHTTPClient.rb

@@ -77,7 +77,7 @@ module Projects
 				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"
+				header["User-Agent"] = "ZohoProjects-Ruby-Wrappers/0.0.6"
 				return header
 			end
 
@@ -202,4 +202,4 @@ module Projects
 			end
 		end
 	end
-end
+end

data/lib/zohoProjects/version.rb

@@ -1,3 +1,3 @@
 module ZohoProjects
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/zohoProjects.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "zohoProjects"
   spec.version       = ZohoProjects::VERSION
   spec.authors       = ["Zoho Corp."]
-  spec.email         = ["arivezhilmarban@gmail.com"]
+  spec.email         = ["sahaya.ramesh@zohocorp.com"]
   spec.summary       = %q{Wrapper for Zoho Projects.}
-  spec.description   = %q{Zoho Projects API lets, users/developers extend their web applications to push or pull data into or from Zoho Projects for application mashups. - See more at: http://cms.zohocorp.com/export/zoho/projects/help/rest-api/zohoprojectsapi.html}
+  spec.description   = %q{Zoho Projects API lets, users/developers extend their web applications to push or pull data into or from Zoho Projects for application mashups. - See more at: https://www.zoho.com/projects/help/rest-api/zohoprojectsapi.html}
   spec.homepage      = ""
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zohoProjects
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &18198300 !ruby/object:Gem::Requirement
+  requirement: &20700380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *18198300
+  version_requirements: *20700380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18196400 !ruby/object:Gem::Requirement
+  requirement: &20699040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,12 +32,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18196400
+  version_requirements: *20699040
 description: ! 'Zoho Projects API lets, users/developers extend their web applications
   to push or pull data into or from Zoho Projects for application mashups. - See more
-  at: http://cms.zohocorp.com/export/zoho/projects/help/rest-api/zohoprojectsapi.html'
+  at: https://www.zoho.com/projects/help/rest-api/zohoprojectsapi.html'
 email:
-- arivezhilmarban@gmail.com
+- sahaya.ramesh@zohocorp.com
 executables: []
 extensions: []
 extra_rdoc_files: []