basecamp3 0.1.3

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 (89) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/Gemfile +2 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +65 -0
  8. data/Rakefile +6 -0
  9. data/basecamp3.gemspec +38 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +8 -0
  12. data/docs/Basecamp3.html +367 -0
  13. data/docs/Basecamp3/Campfire.html +901 -0
  14. data/docs/Basecamp3/CampfireLine.html +1025 -0
  15. data/docs/Basecamp3/Comment.html +1284 -0
  16. data/docs/Basecamp3/Concerns.html +117 -0
  17. data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
  18. data/docs/Basecamp3/Concerns/Commentable.html +285 -0
  19. data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
  20. data/docs/Basecamp3/Concerns/Parentable.html +211 -0
  21. data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
  22. data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
  23. data/docs/Basecamp3/Document.html +1262 -0
  24. data/docs/Basecamp3/Forward.html +1070 -0
  25. data/docs/Basecamp3/Inbox.html +840 -0
  26. data/docs/Basecamp3/Message.html +1262 -0
  27. data/docs/Basecamp3/MessageBoard.html +840 -0
  28. data/docs/Basecamp3/MessageType.html +1160 -0
  29. data/docs/Basecamp3/Model.html +236 -0
  30. data/docs/Basecamp3/Person.html +1288 -0
  31. data/docs/Basecamp3/Project.html +1280 -0
  32. data/docs/Basecamp3/Question.html +1050 -0
  33. data/docs/Basecamp3/QuestionAnswer.html +887 -0
  34. data/docs/Basecamp3/Questionnaire.html +840 -0
  35. data/docs/Basecamp3/Request.html +933 -0
  36. data/docs/Basecamp3/ResponseParser.html +303 -0
  37. data/docs/Basecamp3/Schedule.html +840 -0
  38. data/docs/Basecamp3/ScheduleEntry.html +1560 -0
  39. data/docs/Basecamp3/Todo.html +1726 -0
  40. data/docs/Basecamp3/TodoList.html +1480 -0
  41. data/docs/Basecamp3/TodoSet.html +980 -0
  42. data/docs/Basecamp3/TypeMapper.html +329 -0
  43. data/docs/Basecamp3/Vault.html +1514 -0
  44. data/docs/_index.html +415 -0
  45. data/docs/class_list.html +51 -0
  46. data/docs/css/common.css +1 -0
  47. data/docs/css/full_list.css +58 -0
  48. data/docs/css/style.css +492 -0
  49. data/docs/file.README.html +157 -0
  50. data/docs/file_list.html +56 -0
  51. data/docs/frames.html +17 -0
  52. data/docs/index.html +157 -0
  53. data/docs/js/app.js +248 -0
  54. data/docs/js/full_list.js +216 -0
  55. data/docs/js/jquery.js +4 -0
  56. data/docs/method_list.html +1875 -0
  57. data/docs/top-level-namespace.html +110 -0
  58. data/lib/basecamp3.rb +61 -0
  59. data/lib/basecamp3/concerns/bucketable.rb +17 -0
  60. data/lib/basecamp3/concerns/commentable.rb +15 -0
  61. data/lib/basecamp3/concerns/creatorable.rb +16 -0
  62. data/lib/basecamp3/concerns/parentable.rb +17 -0
  63. data/lib/basecamp3/concerns/recordingable.rb +22 -0
  64. data/lib/basecamp3/model.rb +23 -0
  65. data/lib/basecamp3/models/campfire.rb +42 -0
  66. data/lib/basecamp3/models/campfire_line.rb +52 -0
  67. data/lib/basecamp3/models/comment.rb +65 -0
  68. data/lib/basecamp3/models/document.rb +71 -0
  69. data/lib/basecamp3/models/forward.rb +40 -0
  70. data/lib/basecamp3/models/inbox.rb +31 -0
  71. data/lib/basecamp3/models/message.rb +73 -0
  72. data/lib/basecamp3/models/message_board.rb +31 -0
  73. data/lib/basecamp3/models/message_type.rb +68 -0
  74. data/lib/basecamp3/models/person.rb +46 -0
  75. data/lib/basecamp3/models/project.rb +70 -0
  76. data/lib/basecamp3/models/question.rb +43 -0
  77. data/lib/basecamp3/models/question_answer.rb +35 -0
  78. data/lib/basecamp3/models/questionnaire.rb +31 -0
  79. data/lib/basecamp3/models/schedule.rb +31 -0
  80. data/lib/basecamp3/models/schedule_entry.rb +93 -0
  81. data/lib/basecamp3/models/todo.rb +108 -0
  82. data/lib/basecamp3/models/todo_list.rb +77 -0
  83. data/lib/basecamp3/models/todo_set.rb +33 -0
  84. data/lib/basecamp3/models/vault.rb +79 -0
  85. data/lib/basecamp3/request.rb +163 -0
  86. data/lib/basecamp3/response_parser.rb +44 -0
  87. data/lib/basecamp3/type_mapper.rb +53 -0
  88. data/lib/basecamp3/version.rb +3 -0
  89. metadata +202 -0
data/docs/Basecamp3/Request.html ADDED
@@ -0,0 +1,933 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Basecamp3::Request
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Basecamp3::Request";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
41
+ &raquo;
42
+ <span class="title">Request</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Basecamp3::Request
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Basecamp3::Request</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/basecamp3/request.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A class for handling requests</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+ <h2>
122
+ Instance Method Summary
123
+ <small><a href="#" class="summary_toggle">collapse</a></small>
124
+ </h2>
125
+
126
+ <ul class="summary">
127
+
128
+ <li class="public ">
129
+ <span class="summary_signature">
130
+
131
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, model = &#39;raw&#39;) &#x21d2; Basecamp3::Model, OpenStruct </a>
132
+
133
+
134
+
135
+ </span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <span class="summary_desc"><div class='inline'>
146
+ <p>Sends the delete request.</p>
147
+ </div></span>
148
+
149
+ </li>
150
+
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(path, params = {}, model = &#39;raw&#39;) &#x21d2; Basecamp3::Model, OpenStruct </a>
156
+
157
+
158
+
159
+ </span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'>
170
+ <p>Sends the get request.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(access_token, uri) &#x21d2; Request </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+
186
+ <span class="note title constructor">constructor</span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Initializes the request object.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#post-instance_method" title="#post (instance method)">#<strong>post</strong>(path, data = nil, model = &#39;raw&#39;) &#x21d2; Basecamp3::Model, OpenStruct </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>Sends the post request.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, data = nil, model = &#39;raw&#39;) &#x21d2; Basecamp3::Model, OpenStruct </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ <span class="summary_desc"><div class='inline'>
244
+ <p>Sends the put request.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong>(method, path, data = nil, model = &#39;raw&#39;) &#x21d2; Basecamp3::Model, OpenStruct </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Sends the request.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ </ul>
275
+
276
+
277
+ <div id="constructor_details" class="method_details_list">
278
+ <h2>Constructor Details</h2>
279
+
280
+ <div class="method_details first">
281
+ <h3 class="signature first" id="initialize-instance_method">
282
+
283
+ #<strong>initialize</strong>(access_token, uri) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Request (class)">Request</a></span></tt>
284
+
285
+
286
+
287
+
288
+
289
+ </h3><div class="docstring">
290
+ <div class="discussion">
291
+
292
+ <p>Initializes the request object.</p>
293
+
294
+
295
+ </div>
296
+ </div>
297
+ <div class="tags">
298
+ <p class="tag_title">Parameters:</p>
299
+ <ul class="param">
300
+
301
+ <li>
302
+
303
+ <span class='name'>access_token</span>
304
+
305
+
306
+ <span class='type'>(<tt>String</tt>)</span>
307
+
308
+
309
+
310
+ &mdash;
311
+ <div class='inline'>
312
+ <p>the data to send in the request</p>
313
+ </div>
314
+
315
+ </li>
316
+
317
+ <li>
318
+
319
+ <span class='name'>uri</span>
320
+
321
+
322
+ <span class='type'>(<tt>String</tt>)</span>
323
+
324
+
325
+
326
+ </li>
327
+
328
+ </ul>
329
+
330
+
331
+ </div><table class="source_code">
332
+ <tr>
333
+ <td>
334
+ <pre class="lines">
335
+
336
+
337
+ 8
338
+ 9
339
+ 10
340
+ 11</pre>
341
+ </td>
342
+ <td>
343
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 8</span>
344
+
345
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
346
+ <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
347
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='id identifier rubyid_uri'>uri</span>
348
+ <span class='kw'>end</span></pre>
349
+ </td>
350
+ </tr>
351
+ </table>
352
+ </div>
353
+
354
+ </div>
355
+
356
+
357
+ <div id="instance_method_details" class="method_details_list">
358
+ <h2>Instance Method Details</h2>
359
+
360
+
361
+ <div class="method_details first">
362
+ <h3 class="signature first" id="delete-instance_method">
363
+
364
+ #<strong>delete</strong>(path, model = &#39;raw&#39;) &#x21d2; <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>
365
+
366
+
367
+
368
+
369
+
370
+ </h3><div class="docstring">
371
+ <div class="discussion">
372
+
373
+ <p>Sends the delete request.</p>
374
+
375
+
376
+ </div>
377
+ </div>
378
+ <div class="tags">
379
+ <p class="tag_title">Parameters:</p>
380
+ <ul class="param">
381
+
382
+ <li>
383
+
384
+ <span class='name'>path</span>
385
+
386
+
387
+ <span class='type'>(<tt>String</tt>)</span>
388
+
389
+
390
+
391
+ &mdash;
392
+ <div class='inline'>
393
+ <p>the request path</p>
394
+ </div>
395
+
396
+ </li>
397
+
398
+ <li>
399
+
400
+ <span class='name'>model</span>
401
+
402
+
403
+ <span class='type'>(<tt>String</tt>)</span>
404
+
405
+
406
+ <em class="default">(defaults to: <tt>&#39;raw&#39;</tt>)</em>
407
+
408
+
409
+ &mdash;
410
+ <div class='inline'>
411
+ <p>the name of the model</p>
412
+ </div>
413
+
414
+ </li>
415
+
416
+ </ul>
417
+
418
+ <p class="tag_title">Returns:</p>
419
+ <ul class="return">
420
+
421
+ <li>
422
+
423
+
424
+ <span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>)</span>
425
+
426
+
427
+
428
+ </li>
429
+
430
+ </ul>
431
+
432
+ </div><table class="source_code">
433
+ <tr>
434
+ <td>
435
+ <pre class="lines">
436
+
437
+
438
+ 70
439
+ 71
440
+ 72</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 70</span>
444
+
445
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>raw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
446
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+ <div class="method_details ">
454
+ <h3 class="signature " id="get-instance_method">
455
+
456
+ #<strong>get</strong>(path, params = {}, model = &#39;raw&#39;) &#x21d2; <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>
457
+
458
+
459
+
460
+
461
+
462
+ </h3><div class="docstring">
463
+ <div class="discussion">
464
+
465
+ <p>Sends the get request.</p>
466
+
467
+
468
+ </div>
469
+ </div>
470
+ <div class="tags">
471
+ <p class="tag_title">Parameters:</p>
472
+ <ul class="param">
473
+
474
+ <li>
475
+
476
+ <span class='name'>path</span>
477
+
478
+
479
+ <span class='type'>(<tt>String</tt>)</span>
480
+
481
+
482
+
483
+ &mdash;
484
+ <div class='inline'>
485
+ <p>the request path</p>
486
+ </div>
487
+
488
+ </li>
489
+
490
+ <li>
491
+
492
+ <span class='name'>params</span>
493
+
494
+
495
+ <span class='type'>(<tt>Hash</tt>)</span>
496
+
497
+
498
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
499
+
500
+
501
+ &mdash;
502
+ <div class='inline'>
503
+ <p>the get params</p>
504
+ </div>
505
+
506
+ </li>
507
+
508
+ <li>
509
+
510
+ <span class='name'>model</span>
511
+
512
+
513
+ <span class='type'>(<tt>String</tt>)</span>
514
+
515
+
516
+ <em class="default">(defaults to: <tt>&#39;raw&#39;</tt>)</em>
517
+
518
+
519
+ &mdash;
520
+ <div class='inline'>
521
+ <p>the name of the model</p>
522
+ </div>
523
+
524
+ </li>
525
+
526
+ </ul>
527
+
528
+ <p class="tag_title">Returns:</p>
529
+ <ul class="return">
530
+
531
+ <li>
532
+
533
+
534
+ <span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>)</span>
535
+
536
+
537
+
538
+ </li>
539
+
540
+ </ul>
541
+
542
+ </div><table class="source_code">
543
+ <tr>
544
+ <td>
545
+ <pre class="lines">
546
+
547
+
548
+ 38
549
+ 39
550
+ 40</pre>
551
+ </td>
552
+ <td>
553
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 38</span>
554
+
555
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>raw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
556
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hash_to_get_query'>hash_to_get_query</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
557
+ <span class='kw'>end</span></pre>
558
+ </td>
559
+ </tr>
560
+ </table>
561
+ </div>
562
+
563
+ <div class="method_details ">
564
+ <h3 class="signature " id="post-instance_method">
565
+
566
+ #<strong>post</strong>(path, data = nil, model = &#39;raw&#39;) &#x21d2; <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>
567
+
568
+
569
+
570
+
571
+
572
+ </h3><div class="docstring">
573
+ <div class="discussion">
574
+
575
+ <p>Sends the post request.</p>
576
+
577
+
578
+ </div>
579
+ </div>
580
+ <div class="tags">
581
+ <p class="tag_title">Parameters:</p>
582
+ <ul class="param">
583
+
584
+ <li>
585
+
586
+ <span class='name'>path</span>
587
+
588
+
589
+ <span class='type'>(<tt>String</tt>)</span>
590
+
591
+
592
+
593
+ &mdash;
594
+ <div class='inline'>
595
+ <p>the request path</p>
596
+ </div>
597
+
598
+ </li>
599
+
600
+ <li>
601
+
602
+ <span class='name'>data</span>
603
+
604
+
605
+ <span class='type'>(<tt>Hash</tt>)</span>
606
+
607
+
608
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
609
+
610
+
611
+ &mdash;
612
+ <div class='inline'>
613
+ <p>the request body</p>
614
+ </div>
615
+
616
+ </li>
617
+
618
+ <li>
619
+
620
+ <span class='name'>model</span>
621
+
622
+
623
+ <span class='type'>(<tt>String</tt>)</span>
624
+
625
+
626
+ <em class="default">(defaults to: <tt>&#39;raw&#39;</tt>)</em>
627
+
628
+
629
+ &mdash;
630
+ <div class='inline'>
631
+ <p>the name of the model</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ </ul>
637
+
638
+ <p class="tag_title">Returns:</p>
639
+ <ul class="return">
640
+
641
+ <li>
642
+
643
+
644
+ <span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>)</span>
645
+
646
+
647
+
648
+ </li>
649
+
650
+ </ul>
651
+
652
+ </div><table class="source_code">
653
+ <tr>
654
+ <td>
655
+ <pre class="lines">
656
+
657
+
658
+ 49
659
+ 50
660
+ 51</pre>
661
+ </td>
662
+ <td>
663
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 49</span>
664
+
665
+ <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>raw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
666
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
667
+ <span class='kw'>end</span></pre>
668
+ </td>
669
+ </tr>
670
+ </table>
671
+ </div>
672
+
673
+ <div class="method_details ">
674
+ <h3 class="signature " id="put-instance_method">
675
+
676
+ #<strong>put</strong>(path, data = nil, model = &#39;raw&#39;) &#x21d2; <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>
677
+
678
+
679
+
680
+
681
+
682
+ </h3><div class="docstring">
683
+ <div class="discussion">
684
+
685
+ <p>Sends the put request.</p>
686
+
687
+
688
+ </div>
689
+ </div>
690
+ <div class="tags">
691
+ <p class="tag_title">Parameters:</p>
692
+ <ul class="param">
693
+
694
+ <li>
695
+
696
+ <span class='name'>path</span>
697
+
698
+
699
+ <span class='type'>(<tt>String</tt>)</span>
700
+
701
+
702
+
703
+ &mdash;
704
+ <div class='inline'>
705
+ <p>the request path</p>
706
+ </div>
707
+
708
+ </li>
709
+
710
+ <li>
711
+
712
+ <span class='name'>data</span>
713
+
714
+
715
+ <span class='type'>(<tt>Hash</tt>)</span>
716
+
717
+
718
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
719
+
720
+
721
+ &mdash;
722
+ <div class='inline'>
723
+ <p>the request body</p>
724
+ </div>
725
+
726
+ </li>
727
+
728
+ <li>
729
+
730
+ <span class='name'>model</span>
731
+
732
+
733
+ <span class='type'>(<tt>String</tt>)</span>
734
+
735
+
736
+ <em class="default">(defaults to: <tt>&#39;raw&#39;</tt>)</em>
737
+
738
+
739
+ &mdash;
740
+ <div class='inline'>
741
+ <p>the name of the model</p>
742
+ </div>
743
+
744
+ </li>
745
+
746
+ </ul>
747
+
748
+ <p class="tag_title">Returns:</p>
749
+ <ul class="return">
750
+
751
+ <li>
752
+
753
+
754
+ <span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>)</span>
755
+
756
+
757
+
758
+ </li>
759
+
760
+ </ul>
761
+
762
+ </div><table class="source_code">
763
+ <tr>
764
+ <td>
765
+ <pre class="lines">
766
+
767
+
768
+ 60
769
+ 61
770
+ 62</pre>
771
+ </td>
772
+ <td>
773
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 60</span>
774
+
775
+ <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>raw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
776
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
777
+ <span class='kw'>end</span></pre>
778
+ </td>
779
+ </tr>
780
+ </table>
781
+ </div>
782
+
783
+ <div class="method_details ">
784
+ <h3 class="signature " id="request-instance_method">
785
+
786
+ #<strong>request</strong>(method, path, data = nil, model = &#39;raw&#39;) &#x21d2; <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>
787
+
788
+
789
+
790
+
791
+
792
+ </h3><div class="docstring">
793
+ <div class="discussion">
794
+
795
+ <p>Sends the request.</p>
796
+
797
+
798
+ </div>
799
+ </div>
800
+ <div class="tags">
801
+ <p class="tag_title">Parameters:</p>
802
+ <ul class="param">
803
+
804
+ <li>
805
+
806
+ <span class='name'>method</span>
807
+
808
+
809
+ <span class='type'>(<tt>Symbol</tt>)</span>
810
+
811
+
812
+
813
+ &mdash;
814
+ <div class='inline'>
815
+ <p>the symbol of the http method</p>
816
+ </div>
817
+
818
+ </li>
819
+
820
+ <li>
821
+
822
+ <span class='name'>path</span>
823
+
824
+
825
+ <span class='type'>(<tt>String</tt>)</span>
826
+
827
+
828
+
829
+ &mdash;
830
+ <div class='inline'>
831
+ <p>the request path</p>
832
+ </div>
833
+
834
+ </li>
835
+
836
+ <li>
837
+
838
+ <span class='name'>data</span>
839
+
840
+
841
+ <span class='type'>(<tt>Hash</tt>)</span>
842
+
843
+
844
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
845
+
846
+
847
+ &mdash;
848
+ <div class='inline'>
849
+ <p>the request body</p>
850
+ </div>
851
+
852
+ </li>
853
+
854
+ <li>
855
+
856
+ <span class='name'>model</span>
857
+
858
+
859
+ <span class='type'>(<tt>String</tt>)</span>
860
+
861
+
862
+ <em class="default">(defaults to: <tt>&#39;raw&#39;</tt>)</em>
863
+
864
+
865
+ &mdash;
866
+ <div class='inline'>
867
+ <p>the name of the model</p>
868
+ </div>
869
+
870
+ </li>
871
+
872
+ </ul>
873
+
874
+ <p class="tag_title">Returns:</p>
875
+ <ul class="return">
876
+
877
+ <li>
878
+
879
+
880
+ <span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>OpenStruct</tt>)</span>
881
+
882
+
883
+
884
+ </li>
885
+
886
+ </ul>
887
+
888
+ </div><table class="source_code">
889
+ <tr>
890
+ <td>
891
+ <pre class="lines">
892
+
893
+
894
+ 21
895
+ 22
896
+ 23
897
+ 24
898
+ 25
899
+ 26
900
+ 27
901
+ 28
902
+ 29</pre>
903
+ </td>
904
+ <td>
905
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/request.rb', line 21</span>
906
+
907
+ <span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>raw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
908
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request_uri'>build_request_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
909
+ <span class='id identifier rubyid_https'>https</span> <span class='op'>=</span> <span class='id identifier rubyid_build_https_object'>build_https_object</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
910
+ <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request_object'>build_request_object</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
911
+
912
+ <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span> <span class='kw'>unless</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
913
+
914
+ <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_https'>https</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
915
+ <span class='kw'>end</span></pre>
916
+ </td>
917
+ </tr>
918
+ </table>
919
+ </div>
920
+
921
+ </div>
922
+
923
+ </div>
924
+
925
+ <div id="footer">
926
+ Generated on Tue May 9 15:32:16 2017 by
927
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
928
+ 0.9.9 (ruby-2.2.2).
929
+ </div>
930
+
931
+ </div>
932
+ </body>
933
+ </html>