helium-ruby 0.20.0 → 0.21.0
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.
- checksums.yaml +4 -4
- data/README.md +47 -0
- data/docs/Helium.html +6 -6
- data/docs/Helium/Client.html +62 -34
- data/docs/Helium/Client/Configurations.html +296 -0
- data/docs/Helium/Client/DeviceConfigurations.html +465 -0
- data/docs/Helium/Client/Elements.html +92 -18
- data/docs/Helium/Client/Http.html +86 -28
- data/docs/Helium/Client/Labels.html +29 -86
- data/docs/Helium/Client/Organizations.html +5 -75
- data/docs/Helium/Client/Sensors.html +147 -17
- data/docs/Helium/Client/Users.html +5 -9
- data/docs/Helium/ClientError.html +3 -3
- data/docs/Helium/Collection.html +1053 -0
- data/docs/Helium/Configuration.html +380 -0
- data/docs/Helium/Cursor.html +7 -3
- data/docs/Helium/DataPoint.html +16 -5
- data/docs/Helium/DeviceConfiguration.html +476 -0
- data/docs/Helium/Element.html +203 -43
- data/docs/Helium/Error.html +15 -5
- data/docs/Helium/InvalidApiKey.html +3 -3
- data/docs/Helium/Label.html +35 -36
- data/docs/Helium/Metadata.html +589 -0
- data/docs/Helium/Organization.html +236 -17
- data/docs/Helium/Resource.html +655 -161
- data/docs/Helium/Sensor.html +345 -111
- data/docs/Helium/Timeseries.html +354 -0
- data/docs/Helium/User.html +161 -18
- data/docs/Helium/Utils.html +56 -4
- data/docs/_index.html +72 -7
- data/docs/class_list.html +1 -1
- data/docs/css/style.css +8 -1
- data/docs/file.README.html +66 -6
- data/docs/frames.html +1 -1
- data/docs/index.html +66 -6
- data/docs/method_list.html +619 -139
- data/docs/top-level-namespace.html +3 -3
- data/lib/helium.rb +2 -0
- data/lib/helium/client/configurations.rb +0 -12
- data/lib/helium/client/elements.rb +0 -12
- data/lib/helium/client/labels.rb +1 -12
- data/lib/helium/client/organizations.rb +1 -47
- data/lib/helium/client/sensors.rb +0 -12
- data/lib/helium/client/users.rb +1 -3
- data/lib/helium/collection.rb +129 -0
- data/lib/helium/configuration.rb +5 -1
- data/lib/helium/element.rb +1 -1
- data/lib/helium/label.rb +1 -3
- data/lib/helium/metadata.rb +58 -0
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +28 -29
- data/lib/helium/sensor.rb +1 -1
- data/lib/helium/version.rb +1 -1
- metadata +11 -2
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Helium::Organization
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -173,7 +173,7 @@
|
|
173
173
|
|
174
174
|
|
175
175
|
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
176
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
176
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#params-instance_method" title="Helium::Resource#params (method)">#params</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
177
177
|
|
178
178
|
|
179
179
|
|
@@ -201,6 +201,28 @@
|
|
201
201
|
|
202
202
|
|
203
203
|
|
204
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
205
|
+
|
206
|
+
</li>
|
207
|
+
|
208
|
+
|
209
|
+
<li class="public ">
|
210
|
+
<span class="summary_signature">
|
211
|
+
|
212
|
+
<a href="#elements-instance_method" title="#elements (instance method)">#<strong>elements</strong> ⇒ Object </a>
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
</span>
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
204
226
|
<span class="summary_desc"><div class='inline'></div></span>
|
205
227
|
|
206
228
|
</li>
|
@@ -228,6 +250,72 @@
|
|
228
250
|
<span class="summary_desc"><div class='inline'><p>A new instance of Organization.</p>
|
229
251
|
</div></span>
|
230
252
|
|
253
|
+
</li>
|
254
|
+
|
255
|
+
|
256
|
+
<li class="public ">
|
257
|
+
<span class="summary_signature">
|
258
|
+
|
259
|
+
<a href="#labels-instance_method" title="#labels (instance method)">#<strong>labels</strong> ⇒ Object </a>
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</span>
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
274
|
+
|
275
|
+
</li>
|
276
|
+
|
277
|
+
|
278
|
+
<li class="public ">
|
279
|
+
<span class="summary_signature">
|
280
|
+
|
281
|
+
<a href="#resource_path-instance_method" title="#resource_path (instance method)">#<strong>resource_path</strong> ⇒ Object </a>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
</span>
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
296
|
+
|
297
|
+
</li>
|
298
|
+
|
299
|
+
|
300
|
+
<li class="public ">
|
301
|
+
<span class="summary_signature">
|
302
|
+
|
303
|
+
<a href="#sensors-instance_method" title="#sensors (instance method)">#<strong>sensors</strong> ⇒ Object </a>
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
</span>
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
318
|
+
|
231
319
|
</li>
|
232
320
|
|
233
321
|
|
@@ -267,7 +355,18 @@
|
|
267
355
|
|
268
356
|
|
269
357
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
270
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
358
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#all_path-class_method" title="Helium::Resource.all_path (method)">all_path</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#initialize_from_path-class_method" title="Helium::Resource.initialize_from_path (method)">initialize_from_path</a></span>, <span class='object_link'><a href="Resource.html#metadata-instance_method" title="Helium::Resource#metadata (method)">#metadata</a></span>, <span class='object_link'><a href="Resource.html#resource_name-class_method" title="Helium::Resource.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Resource.html#resource_name-instance_method" title="Helium::Resource#resource_name (method)">#resource_name</a></span>, <span class='object_link'><a href="Resource.html#singleton-class_method" title="Helium::Resource.singleton (method)">singleton</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
369
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">#kebab_case</a></span></p>
|
271
370
|
<div id="constructor_details" class="method_details_list">
|
272
371
|
<h2>Constructor Details</h2>
|
273
372
|
|
@@ -428,15 +527,15 @@
|
|
428
527
|
<pre class="lines">
|
429
528
|
|
430
529
|
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
530
|
+
33
|
531
|
+
34
|
532
|
+
35
|
533
|
+
36
|
534
|
+
37
|
535
|
+
38</pre>
|
437
536
|
</td>
|
438
537
|
<td>
|
439
|
-
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line
|
538
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 33</span>
|
440
539
|
|
441
540
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
442
541
|
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
@@ -447,6 +546,126 @@
|
|
447
546
|
</td>
|
448
547
|
</tr>
|
449
548
|
</table>
|
549
|
+
</div>
|
550
|
+
|
551
|
+
<div class="method_details ">
|
552
|
+
<h3 class="signature " id="elements-instance_method">
|
553
|
+
|
554
|
+
#<strong>elements</strong> ⇒ <tt>Object</tt>
|
555
|
+
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
</h3><table class="source_code">
|
561
|
+
<tr>
|
562
|
+
<td>
|
563
|
+
<pre class="lines">
|
564
|
+
|
565
|
+
|
566
|
+
25
|
567
|
+
26
|
568
|
+
27</pre>
|
569
|
+
</td>
|
570
|
+
<td>
|
571
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 25</span>
|
572
|
+
|
573
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_elements'>elements</span>
|
574
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='const'>Element</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>belongs_to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
575
|
+
<span class='kw'>end</span></pre>
|
576
|
+
</td>
|
577
|
+
</tr>
|
578
|
+
</table>
|
579
|
+
</div>
|
580
|
+
|
581
|
+
<div class="method_details ">
|
582
|
+
<h3 class="signature " id="labels-instance_method">
|
583
|
+
|
584
|
+
#<strong>labels</strong> ⇒ <tt>Object</tt>
|
585
|
+
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
|
590
|
+
</h3><table class="source_code">
|
591
|
+
<tr>
|
592
|
+
<td>
|
593
|
+
<pre class="lines">
|
594
|
+
|
595
|
+
|
596
|
+
21
|
597
|
+
22
|
598
|
+
23</pre>
|
599
|
+
</td>
|
600
|
+
<td>
|
601
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 21</span>
|
602
|
+
|
603
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
|
604
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='const'>Label</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>belongs_to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
605
|
+
<span class='kw'>end</span></pre>
|
606
|
+
</td>
|
607
|
+
</tr>
|
608
|
+
</table>
|
609
|
+
</div>
|
610
|
+
|
611
|
+
<div class="method_details ">
|
612
|
+
<h3 class="signature " id="resource_path-instance_method">
|
613
|
+
|
614
|
+
#<strong>resource_path</strong> ⇒ <tt>Object</tt>
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
</h3><table class="source_code">
|
621
|
+
<tr>
|
622
|
+
<td>
|
623
|
+
<pre class="lines">
|
624
|
+
|
625
|
+
|
626
|
+
12
|
627
|
+
13
|
628
|
+
14</pre>
|
629
|
+
</td>
|
630
|
+
<td>
|
631
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 12</span>
|
632
|
+
|
633
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_path'>resource_path</span>
|
634
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organization</span><span class='tstring_end'>"</span></span>
|
635
|
+
<span class='kw'>end</span></pre>
|
636
|
+
</td>
|
637
|
+
</tr>
|
638
|
+
</table>
|
639
|
+
</div>
|
640
|
+
|
641
|
+
<div class="method_details ">
|
642
|
+
<h3 class="signature " id="sensors-instance_method">
|
643
|
+
|
644
|
+
#<strong>sensors</strong> ⇒ <tt>Object</tt>
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
</h3><table class="source_code">
|
651
|
+
<tr>
|
652
|
+
<td>
|
653
|
+
<pre class="lines">
|
654
|
+
|
655
|
+
|
656
|
+
29
|
657
|
+
30
|
658
|
+
31</pre>
|
659
|
+
</td>
|
660
|
+
<td>
|
661
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 29</span>
|
662
|
+
|
663
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
664
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='const'>Sensor</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>belongs_to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
665
|
+
<span class='kw'>end</span></pre>
|
666
|
+
</td>
|
667
|
+
</tr>
|
668
|
+
</table>
|
450
669
|
</div>
|
451
670
|
|
452
671
|
<div class="method_details ">
|
@@ -474,15 +693,15 @@
|
|
474
693
|
<pre class="lines">
|
475
694
|
|
476
695
|
|
477
|
-
|
478
|
-
|
479
|
-
|
696
|
+
17
|
697
|
+
18
|
698
|
+
19</pre>
|
480
699
|
</td>
|
481
700
|
<td>
|
482
|
-
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line
|
701
|
+
<pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 17</span>
|
483
702
|
|
484
703
|
<span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
|
485
|
-
<span class='
|
704
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='const'>User</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>belongs_to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
486
705
|
<span class='kw'>end</span></pre>
|
487
706
|
</td>
|
488
707
|
</tr>
|
@@ -494,9 +713,9 @@
|
|
494
713
|
</div>
|
495
714
|
|
496
715
|
<div id="footer">
|
497
|
-
Generated on Thu
|
716
|
+
Generated on Thu Jan 12 15:58:35 2017 by
|
498
717
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
499
|
-
0.9.
|
718
|
+
0.9.5 (ruby-2.3.1).
|
500
719
|
</div>
|
501
720
|
|
502
721
|
</div>
|
data/docs/Helium/Resource.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Helium::Resource
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -87,8 +87,18 @@
|
|
87
87
|
|
88
88
|
|
89
89
|
|
90
|
+
<dl>
|
91
|
+
<dt>Extended by:</dt>
|
92
|
+
<dd><span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></dd>
|
93
|
+
</dl>
|
94
|
+
|
90
95
|
|
91
96
|
|
97
|
+
<dl>
|
98
|
+
<dt>Includes:</dt>
|
99
|
+
<dd><span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></dd>
|
100
|
+
</dl>
|
101
|
+
|
92
102
|
|
93
103
|
|
94
104
|
|
@@ -113,7 +123,7 @@
|
|
113
123
|
|
114
124
|
</div><div id="subclasses">
|
115
125
|
<h2>Direct Known Subclasses</h2>
|
116
|
-
<p class="children"><span class='object_link'><a href="DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span>, <span class='object_link'><a href="Element.html" title="Helium::Element (class)">Element</a></span>, <span class='object_link'><a href="Label.html" title="Helium::Label (class)">Label</a></span>, <span class='object_link'><a href="Organization.html" title="Helium::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Sensor.html" title="Helium::Sensor (class)">Sensor</a></span>, <span class='object_link'><a href="User.html" title="Helium::User (class)">User</a></span></p>
|
126
|
+
<p class="children"><span class='object_link'><a href="Configuration.html" title="Helium::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span>, <span class='object_link'><a href="DeviceConfiguration.html" title="Helium::DeviceConfiguration (class)">DeviceConfiguration</a></span>, <span class='object_link'><a href="Element.html" title="Helium::Element (class)">Element</a></span>, <span class='object_link'><a href="Label.html" title="Helium::Label (class)">Label</a></span>, <span class='object_link'><a href="Organization.html" title="Helium::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Sensor.html" title="Helium::Sensor (class)">Sensor</a></span>, <span class='object_link'><a href="User.html" title="Helium::User (class)">User</a></span></p>
|
117
127
|
</div>
|
118
128
|
|
119
129
|
|
@@ -147,6 +157,34 @@
|
|
147
157
|
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
|
148
158
|
</div></span>
|
149
159
|
|
160
|
+
</li>
|
161
|
+
|
162
|
+
|
163
|
+
<li class="public ">
|
164
|
+
<span class="summary_signature">
|
165
|
+
|
166
|
+
<a href="#params-instance_method" title="#params (instance method)">#<strong>params</strong> ⇒ Object </a>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
</span>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<span class="note title readonly">readonly</span>
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute params.</p>
|
186
|
+
</div></span>
|
187
|
+
|
150
188
|
</li>
|
151
189
|
|
152
190
|
|
@@ -194,7 +232,7 @@
|
|
194
232
|
<li class="public ">
|
195
233
|
<span class="summary_signature">
|
196
234
|
|
197
|
-
<a href="#all-class_method" title="all (class method)">.<strong>all</strong>(opts = {}) ⇒
|
235
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong>(opts = {}) ⇒ Object </a>
|
198
236
|
|
199
237
|
|
200
238
|
|
@@ -208,7 +246,29 @@
|
|
208
246
|
|
209
247
|
|
210
248
|
|
211
|
-
<span class="summary_desc"><div class='inline'
|
249
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
250
|
+
|
251
|
+
</li>
|
252
|
+
|
253
|
+
|
254
|
+
<li class="public ">
|
255
|
+
<span class="summary_signature">
|
256
|
+
|
257
|
+
<a href="#all_path-class_method" title="all_path (class method)">.<strong>all_path</strong> ⇒ String </a>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
</span>
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
<span class="summary_desc"><div class='inline'><p>The resource's index API route.</p>
|
212
272
|
</div></span>
|
213
273
|
|
214
274
|
</li>
|
@@ -257,6 +317,73 @@
|
|
257
317
|
<span class="summary_desc"><div class='inline'><p>Finds a single Resource by id.</p>
|
258
318
|
</div></span>
|
259
319
|
|
320
|
+
</li>
|
321
|
+
|
322
|
+
|
323
|
+
<li class="public ">
|
324
|
+
<span class="summary_signature">
|
325
|
+
|
326
|
+
<a href="#initialize_from_path-class_method" title="initialize_from_path (class method)">.<strong>initialize_from_path</strong>(opts = {}) ⇒ Object </a>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
</span>
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
341
|
+
|
342
|
+
</li>
|
343
|
+
|
344
|
+
|
345
|
+
<li class="public ">
|
346
|
+
<span class="summary_signature">
|
347
|
+
|
348
|
+
<a href="#resource_name-class_method" title="resource_name (class method)">.<strong>resource_name</strong> ⇒ Object </a>
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
</span>
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
363
|
+
|
364
|
+
</li>
|
365
|
+
|
366
|
+
|
367
|
+
<li class="public ">
|
368
|
+
<span class="summary_signature">
|
369
|
+
|
370
|
+
<a href="#singleton-class_method" title="singleton (class method)">.<strong>singleton</strong>(opts = {}) ⇒ Resource </a>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
</span>
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
<span class="summary_desc"><div class='inline'><p>Fetches a singleton resource (e.g. organization, user).</p>
|
385
|
+
</div></span>
|
386
|
+
|
260
387
|
</li>
|
261
388
|
|
262
389
|
|
@@ -429,6 +556,73 @@
|
|
429
556
|
<span class="summary_desc"><div class='inline'><p>A new instance of Resource.</p>
|
430
557
|
</div></span>
|
431
558
|
|
559
|
+
</li>
|
560
|
+
|
561
|
+
|
562
|
+
<li class="public ">
|
563
|
+
<span class="summary_signature">
|
564
|
+
|
565
|
+
<a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong> ⇒ Object </a>
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
</span>
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
580
|
+
|
581
|
+
</li>
|
582
|
+
|
583
|
+
|
584
|
+
<li class="public ">
|
585
|
+
<span class="summary_signature">
|
586
|
+
|
587
|
+
<a href="#resource_name-instance_method" title="#resource_name (instance method)">#<strong>resource_name</strong> ⇒ Object </a>
|
588
|
+
|
589
|
+
|
590
|
+
|
591
|
+
</span>
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
602
|
+
|
603
|
+
</li>
|
604
|
+
|
605
|
+
|
606
|
+
<li class="public ">
|
607
|
+
<span class="summary_signature">
|
608
|
+
|
609
|
+
<a href="#resource_path-instance_method" title="#resource_path (instance method)">#<strong>resource_path</strong> ⇒ String </a>
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
</span>
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
|
623
|
+
<span class="summary_desc"><div class='inline'><p>Returns a path identifying the current resource.</p>
|
624
|
+
</div></span>
|
625
|
+
|
432
626
|
</li>
|
433
627
|
|
434
628
|
|
@@ -504,6 +698,17 @@
|
|
504
698
|
</ul>
|
505
699
|
|
506
700
|
|
701
|
+
|
702
|
+
|
703
|
+
|
704
|
+
|
705
|
+
|
706
|
+
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
711
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">kebab_case</a></span></p>
|
507
712
|
<div id="constructor_details" class="method_details_list">
|
508
713
|
<h2>Constructor Details</h2>
|
509
714
|
|
@@ -532,7 +737,6 @@
|
|
532
737
|
<pre class="lines">
|
533
738
|
|
534
739
|
|
535
|
-
6
|
536
740
|
7
|
537
741
|
8
|
538
742
|
9
|
@@ -540,10 +744,11 @@
|
|
540
744
|
11
|
541
745
|
12
|
542
746
|
13
|
543
|
-
14
|
747
|
+
14
|
748
|
+
15</pre>
|
544
749
|
</td>
|
545
750
|
<td>
|
546
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
751
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 7</span>
|
547
752
|
|
548
753
|
<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>
|
549
754
|
<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>
|
@@ -607,6 +812,48 @@
|
|
607
812
|
</div>
|
608
813
|
|
609
814
|
|
815
|
+
<span id=""></span>
|
816
|
+
<div class="method_details ">
|
817
|
+
<h3 class="signature " id="params-instance_method">
|
818
|
+
|
819
|
+
#<strong>params</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
|
824
|
+
|
825
|
+
</h3><div class="docstring">
|
826
|
+
<div class="discussion">
|
827
|
+
<p>Returns the value of attribute params</p>
|
828
|
+
|
829
|
+
|
830
|
+
</div>
|
831
|
+
</div>
|
832
|
+
<div class="tags">
|
833
|
+
|
834
|
+
|
835
|
+
</div><table class="source_code">
|
836
|
+
<tr>
|
837
|
+
<td>
|
838
|
+
<pre class="lines">
|
839
|
+
|
840
|
+
|
841
|
+
4
|
842
|
+
5
|
843
|
+
6</pre>
|
844
|
+
</td>
|
845
|
+
<td>
|
846
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 4</span>
|
847
|
+
|
848
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
|
849
|
+
<span class='ivar'>@params</span>
|
850
|
+
<span class='kw'>end</span></pre>
|
851
|
+
</td>
|
852
|
+
</tr>
|
853
|
+
</table>
|
854
|
+
</div>
|
855
|
+
|
856
|
+
|
610
857
|
<span id=""></span>
|
611
858
|
<div class="method_details ">
|
612
859
|
<h3 class="signature " id="type-instance_method">
|
@@ -658,7 +905,96 @@
|
|
658
905
|
<div class="method_details first">
|
659
906
|
<h3 class="signature first" id="all-class_method">
|
660
907
|
|
661
|
-
.<strong>all</strong>(opts = {}) ⇒ <tt>
|
908
|
+
.<strong>all</strong>(opts = {}) ⇒ <tt>Object</tt>
|
909
|
+
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
</h3><table class="source_code">
|
915
|
+
<tr>
|
916
|
+
<td>
|
917
|
+
<pre class="lines">
|
918
|
+
|
919
|
+
|
920
|
+
26
|
921
|
+
27
|
922
|
+
28
|
923
|
+
29</pre>
|
924
|
+
</td>
|
925
|
+
<td>
|
926
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 26</span>
|
927
|
+
|
928
|
+
<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>
|
929
|
+
<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>
|
930
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
931
|
+
<span class='kw'>end</span></pre>
|
932
|
+
</td>
|
933
|
+
</tr>
|
934
|
+
</table>
|
935
|
+
</div>
|
936
|
+
|
937
|
+
<div class="method_details ">
|
938
|
+
<h3 class="signature " id="all_path-class_method">
|
939
|
+
|
940
|
+
.<strong>all_path</strong> ⇒ <tt>String</tt>
|
941
|
+
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
</h3><div class="docstring">
|
947
|
+
<div class="discussion">
|
948
|
+
<p>The resource's index API route</p>
|
949
|
+
|
950
|
+
|
951
|
+
</div>
|
952
|
+
</div>
|
953
|
+
<div class="tags">
|
954
|
+
|
955
|
+
<p class="tag_title">Returns:</p>
|
956
|
+
<ul class="return">
|
957
|
+
|
958
|
+
<li>
|
959
|
+
|
960
|
+
|
961
|
+
<span class='type'>(<tt>String</tt>)</span>
|
962
|
+
|
963
|
+
|
964
|
+
|
965
|
+
—
|
966
|
+
<div class='inline'><p>path to resource's index</p>
|
967
|
+
</div>
|
968
|
+
|
969
|
+
</li>
|
970
|
+
|
971
|
+
</ul>
|
972
|
+
|
973
|
+
</div><table class="source_code">
|
974
|
+
<tr>
|
975
|
+
<td>
|
976
|
+
<pre class="lines">
|
977
|
+
|
978
|
+
|
979
|
+
22
|
980
|
+
23
|
981
|
+
24</pre>
|
982
|
+
</td>
|
983
|
+
<td>
|
984
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 22</span>
|
985
|
+
|
986
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all_path'>all_path</span>
|
987
|
+
<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>
|
988
|
+
<span class='kw'>end</span></pre>
|
989
|
+
</td>
|
990
|
+
</tr>
|
991
|
+
</table>
|
992
|
+
</div>
|
993
|
+
|
994
|
+
<div class="method_details ">
|
995
|
+
<h3 class="signature " id="create-class_method">
|
996
|
+
|
997
|
+
.<strong>create</strong>(attributes, opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
662
998
|
|
663
999
|
|
664
1000
|
|
@@ -666,7 +1002,7 @@
|
|
666
1002
|
|
667
1003
|
</h3><div class="docstring">
|
668
1004
|
<div class="discussion">
|
669
|
-
<p>
|
1005
|
+
<p>Creates a new resource with given attributes</p>
|
670
1006
|
|
671
1007
|
|
672
1008
|
</div>
|
@@ -675,6 +1011,21 @@
|
|
675
1011
|
<p class="tag_title">Parameters:</p>
|
676
1012
|
<ul class="param">
|
677
1013
|
|
1014
|
+
<li>
|
1015
|
+
|
1016
|
+
<span class='name'>attributes</span>
|
1017
|
+
|
1018
|
+
|
1019
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
1023
|
+
—
|
1024
|
+
<div class='inline'><p>The attributes for the new Resource</p>
|
1025
|
+
</div>
|
1026
|
+
|
1027
|
+
</li>
|
1028
|
+
|
678
1029
|
<li>
|
679
1030
|
|
680
1031
|
<span class='name'>opts</span>
|
@@ -697,6 +1048,8 @@
|
|
697
1048
|
|
698
1049
|
|
699
1050
|
|
1051
|
+
|
1052
|
+
|
700
1053
|
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
701
1054
|
<ul class="option">
|
702
1055
|
|
@@ -721,13 +1074,9 @@
|
|
721
1074
|
<li>
|
722
1075
|
|
723
1076
|
|
724
|
-
<span class='type'>(<tt
|
725
|
-
|
1077
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>)</span>
|
726
1078
|
|
727
1079
|
|
728
|
-
—
|
729
|
-
<div class='inline'><p>an Array of all of the inheriting Resource</p>
|
730
|
-
</div>
|
731
1080
|
|
732
1081
|
</li>
|
733
1082
|
|
@@ -739,33 +1088,43 @@
|
|
739
1088
|
<pre class="lines">
|
740
1089
|
|
741
1090
|
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
1091
|
+
52
|
1092
|
+
53
|
1093
|
+
54
|
1094
|
+
55
|
1095
|
+
56
|
1096
|
+
57
|
1097
|
+
58
|
1098
|
+
59
|
1099
|
+
60
|
1100
|
+
61
|
1101
|
+
62
|
1102
|
+
63
|
1103
|
+
64
|
1104
|
+
65
|
1105
|
+
66
|
1106
|
+
67
|
1107
|
+
68</pre>
|
754
1108
|
</td>
|
755
1109
|
<td>
|
756
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1110
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 52</span>
|
757
1111
|
|
758
|
-
<span class='kw'>def</span> <span class='id identifier
|
1112
|
+
<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>
|
759
1113
|
<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>
|
760
1114
|
|
761
|
-
<span class='id identifier
|
762
|
-
|
1115
|
+
<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>
|
1116
|
+
|
1117
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1118
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
1119
|
+
<span class='label'>attributes:</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
|
1120
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
1121
|
+
<span class='rbrace'>}</span>
|
1122
|
+
<span class='rbrace'>}</span>
|
763
1123
|
|
764
|
-
<span class='id identifier
|
765
|
-
|
766
|
-
<span class='kw'>end</span>
|
1124
|
+
<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>
|
1125
|
+
<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>
|
767
1126
|
|
768
|
-
<span class='kw'>return</span> <span class='id identifier
|
1127
|
+
<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>
|
769
1128
|
<span class='kw'>end</span></pre>
|
770
1129
|
</td>
|
771
1130
|
</tr>
|
@@ -773,9 +1132,9 @@
|
|
773
1132
|
</div>
|
774
1133
|
|
775
1134
|
<div class="method_details ">
|
776
|
-
<h3 class="signature " id="
|
1135
|
+
<h3 class="signature " id="find-class_method">
|
777
1136
|
|
778
|
-
.<strong>
|
1137
|
+
.<strong>find</strong>(id, opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
779
1138
|
|
780
1139
|
|
781
1140
|
|
@@ -783,7 +1142,7 @@
|
|
783
1142
|
|
784
1143
|
</h3><div class="docstring">
|
785
1144
|
<div class="discussion">
|
786
|
-
<p>
|
1145
|
+
<p>Finds a single Resource by id</p>
|
787
1146
|
|
788
1147
|
|
789
1148
|
</div>
|
@@ -794,15 +1153,15 @@
|
|
794
1153
|
|
795
1154
|
<li>
|
796
1155
|
|
797
|
-
<span class='name'>
|
1156
|
+
<span class='name'>id</span>
|
798
1157
|
|
799
1158
|
|
800
|
-
<span class='type'>(<tt>
|
1159
|
+
<span class='type'>(<tt>String</tt>)</span>
|
801
1160
|
|
802
1161
|
|
803
1162
|
|
804
1163
|
—
|
805
|
-
<div class='inline'><p>
|
1164
|
+
<div class='inline'><p>An id to find the Resource</p>
|
806
1165
|
</div>
|
807
1166
|
|
808
1167
|
</li>
|
@@ -869,42 +1228,56 @@
|
|
869
1228
|
<pre class="lines">
|
870
1229
|
|
871
1230
|
|
872
|
-
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
58
|
877
|
-
59
|
878
|
-
60
|
879
|
-
61
|
880
|
-
62
|
881
|
-
63
|
882
|
-
64
|
883
|
-
65
|
884
|
-
66
|
885
|
-
67
|
886
|
-
68
|
887
|
-
69
|
888
|
-
70</pre>
|
1231
|
+
35
|
1232
|
+
36
|
1233
|
+
37
|
1234
|
+
38</pre>
|
889
1235
|
</td>
|
890
1236
|
<td>
|
891
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1237
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 35</span>
|
892
1238
|
|
893
|
-
<span class='kw'>def</span> <span class='id identifier
|
1239
|
+
<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>
|
894
1240
|
<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>
|
1241
|
+
<span class='id identifier rubyid_initialize_from_path'>initialize_from_path</span><span class='lparen'>(</span><span class='label'>path:</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='comma'>,</span> <span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
|
1242
|
+
<span class='kw'>end</span></pre>
|
1243
|
+
</td>
|
1244
|
+
</tr>
|
1245
|
+
</table>
|
1246
|
+
</div>
|
1247
|
+
|
1248
|
+
<div class="method_details ">
|
1249
|
+
<h3 class="signature " id="initialize_from_path-class_method">
|
1250
|
+
|
1251
|
+
.<strong>initialize_from_path</strong>(opts = {}) ⇒ <tt>Object</tt>
|
1252
|
+
|
895
1253
|
|
896
|
-
|
1254
|
+
|
897
1255
|
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
<span class='rbrace'>}</span>
|
1256
|
+
|
1257
|
+
</h3><table class="source_code">
|
1258
|
+
<tr>
|
1259
|
+
<td>
|
1260
|
+
<pre class="lines">
|
904
1261
|
|
905
|
-
<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>
|
906
|
-
<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>
|
907
1262
|
|
1263
|
+
74
|
1264
|
+
75
|
1265
|
+
76
|
1266
|
+
77
|
1267
|
+
78
|
1268
|
+
79
|
1269
|
+
80
|
1270
|
+
81</pre>
|
1271
|
+
</td>
|
1272
|
+
<td>
|
1273
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 74</span>
|
1274
|
+
|
1275
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_from_path'>initialize_from_path</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>
|
1276
|
+
<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>
|
1277
|
+
<span class='id identifier rubyid_path'>path</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'>:path</span><span class='rparen'>)</span>
|
1278
|
+
|
1279
|
+
<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='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
1280
|
+
<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>
|
908
1281
|
<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>
|
909
1282
|
<span class='kw'>end</span></pre>
|
910
1283
|
</td>
|
@@ -913,9 +1286,39 @@
|
|
913
1286
|
</div>
|
914
1287
|
|
915
1288
|
<div class="method_details ">
|
916
|
-
<h3 class="signature " id="
|
1289
|
+
<h3 class="signature " id="resource_name-class_method">
|
917
1290
|
|
918
|
-
.<strong>
|
1291
|
+
.<strong>resource_name</strong> ⇒ <tt>Object</tt>
|
1292
|
+
|
1293
|
+
|
1294
|
+
|
1295
|
+
|
1296
|
+
|
1297
|
+
</h3><table class="source_code">
|
1298
|
+
<tr>
|
1299
|
+
<td>
|
1300
|
+
<pre class="lines">
|
1301
|
+
|
1302
|
+
|
1303
|
+
70
|
1304
|
+
71
|
1305
|
+
72</pre>
|
1306
|
+
</td>
|
1307
|
+
<td>
|
1308
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 70</span>
|
1309
|
+
|
1310
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
1311
|
+
<span class='id identifier rubyid_kebab_case'>kebab_case</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>::</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
|
1312
|
+
<span class='kw'>end</span></pre>
|
1313
|
+
</td>
|
1314
|
+
</tr>
|
1315
|
+
</table>
|
1316
|
+
</div>
|
1317
|
+
|
1318
|
+
<div class="method_details ">
|
1319
|
+
<h3 class="signature " id="singleton-class_method">
|
1320
|
+
|
1321
|
+
.<strong>singleton</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
|
919
1322
|
|
920
1323
|
|
921
1324
|
|
@@ -923,7 +1326,7 @@
|
|
923
1326
|
|
924
1327
|
</h3><div class="docstring">
|
925
1328
|
<div class="discussion">
|
926
|
-
<p>
|
1329
|
+
<p>Fetches a singleton resource (e.g. organization, user)</p>
|
927
1330
|
|
928
1331
|
|
929
1332
|
</div>
|
@@ -932,21 +1335,6 @@
|
|
932
1335
|
<p class="tag_title">Parameters:</p>
|
933
1336
|
<ul class="param">
|
934
1337
|
|
935
|
-
<li>
|
936
|
-
|
937
|
-
<span class='name'>id</span>
|
938
|
-
|
939
|
-
|
940
|
-
<span class='type'>(<tt>String</tt>)</span>
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
—
|
945
|
-
<div class='inline'><p>An id to find the Resource</p>
|
946
|
-
</div>
|
947
|
-
|
948
|
-
</li>
|
949
|
-
|
950
1338
|
<li>
|
951
1339
|
|
952
1340
|
<span class='name'>opts</span>
|
@@ -969,8 +1357,6 @@
|
|
969
1357
|
|
970
1358
|
|
971
1359
|
|
972
|
-
|
973
|
-
|
974
1360
|
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
975
1361
|
<ul class="option">
|
976
1362
|
|
@@ -999,6 +1385,10 @@
|
|
999
1385
|
|
1000
1386
|
|
1001
1387
|
|
1388
|
+
—
|
1389
|
+
<div class='inline'><p>A singleton resource</p>
|
1390
|
+
</div>
|
1391
|
+
|
1002
1392
|
</li>
|
1003
1393
|
|
1004
1394
|
</ul>
|
@@ -1009,25 +1399,17 @@
|
|
1009
1399
|
<pre class="lines">
|
1010
1400
|
|
1011
1401
|
|
1012
|
-
41
|
1013
|
-
42
|
1014
1402
|
43
|
1015
1403
|
44
|
1016
1404
|
45
|
1017
|
-
46
|
1018
|
-
47
|
1019
|
-
48</pre>
|
1405
|
+
46</pre>
|
1020
1406
|
</td>
|
1021
1407
|
<td>
|
1022
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1408
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 43</span>
|
1023
1409
|
|
1024
|
-
<span class='kw'>def</span> <span class='id identifier
|
1410
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_singleton'>singleton</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>
|
1025
1411
|
<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>
|
1026
|
-
|
1027
|
-
<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>
|
1028
|
-
<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>
|
1029
|
-
|
1030
|
-
<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>
|
1412
|
+
<span class='id identifier rubyid_initialize_from_path'>initialize_from_path</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='id identifier rubyid_all_path'>all_path</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
|
1031
1413
|
<span class='kw'>end</span></pre>
|
1032
1414
|
</td>
|
1033
1415
|
</tr>
|
@@ -1078,12 +1460,12 @@
|
|
1078
1460
|
<pre class="lines">
|
1079
1461
|
|
1080
1462
|
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1463
|
+
121
|
1464
|
+
122
|
1465
|
+
123</pre>
|
1084
1466
|
</td>
|
1085
1467
|
<td>
|
1086
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1468
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 121</span>
|
1087
1469
|
|
1088
1470
|
<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>
|
1089
1471
|
<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>
|
@@ -1135,17 +1517,17 @@
|
|
1135
1517
|
<pre class="lines">
|
1136
1518
|
|
1137
1519
|
|
1138
|
-
|
1139
|
-
|
1140
|
-
|
1141
|
-
|
1142
|
-
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1520
|
+
151
|
1521
|
+
152
|
1522
|
+
153
|
1523
|
+
154
|
1524
|
+
155
|
1525
|
+
156
|
1526
|
+
157
|
1527
|
+
158</pre>
|
1146
1528
|
</td>
|
1147
1529
|
<td>
|
1148
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1530
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 151</span>
|
1149
1531
|
|
1150
1532
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
1151
1533
|
<span class='lbrace'>{</span>
|
@@ -1202,13 +1584,13 @@
|
|
1202
1584
|
<pre class="lines">
|
1203
1585
|
|
1204
1586
|
|
1205
|
-
|
1206
|
-
|
1207
|
-
|
1208
|
-
|
1587
|
+
138
|
1588
|
+
139
|
1589
|
+
140
|
1590
|
+
141</pre>
|
1209
1591
|
</td>
|
1210
1592
|
<td>
|
1211
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1593
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 138</span>
|
1212
1594
|
|
1213
1595
|
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
1214
1596
|
<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>
|
@@ -1261,17 +1643,15 @@
|
|
1261
1643
|
<pre class="lines">
|
1262
1644
|
|
1263
1645
|
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
104</pre>
|
1646
|
+
111
|
1647
|
+
112
|
1648
|
+
113</pre>
|
1268
1649
|
</td>
|
1269
1650
|
<td>
|
1270
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1651
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 111</span>
|
1271
1652
|
|
1272
1653
|
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
|
1273
|
-
<span class='
|
1274
|
-
<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>
|
1654
|
+
<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_resource_path'>resource_path</span><span class='rparen'>)</span>
|
1275
1655
|
<span class='kw'>end</span></pre>
|
1276
1656
|
</td>
|
1277
1657
|
</tr>
|
@@ -1316,12 +1696,12 @@
|
|
1316
1696
|
<pre class="lines">
|
1317
1697
|
|
1318
1698
|
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1699
|
+
127
|
1700
|
+
128
|
1701
|
+
129</pre>
|
1322
1702
|
</td>
|
1323
1703
|
<td>
|
1324
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1704
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 127</span>
|
1325
1705
|
|
1326
1706
|
<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>
|
1327
1707
|
<span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
|
@@ -1369,12 +1749,12 @@
|
|
1369
1749
|
<pre class="lines">
|
1370
1750
|
|
1371
1751
|
|
1372
|
-
|
1373
|
-
|
1374
|
-
|
1752
|
+
133
|
1753
|
+
134
|
1754
|
+
135</pre>
|
1375
1755
|
</td>
|
1376
1756
|
<td>
|
1377
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1757
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 133</span>
|
1378
1758
|
|
1379
1759
|
<span class='kw'>def</span> <span class='id identifier rubyid_hash'>hash</span>
|
1380
1760
|
<span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span>
|
@@ -1382,6 +1762,124 @@
|
|
1382
1762
|
</td>
|
1383
1763
|
</tr>
|
1384
1764
|
</table>
|
1765
|
+
</div>
|
1766
|
+
|
1767
|
+
<div class="method_details ">
|
1768
|
+
<h3 class="signature " id="metadata-instance_method">
|
1769
|
+
|
1770
|
+
#<strong>metadata</strong> ⇒ <tt>Object</tt>
|
1771
|
+
|
1772
|
+
|
1773
|
+
|
1774
|
+
|
1775
|
+
|
1776
|
+
</h3><table class="source_code">
|
1777
|
+
<tr>
|
1778
|
+
<td>
|
1779
|
+
<pre class="lines">
|
1780
|
+
|
1781
|
+
|
1782
|
+
115
|
1783
|
+
116
|
1784
|
+
117</pre>
|
1785
|
+
</td>
|
1786
|
+
<td>
|
1787
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 115</span>
|
1788
|
+
|
1789
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
1790
|
+
<span class='const'>Metadata</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>klass:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
1791
|
+
<span class='kw'>end</span></pre>
|
1792
|
+
</td>
|
1793
|
+
</tr>
|
1794
|
+
</table>
|
1795
|
+
</div>
|
1796
|
+
|
1797
|
+
<div class="method_details ">
|
1798
|
+
<h3 class="signature " id="resource_name-instance_method">
|
1799
|
+
|
1800
|
+
#<strong>resource_name</strong> ⇒ <tt>Object</tt>
|
1801
|
+
|
1802
|
+
|
1803
|
+
|
1804
|
+
|
1805
|
+
|
1806
|
+
</h3><table class="source_code">
|
1807
|
+
<tr>
|
1808
|
+
<td>
|
1809
|
+
<pre class="lines">
|
1810
|
+
|
1811
|
+
|
1812
|
+
165
|
1813
|
+
166
|
1814
|
+
167</pre>
|
1815
|
+
</td>
|
1816
|
+
<td>
|
1817
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 165</span>
|
1818
|
+
|
1819
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
1820
|
+
<span class='id identifier rubyid_kebab_case'>kebab_case</span><span class='lparen'>(</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_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>::</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
|
1821
|
+
<span class='kw'>end</span></pre>
|
1822
|
+
</td>
|
1823
|
+
</tr>
|
1824
|
+
</table>
|
1825
|
+
</div>
|
1826
|
+
|
1827
|
+
<div class="method_details ">
|
1828
|
+
<h3 class="signature " id="resource_path-instance_method">
|
1829
|
+
|
1830
|
+
#<strong>resource_path</strong> ⇒ <tt>String</tt>
|
1831
|
+
|
1832
|
+
|
1833
|
+
|
1834
|
+
|
1835
|
+
|
1836
|
+
</h3><div class="docstring">
|
1837
|
+
<div class="discussion">
|
1838
|
+
<p>Returns a path identifying the current resource. Can be overridden
|
1839
|
+
in child classes to handle non-standard resources (e.g. Organization)</p>
|
1840
|
+
|
1841
|
+
|
1842
|
+
</div>
|
1843
|
+
</div>
|
1844
|
+
<div class="tags">
|
1845
|
+
|
1846
|
+
<p class="tag_title">Returns:</p>
|
1847
|
+
<ul class="return">
|
1848
|
+
|
1849
|
+
<li>
|
1850
|
+
|
1851
|
+
|
1852
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1853
|
+
|
1854
|
+
|
1855
|
+
|
1856
|
+
—
|
1857
|
+
<div class='inline'><p>path to resource</p>
|
1858
|
+
</div>
|
1859
|
+
|
1860
|
+
</li>
|
1861
|
+
|
1862
|
+
</ul>
|
1863
|
+
|
1864
|
+
</div><table class="source_code">
|
1865
|
+
<tr>
|
1866
|
+
<td>
|
1867
|
+
<pre class="lines">
|
1868
|
+
|
1869
|
+
|
1870
|
+
87
|
1871
|
+
88
|
1872
|
+
89</pre>
|
1873
|
+
</td>
|
1874
|
+
<td>
|
1875
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 87</span>
|
1876
|
+
|
1877
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_path'>resource_path</span>
|
1878
|
+
<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>
|
1879
|
+
<span class='kw'>end</span></pre>
|
1880
|
+
</td>
|
1881
|
+
</tr>
|
1882
|
+
</table>
|
1385
1883
|
</div>
|
1386
1884
|
|
1387
1885
|
<div class="method_details ">
|
@@ -1426,12 +1924,12 @@
|
|
1426
1924
|
<pre class="lines">
|
1427
1925
|
|
1428
1926
|
|
1429
|
-
|
1430
|
-
|
1431
|
-
|
1927
|
+
161
|
1928
|
+
162
|
1929
|
+
163</pre>
|
1432
1930
|
</td>
|
1433
1931
|
<td>
|
1434
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
1932
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 161</span>
|
1435
1933
|
|
1436
1934
|
<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>
|
1437
1935
|
<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>
|
@@ -1502,29 +2000,25 @@
|
|
1502
2000
|
<pre class="lines">
|
1503
2001
|
|
1504
2002
|
|
1505
|
-
82
|
1506
|
-
83
|
1507
|
-
84
|
1508
|
-
85
|
1509
|
-
86
|
1510
|
-
87
|
1511
|
-
88
|
1512
|
-
89
|
1513
|
-
90
|
1514
|
-
91
|
1515
|
-
92
|
1516
|
-
93
|
1517
2003
|
94
|
1518
2004
|
95
|
1519
2005
|
96
|
1520
|
-
97
|
2006
|
+
97
|
2007
|
+
98
|
2008
|
+
99
|
2009
|
+
100
|
2010
|
+
101
|
2011
|
+
102
|
2012
|
+
103
|
2013
|
+
104
|
2014
|
+
105
|
2015
|
+
106
|
2016
|
+
107</pre>
|
1521
2017
|
</td>
|
1522
2018
|
<td>
|
1523
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
2019
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 94</span>
|
1524
2020
|
|
1525
2021
|
<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>
|
1526
|
-
<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>
|
1527
|
-
|
1528
2022
|
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1529
2023
|
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
1530
2024
|
<span class='label'>attributes:</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span>
|
@@ -1533,7 +2027,7 @@
|
|
1533
2027
|
<span class='rbrace'>}</span>
|
1534
2028
|
<span class='rbrace'>}</span>
|
1535
2029
|
|
1536
|
-
<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
|
2030
|
+
<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_resource_path'>resource_path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
1537
2031
|
<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>
|
1538
2032
|
|
1539
2033
|
<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>
|
@@ -1585,13 +2079,13 @@
|
|
1585
2079
|
<pre class="lines">
|
1586
2080
|
|
1587
2081
|
|
1588
|
-
|
1589
|
-
|
1590
|
-
|
1591
|
-
|
2082
|
+
144
|
2083
|
+
145
|
2084
|
+
146
|
2085
|
+
147</pre>
|
1592
2086
|
</td>
|
1593
2087
|
<td>
|
1594
|
-
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line
|
2088
|
+
<pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 144</span>
|
1595
2089
|
|
1596
2090
|
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
1597
2091
|
<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>
|
@@ -1607,9 +2101,9 @@
|
|
1607
2101
|
</div>
|
1608
2102
|
|
1609
2103
|
<div id="footer">
|
1610
|
-
Generated on Thu
|
2104
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
1611
2105
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1612
|
-
0.9.
|
2106
|
+
0.9.5 (ruby-2.3.1).
|
1613
2107
|
</div>
|
1614
2108
|
|
1615
2109
|
</div>
|