helium-ruby 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -0
- data/README.md +3 -3
- data/docs/Helium.html +4 -4
- data/docs/Helium/Client.html +9 -9
- data/docs/Helium/Client/Elements.html +8 -110
- data/docs/Helium/Client/Http.html +31 -33
- data/docs/Helium/Client/Labels.html +38 -218
- data/docs/Helium/Client/Organizations.html +1 -1
- data/docs/Helium/Client/Sensors.html +30 -214
- data/docs/Helium/Client/Users.html +1 -1
- data/docs/Helium/ClientError.html +153 -0
- data/docs/Helium/Cursor.html +8 -8
- data/docs/Helium/DataPoint.html +9 -9
- data/docs/Helium/Element.html +16 -79
- data/docs/Helium/Error.html +267 -0
- data/docs/Helium/InvalidApiKey.html +157 -0
- data/docs/Helium/Label.html +29 -133
- data/docs/Helium/Organization.html +8 -8
- data/docs/Helium/Resource.html +717 -43
- data/docs/Helium/Sensor.html +31 -132
- data/docs/Helium/User.html +8 -8
- data/docs/Helium/Utils.html +1 -1
- data/docs/_index.html +33 -4
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +4 -4
- data/docs/index.html +4 -4
- data/docs/method_list.html +112 -144
- data/docs/top-level-namespace.html +1 -1
- data/lib/helium.rb +1 -0
- data/lib/helium/client.rb +3 -3
- data/lib/helium/client/elements.rb +10 -27
- data/lib/helium/client/http.rb +38 -19
- data/lib/helium/client/labels.rb +7 -53
- data/lib/helium/client/sensors.rb +5 -54
- data/lib/helium/cursor.rb +6 -6
- data/lib/helium/data_point.rb +5 -5
- data/lib/helium/element.rb +7 -8
- data/lib/helium/error.rb +28 -0
- data/lib/helium/label.rb +3 -11
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +103 -5
- data/lib/helium/sensor.rb +13 -15
- data/lib/helium/user.rb +4 -4
- data/lib/helium/version.rb +1 -1
- metadata +6 -2
data/docs/Helium/Resource.html
CHANGED
@@ -156,6 +156,84 @@
|
|
156
156
|
|
157
157
|
|
158
158
|
|
159
|
+
<h2>
|
160
|
+
Class Method Summary
|
161
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
162
|
+
</h2>
|
163
|
+
|
164
|
+
<ul class="summary">
|
165
|
+
|
166
|
+
<li class="public ">
|
167
|
+
<span class="summary_signature">
|
168
|
+
|
169
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong>(opts = {}) ⇒ Array<Resource> </a>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
</span>
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
<span class="summary_desc"><div class='inline'><p>Returns all resources.</p>
|
184
|
+
</div></span>
|
185
|
+
|
186
|
+
</li>
|
187
|
+
|
188
|
+
|
189
|
+
<li class="public ">
|
190
|
+
<span class="summary_signature">
|
191
|
+
|
192
|
+
<a href="#create-class_method" title="create (class method)">.<strong>create</strong>(attributes, opts = {}) ⇒ Resource </a>
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
</span>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
<span class="summary_desc"><div class='inline'><p>Creates a new resource with given attributes.</p>
|
207
|
+
</div></span>
|
208
|
+
|
209
|
+
</li>
|
210
|
+
|
211
|
+
|
212
|
+
<li class="public ">
|
213
|
+
<span class="summary_signature">
|
214
|
+
|
215
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(id, opts = {}) ⇒ Resource </a>
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
</span>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
<span class="summary_desc"><div class='inline'><p>Finds a single Resource by id.</p>
|
230
|
+
</div></span>
|
231
|
+
|
232
|
+
</li>
|
233
|
+
|
234
|
+
|
235
|
+
</ul>
|
236
|
+
|
159
237
|
<h2>
|
160
238
|
Instance Method Summary
|
161
239
|
<small><a href="#" class="summary_toggle">collapse</a></small>
|
@@ -229,6 +307,29 @@
|
|
229
307
|
<span class="summary_desc"><div class='inline'><p>When the resource was created.</p>
|
230
308
|
</div></span>
|
231
309
|
|
310
|
+
</li>
|
311
|
+
|
312
|
+
|
313
|
+
<li class="public ">
|
314
|
+
<span class="summary_signature">
|
315
|
+
|
316
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong> ⇒ Boolean </a>
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
</span>
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
<span class="summary_desc"><div class='inline'><p>Deletes the Resource.</p>
|
331
|
+
</div></span>
|
332
|
+
|
232
333
|
</li>
|
233
334
|
|
234
335
|
|
@@ -281,7 +382,7 @@
|
|
281
382
|
<li class="public ">
|
282
383
|
<span class="summary_signature">
|
283
384
|
|
284
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(
|
385
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) ⇒ Resource </a>
|
285
386
|
|
286
387
|
|
287
388
|
|
@@ -323,6 +424,29 @@
|
|
323
424
|
<span class="summary_desc"><div class='inline'><p>A JSON-encoded String representing the resource.</p>
|
324
425
|
</div></span>
|
325
426
|
|
427
|
+
</li>
|
428
|
+
|
429
|
+
|
430
|
+
<li class="public ">
|
431
|
+
<span class="summary_signature">
|
432
|
+
|
433
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(attributes) ⇒ Resource </a>
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
</span>
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
<span class="summary_desc"><div class='inline'><p>Updates a Resource.</p>
|
448
|
+
</div></span>
|
449
|
+
|
326
450
|
</li>
|
327
451
|
|
328
452
|
|
@@ -358,7 +482,7 @@
|
|
358
482
|
<div class="method_details first">
|
359
483
|
<h3 class="signature first" id="initialize-instance_method">
|
360
484
|
|
361
|
-
#<strong>initialize</strong>(
|
485
|
+
#<strong>initialize</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
362
486
|
|
363
487
|
|
364
488
|
|
@@ -385,16 +509,20 @@
|
|
385
509
|
8
|
386
510
|
9
|
387
511
|
10
|
388
|
-
11
|
512
|
+
11
|
513
|
+
12
|
514
|
+
13</pre>
|
389
515
|
</td>
|
390
516
|
<td>
|
391
517
|
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 6</span>
|
392
518
|
|
393
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='
|
394
|
-
<span class='ivar'>@client</span>
|
395
|
-
<span class='ivar'>@
|
396
|
-
|
397
|
-
<span class='ivar'>@
|
519
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
520
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:client</span><span class='rparen'>)</span>
|
521
|
+
<span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:params</span><span class='rparen'>)</span>
|
522
|
+
|
523
|
+
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>id</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
524
|
+
<span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>created</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
525
|
+
<span class='ivar'>@updated_at</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>updated</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
398
526
|
<span class='kw'>end</span></pre>
|
399
527
|
</td>
|
400
528
|
</tr>
|
@@ -451,6 +579,391 @@
|
|
451
579
|
</div>
|
452
580
|
|
453
581
|
|
582
|
+
<div id="class_method_details" class="method_details_list">
|
583
|
+
<h2>Class Method Details</h2>
|
584
|
+
|
585
|
+
|
586
|
+
<div class="method_details first">
|
587
|
+
<h3 class="signature first" id="all-class_method">
|
588
|
+
|
589
|
+
.<strong>all</strong>(opts = {}) ⇒ <tt>Array<<span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span>></tt>
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
</h3><div class="docstring">
|
596
|
+
<div class="discussion">
|
597
|
+
<p>Returns all resources</p>
|
598
|
+
|
599
|
+
|
600
|
+
</div>
|
601
|
+
</div>
|
602
|
+
<div class="tags">
|
603
|
+
<p class="tag_title">Parameters:</p>
|
604
|
+
<ul class="param">
|
605
|
+
|
606
|
+
<li>
|
607
|
+
|
608
|
+
<span class='name'>opts</span>
|
609
|
+
|
610
|
+
|
611
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
612
|
+
|
613
|
+
|
614
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
615
|
+
|
616
|
+
|
617
|
+
—
|
618
|
+
<div class='inline'><p>a customizable set of options</p>
|
619
|
+
</div>
|
620
|
+
|
621
|
+
</li>
|
622
|
+
|
623
|
+
</ul>
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
629
|
+
<ul class="option">
|
630
|
+
|
631
|
+
<li>
|
632
|
+
<span class="name">:client</span>
|
633
|
+
<span class="type">(<tt><span class='object_link'><a href="Client.html" title="Helium::Client (class)">Client</a></span></tt>)</span>
|
634
|
+
<span class="default">
|
635
|
+
|
636
|
+
</span>
|
637
|
+
|
638
|
+
— <div class='inline'><p>A Helium::Client</p>
|
639
|
+
</div>
|
640
|
+
|
641
|
+
</li>
|
642
|
+
|
643
|
+
</ul>
|
644
|
+
|
645
|
+
|
646
|
+
<p class="tag_title">Returns:</p>
|
647
|
+
<ul class="return">
|
648
|
+
|
649
|
+
<li>
|
650
|
+
|
651
|
+
|
652
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span>></tt>)</span>
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
—
|
657
|
+
<div class='inline'><p>an Array of all of the inheriting Resource</p>
|
658
|
+
</div>
|
659
|
+
|
660
|
+
</li>
|
661
|
+
|
662
|
+
</ul>
|
663
|
+
|
664
|
+
</div><table class="source_code">
|
665
|
+
<tr>
|
666
|
+
<td>
|
667
|
+
<pre class="lines">
|
668
|
+
|
669
|
+
|
670
|
+
23
|
671
|
+
24
|
672
|
+
25
|
673
|
+
26
|
674
|
+
27
|
675
|
+
28
|
676
|
+
29
|
677
|
+
30
|
678
|
+
31
|
679
|
+
32
|
680
|
+
33
|
681
|
+
34</pre>
|
682
|
+
</td>
|
683
|
+
<td>
|
684
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 23</span>
|
685
|
+
|
686
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
687
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:client</span><span class='rparen'>)</span>
|
688
|
+
|
689
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
690
|
+
<span class='id identifier rubyid_resources_data'>resources_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
691
|
+
|
692
|
+
<span class='id identifier rubyid_resources'>resources</span> <span class='op'>=</span> <span class='id identifier rubyid_resources_data'>resources_data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource_data'>resource_data</span><span class='op'>|</span>
|
693
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_resource_data'>resource_data</span><span class='rparen'>)</span>
|
694
|
+
<span class='kw'>end</span>
|
695
|
+
|
696
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_resources'>resources</span>
|
697
|
+
<span class='kw'>end</span></pre>
|
698
|
+
</td>
|
699
|
+
</tr>
|
700
|
+
</table>
|
701
|
+
</div>
|
702
|
+
|
703
|
+
<div class="method_details ">
|
704
|
+
<h3 class="signature " id="create-class_method">
|
705
|
+
|
706
|
+
.<strong>create</strong>(attributes, opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
</h3><div class="docstring">
|
713
|
+
<div class="discussion">
|
714
|
+
<p>Creates a new resource with given attributes</p>
|
715
|
+
|
716
|
+
|
717
|
+
</div>
|
718
|
+
</div>
|
719
|
+
<div class="tags">
|
720
|
+
<p class="tag_title">Parameters:</p>
|
721
|
+
<ul class="param">
|
722
|
+
|
723
|
+
<li>
|
724
|
+
|
725
|
+
<span class='name'>attributes</span>
|
726
|
+
|
727
|
+
|
728
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
729
|
+
|
730
|
+
|
731
|
+
|
732
|
+
—
|
733
|
+
<div class='inline'><p>The attributes for the new Resource</p>
|
734
|
+
</div>
|
735
|
+
|
736
|
+
</li>
|
737
|
+
|
738
|
+
<li>
|
739
|
+
|
740
|
+
<span class='name'>opts</span>
|
741
|
+
|
742
|
+
|
743
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
744
|
+
|
745
|
+
|
746
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
747
|
+
|
748
|
+
|
749
|
+
—
|
750
|
+
<div class='inline'><p>a customizable set of options</p>
|
751
|
+
</div>
|
752
|
+
|
753
|
+
</li>
|
754
|
+
|
755
|
+
</ul>
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
|
762
|
+
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
763
|
+
<ul class="option">
|
764
|
+
|
765
|
+
<li>
|
766
|
+
<span class="name">:client</span>
|
767
|
+
<span class="type">(<tt><span class='object_link'><a href="Client.html" title="Helium::Client (class)">Client</a></span></tt>)</span>
|
768
|
+
<span class="default">
|
769
|
+
|
770
|
+
</span>
|
771
|
+
|
772
|
+
— <div class='inline'><p>A Helium::Client</p>
|
773
|
+
</div>
|
774
|
+
|
775
|
+
</li>
|
776
|
+
|
777
|
+
</ul>
|
778
|
+
|
779
|
+
|
780
|
+
<p class="tag_title">Returns:</p>
|
781
|
+
<ul class="return">
|
782
|
+
|
783
|
+
<li>
|
784
|
+
|
785
|
+
|
786
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>)</span>
|
787
|
+
|
788
|
+
|
789
|
+
|
790
|
+
</li>
|
791
|
+
|
792
|
+
</ul>
|
793
|
+
|
794
|
+
</div><table class="source_code">
|
795
|
+
<tr>
|
796
|
+
<td>
|
797
|
+
<pre class="lines">
|
798
|
+
|
799
|
+
|
800
|
+
53
|
801
|
+
54
|
802
|
+
55
|
803
|
+
56
|
804
|
+
57
|
805
|
+
58
|
806
|
+
59
|
807
|
+
60
|
808
|
+
61
|
809
|
+
62
|
810
|
+
63
|
811
|
+
64
|
812
|
+
65
|
813
|
+
66
|
814
|
+
67
|
815
|
+
68
|
816
|
+
69</pre>
|
817
|
+
</td>
|
818
|
+
<td>
|
819
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 53</span>
|
820
|
+
|
821
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
822
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:client</span><span class='rparen'>)</span>
|
823
|
+
|
824
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
825
|
+
|
826
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
827
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
828
|
+
<span class='label'>attributes:</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
|
829
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
830
|
+
<span class='rbrace'>}</span>
|
831
|
+
<span class='rbrace'>}</span>
|
832
|
+
|
833
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</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='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
834
|
+
<span class='id identifier rubyid_resource_data'>resource_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
835
|
+
|
836
|
+
<span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_resource_data'>resource_data</span><span class='rparen'>)</span>
|
837
|
+
<span class='kw'>end</span></pre>
|
838
|
+
</td>
|
839
|
+
</tr>
|
840
|
+
</table>
|
841
|
+
</div>
|
842
|
+
|
843
|
+
<div class="method_details ">
|
844
|
+
<h3 class="signature " id="find-class_method">
|
845
|
+
|
846
|
+
.<strong>find</strong>(id, opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
847
|
+
|
848
|
+
|
849
|
+
|
850
|
+
|
851
|
+
|
852
|
+
</h3><div class="docstring">
|
853
|
+
<div class="discussion">
|
854
|
+
<p>Finds a single Resource by id</p>
|
855
|
+
|
856
|
+
|
857
|
+
</div>
|
858
|
+
</div>
|
859
|
+
<div class="tags">
|
860
|
+
<p class="tag_title">Parameters:</p>
|
861
|
+
<ul class="param">
|
862
|
+
|
863
|
+
<li>
|
864
|
+
|
865
|
+
<span class='name'>id</span>
|
866
|
+
|
867
|
+
|
868
|
+
<span class='type'>(<tt>String</tt>)</span>
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
—
|
873
|
+
<div class='inline'><p>An id to find the Resource</p>
|
874
|
+
</div>
|
875
|
+
|
876
|
+
</li>
|
877
|
+
|
878
|
+
<li>
|
879
|
+
|
880
|
+
<span class='name'>opts</span>
|
881
|
+
|
882
|
+
|
883
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
884
|
+
|
885
|
+
|
886
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
887
|
+
|
888
|
+
|
889
|
+
—
|
890
|
+
<div class='inline'><p>a customizable set of options</p>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
</li>
|
894
|
+
|
895
|
+
</ul>
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
903
|
+
<ul class="option">
|
904
|
+
|
905
|
+
<li>
|
906
|
+
<span class="name">:client</span>
|
907
|
+
<span class="type">(<tt><span class='object_link'><a href="Client.html" title="Helium::Client (class)">Client</a></span></tt>)</span>
|
908
|
+
<span class="default">
|
909
|
+
|
910
|
+
</span>
|
911
|
+
|
912
|
+
— <div class='inline'><p>A Helium::Client</p>
|
913
|
+
</div>
|
914
|
+
|
915
|
+
</li>
|
916
|
+
|
917
|
+
</ul>
|
918
|
+
|
919
|
+
|
920
|
+
<p class="tag_title">Returns:</p>
|
921
|
+
<ul class="return">
|
922
|
+
|
923
|
+
<li>
|
924
|
+
|
925
|
+
|
926
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>)</span>
|
927
|
+
|
928
|
+
|
929
|
+
|
930
|
+
</li>
|
931
|
+
|
932
|
+
</ul>
|
933
|
+
|
934
|
+
</div><table class="source_code">
|
935
|
+
<tr>
|
936
|
+
<td>
|
937
|
+
<pre class="lines">
|
938
|
+
|
939
|
+
|
940
|
+
40
|
941
|
+
41
|
942
|
+
42
|
943
|
+
43
|
944
|
+
44
|
945
|
+
45
|
946
|
+
46
|
947
|
+
47</pre>
|
948
|
+
</td>
|
949
|
+
<td>
|
950
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 40</span>
|
951
|
+
|
952
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
953
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:client</span><span class='rparen'>)</span>
|
954
|
+
|
955
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
956
|
+
<span class='id identifier rubyid_resource_data'>resource_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
957
|
+
|
958
|
+
<span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_resource_data'>resource_data</span><span class='rparen'>)</span>
|
959
|
+
<span class='kw'>end</span></pre>
|
960
|
+
</td>
|
961
|
+
</tr>
|
962
|
+
</table>
|
963
|
+
</div>
|
964
|
+
|
965
|
+
</div>
|
966
|
+
|
454
967
|
<div id="instance_method_details" class="method_details_list">
|
455
968
|
<h2>Instance Method Details</h2>
|
456
969
|
|
@@ -493,12 +1006,12 @@
|
|
493
1006
|
<pre class="lines">
|
494
1007
|
|
495
1008
|
|
496
|
-
|
497
|
-
|
498
|
-
|
1009
|
+
107
|
1010
|
+
108
|
1011
|
+
109</pre>
|
499
1012
|
</td>
|
500
1013
|
<td>
|
501
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1014
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 107</span>
|
502
1015
|
|
503
1016
|
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
504
1017
|
<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_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
|
@@ -550,16 +1063,16 @@
|
|
550
1063
|
<pre class="lines">
|
551
1064
|
|
552
1065
|
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
1066
|
+
137
|
1067
|
+
138
|
1068
|
+
139
|
1069
|
+
140
|
1070
|
+
141
|
1071
|
+
142
|
1072
|
+
143</pre>
|
560
1073
|
</td>
|
561
1074
|
<td>
|
562
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1075
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 137</span>
|
563
1076
|
|
564
1077
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
565
1078
|
<span class='lbrace'>{</span>
|
@@ -615,13 +1128,13 @@
|
|
615
1128
|
<pre class="lines">
|
616
1129
|
|
617
1130
|
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
1131
|
+
124
|
1132
|
+
125
|
1133
|
+
126
|
1134
|
+
127</pre>
|
622
1135
|
</td>
|
623
1136
|
<td>
|
624
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1137
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 124</span>
|
625
1138
|
|
626
1139
|
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
627
1140
|
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@created_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
@@ -630,6 +1143,65 @@
|
|
630
1143
|
</td>
|
631
1144
|
</tr>
|
632
1145
|
</table>
|
1146
|
+
</div>
|
1147
|
+
|
1148
|
+
<div class="method_details ">
|
1149
|
+
<h3 class="signature " id="destroy-instance_method">
|
1150
|
+
|
1151
|
+
#<strong>destroy</strong> ⇒ <tt>Boolean</tt>
|
1152
|
+
|
1153
|
+
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1157
|
+
</h3><div class="docstring">
|
1158
|
+
<div class="discussion">
|
1159
|
+
<p>Deletes the Resource</p>
|
1160
|
+
|
1161
|
+
|
1162
|
+
</div>
|
1163
|
+
</div>
|
1164
|
+
<div class="tags">
|
1165
|
+
|
1166
|
+
<p class="tag_title">Returns:</p>
|
1167
|
+
<ul class="return">
|
1168
|
+
|
1169
|
+
<li>
|
1170
|
+
|
1171
|
+
|
1172
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1173
|
+
|
1174
|
+
|
1175
|
+
|
1176
|
+
—
|
1177
|
+
<div class='inline'><p>Whether the operation was successful</p>
|
1178
|
+
</div>
|
1179
|
+
|
1180
|
+
</li>
|
1181
|
+
|
1182
|
+
</ul>
|
1183
|
+
|
1184
|
+
</div><table class="source_code">
|
1185
|
+
<tr>
|
1186
|
+
<td>
|
1187
|
+
<pre class="lines">
|
1188
|
+
|
1189
|
+
|
1190
|
+
100
|
1191
|
+
101
|
1192
|
+
102
|
1193
|
+
103</pre>
|
1194
|
+
</td>
|
1195
|
+
<td>
|
1196
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 100</span>
|
1197
|
+
|
1198
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
|
1199
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1200
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
1201
|
+
<span class='kw'>end</span></pre>
|
1202
|
+
</td>
|
1203
|
+
</tr>
|
1204
|
+
</table>
|
633
1205
|
</div>
|
634
1206
|
|
635
1207
|
<div class="method_details ">
|
@@ -670,12 +1242,12 @@
|
|
670
1242
|
<pre class="lines">
|
671
1243
|
|
672
1244
|
|
673
|
-
|
674
|
-
|
675
|
-
|
1245
|
+
113
|
1246
|
+
114
|
1247
|
+
115</pre>
|
676
1248
|
</td>
|
677
1249
|
<td>
|
678
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1250
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 113</span>
|
679
1251
|
|
680
1252
|
<span class='kw'>def</span> <span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
681
1253
|
<span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
|
@@ -723,12 +1295,12 @@
|
|
723
1295
|
<pre class="lines">
|
724
1296
|
|
725
1297
|
|
726
|
-
|
727
|
-
|
728
|
-
|
1298
|
+
119
|
1299
|
+
120
|
1300
|
+
121</pre>
|
729
1301
|
</td>
|
730
1302
|
<td>
|
731
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1303
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 119</span>
|
732
1304
|
|
733
1305
|
<span class='kw'>def</span> <span class='id identifier rubyid_hash'>hash</span>
|
734
1306
|
<span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span>
|
@@ -780,12 +1352,12 @@
|
|
780
1352
|
<pre class="lines">
|
781
1353
|
|
782
1354
|
|
783
|
-
|
784
|
-
|
785
|
-
|
1355
|
+
146
|
1356
|
+
147
|
1357
|
+
148</pre>
|
786
1358
|
</td>
|
787
1359
|
<td>
|
788
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1360
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 146</span>
|
789
1361
|
|
790
1362
|
<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
791
1363
|
<span class='id identifier rubyid_as_json'>as_json</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
@@ -793,6 +1365,108 @@
|
|
793
1365
|
</td>
|
794
1366
|
</tr>
|
795
1367
|
</table>
|
1368
|
+
</div>
|
1369
|
+
|
1370
|
+
<div class="method_details ">
|
1371
|
+
<h3 class="signature " id="update-instance_method">
|
1372
|
+
|
1373
|
+
#<strong>update</strong>(attributes) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
1374
|
+
|
1375
|
+
|
1376
|
+
|
1377
|
+
|
1378
|
+
|
1379
|
+
</h3><div class="docstring">
|
1380
|
+
<div class="discussion">
|
1381
|
+
<p>Updates a Resource</p>
|
1382
|
+
|
1383
|
+
|
1384
|
+
</div>
|
1385
|
+
</div>
|
1386
|
+
<div class="tags">
|
1387
|
+
<p class="tag_title">Parameters:</p>
|
1388
|
+
<ul class="param">
|
1389
|
+
|
1390
|
+
<li>
|
1391
|
+
|
1392
|
+
<span class='name'>attributes</span>
|
1393
|
+
|
1394
|
+
|
1395
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1396
|
+
|
1397
|
+
|
1398
|
+
|
1399
|
+
—
|
1400
|
+
<div class='inline'><p>The attributes to update</p>
|
1401
|
+
</div>
|
1402
|
+
|
1403
|
+
</li>
|
1404
|
+
|
1405
|
+
</ul>
|
1406
|
+
|
1407
|
+
<p class="tag_title">Returns:</p>
|
1408
|
+
<ul class="return">
|
1409
|
+
|
1410
|
+
<li>
|
1411
|
+
|
1412
|
+
|
1413
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>)</span>
|
1414
|
+
|
1415
|
+
|
1416
|
+
|
1417
|
+
—
|
1418
|
+
<div class='inline'><p>The updated resource</p>
|
1419
|
+
</div>
|
1420
|
+
|
1421
|
+
</li>
|
1422
|
+
|
1423
|
+
</ul>
|
1424
|
+
|
1425
|
+
</div><table class="source_code">
|
1426
|
+
<tr>
|
1427
|
+
<td>
|
1428
|
+
<pre class="lines">
|
1429
|
+
|
1430
|
+
|
1431
|
+
81
|
1432
|
+
82
|
1433
|
+
83
|
1434
|
+
84
|
1435
|
+
85
|
1436
|
+
86
|
1437
|
+
87
|
1438
|
+
88
|
1439
|
+
89
|
1440
|
+
90
|
1441
|
+
91
|
1442
|
+
92
|
1443
|
+
93
|
1444
|
+
94
|
1445
|
+
95
|
1446
|
+
96</pre>
|
1447
|
+
</td>
|
1448
|
+
<td>
|
1449
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 81</span>
|
1450
|
+
|
1451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
1452
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1453
|
+
|
1454
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1455
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
1456
|
+
<span class='label'>attributes:</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
|
1457
|
+
<span class='label'>id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1458
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
1459
|
+
<span class='rbrace'>}</span>
|
1460
|
+
<span class='rbrace'>}</span>
|
1461
|
+
|
1462
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
1463
|
+
<span class='id identifier rubyid_resource_data'>resource_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1464
|
+
|
1465
|
+
<span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_resource_data'>resource_data</span><span class='rparen'>)</span>
|
1466
|
+
<span class='kw'>end</span></pre>
|
1467
|
+
</td>
|
1468
|
+
</tr>
|
1469
|
+
</table>
|
796
1470
|
</div>
|
797
1471
|
|
798
1472
|
<div class="method_details ">
|
@@ -837,13 +1511,13 @@
|
|
837
1511
|
<pre class="lines">
|
838
1512
|
|
839
1513
|
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
1514
|
+
130
|
1515
|
+
131
|
1516
|
+
132
|
1517
|
+
133</pre>
|
844
1518
|
</td>
|
845
1519
|
<td>
|
846
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1520
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 130</span>
|
847
1521
|
|
848
1522
|
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
849
1523
|
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@updated_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
@@ -859,7 +1533,7 @@
|
|
859
1533
|
</div>
|
860
1534
|
|
861
1535
|
<div id="footer">
|
862
|
-
Generated on
|
1536
|
+
Generated on Wed Aug 24 13:22:51 2016 by
|
863
1537
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
864
1538
|
0.9.3 (ruby-2.3.1).
|
865
1539
|
</div>
|