zohoProjects 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. checksums.yaml +15 -0
  2. data/Gemfile +4 -0
  3. data/Gemfile.lock +17 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +145 -0
  6. data/Rakefile +2 -0
  7. data/lib/projects/api/API.rb +57 -0
  8. data/lib/projects/api/BugsAPI.rb +135 -0
  9. data/lib/projects/api/DocumentsAPI.rb +145 -0
  10. data/lib/projects/api/EventsAPI.rb +115 -0
  11. data/lib/projects/api/FoldersAPI.rb +111 -0
  12. data/lib/projects/api/ForumsAPI.rb +198 -0
  13. data/lib/projects/api/MilestonesAPI.rb +159 -0
  14. data/lib/projects/api/PortalAPI.rb +41 -0
  15. data/lib/projects/api/ProjectsAPI.rb +203 -0
  16. data/lib/projects/api/TasklistsAPI.rb +113 -0
  17. data/lib/projects/api/TasksAPI.rb +153 -0
  18. data/lib/projects/api/TimesheetsAPI.rb +240 -0
  19. data/lib/projects/api/UsersAPI.rb +48 -0
  20. data/lib/projects/exception/ProjectsException.rb +50 -0
  21. data/lib/projects/model/Activity.rb +173 -0
  22. data/lib/projects/model/Bug.rb +701 -0
  23. data/lib/projects/model/Buglog.rb +56 -0
  24. data/lib/projects/model/Category.rb +70 -0
  25. data/lib/projects/model/Comment.rb +289 -0
  26. data/lib/projects/model/Document.rb +260 -0
  27. data/lib/projects/model/Event.rb +391 -0
  28. data/lib/projects/model/Folder.rb +110 -0
  29. data/lib/projects/model/Forum.rb +320 -0
  30. data/lib/projects/model/Generallog.rb +36 -0
  31. data/lib/projects/model/Log.rb +359 -0
  32. data/lib/projects/model/Milestone.rb +322 -0
  33. data/lib/projects/model/Owner.rb +54 -0
  34. data/lib/projects/model/Participant.rb +54 -0
  35. data/lib/projects/model/Portal.rb +273 -0
  36. data/lib/projects/model/Project.rb +593 -0
  37. data/lib/projects/model/Status.rb +168 -0
  38. data/lib/projects/model/Task.rb +497 -0
  39. data/lib/projects/model/Tasklist.rb +300 -0
  40. data/lib/projects/model/Tasklog.rb +56 -0
  41. data/lib/projects/model/Timelog.rb +134 -0
  42. data/lib/projects/model/TimelogList.rb +54 -0
  43. data/lib/projects/model/User.rb +94 -0
  44. data/lib/projects/model/Version.rb +194 -0
  45. data/lib/projects/parser/BugParser.rb +208 -0
  46. data/lib/projects/parser/DocumentParser.rb +197 -0
  47. data/lib/projects/parser/EventParser.rb +156 -0
  48. data/lib/projects/parser/FolderParser.rb +99 -0
  49. data/lib/projects/parser/ForumParser.rb +253 -0
  50. data/lib/projects/parser/MilestonesParser.rb +129 -0
  51. data/lib/projects/parser/PortalParser.rb +103 -0
  52. data/lib/projects/parser/ProjectParser.rb +318 -0
  53. data/lib/projects/parser/TaskParser.rb +293 -0
  54. data/lib/projects/parser/TasklistParser.rb +127 -0
  55. data/lib/projects/parser/TimesheetParser.rb +390 -0
  56. data/lib/projects/parser/UserParser.rb +63 -0
  57. data/lib/projects/service/ZohoProject.rb +174 -0
  58. data/lib/projects/util/ZohoHTTPClient.rb +205 -0
  59. data/lib/test/ProjectsTest.rb +321 -0
  60. data/lib/zohoProjects.rb +35 -0
  61. data/lib/zohoProjects/version.rb +3 -0
  62. data/zohoProjects.gemspec +86 -0
  63. metadata +135 -0
@@ -0,0 +1,322 @@
1
+ # $Id$
2
+ module Projects
3
+ module Model
4
+ # * This class is used to make an object for Milestone.
5
+
6
+ class Milestone
7
+
8
+ private
9
+ attr_accessor :id, :name, :startDate, :startDateFormat, :startDateLong, :endDate, :endDateFormat, :endDateLong, :status, :ownerId, :ownerName, :flag, :url, :statusUrl
10
+
11
+ public
12
+
13
+
14
+ # * Set the milestone id.
15
+ #
16
+ # ==== Parameters
17
+ #
18
+ # * id:: - ID of the milestone.
19
+
20
+
21
+ def setId(id)
22
+ @id = id
23
+ end
24
+
25
+ # * Get the milestone id.
26
+ #
27
+ # ==== Returns
28
+ #
29
+ # * Milestone id.
30
+
31
+ def getId
32
+ return @id
33
+ end
34
+
35
+ # * Set the milestone name.
36
+ #
37
+ # ==== Parameters
38
+ #
39
+ # * name:: - Name of the milestone.
40
+
41
+ def setName(name)
42
+ @name = name
43
+ end
44
+
45
+ # * Get the milestone name.
46
+ #
47
+ # ==== Returns
48
+ #
49
+ # * Milestone name.
50
+
51
+ def getName
52
+ return name
53
+ end
54
+
55
+ # * Set the start date of the milestone.
56
+ #
57
+ # ==== Parameters
58
+ #
59
+ # * startDate:: - Start date of the milestone.
60
+
61
+ def setStartDate(startDate)
62
+ @startDate = startDate
63
+ end
64
+
65
+ # * Get the start date of the milestone.
66
+ #
67
+ # ==== Returns
68
+ #
69
+ # * Start date of the milestone.
70
+
71
+ def getStartDate
72
+ return @startDate
73
+ end
74
+
75
+ # * Set the start date format of the milestone.
76
+ #
77
+ # ==== Parameters
78
+ #
79
+ # * startDateLong:: - Start date format of the milestone.
80
+
81
+ def setStartDateFormat(startDateFormat)
82
+ @startDateFormat = startDateFormat
83
+ end
84
+
85
+ # * Get the start date format.
86
+ #
87
+ # ==== Returns
88
+ #
89
+ # * Start date format.
90
+
91
+ def getStartDateFormat
92
+ return @startDateFormat
93
+ end
94
+
95
+ # * Set the start date long of the milestone.
96
+ #
97
+ # ==== Parameters
98
+ #
99
+ # * startDateLong:: - Start date long of the milestone.
100
+
101
+ def setStartDateLong(startDateLong)
102
+ @startDateLong = startDateLong
103
+ end
104
+
105
+ # * Get the start date.
106
+ #
107
+ # ==== Returns
108
+ #
109
+ # * Start date.
110
+
111
+ def getStartDateLong
112
+ return @startDateLong
113
+ end
114
+
115
+ # * Set the end date of the milestone.
116
+ #
117
+ # ==== Parameters
118
+ #
119
+ # * endDate:: - End date of the milestone.
120
+
121
+ def setEndDate(endDate)
122
+ @endDate = endDate
123
+ end
124
+
125
+ # * Get the end date of the milestone.
126
+ #
127
+ # ==== Returns
128
+ #
129
+ # * End date of the milestone.
130
+
131
+ def getEndDate
132
+ return @endDate
133
+ end
134
+
135
+ # * Set the end date format.
136
+ #
137
+ # ==== Parameters
138
+ #
139
+ # * endDateLong:: - End date format of the milestone.
140
+
141
+ def setEndDateFormat(endDateFormat)
142
+ @endDateFormat = endDateFormat
143
+ end
144
+
145
+ # * Get the end date format.
146
+ #
147
+ # ==== Returns
148
+ #
149
+ # * End date format.
150
+
151
+ def getEndDateFormat
152
+ return @endDateFormat
153
+ end
154
+
155
+ # * Set the end date long.
156
+ #
157
+ # ==== Parameters
158
+ #
159
+ # * endDateLong:: - End date long of the milestone.
160
+
161
+ def setEndDateLong(endDateLong)
162
+ @endDateLong = endDateLong
163
+ end
164
+
165
+ # * Get the end date.
166
+ #
167
+ # ==== Returns
168
+ #
169
+ # * End date.
170
+
171
+ def getEndDateLong
172
+ return @endDateLong
173
+ end
174
+
175
+ # * Set the status of the milestone.
176
+ #
177
+ # ==== Parameters
178
+ #
179
+ # * status:: - Status of the milestone.
180
+
181
+ def setStatus(status)
182
+ @status = status
183
+ end
184
+
185
+ # * Get the status of the milestone.
186
+ #
187
+ # ==== Returns
188
+ #
189
+ # * Milestone status.
190
+
191
+ def getStatus
192
+ return @status
193
+ end
194
+
195
+ # * Set the owner id.
196
+ #
197
+ # ==== Parameters
198
+ #
199
+ # * ownerId:: - ID of the owner.
200
+
201
+ def setOwnerId(ownerId)
202
+ @ownerId = ownerId
203
+ end
204
+
205
+ # * Get the owner id.
206
+ #
207
+ # ==== Returns
208
+ #
209
+ # * Owner id.
210
+
211
+ def getOwnerId
212
+ return @ownerId
213
+ end
214
+
215
+ # * Set the owner name.
216
+ #
217
+ # ==== Parameters
218
+ #
219
+ # * ownerName:: - Name of the owner.
220
+
221
+ def setOwnerName(ownerName)
222
+ @ownerName = ownerName
223
+ end
224
+
225
+ # * Get the owner name.
226
+ #
227
+ # ==== Returns
228
+ #
229
+ # * Owner name.
230
+
231
+ def getOwnerName
232
+ return @ownerName
233
+ end
234
+
235
+ # * Set the flag for the milestone.
236
+ #
237
+ # ==== Parameters
238
+ #
239
+ # * flag:: - Flag for the milestone.
240
+
241
+ def setFlag(flag)
242
+ @flag = flag
243
+ end
244
+
245
+ # * Get the flag for the milestone.
246
+ #
247
+ # ==== Returns
248
+ #
249
+ # * Flag for the milestone.
250
+
251
+ def getFlag
252
+ return @flag
253
+ end
254
+
255
+ # * Set the milestone URL.
256
+ #
257
+ # ==== Parameters
258
+ #
259
+ # * url:: - URL for the milestone.
260
+
261
+ def setURL(url)
262
+ @url = url
263
+ end
264
+
265
+ # * Get the milestone URL.
266
+ #
267
+ # ==== Returns
268
+ #
269
+ # * Milestone URL.
270
+
271
+ def getURL
272
+ return @url
273
+ end
274
+
275
+ # * Set the status URL.
276
+ #
277
+ # ==== Parameters
278
+ #
279
+ # * statusUrl:: - Status URL for the milestone.
280
+
281
+ def setStatusURL(statusUrl)
282
+ @statusUrl = statusUrl
283
+ end
284
+
285
+ # * Get the status URL.
286
+ #
287
+ # * status URL for the milestone.
288
+
289
+ def getStatusURL
290
+ return statusUrl
291
+ end
292
+
293
+ # * Convert the Milestone object into HashMap.
294
+ #
295
+ # ==== Returns
296
+ #
297
+ # * HashMap object.
298
+
299
+ def toParamMAP
300
+ requestBody = Hash.new
301
+
302
+ if name != nil
303
+ requestBody["name"] = name
304
+ end
305
+ if startDate != nil
306
+ requestBody["start_date"] = startDate
307
+ end
308
+ if endDate != nil
309
+ requestBody["end_date"] = endDate
310
+ end
311
+ if ownerId != nil
312
+ requestBody["owner"] = ownerId
313
+ end
314
+ if flag != nil
315
+ requestBody["flag"] = flag
316
+ end
317
+
318
+ return requestBody
319
+ end
320
+ end
321
+ end
322
+ end
@@ -0,0 +1,54 @@
1
+ # $Id$
2
+ module Projects
3
+ module Model
4
+ # * This class is used to make an object for Owner.
5
+
6
+ class Owner
7
+
8
+ private
9
+ attr_accessor :name, :id
10
+
11
+ public
12
+
13
+ # * Set the owner name.
14
+ #
15
+ # ==== Parameters
16
+ #
17
+ # * name:: - Name of the owner.
18
+
19
+ def setName(name)
20
+ @name = name
21
+ end
22
+
23
+ # * Get the owner name.
24
+ #
25
+ # ==== Returns
26
+ #
27
+ # * Owner name.
28
+
29
+ def getName
30
+ return @name
31
+ end
32
+
33
+ # * Set the owner id.
34
+ #
35
+ # ==== Parameters
36
+ #
37
+ # * id:: - ID of the owner.
38
+
39
+ def setId(id)
40
+ @id = id
41
+ end
42
+
43
+ # * Get the owner id.
44
+ #
45
+ # ==== Returns
46
+ #
47
+ # * Owner id.
48
+
49
+ def getId
50
+ return @id
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,54 @@
1
+ # $Id$
2
+ module Projects
3
+ module Model
4
+ # * This class is used to make an object for Participant.
5
+
6
+ class Participant
7
+
8
+ private
9
+ attr_accessor :participantId, :participantPerson
10
+
11
+ public
12
+
13
+ # * Set the participant id.
14
+ #
15
+ # ==== Parameters
16
+ #
17
+ # * participantId:: - ID of the participant.
18
+
19
+ def setParticipantId(participantId)
20
+ @participantId = participantId
21
+ end
22
+
23
+ # * Get the participant id.
24
+ #
25
+ # ==== Returns
26
+ #
27
+ # * Participant id.
28
+
29
+ def getParticipantId
30
+ return @participantId
31
+ end
32
+
33
+ # * Set the participant name.
34
+ #
35
+ # ==== Parameters
36
+ #
37
+ # * participantPerson:: - Name of the participant.
38
+
39
+ def setParticipantPerson(participantPerson)
40
+ @participantPerson = participantPerson
41
+ end
42
+
43
+ # * Get the participant name.
44
+ #
45
+ # ==== Returns
46
+ #
47
+ # * Participant name.
48
+
49
+ def getParticipantPerson
50
+ return @participantPerson
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,273 @@
1
+ # $Id$
2
+ module Projects
3
+ module Model
4
+ # * This class is used to make an object for Portal.
5
+
6
+ class Portal
7
+ private
8
+ attr_accessor :id, :name, :default, :gmtTimeZone, :role, :companyName, :websiteURL, :timeZone, :dateFormat, :code, :language, :country, :projectURL
9
+
10
+ public
11
+
12
+ # * Set the portal id.
13
+ #
14
+ # ==== Parameters
15
+ #
16
+ # * id:: - ID of the portal.
17
+
18
+ def setId(id)
19
+ @id = id
20
+ end
21
+
22
+ # * Get the portal id.
23
+ #
24
+ # ==== Returns
25
+ #
26
+ # * Portal id.
27
+
28
+ def getId
29
+ return @id
30
+ end
31
+
32
+ # * Set the portal name.
33
+ #
34
+ # ==== Parameters
35
+ #
36
+ # * name:: - Name of the portal.
37
+
38
+ def setName(name)
39
+ @name = name
40
+ end
41
+
42
+ # * Get the portal name.
43
+ #
44
+ # ==== Returns
45
+ #
46
+ # * Portal name.
47
+
48
+ def getName
49
+ return @name
50
+ end
51
+
52
+ # * Set whether portal is default portal or not.
53
+ #
54
+ # ==== Parameters
55
+ #
56
+ # * isDefault:: - Is this postal default portal or not.
57
+
58
+ def setDefault(isDefault)
59
+ @isDefault = isDefault
60
+ end
61
+
62
+ # * Get whether portal is default portal or not.
63
+ #
64
+ # ==== Returns
65
+ #
66
+ # * true, if the portal is a default portal else false.
67
+
68
+ def isDefault
69
+ return @isDefault
70
+ end
71
+
72
+ # * Set the gmt time zone.
73
+ #
74
+ # ==== Parameters
75
+ #
76
+ # * gmtTimeZone:: - Gmt time zone for the portal.
77
+
78
+ def setGmtTimeZone(gmtTimeZone)
79
+ @gmtTimeZone = gmtTimeZone
80
+ end
81
+
82
+ # * Get the gmt time zone.
83
+ #
84
+ # ==== Returns
85
+ #
86
+ # * gmt time zone.
87
+
88
+ def getGmtTimeZone
89
+ return @gmtTimeZone
90
+ end
91
+
92
+ # * Set the role.
93
+ #
94
+ # ==== Parameters
95
+ #
96
+ # * role:: - Role of the person.
97
+
98
+ def setRole(role)
99
+ @role = role
100
+ end
101
+
102
+ # * Get the role.
103
+ #
104
+ # ==== Returns
105
+ #
106
+ # * Role of the person.
107
+
108
+ def getRole
109
+ return @role
110
+ end
111
+
112
+ # * Set the company name.
113
+ #
114
+ # ==== Parameters
115
+ #
116
+ # * companyName:: - Name of the company.
117
+
118
+ def setCompanyName(companyName)
119
+ @companyName = companyName
120
+ end
121
+
122
+ # * Get the company name.
123
+ #
124
+ # ==== Returns
125
+ #
126
+ # * Company name.
127
+
128
+ def getCompanyName
129
+ return @companyName
130
+ end
131
+
132
+ # * Set the WEBsite URL.
133
+ #
134
+ # ==== Parameters
135
+ #
136
+ # * websiteUrl:: - URL for the Website.
137
+
138
+ def setWebsiteURL(websiteUrl)
139
+ @websiteUrl = websiteUrl
140
+ end
141
+
142
+ # * Get the Website URL.
143
+ #
144
+ # ==== Returns
145
+ #
146
+ # * Website URL.
147
+
148
+ def getWebsiteURL
149
+ return @websiteUrl
150
+ end
151
+
152
+ # * Set the time zone.
153
+ #
154
+ # ==== Parameters
155
+ #
156
+ # * timeZone:: - Time zone for the portal.
157
+
158
+ def setTimeZone(timeZone)
159
+ @timeZone = timeZone
160
+ end
161
+
162
+ # * Get the time zone.
163
+ #
164
+ # ==== Returns
165
+ #
166
+ # * Time zone for the portal.
167
+
168
+ def getTimeZone
169
+ return @timeZone
170
+ end
171
+
172
+ # * Set the date format.
173
+ #
174
+ # ==== Parameters
175
+ #
176
+ # * dateFormat:: - Date format for the portal.
177
+
178
+ def setDateFormat(dateFormat)
179
+ @dateFormat = dateFormat
180
+ end
181
+
182
+ # * Get the date format.
183
+ #
184
+ # ==== Returns
185
+ #
186
+ # * Date format of the portal.
187
+
188
+ def getDateFormat
189
+ return @dateFormat
190
+ end
191
+
192
+ # * Set the language code.
193
+ #
194
+ # ==== Parameters
195
+ #
196
+ # * code:: - Code of the language.
197
+
198
+ def setCode(code)
199
+ @code =code
200
+ end
201
+
202
+ # * Get the language code.
203
+ #
204
+ # ==== Returns
205
+ #
206
+ # * Language code.
207
+
208
+ def getCode
209
+ return @code
210
+ end
211
+
212
+ # * Set the language.
213
+ #
214
+ # ==== Parameters
215
+ #
216
+ # * language:: - Language for the portal.
217
+
218
+ def setLanguage(language)
219
+ @language = language
220
+ end
221
+
222
+ # * Get the language.
223
+ #
224
+ # ==== Returns
225
+ #
226
+ # * Language of the portal.
227
+
228
+ def getLanguage
229
+ return @language
230
+ end
231
+
232
+ # * Set the country.
233
+ #
234
+ # ==== Parameters
235
+ #
236
+ # * country:: - Country for portal.
237
+
238
+ def setCountry(country)
239
+ @country = country
240
+ end
241
+
242
+ # * Get the country.
243
+ #
244
+ # ==== Returns
245
+ #
246
+ # * Country name.
247
+
248
+ def getCountry
249
+ return @country
250
+ end
251
+
252
+ # * Set the project URL.
253
+ #
254
+ # ==== Parameters
255
+ #
256
+ # * projectUrl:: - URL for the project.
257
+
258
+ def setProjectURL(projectUrl)
259
+ @projectUrl = projectUrl
260
+ end
261
+
262
+ # * Get the project URL.
263
+ #
264
+ # ==== Returns
265
+ #
266
+ # * Project URL.
267
+
268
+ def getProjectURL
269
+ return @projectUrl
270
+ end
271
+ end
272
+ end
273
+ end