rest_baby 0.1 → 0.2

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 (55) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +13 -0
  3. data/README.md +2 -2
  4. data/Rakefile +8 -1
  5. data/doc/MockRestService.html +351 -0
  6. data/doc/PinchRestService.html +349 -0
  7. data/doc/RestBaby/Client.html +936 -0
  8. data/doc/RestBaby.html +170 -0
  9. data/doc/_index.html +182 -0
  10. data/doc/class_list.html +74 -0
  11. data/doc/css/common.css +1 -0
  12. data/doc/css/cucumber.css +227 -0
  13. data/doc/css/full_list.css +57 -0
  14. data/doc/css/style.css +338 -0
  15. data/doc/feature_list.html +245 -0
  16. data/doc/featuredirectories_list.html +179 -0
  17. data/doc/file.README.html +134 -0
  18. data/doc/file_list.html +76 -0
  19. data/doc/frames.html +28 -0
  20. data/doc/index.html +134 -0
  21. data/doc/js/app.js +214 -0
  22. data/doc/js/cucumber.js +305 -0
  23. data/doc/js/full_list.js +178 -0
  24. data/doc/js/jquery.js +4 -0
  25. data/doc/method_list.html +169 -0
  26. data/doc/requirements/features/header_options.html +1020 -0
  27. data/doc/requirements/features/headers/header_options.html +1020 -0
  28. data/doc/requirements/features/headers.html +157 -0
  29. data/doc/requirements/features/print_response.html +969 -0
  30. data/doc/requirements/features/rest_client.html +835 -0
  31. data/doc/requirements/features.html +199 -0
  32. data/doc/requirements/step_transformers.html +1508 -0
  33. data/doc/requirements/tags/authentication.html +169 -0
  34. data/doc/requirements/tags/core.html +187 -0
  35. data/doc/requirements/tags/delete.html +169 -0
  36. data/doc/requirements/tags/extended.html +223 -0
  37. data/doc/requirements/tags/get.html +178 -0
  38. data/doc/requirements/tags/headers.html +169 -0
  39. data/doc/requirements/tags/post.html +196 -0
  40. data/doc/requirements/tags/print.html +187 -0
  41. data/doc/requirements/tags/put.html +169 -0
  42. data/doc/requirements/tags.html +408 -0
  43. data/doc/requirements.html +213 -0
  44. data/doc/step_list.html +825 -0
  45. data/doc/stepdefinition_list.html +230 -0
  46. data/doc/tag_list.html +131 -0
  47. data/doc/top-level-namespace.html +244 -0
  48. data/features/{header_options.feature → headers/header_options.feature} +0 -0
  49. data/features/step_definitions/rest_client_steps.rb +5 -4
  50. data/features/support/env.rb +1 -18
  51. data/features/support/mock_rest_service.rb +1 -1
  52. data/lib/rest_baby/version.rb +1 -1
  53. data/lib/rest_baby.rb +62 -35
  54. metadata +49 -5
  55. data/LICENSE +0 -24
data/doc/RestBaby/Client.html ADDED
@@ -0,0 +1,936 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: RestBaby::Client
8
+
9
+ &mdash; Documentation by YARD 0.8.7
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
+ <link rel="stylesheet" href="../css/cucumber.css" type="text/css" charset="utf-8" />
18
+
19
+ <script type="text/javascript" charset="utf-8">
20
+ hasFrames = window.top.frames.main ? true : false;
21
+ relpath = '../';
22
+ framesUrl = "../frames.html#!" + escape(window.location.href);
23
+ </script>
24
+
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
27
+
28
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
29
+
30
+ <script type="text/javascript" charset="utf-8" src="../js/cucumber.js"></script>
31
+
32
+
33
+ </head>
34
+ <body>
35
+ <div id="header">
36
+ <div id="menu">
37
+
38
+ <a href="../_index.html">Index (C)</a> &raquo;
39
+ <span class='title'><span class='object_link'><a href="../RestBaby.html" title="RestBaby (module)">RestBaby</a></span></span>
40
+ &raquo;
41
+ <span class="title">Client</span>
42
+
43
+
44
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
45
+ </div>
46
+
47
+ <div id="search">
48
+
49
+ <a class="full_list_link" id="feature_list_link"
50
+ href="../feature_list.html">
51
+ Features
52
+ </a>
53
+
54
+ <a class="full_list_link" id="featuredirectories_list_link"
55
+ href="../featuredirectories_list.html">
56
+ Features by Directory
57
+ </a>
58
+
59
+ <a class="full_list_link" id="tag_list_link"
60
+ href="../tag_list.html">
61
+ Tags
62
+ </a>
63
+
64
+ <a class="full_list_link" id="step_list_link"
65
+ href="../step_list.html">
66
+ Steps
67
+ </a>
68
+
69
+ <a class="full_list_link" id="stepdefinition_list_link"
70
+ href="../stepdefinition_list.html">
71
+ Step Defs
72
+ </a>
73
+
74
+ <a class="full_list_link" id="class_list_link"
75
+ href="../class_list.html">
76
+ Class List
77
+ </a>
78
+
79
+ <a class="full_list_link" id="method_list_link"
80
+ href="../method_list.html">
81
+ Method List
82
+ </a>
83
+
84
+ <a class="full_list_link" id="file_list_link"
85
+ href="../file_list.html">
86
+ File List
87
+ </a>
88
+
89
+ </div>
90
+ <div class="clear"></div>
91
+ </div>
92
+
93
+ <iframe id="search_frame"></iframe>
94
+
95
+ <div id="content"><h1>Class: RestBaby::Client
96
+
97
+
98
+
99
+ </h1>
100
+
101
+ <dl class="box">
102
+
103
+ <dt class="r1">Inherits:</dt>
104
+ <dd class="r1">
105
+ <span class="inheritName">Object</span>
106
+
107
+ <ul class="fullTree">
108
+ <li>Object</li>
109
+
110
+ <li class="next">RestBaby::Client</li>
111
+
112
+ </ul>
113
+ <a href="#" class="inheritanceTree">show all</a>
114
+
115
+ </dd>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <dt class="r2 last">Defined in:</dt>
126
+ <dd class="r2 last">lib/rest_baby.rb</dd>
127
+
128
+ </dl>
129
+ <div class="clear"></div>
130
+
131
+ <h2>Overview</h2><div class="docstring">
132
+ <div class="discussion">
133
+
134
+ <p>Sends and receives data to a restful web service</p>
135
+
136
+
137
+ </div>
138
+ </div>
139
+ <div class="tags">
140
+
141
+
142
+ </div>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <h2>
151
+ Instance Method Summary
152
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
153
+ </h2>
154
+
155
+ <ul class="summary">
156
+
157
+ <li class="public ">
158
+ <span class="summary_signature">
159
+
160
+ <a href="#delete-instance_method" title="#delete (instance method)">- (Object) <strong>delete</strong>(path, headers = {}) </a>
161
+
162
+
163
+
164
+ </span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'>
175
+ <p>Basic web services Delete command.</p>
176
+ </div></span>
177
+
178
+ </li>
179
+
180
+
181
+ <li class="public ">
182
+ <span class="summary_signature">
183
+
184
+ <a href="#get-instance_method" title="#get (instance method)">- (Object) <strong>get</strong>(path, headers = {}) </a>
185
+
186
+
187
+
188
+ </span>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'>
199
+ <p>Basic web services Get command.</p>
200
+ </div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#get_code-instance_method" title="#get_code (instance method)">- (Object) <strong>get_code</strong> </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <span class="summary_desc"><div class='inline'></div></span>
223
+
224
+ </li>
225
+
226
+
227
+ <li class="public ">
228
+ <span class="summary_signature">
229
+
230
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(url, headers = {}) </a>
231
+
232
+
233
+
234
+ </span>
235
+
236
+
237
+ <span class="note title constructor">constructor</span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'>
247
+ <p>Creates a new rest client.</p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#post-instance_method" title="#post (instance method)">- (Object) <strong>post</strong>(path, body = nil, headers = {}) </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <span class="summary_desc"><div class='inline'>
271
+ <p>Basic web services Post command.</p>
272
+ </div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#print_last_response-instance_method" title="#print_last_response (instance method)">- (Object) <strong>print_last_response</strong> </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'>
295
+ <p>Pretty print the web services last response.</p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ <li class="public ">
302
+ <span class="summary_signature">
303
+
304
+ <a href="#put-instance_method" title="#put (instance method)">- (Object) <strong>put</strong>(path, body = nil, headers = {}) </a>
305
+
306
+
307
+
308
+ </span>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+ <span class="summary_desc"><div class='inline'>
319
+ <p>Basic web services Put command.</p>
320
+ </div></span>
321
+
322
+ </li>
323
+
324
+
325
+ <li class="public ">
326
+ <span class="summary_signature">
327
+
328
+ <a href="#request-instance_method" title="#request (instance method)">- (Object) <strong>request</strong>(uri, request, body = nil, headers) </a>
329
+
330
+
331
+
332
+ </span>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+ <span class="summary_desc"><div class='inline'>
343
+ <p>Sending the web services command.</p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ <li class="public ">
350
+ <span class="summary_signature">
351
+
352
+ <a href="#set_auth-instance_method" title="#set_auth (instance method)">- (Object) <strong>set_auth</strong>(user, password) </a>
353
+
354
+
355
+
356
+ </span>
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <span class="summary_desc"><div class='inline'>
367
+ <p>Modifies the authentication for the rest client.</p>
368
+ </div></span>
369
+
370
+ </li>
371
+
372
+
373
+ <li class="public ">
374
+ <span class="summary_signature">
375
+
376
+ <a href="#set_headers-instance_method" title="#set_headers (instance method)">- (Object) <strong>set_headers</strong>(headers) </a>
377
+
378
+
379
+
380
+ </span>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <span class="summary_desc"><div class='inline'>
391
+ <p>Modifies the headers by merging new headers with current headers.</p>
392
+ </div></span>
393
+
394
+ </li>
395
+
396
+
397
+ </ul>
398
+
399
+
400
+ <div id="constructor_details" class="method_details_list">
401
+ <h2>Constructor Details</h2>
402
+
403
+ <div class="method_details first">
404
+ <h3 class="signature first" id="initialize-instance_method">
405
+
406
+ - (<tt><span class='object_link'><a href="" title="RestBaby::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(url, headers = {})
407
+
408
+
409
+
410
+
411
+
412
+ </h3><div class="docstring">
413
+ <div class="discussion">
414
+
415
+ <p>Creates a new rest client</p>
416
+ <ul><li>
417
+ <p><code>url</code> = url of the rest service</p>
418
+ </li></ul>
419
+
420
+ <p>eg. <a
421
+ href="http://myrestservice.com:80/time">myrestservice.com:80/time</a></p>
422
+ <ul><li>
423
+ <p><code>headers</code> = default headers to use.</p>
424
+ </li></ul>
425
+
426
+ <p>eg. &#39;{ &quot;Content-Type&quot; =&gt;
427
+ &quot;application/json&quot;}&#39; can be multiple headers</p>
428
+
429
+
430
+ </div>
431
+ </div>
432
+ <div class="tags">
433
+
434
+
435
+ </div><table class="source_code">
436
+ <tr>
437
+ <td>
438
+ <pre class="lines">
439
+
440
+
441
+ 27
442
+ 28
443
+ 29
444
+ 30
445
+ 31
446
+ 32</pre>
447
+ </td>
448
+ <td>
449
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 27</span>
450
+
451
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
452
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
453
+ <span class='ivar'>@headers</span> <span class='op'>=</span> <span class='id identifier rubyid_headers'>headers</span>
454
+ <span class='ivar'>@user</span> <span class='op'>=</span> <span class='kw'>nil</span>
455
+ <span class='ivar'>@password</span> <span class='op'>=</span> <span class='kw'>nil</span>
456
+ <span class='kw'>end</span></pre>
457
+ </td>
458
+ </tr>
459
+ </table>
460
+ </div>
461
+
462
+ </div>
463
+
464
+
465
+ <div id="instance_method_details" class="method_details_list">
466
+ <h2>Instance Method Details</h2>
467
+
468
+
469
+ <div class="method_details first">
470
+ <h3 class="signature first" id="delete-instance_method">
471
+
472
+ - (<tt>Object</tt>) <strong>delete</strong>(path, headers = {})
473
+
474
+
475
+
476
+
477
+
478
+ </h3><div class="docstring">
479
+ <div class="discussion">
480
+
481
+ <p>Basic web services Delete command</p>
482
+ <ul><li>
483
+ <p><code>url</code> = url to send the command to</p>
484
+ </li><li>
485
+ <p><code>headers</code> = header parameters including authorization and
486
+ Content-Type</p>
487
+ </li></ul>
488
+
489
+ <p>The response from the rest server is returned</p>
490
+
491
+
492
+ </div>
493
+ </div>
494
+ <div class="tags">
495
+
496
+
497
+ </div><table class="source_code">
498
+ <tr>
499
+ <td>
500
+ <pre class="lines">
501
+
502
+
503
+ 79
504
+ 80
505
+ 81</pre>
506
+ </td>
507
+ <td>
508
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 79</span>
509
+
510
+ <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_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
511
+ <span class='kw'>return</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='comma'>,</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Delete</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_request_uri'>request_uri</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
512
+ <span class='kw'>end</span></pre>
513
+ </td>
514
+ </tr>
515
+ </table>
516
+ </div>
517
+
518
+ <div class="method_details ">
519
+ <h3 class="signature " id="get-instance_method">
520
+
521
+ - (<tt>Object</tt>) <strong>get</strong>(path, headers = {})
522
+
523
+
524
+
525
+
526
+
527
+ </h3><div class="docstring">
528
+ <div class="discussion">
529
+
530
+ <p>Basic web services Get command</p>
531
+ <ul><li>
532
+ <p><code>url</code> = url to send the command to</p>
533
+ </li><li>
534
+ <p><code>headers</code> = header parameters including authorization and
535
+ Content-Type</p>
536
+ </li></ul>
537
+
538
+ <p>The response from the rest server is returned</p>
539
+
540
+
541
+ </div>
542
+ </div>
543
+ <div class="tags">
544
+
545
+
546
+ </div><table class="source_code">
547
+ <tr>
548
+ <td>
549
+ <pre class="lines">
550
+
551
+
552
+ 58
553
+ 59
554
+ 60</pre>
555
+ </td>
556
+ <td>
557
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 58</span>
558
+
559
+ <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_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
560
+ <span class='kw'>return</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='comma'>,</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_request_uri'>request_uri</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
561
+ <span class='kw'>end</span></pre>
562
+ </td>
563
+ </tr>
564
+ </table>
565
+ </div>
566
+
567
+ <div class="method_details ">
568
+ <h3 class="signature " id="get_code-instance_method">
569
+
570
+ - (<tt>Object</tt>) <strong>get_code</strong>
571
+
572
+
573
+
574
+
575
+
576
+ </h3><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 116
583
+ 117
584
+ 118</pre>
585
+ </td>
586
+ <td>
587
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 116</span>
588
+
589
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_code'>get_code</span>
590
+ <span class='ivar'>@wsresponse</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
591
+ <span class='kw'>end</span></pre>
592
+ </td>
593
+ </tr>
594
+ </table>
595
+ </div>
596
+
597
+ <div class="method_details ">
598
+ <h3 class="signature " id="post-instance_method">
599
+
600
+ - (<tt>Object</tt>) <strong>post</strong>(path, body = nil, headers = {})
601
+
602
+
603
+
604
+
605
+
606
+ </h3><div class="docstring">
607
+ <div class="discussion">
608
+
609
+ <p>Basic web services Post command</p>
610
+ <ul><li>
611
+ <p><code>url</code> = url to send the command to</p>
612
+ </li><li>
613
+ <p><code>body</code> = data to put in the body</p>
614
+ </li><li>
615
+ <p><code>headers</code> = header parameters including authorization and
616
+ Content-Type</p>
617
+ </li></ul>
618
+
619
+ <p>The response from the rest server is returned</p>
620
+
621
+
622
+ </div>
623
+ </div>
624
+ <div class="tags">
625
+
626
+
627
+ </div><table class="source_code">
628
+ <tr>
629
+ <td>
630
+ <pre class="lines">
631
+
632
+
633
+ 69
634
+ 70
635
+ 71</pre>
636
+ </td>
637
+ <td>
638
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 69</span>
639
+
640
+ <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_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
641
+ <span class='kw'>return</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='comma'>,</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_request_uri'>request_uri</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
642
+ <span class='kw'>end</span></pre>
643
+ </td>
644
+ </tr>
645
+ </table>
646
+ </div>
647
+
648
+ <div class="method_details ">
649
+ <h3 class="signature " id="print_last_response-instance_method">
650
+
651
+ - (<tt>Object</tt>) <strong>print_last_response</strong>
652
+
653
+
654
+
655
+
656
+
657
+ </h3><div class="docstring">
658
+ <div class="discussion">
659
+
660
+ <p>Pretty print the web services last response</p>
661
+
662
+ <p>The nice looking output is returned as a string</p>
663
+
664
+
665
+ </div>
666
+ </div>
667
+ <div class="tags">
668
+
669
+
670
+ </div><table class="source_code">
671
+ <tr>
672
+ <td>
673
+ <pre class="lines">
674
+
675
+
676
+ 124
677
+ 125
678
+ 126
679
+ 127
680
+ 128
681
+ 129
682
+ 130
683
+ 131
684
+ 132
685
+ 133
686
+ 134
687
+ 135</pre>
688
+ </td>
689
+ <td>
690
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 124</span>
691
+
692
+ <span class='kw'>def</span> <span class='id identifier rubyid_print_last_response'>print_last_response</span>
693
+ <span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CODE = </span><span class='embexpr_beg'>#{</span><span class='ivar'>@wsresponse</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
694
+ <span class='id identifier rubyid_output'>output</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>MESSAGE = </span><span class='embexpr_beg'>#{</span><span class='ivar'>@wsresponse</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
695
+ <span class='ivar'>@wsresponse</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_output'>output</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'> = </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
696
+ <span class='kw'>begin</span>
697
+ <span class='id identifier rubyid_output'>output</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>BODY = </span><span class='tstring_end'>&quot;</span></span>
698
+ <span class='id identifier rubyid_output'>output</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@wsresponse</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
699
+ <span class='kw'>rescue</span>
700
+ <span class='id identifier rubyid_output'>output</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[Empty]</span><span class='tstring_end'>&quot;</span></span>
701
+ <span class='kw'>end</span>
702
+ <span class='kw'>return</span> <span class='id identifier rubyid_output'>output</span>
703
+ <span class='kw'>end</span></pre>
704
+ </td>
705
+ </tr>
706
+ </table>
707
+ </div>
708
+
709
+ <div class="method_details ">
710
+ <h3 class="signature " id="put-instance_method">
711
+
712
+ - (<tt>Object</tt>) <strong>put</strong>(path, body = nil, headers = {})
713
+
714
+
715
+
716
+
717
+
718
+ </h3><div class="docstring">
719
+ <div class="discussion">
720
+
721
+ <p>Basic web services Put command</p>
722
+ <ul><li>
723
+ <p><code>url</code> = url to send the command to</p>
724
+ </li><li>
725
+ <p><code>body</code> = data to put in the body</p>
726
+ </li><li>
727
+ <p><code>headers</code> = header parameters including authorization and
728
+ Content-Type</p>
729
+ </li></ul>
730
+
731
+ <p>The response from the rest server is returned</p>
732
+
733
+
734
+ </div>
735
+ </div>
736
+ <div class="tags">
737
+
738
+
739
+ </div><table class="source_code">
740
+ <tr>
741
+ <td>
742
+ <pre class="lines">
743
+
744
+
745
+ 90
746
+ 91
747
+ 92</pre>
748
+ </td>
749
+ <td>
750
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 90</span>
751
+
752
+ <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_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
753
+ <span class='kw'>return</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='comma'>,</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Put</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_request_uri'>request_uri</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
754
+ <span class='kw'>end</span></pre>
755
+ </td>
756
+ </tr>
757
+ </table>
758
+ </div>
759
+
760
+ <div class="method_details ">
761
+ <h3 class="signature " id="request-instance_method">
762
+
763
+ - (<tt>Object</tt>) <strong>request</strong>(uri, request, body = nil, headers)
764
+
765
+
766
+
767
+
768
+
769
+ </h3><div class="docstring">
770
+ <div class="discussion">
771
+
772
+ <p>Sending the web services command</p>
773
+ <ul><li>
774
+ <p><code>url</code> = url to send the command to</p>
775
+ </li><li>
776
+ <p><code>req</code> = command to send as Net::HTTP:&lt;command&gt; class</p>
777
+ </li><li>
778
+ <p><code>body</code> = data to put in the body</p>
779
+ </li><li>
780
+ <p><code>headers</code> = header parameters including authorization and
781
+ Content-Type</p>
782
+ </li></ul>
783
+
784
+ <p>The response from the rest server is returned</p>
785
+
786
+
787
+ </div>
788
+ </div>
789
+ <div class="tags">
790
+
791
+
792
+ </div><table class="source_code">
793
+ <tr>
794
+ <td>
795
+ <pre class="lines">
796
+
797
+
798
+ 102
799
+ 103
800
+ 104
801
+ 105
802
+ 106
803
+ 107
804
+ 108
805
+ 109
806
+ 110
807
+ 111
808
+ 112
809
+ 113
810
+ 114</pre>
811
+ </td>
812
+ <td>
813
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 102</span>
814
+
815
+ <span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
816
+ <span class='ivar'>@headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_request'>request</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='rbrace'>}</span>
817
+ <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_body'>body</span> <span class='kw'>unless</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
818
+ <span class='id identifier rubyid_http'>http</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
819
+ <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_use_ssl'>use_ssl</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_scheme'>scheme</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span>
820
+ <span class='kw'>begin</span>
821
+ <span class='ivar'>@wsresponse</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
822
+ <span class='comment'># puts print_last_response
823
+ </span> <span class='kw'>return</span> <span class='ivar'>@wsresponse</span>
824
+ <span class='kw'>rescue</span> <span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
825
+ <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span>
826
+ <span class='kw'>end</span>
827
+ <span class='kw'>end</span></pre>
828
+ </td>
829
+ </tr>
830
+ </table>
831
+ </div>
832
+
833
+ <div class="method_details ">
834
+ <h3 class="signature " id="set_auth-instance_method">
835
+
836
+ - (<tt>Object</tt>) <strong>set_auth</strong>(user, password)
837
+
838
+
839
+
840
+
841
+
842
+ </h3><div class="docstring">
843
+ <div class="discussion">
844
+
845
+ <p>Modifies the authentication for the rest client</p>
846
+ <ul><li>
847
+ <p><code>user</code> = authorized username</p>
848
+ </li><li>
849
+ <p><code>password</code> = password for the user</p>
850
+ </li></ul>
851
+
852
+
853
+ </div>
854
+ </div>
855
+ <div class="tags">
856
+
857
+
858
+ </div><table class="source_code">
859
+ <tr>
860
+ <td>
861
+ <pre class="lines">
862
+
863
+
864
+ 47
865
+ 48
866
+ 49
867
+ 50</pre>
868
+ </td>
869
+ <td>
870
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 47</span>
871
+
872
+ <span class='kw'>def</span> <span class='id identifier rubyid_set_auth'>set_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
873
+ <span class='id identifier rubyid_new_url'>new_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_scheme'>scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_password'>password</span><span class='embexpr_end'>}</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@uri</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
874
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_new_url'>new_url</span><span class='rparen'>)</span>
875
+ <span class='kw'>end</span></pre>
876
+ </td>
877
+ </tr>
878
+ </table>
879
+ </div>
880
+
881
+ <div class="method_details ">
882
+ <h3 class="signature " id="set_headers-instance_method">
883
+
884
+ - (<tt>Object</tt>) <strong>set_headers</strong>(headers)
885
+
886
+
887
+
888
+
889
+
890
+ </h3><div class="docstring">
891
+ <div class="discussion">
892
+
893
+ <p>Modifies the headers by merging new headers with current headers.</p>
894
+ <ul><li>
895
+ <p><code>headers</code> = new headers to merge with current headers</p>
896
+ </li></ul>
897
+
898
+
899
+ </div>
900
+ </div>
901
+ <div class="tags">
902
+
903
+
904
+ </div><table class="source_code">
905
+ <tr>
906
+ <td>
907
+ <pre class="lines">
908
+
909
+
910
+ 38
911
+ 39
912
+ 40</pre>
913
+ </td>
914
+ <td>
915
+ <pre class="code"><span class="info file"># File 'lib/rest_baby.rb', line 38</span>
916
+
917
+ <span class='kw'>def</span> <span class='id identifier rubyid_set_headers'>set_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
918
+ <span class='ivar'>@headers</span> <span class='op'>=</span> <span class='ivar'>@headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
919
+ <span class='kw'>end</span></pre>
920
+ </td>
921
+ </tr>
922
+ </table>
923
+ </div>
924
+
925
+ </div>
926
+
927
+ </div>
928
+
929
+ <div id="footer">
930
+ Generated on Tue Aug 6 23:42:42 2013 by
931
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
932
+ 0.8.7 (ruby-2.0.0).
933
+ </div>
934
+
935
+ </body>
936
+ </html>