aceroute 0.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1111 @@
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: Aceroute::Location
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Aceroute/Location.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (L)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Aceroute.html" title="Aceroute (module)">Aceroute</a></span></span>
36
+ &raquo;
37
+ <span class="title">Location</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Aceroute::Location
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="Aceroute::Base (class)">Base</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="Base.html" title="Aceroute::Base (class)">Base</a></span></li>
82
+
83
+ <li class="next">Aceroute::Location</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/aceroute/location.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#address1-instance_method" title="#address1 (instance method)">- (Object) <strong>address1</strong> </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Returns the value of attribute address1.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#address2-instance_method" title="#address2 (instance method)">- (Object) <strong>address2</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Returns the value of attribute address2.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#cid-instance_method" title="#cid (instance method)">- (Object) <strong>cid</strong> </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>Returns the value of attribute cid.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#description-instance_method" title="#description (instance method)">- (Object) <strong>description</strong> </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Returns the value of attribute description.</p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>Returns the value of attribute id.</p>
241
+ </div></span>
242
+
243
+ </li>
244
+
245
+
246
+ <li class="public ">
247
+ <span class="summary_signature">
248
+
249
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
250
+
251
+
252
+
253
+ </span>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <span class="summary_desc"><div class='inline'>
267
+ <p>Returns the value of attribute name.</p>
268
+ </div></span>
269
+
270
+ </li>
271
+
272
+
273
+ <li class="public ">
274
+ <span class="summary_signature">
275
+
276
+ <a href="#phone-instance_method" title="#phone (instance method)">- (Object) <strong>phone</strong> </a>
277
+
278
+
279
+
280
+ </span>
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+ <span class="summary_desc"><div class='inline'>
294
+ <p>Returns the value of attribute phone.</p>
295
+ </div></span>
296
+
297
+ </li>
298
+
299
+
300
+ </ul>
301
+
302
+
303
+
304
+
305
+
306
+ <h2>
307
+ Class Method Summary
308
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
309
+ </h2>
310
+
311
+ <ul class="summary">
312
+
313
+ <li class="public ">
314
+ <span class="summary_signature">
315
+
316
+ <a href="#delete-class_method" title="delete (class method)">+ (Object) <strong>delete</strong>(id) </a>
317
+
318
+
319
+
320
+ </span>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ <span class="summary_desc"><div class='inline'>
331
+ <p>Deletes Aceroute::Location of given id from Aceroute.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ </ul>
338
+
339
+ <h2>
340
+ Instance Method Summary
341
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
342
+ </h2>
343
+
344
+ <ul class="summary">
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#create%21-instance_method" title="#create! (instance method)">- (Aceroute::Location) <strong>create!</strong> </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'>
364
+ <p>Persists Aceroute::Location object to Aceroute API.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Object) <strong>destroy!</strong>(id = nil) </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ <span class="summary_desc"><div class='inline'>
388
+ <p>Deletes this Aceroute::Location object (self) from Aceroute.</p>
389
+ </div></span>
390
+
391
+ </li>
392
+
393
+
394
+ <li class="public ">
395
+ <span class="summary_signature">
396
+
397
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Aceroute::Location) <strong>initialize</strong>(address1, address2, description, name, phone, cid = nil, id = nil) </a>
398
+
399
+
400
+
401
+ </span>
402
+
403
+
404
+ <span class="note title constructor">constructor</span>
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+ <span class="summary_desc"><div class='inline'>
414
+ <p>Creates a new Aceroute::Location object.</p>
415
+ </div></span>
416
+
417
+ </li>
418
+
419
+
420
+ </ul>
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ <div id="constructor_details" class="method_details_list">
430
+ <h2>Constructor Details</h2>
431
+
432
+ <div class="method_details first">
433
+ <h3 class="signature first" id="initialize-instance_method">
434
+
435
+ - (<tt><span class='object_link'><a href="" title="Aceroute::Location (class)">Aceroute::Location</a></span></tt>) <strong>initialize</strong>(address1, address2, description, name, phone, cid = nil, id = nil)
436
+
437
+
438
+
439
+
440
+
441
+ </h3><div class="docstring">
442
+ <div class="discussion">
443
+
444
+ <p>Creates a new Aceroute::Location object. Note this does not persist the
445
+ Location to Aceroute, that can be done by calling the create! method on the
446
+ new object.</p>
447
+
448
+
449
+ </div>
450
+ </div>
451
+ <div class="tags">
452
+ <p class="tag_title">Parameters:</p>
453
+ <ul class="param">
454
+
455
+ <li>
456
+
457
+ <span class='name'>address1</span>
458
+
459
+
460
+ <span class='type'>(<tt>String</tt>)</span>
461
+
462
+
463
+
464
+ &mdash;
465
+ <div class='inline'>
466
+ <p>customer address line 1 (street)</p>
467
+ </div>
468
+
469
+ </li>
470
+
471
+ <li>
472
+
473
+ <span class='name'>address2</span>
474
+
475
+
476
+ <span class='type'>(<tt>String</tt>)</span>
477
+
478
+
479
+
480
+ &mdash;
481
+ <div class='inline'>
482
+ <p>customer address line 2 (eg apartment number)</p>
483
+ </div>
484
+
485
+ </li>
486
+
487
+ <li>
488
+
489
+ <span class='name'>description</span>
490
+
491
+
492
+ <span class='type'>(<tt>String</tt>)</span>
493
+
494
+
495
+
496
+ &mdash;
497
+ <div class='inline'>
498
+ <p>description of address (eg &#39;Home&#39;)</p>
499
+ </div>
500
+
501
+ </li>
502
+
503
+ <li>
504
+
505
+ <span class='name'>name</span>
506
+
507
+
508
+ <span class='type'>(<tt>String</tt>)</span>
509
+
510
+
511
+
512
+ &mdash;
513
+ <div class='inline'>
514
+ <p>name of address (eg &#39;Home&#39;)</p>
515
+ </div>
516
+
517
+ </li>
518
+
519
+ <li>
520
+
521
+ <span class='name'>phone</span>
522
+
523
+
524
+ <span class='type'>(<tt>String</tt>)</span>
525
+
526
+
527
+
528
+ &mdash;
529
+ <div class='inline'>
530
+ <p>phone number associated with this address</p>
531
+ </div>
532
+
533
+ </li>
534
+
535
+ <li>
536
+
537
+ <span class='name'>cid</span>
538
+
539
+
540
+ <span class='type'>(<tt>Integer</tt>)</span>
541
+
542
+
543
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
544
+
545
+
546
+ &mdash;
547
+ <div class='inline'>
548
+ <p>Aceroute customer id, optional; associates this Location with that Customer</p>
549
+ </div>
550
+
551
+ </li>
552
+
553
+ <li>
554
+
555
+ <span class='name'>id</span>
556
+
557
+
558
+ <span class='type'>(<tt>Integer</tt>)</span>
559
+
560
+
561
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
562
+
563
+
564
+ &mdash;
565
+ <div class='inline'>
566
+ <p>Aceroute location id, optional; useful for instantiating Location objects
567
+ from Aceroute API response</p>
568
+ </div>
569
+
570
+ </li>
571
+
572
+ </ul>
573
+
574
+
575
+ </div><table class="source_code">
576
+ <tr>
577
+ <td>
578
+ <pre class="lines">
579
+
580
+
581
+ 22
582
+ 23
583
+ 24
584
+ 25
585
+ 26
586
+ 27
587
+ 28
588
+ 29
589
+ 30</pre>
590
+ </td>
591
+ <td>
592
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 22</span>
593
+
594
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_address1'>address1</span><span class='comma'>,</span> <span class='id identifier rubyid_address2'>address2</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_phone'>phone</span><span class='comma'>,</span> <span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
595
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address1'>address1</span> <span class='op'>=</span> <span class='id identifier rubyid_address1'>address1</span>
596
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address2'>address2</span> <span class='op'>=</span> <span class='id identifier rubyid_address2'>address2</span>
597
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span>
598
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
599
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_phone'>phone</span> <span class='op'>=</span> <span class='id identifier rubyid_phone'>phone</span>
600
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span>
601
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
602
+ <span class='kw'>end</span></pre>
603
+ </td>
604
+ </tr>
605
+ </table>
606
+ </div>
607
+
608
+ </div>
609
+
610
+ <div id="instance_attr_details" class="attr_details">
611
+ <h2>Instance Attribute Details</h2>
612
+
613
+
614
+ <span id="address1=-instance_method"></span>
615
+ <div class="method_details first">
616
+ <h3 class="signature first" id="address1-instance_method">
617
+
618
+ - (<tt>Object</tt>) <strong>address1</strong>
619
+
620
+
621
+
622
+
623
+
624
+ </h3><div class="docstring">
625
+ <div class="discussion">
626
+
627
+ <p>Returns the value of attribute address1</p>
628
+
629
+
630
+ </div>
631
+ </div>
632
+ <div class="tags">
633
+
634
+
635
+ </div><table class="source_code">
636
+ <tr>
637
+ <td>
638
+ <pre class="lines">
639
+
640
+
641
+ 3
642
+ 4
643
+ 5</pre>
644
+ </td>
645
+ <td>
646
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 3</span>
647
+
648
+ <span class='kw'>def</span> <span class='id identifier rubyid_address1'>address1</span>
649
+ <span class='ivar'>@address1</span>
650
+ <span class='kw'>end</span></pre>
651
+ </td>
652
+ </tr>
653
+ </table>
654
+ </div>
655
+
656
+
657
+ <span id="address2=-instance_method"></span>
658
+ <div class="method_details ">
659
+ <h3 class="signature " id="address2-instance_method">
660
+
661
+ - (<tt>Object</tt>) <strong>address2</strong>
662
+
663
+
664
+
665
+
666
+
667
+ </h3><div class="docstring">
668
+ <div class="discussion">
669
+
670
+ <p>Returns the value of attribute address2</p>
671
+
672
+
673
+ </div>
674
+ </div>
675
+ <div class="tags">
676
+
677
+
678
+ </div><table class="source_code">
679
+ <tr>
680
+ <td>
681
+ <pre class="lines">
682
+
683
+
684
+ 4
685
+ 5
686
+ 6</pre>
687
+ </td>
688
+ <td>
689
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 4</span>
690
+
691
+ <span class='kw'>def</span> <span class='id identifier rubyid_address2'>address2</span>
692
+ <span class='ivar'>@address2</span>
693
+ <span class='kw'>end</span></pre>
694
+ </td>
695
+ </tr>
696
+ </table>
697
+ </div>
698
+
699
+
700
+ <span id="cid=-instance_method"></span>
701
+ <div class="method_details ">
702
+ <h3 class="signature " id="cid-instance_method">
703
+
704
+ - (<tt>Object</tt>) <strong>cid</strong>
705
+
706
+
707
+
708
+
709
+
710
+ </h3><div class="docstring">
711
+ <div class="discussion">
712
+
713
+ <p>Returns the value of attribute cid</p>
714
+
715
+
716
+ </div>
717
+ </div>
718
+ <div class="tags">
719
+
720
+
721
+ </div><table class="source_code">
722
+ <tr>
723
+ <td>
724
+ <pre class="lines">
725
+
726
+
727
+ 8
728
+ 9
729
+ 10</pre>
730
+ </td>
731
+ <td>
732
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 8</span>
733
+
734
+ <span class='kw'>def</span> <span class='id identifier rubyid_cid'>cid</span>
735
+ <span class='ivar'>@cid</span>
736
+ <span class='kw'>end</span></pre>
737
+ </td>
738
+ </tr>
739
+ </table>
740
+ </div>
741
+
742
+
743
+ <span id="description=-instance_method"></span>
744
+ <div class="method_details ">
745
+ <h3 class="signature " id="description-instance_method">
746
+
747
+ - (<tt>Object</tt>) <strong>description</strong>
748
+
749
+
750
+
751
+
752
+
753
+ </h3><div class="docstring">
754
+ <div class="discussion">
755
+
756
+ <p>Returns the value of attribute description</p>
757
+
758
+
759
+ </div>
760
+ </div>
761
+ <div class="tags">
762
+
763
+
764
+ </div><table class="source_code">
765
+ <tr>
766
+ <td>
767
+ <pre class="lines">
768
+
769
+
770
+ 5
771
+ 6
772
+ 7</pre>
773
+ </td>
774
+ <td>
775
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 5</span>
776
+
777
+ <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
778
+ <span class='ivar'>@description</span>
779
+ <span class='kw'>end</span></pre>
780
+ </td>
781
+ </tr>
782
+ </table>
783
+ </div>
784
+
785
+
786
+ <span id="id=-instance_method"></span>
787
+ <div class="method_details ">
788
+ <h3 class="signature " id="id-instance_method">
789
+
790
+ - (<tt>Object</tt>) <strong>id</strong>
791
+
792
+
793
+
794
+
795
+
796
+ </h3><div class="docstring">
797
+ <div class="discussion">
798
+
799
+ <p>Returns the value of attribute id</p>
800
+
801
+
802
+ </div>
803
+ </div>
804
+ <div class="tags">
805
+
806
+
807
+ </div><table class="source_code">
808
+ <tr>
809
+ <td>
810
+ <pre class="lines">
811
+
812
+
813
+ 8
814
+ 9
815
+ 10</pre>
816
+ </td>
817
+ <td>
818
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 8</span>
819
+
820
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
821
+ <span class='ivar'>@id</span>
822
+ <span class='kw'>end</span></pre>
823
+ </td>
824
+ </tr>
825
+ </table>
826
+ </div>
827
+
828
+
829
+ <span id="name=-instance_method"></span>
830
+ <div class="method_details ">
831
+ <h3 class="signature " id="name-instance_method">
832
+
833
+ - (<tt>Object</tt>) <strong>name</strong>
834
+
835
+
836
+
837
+
838
+
839
+ </h3><div class="docstring">
840
+ <div class="discussion">
841
+
842
+ <p>Returns the value of attribute name</p>
843
+
844
+
845
+ </div>
846
+ </div>
847
+ <div class="tags">
848
+
849
+
850
+ </div><table class="source_code">
851
+ <tr>
852
+ <td>
853
+ <pre class="lines">
854
+
855
+
856
+ 6
857
+ 7
858
+ 8</pre>
859
+ </td>
860
+ <td>
861
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 6</span>
862
+
863
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
864
+ <span class='ivar'>@name</span>
865
+ <span class='kw'>end</span></pre>
866
+ </td>
867
+ </tr>
868
+ </table>
869
+ </div>
870
+
871
+
872
+ <span id="phone=-instance_method"></span>
873
+ <div class="method_details ">
874
+ <h3 class="signature " id="phone-instance_method">
875
+
876
+ - (<tt>Object</tt>) <strong>phone</strong>
877
+
878
+
879
+
880
+
881
+
882
+ </h3><div class="docstring">
883
+ <div class="discussion">
884
+
885
+ <p>Returns the value of attribute phone</p>
886
+
887
+
888
+ </div>
889
+ </div>
890
+ <div class="tags">
891
+
892
+
893
+ </div><table class="source_code">
894
+ <tr>
895
+ <td>
896
+ <pre class="lines">
897
+
898
+
899
+ 7
900
+ 8
901
+ 9</pre>
902
+ </td>
903
+ <td>
904
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 7</span>
905
+
906
+ <span class='kw'>def</span> <span class='id identifier rubyid_phone'>phone</span>
907
+ <span class='ivar'>@phone</span>
908
+ <span class='kw'>end</span></pre>
909
+ </td>
910
+ </tr>
911
+ </table>
912
+ </div>
913
+
914
+ </div>
915
+
916
+
917
+ <div id="class_method_details" class="method_details_list">
918
+ <h2>Class Method Details</h2>
919
+
920
+
921
+ <div class="method_details first">
922
+ <h3 class="signature first" id="delete-class_method">
923
+
924
+ + (<tt>Object</tt>) <strong>delete</strong>(id)
925
+
926
+
927
+
928
+
929
+
930
+ </h3><div class="docstring">
931
+ <div class="discussion">
932
+
933
+ <p>Deletes Aceroute::Location of given id from Aceroute</p>
934
+
935
+
936
+ </div>
937
+ </div>
938
+ <div class="tags">
939
+ <p class="tag_title">Parameters:</p>
940
+ <ul class="param">
941
+
942
+ <li>
943
+
944
+ <span class='name'>id</span>
945
+
946
+
947
+ <span class='type'>(<tt>Integer</tt>)</span>
948
+
949
+
950
+
951
+ </li>
952
+
953
+ </ul>
954
+
955
+
956
+ </div><table class="source_code">
957
+ <tr>
958
+ <td>
959
+ <pre class="lines">
960
+
961
+
962
+ 55
963
+ 56
964
+ 57
965
+ 58
966
+ 59</pre>
967
+ </td>
968
+ <td>
969
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 55</span>
970
+
971
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
972
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;data&gt;&lt;del&gt;&lt;id&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/id&gt;&lt;/del&gt;&lt;/data&gt;</span><span class='tstring_end'>&quot;</span></span>
973
+ <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>customer.location.delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='rparen'>)</span>
974
+ <span class='id identifier rubyid_ret'>ret</span><span class='period'>.</span><span class='id identifier rubyid_success'>success</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>true</span><span class='tstring_end'>&quot;</span></span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span> <span class='comment'>#maybe raise error here instead
975
+ </span><span class='kw'>end</span></pre>
976
+ </td>
977
+ </tr>
978
+ </table>
979
+ </div>
980
+
981
+ </div>
982
+
983
+ <div id="instance_method_details" class="method_details_list">
984
+ <h2>Instance Method Details</h2>
985
+
986
+
987
+ <div class="method_details first">
988
+ <h3 class="signature first" id="create!-instance_method">
989
+
990
+ - (<tt><span class='object_link'><a href="" title="Aceroute::Location (class)">Aceroute::Location</a></span></tt>) <strong>create!</strong>
991
+
992
+
993
+
994
+
995
+
996
+ </h3><div class="docstring">
997
+ <div class="discussion">
998
+
999
+ <p>Persists Aceroute::Location object to Aceroute API.</p>
1000
+
1001
+
1002
+ </div>
1003
+ </div>
1004
+ <div class="tags">
1005
+
1006
+ <p class="tag_title">Returns:</p>
1007
+ <ul class="return">
1008
+
1009
+ <li>
1010
+
1011
+
1012
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Aceroute::Location (class)">Aceroute::Location</a></span></tt>)</span>
1013
+
1014
+
1015
+
1016
+ </li>
1017
+
1018
+ </ul>
1019
+
1020
+ </div><table class="source_code">
1021
+ <tr>
1022
+ <td>
1023
+ <pre class="lines">
1024
+
1025
+
1026
+ 35
1027
+ 36
1028
+ 37
1029
+ 38
1030
+ 39
1031
+ 40
1032
+ 41
1033
+ 42
1034
+ 43
1035
+ 44
1036
+ 45
1037
+ 46</pre>
1038
+ </td>
1039
+ <td>
1040
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 35</span>
1041
+
1042
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span>
1043
+ <span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;data&gt;&lt;loc&gt;&lt;id&gt;0&lt;/id&gt;
1044
+ &lt;cid&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/cid&gt;
1045
+ &lt;nm&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/nm&gt;
1046
+ &lt;adr&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address1'>address1</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/adr&gt;
1047
+ &lt;adr2&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address2'>address2</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/adr2&gt;
1048
+ &lt;/loc&gt;&lt;/data&gt;</span><span class='tstring_end'>&quot;</span></span>
1049
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>customer.location.save</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
1050
+ <span class='id identifier rubyid_loc'>loc</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_loc'>loc</span>
1051
+ <span class='id identifier rubyid_update_attrs'>update_attrs</span><span class='lparen'>(</span><span class='id identifier rubyid_loc'>loc</span><span class='rparen'>)</span>
1052
+ <span class='kw'>return</span> <span class='kw'>self</span>
1053
+ <span class='kw'>end</span></pre>
1054
+ </td>
1055
+ </tr>
1056
+ </table>
1057
+ </div>
1058
+
1059
+ <div class="method_details ">
1060
+ <h3 class="signature " id="destroy!-instance_method">
1061
+
1062
+ - (<tt>Object</tt>) <strong>destroy!</strong>(id = nil)
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+ </h3><div class="docstring">
1069
+ <div class="discussion">
1070
+
1071
+ <p>Deletes this Aceroute::Location object (self) from Aceroute</p>
1072
+
1073
+
1074
+ </div>
1075
+ </div>
1076
+ <div class="tags">
1077
+
1078
+
1079
+ </div><table class="source_code">
1080
+ <tr>
1081
+ <td>
1082
+ <pre class="lines">
1083
+
1084
+
1085
+ 49
1086
+ 50
1087
+ 51</pre>
1088
+ </td>
1089
+ <td>
1090
+ <pre class="code"><span class="info file"># File 'lib/aceroute/location.rb', line 49</span>
1091
+
1092
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy!'>destroy!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1093
+ <span class='const'>Location</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>?</span> <span class='id identifier rubyid_id'>id</span> <span class='op'>:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1094
+ <span class='kw'>end</span></pre>
1095
+ </td>
1096
+ </tr>
1097
+ </table>
1098
+ </div>
1099
+
1100
+ </div>
1101
+
1102
+ </div>
1103
+
1104
+ <div id="footer">
1105
+ Generated on Sun Dec 4 11:17:52 2016 by
1106
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1107
+ 0.8.7.6 (ruby-2.3.1).
1108
+ </div>
1109
+
1110
+ </body>
1111
+ </html>