helium-ruby 0.3.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -71,11 +71,13 @@
71
71
  <dl>
72
72
  <dt>Inherits:</dt>
73
73
  <dd>
74
- <span class="inheritName">Object</span>
74
+ <span class="inheritName"><span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></span>
75
75
 
76
76
  <ul class="fullTree">
77
77
  <li>Object</li>
78
78
 
79
+ <li class="next"><span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></li>
80
+
79
81
  <li class="next">Helium::Organization</li>
80
82
 
81
83
  </ul>
@@ -111,7 +113,7 @@
111
113
  <li class="public ">
112
114
  <span class="summary_signature">
113
115
 
114
- <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
116
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
115
117
 
116
118
 
117
119
 
@@ -120,6 +122,8 @@
120
122
 
121
123
 
122
124
 
125
+ <span class="note title readonly">readonly</span>
126
+
123
127
 
124
128
 
125
129
 
@@ -128,7 +132,7 @@
128
132
 
129
133
 
130
134
 
131
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute created_at.</p>
135
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
132
136
  </div></span>
133
137
 
134
138
  </li>
@@ -137,7 +141,7 @@
137
141
  <li class="public ">
138
142
  <span class="summary_signature">
139
143
 
140
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
144
+ <a href="#timezone-instance_method" title="#timezone (instance method)">#<strong>timezone</strong> &#x21d2; Object </a>
141
145
 
142
146
 
143
147
 
@@ -146,6 +150,8 @@
146
150
 
147
151
 
148
152
 
153
+ <span class="note title readonly">readonly</span>
154
+
149
155
 
150
156
 
151
157
 
@@ -154,68 +160,34 @@
154
160
 
155
161
 
156
162
 
157
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
163
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute timezone.</p>
158
164
  </div></span>
159
165
 
160
166
  </li>
161
167
 
162
168
 
163
- <li class="public ">
164
- <span class="summary_signature">
165
-
166
- <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
167
-
168
-
169
-
170
- </span>
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
169
+ </ul>
181
170
 
182
-
183
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
184
- </div></span>
185
-
186
- </li>
187
171
 
188
-
189
- <li class="public ">
190
- <span class="summary_signature">
191
-
192
- <a href="#timezone-instance_method" title="#timezone (instance method)">#<strong>timezone</strong> &#x21d2; Object </a>
193
-
194
172
 
195
-
196
- </span>
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
173
 
206
174
 
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></p>
177
+
207
178
 
208
179
 
209
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute timezone.</p>
210
- </div></span>
211
-
212
- </li>
180
+ <h2>
181
+ Instance Method Summary
182
+ <small><a href="#" class="summary_toggle">collapse</a></small>
183
+ </h2>
213
184
 
214
-
215
- <li class="public ">
185
+ <ul class="summary">
186
+
187
+ <li class="public ">
216
188
  <span class="summary_signature">
217
189
 
218
- <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> &#x21d2; Object </a>
190
+ <a href="#as_json-instance_method" title="#as_json (instance method)">#<strong>as_json</strong> &#x21d2; Object </a>
219
191
 
220
192
 
221
193
 
@@ -223,33 +195,16 @@
223
195
 
224
196
 
225
197
 
226
-
227
-
228
-
229
198
 
230
199
 
231
200
 
232
201
 
233
202
 
234
203
 
235
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute updated_at.</p>
236
- </div></span>
204
+ <span class="summary_desc"><div class='inline'></div></span>
237
205
 
238
206
  </li>
239
207
 
240
-
241
- </ul>
242
-
243
-
244
-
245
-
246
-
247
- <h2>
248
- Instance Method Summary
249
- <small><a href="#" class="summary_toggle">collapse</a></small>
250
- </h2>
251
-
252
- <ul class="summary">
253
208
 
254
209
  <li class="public ">
255
210
  <span class="summary_signature">
@@ -302,6 +257,17 @@
302
257
  </ul>
303
258
 
304
259
 
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ <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#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</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#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#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
305
271
  <div id="constructor_details" class="method_details_list">
306
272
  <h2>Constructor Details</h2>
307
273
 
@@ -335,20 +301,16 @@
335
301
  7
336
302
  8
337
303
  9
338
- 10
339
- 11
340
- 12</pre>
304
+ 10</pre>
341
305
  </td>
342
306
  <td>
343
307
  <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 5</span>
344
308
 
345
309
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>params:</span><span class='rparen'>)</span>
346
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
347
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
348
- <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attributes</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>name</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
349
- <span class='ivar'>@timezone</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attributes</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>timezone</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
350
- <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>meta</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>created</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
351
- <span class='ivar'>@updated_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>meta</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>updated</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
310
+ <span class='kw'>super</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_params'>params</span><span class='rparen'>)</span>
311
+
312
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>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'>&#39;</span><span class='tstring_content'>attributes</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
313
+ <span class='ivar'>@timezone</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>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'>&#39;</span><span class='tstring_content'>attributes</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>timezone</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
352
314
  <span class='kw'>end</span></pre>
353
315
  </td>
354
316
  </tr>
@@ -361,95 +323,11 @@
361
323
  <h2>Instance Attribute Details</h2>
362
324
 
363
325
 
364
- <span id="created_at=-instance_method"></span>
326
+ <span id=""></span>
365
327
  <div class="method_details first">
366
- <h3 class="signature first" id="created_at-instance_method">
328
+ <h3 class="signature first" id="name-instance_method">
367
329
 
368
- #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
369
-
370
-
371
-
372
-
373
-
374
- </h3><div class="docstring">
375
- <div class="discussion">
376
- <p>Returns the value of attribute created_at</p>
377
-
378
-
379
- </div>
380
- </div>
381
- <div class="tags">
382
-
383
-
384
- </div><table class="source_code">
385
- <tr>
386
- <td>
387
- <pre class="lines">
388
-
389
-
390
- 3
391
- 4
392
- 5</pre>
393
- </td>
394
- <td>
395
- <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 3</span>
396
-
397
- <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
398
- <span class='ivar'>@created_at</span>
399
- <span class='kw'>end</span></pre>
400
- </td>
401
- </tr>
402
- </table>
403
- </div>
404
-
405
-
406
- <span id="id=-instance_method"></span>
407
- <div class="method_details ">
408
- <h3 class="signature " id="id-instance_method">
409
-
410
- #<strong>id</strong> &#x21d2; <tt>Object</tt>
411
-
412
-
413
-
414
-
415
-
416
- </h3><div class="docstring">
417
- <div class="discussion">
418
- <p>Returns the value of attribute id</p>
419
-
420
-
421
- </div>
422
- </div>
423
- <div class="tags">
424
-
425
-
426
- </div><table class="source_code">
427
- <tr>
428
- <td>
429
- <pre class="lines">
430
-
431
-
432
- 3
433
- 4
434
- 5</pre>
435
- </td>
436
- <td>
437
- <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 3</span>
438
-
439
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
440
- <span class='ivar'>@id</span>
441
- <span class='kw'>end</span></pre>
442
- </td>
443
- </tr>
444
- </table>
445
- </div>
446
-
447
-
448
- <span id="name=-instance_method"></span>
449
- <div class="method_details ">
450
- <h3 class="signature " id="name-instance_method">
451
-
452
- #<strong>name</strong> &#x21d2; <tt>Object</tt>
330
+ #<strong>name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
453
331
 
454
332
 
455
333
 
@@ -487,11 +365,11 @@
487
365
  </div>
488
366
 
489
367
 
490
- <span id="timezone=-instance_method"></span>
368
+ <span id=""></span>
491
369
  <div class="method_details ">
492
370
  <h3 class="signature " id="timezone-instance_method">
493
371
 
494
- #<strong>timezone</strong> &#x21d2; <tt>Object</tt>
372
+ #<strong>timezone</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
495
373
 
496
374
 
497
375
 
@@ -528,57 +406,51 @@
528
406
  </table>
529
407
  </div>
530
408
 
531
-
532
- <span id="updated_at=-instance_method"></span>
533
- <div class="method_details ">
534
- <h3 class="signature " id="updated_at-instance_method">
535
-
536
- #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
537
-
409
+ </div>
538
410
 
539
-
540
411
 
541
-
542
- </h3><div class="docstring">
543
- <div class="discussion">
544
- <p>Returns the value of attribute updated_at</p>
412
+ <div id="instance_method_details" class="method_details_list">
413
+ <h2>Instance Method Details</h2>
545
414
 
415
+
416
+ <div class="method_details first">
417
+ <h3 class="signature first" id="as_json-instance_method">
418
+
419
+ #<strong>as_json</strong> &#x21d2; <tt>Object</tt>
420
+
546
421
 
547
- </div>
548
- </div>
549
- <div class="tags">
550
422
 
551
423
 
552
- </div><table class="source_code">
424
+
425
+ </h3><table class="source_code">
553
426
  <tr>
554
427
  <td>
555
428
  <pre class="lines">
556
429
 
557
430
 
558
- 3
559
- 4
560
- 5</pre>
431
+ 17
432
+ 18
433
+ 19
434
+ 20
435
+ 21
436
+ 22</pre>
561
437
  </td>
562
438
  <td>
563
- <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 3</span>
439
+ <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 17</span>
564
440
 
565
- <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
566
- <span class='ivar'>@updated_at</span>
441
+ <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
442
+ <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>
443
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
444
+ <span class='label'>timezone:</span> <span class='id identifier rubyid_timezone'>timezone</span>
445
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
567
446
  <span class='kw'>end</span></pre>
568
447
  </td>
569
448
  </tr>
570
449
  </table>
571
450
  </div>
572
451
 
573
- </div>
574
-
575
-
576
- <div id="instance_method_details" class="method_details_list">
577
- <h2>Instance Method Details</h2>
578
-
579
-
580
- <div class="method_details first">
581
- <h3 class="signature first" id="users-instance_method">
452
+ <div class="method_details ">
453
+ <h3 class="signature " id="users-instance_method">
582
454
 
583
455
  #<strong>users</strong> &#x21d2; <tt>Object</tt>
584
456
 
@@ -602,12 +474,12 @@
602
474
  <pre class="lines">
603
475
 
604
476
 
605
- 23
606
- 24
607
- 25</pre>
477
+ 13
478
+ 14
479
+ 15</pre>
608
480
  </td>
609
481
  <td>
610
- <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 23</span>
482
+ <pre class="code"><span class="info file"># File 'lib/helium/organization.rb', line 13</span>
611
483
 
612
484
  <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
613
485
  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_organization_users'>organization_users</span>
@@ -622,7 +494,7 @@
622
494
  </div>
623
495
 
624
496
  <div id="footer">
625
- Generated on Thu Aug 18 10:50:33 2016 by
497
+ Generated on Mon Aug 22 15:52:20 2016 by
626
498
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
627
499
  0.9.3 (ruby-2.3.1).
628
500
  </div>
@@ -0,0 +1,869 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Helium::Resource
8
+
9
+ &mdash; Documentation by YARD 0.9.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Helium::Resource";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Helium.html" title="Helium (module)">Helium</a></span></span>
41
+ &raquo;
42
+ <span class="title">Resource</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame" src="../class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Class: Helium::Resource
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">Helium::Resource</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/helium/resource.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+ <p>Abstract base class for Helium Resources returned by the API</p>
107
+
108
+
109
+ </div>
110
+ </div>
111
+ <div class="tags">
112
+
113
+
114
+ </div><div id="subclasses">
115
+ <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>
117
+ </div>
118
+
119
+
120
+
121
+
122
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
123
+ <ul class="summary">
124
+
125
+ <li class="public ">
126
+ <span class="summary_signature">
127
+
128
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
129
+
130
+
131
+
132
+ </span>
133
+
134
+
135
+
136
+
137
+ <span class="note title readonly">readonly</span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ </ul>
154
+
155
+
156
+
157
+
158
+
159
+ <h2>
160
+ Instance 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="#%3D%3D-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Boolean </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'><p>Override equality to use id for comparisons.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#as_json-instance_method" title="#as_json (instance method)">#<strong>as_json</strong> &#x21d2; Hash </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'><p>Inheriting resources should implement this with super.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ <li class="public ">
213
+ <span class="summary_signature">
214
+
215
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; DateTime<sup>?</sup> </a>
216
+
217
+
218
+
219
+ </span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'><p>When the resource was created.</p>
230
+ </div></span>
231
+
232
+ </li>
233
+
234
+
235
+ <li class="public ">
236
+ <span class="summary_signature">
237
+
238
+ <a href="#eql%3F-instance_method" title="#eql? (instance method)">#<strong>eql?</strong>(other) &#x21d2; Boolean </a>
239
+
240
+
241
+
242
+ </span>
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <span class="summary_desc"><div class='inline'><p>Override equality to use id for comparisons.</p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ <li class="public ">
259
+ <span class="summary_signature">
260
+
261
+ <a href="#hash-instance_method" title="#hash (instance method)">#<strong>hash</strong> &#x21d2; Integer </a>
262
+
263
+
264
+
265
+ </span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <span class="summary_desc"><div class='inline'><p>Override equality to use id for comparisons.</p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ <li class="public ">
282
+ <span class="summary_signature">
283
+
284
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, params:) &#x21d2; Resource </a>
285
+
286
+
287
+
288
+ </span>
289
+
290
+
291
+ <span class="note title constructor">constructor</span>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ <span class="summary_desc"><div class='inline'><p>A new instance of Resource.</p>
301
+ </div></span>
302
+
303
+ </li>
304
+
305
+
306
+ <li class="public ">
307
+ <span class="summary_signature">
308
+
309
+ <a href="#to_json-instance_method" title="#to_json (instance method)">#<strong>to_json</strong>(*options) &#x21d2; String </a>
310
+
311
+
312
+
313
+ </span>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <span class="summary_desc"><div class='inline'><p>A JSON-encoded String representing the resource.</p>
324
+ </div></span>
325
+
326
+ </li>
327
+
328
+
329
+ <li class="public ">
330
+ <span class="summary_signature">
331
+
332
+ <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> &#x21d2; DateTime<sup>?</sup> </a>
333
+
334
+
335
+
336
+ </span>
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+ <span class="summary_desc"><div class='inline'><p>When the resource was last updated.</p>
347
+ </div></span>
348
+
349
+ </li>
350
+
351
+
352
+ </ul>
353
+
354
+
355
+ <div id="constructor_details" class="method_details_list">
356
+ <h2>Constructor Details</h2>
357
+
358
+ <div class="method_details first">
359
+ <h3 class="signature first" id="initialize-instance_method">
360
+
361
+ #<strong>initialize</strong>(client:, params:) &#x21d2; <tt><span class='object_link'><a href="" title="Helium::Resource (class)">Resource</a></span></tt>
362
+
363
+
364
+
365
+
366
+
367
+ </h3><div class="docstring">
368
+ <div class="discussion">
369
+ <p>Returns a new instance of Resource</p>
370
+
371
+
372
+ </div>
373
+ </div>
374
+ <div class="tags">
375
+
376
+
377
+ </div><table class="source_code">
378
+ <tr>
379
+ <td>
380
+ <pre class="lines">
381
+
382
+
383
+ 6
384
+ 7
385
+ 8
386
+ 9
387
+ 10
388
+ 11</pre>
389
+ </td>
390
+ <td>
391
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 6</span>
392
+
393
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>params:</span><span class='rparen'>)</span>
394
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
395
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
396
+ <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>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'>&#39;</span><span class='tstring_content'>meta</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>created</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
397
+ <span class='ivar'>@updated_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>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'>&#39;</span><span class='tstring_content'>meta</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>updated</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ </div>
405
+
406
+ <div id="instance_attr_details" class="attr_details">
407
+ <h2>Instance Attribute Details</h2>
408
+
409
+
410
+ <span id=""></span>
411
+ <div class="method_details first">
412
+ <h3 class="signature first" id="id-instance_method">
413
+
414
+ #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
415
+
416
+
417
+
418
+
419
+
420
+ </h3><div class="docstring">
421
+ <div class="discussion">
422
+ <p>Returns the value of attribute id</p>
423
+
424
+
425
+ </div>
426
+ </div>
427
+ <div class="tags">
428
+
429
+
430
+ </div><table class="source_code">
431
+ <tr>
432
+ <td>
433
+ <pre class="lines">
434
+
435
+
436
+ 4
437
+ 5
438
+ 6</pre>
439
+ </td>
440
+ <td>
441
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 4</span>
442
+
443
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
444
+ <span class='ivar'>@id</span>
445
+ <span class='kw'>end</span></pre>
446
+ </td>
447
+ </tr>
448
+ </table>
449
+ </div>
450
+
451
+ </div>
452
+
453
+
454
+ <div id="instance_method_details" class="method_details_list">
455
+ <h2>Instance Method Details</h2>
456
+
457
+
458
+ <div class="method_details first">
459
+ <h3 class="signature first" id="==-instance_method">
460
+
461
+ #<strong>==</strong>(other) &#x21d2; <tt>Boolean</tt>
462
+
463
+
464
+
465
+
466
+
467
+ </h3><div class="docstring">
468
+ <div class="discussion">
469
+ <p>Override equality to use id for comparisons</p>
470
+
471
+
472
+ </div>
473
+ </div>
474
+ <div class="tags">
475
+
476
+ <p class="tag_title">Returns:</p>
477
+ <ul class="return">
478
+
479
+ <li>
480
+
481
+
482
+ <span class='type'>(<tt>Boolean</tt>)</span>
483
+
484
+
485
+
486
+ </li>
487
+
488
+ </ul>
489
+
490
+ </div><table class="source_code">
491
+ <tr>
492
+ <td>
493
+ <pre class="lines">
494
+
495
+
496
+ 15
497
+ 16
498
+ 17</pre>
499
+ </td>
500
+ <td>
501
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 15</span>
502
+
503
+ <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
+ <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>
505
+ <span class='kw'>end</span></pre>
506
+ </td>
507
+ </tr>
508
+ </table>
509
+ </div>
510
+
511
+ <div class="method_details ">
512
+ <h3 class="signature " id="as_json-instance_method">
513
+
514
+ #<strong>as_json</strong> &#x21d2; <tt>Hash</tt>
515
+
516
+
517
+
518
+
519
+
520
+ </h3><div class="docstring">
521
+ <div class="discussion">
522
+ <p>Inheriting resources should implement this with super</p>
523
+
524
+
525
+ </div>
526
+ </div>
527
+ <div class="tags">
528
+
529
+ <p class="tag_title">Returns:</p>
530
+ <ul class="return">
531
+
532
+ <li>
533
+
534
+
535
+ <span class='type'>(<tt>Hash</tt>)</span>
536
+
537
+
538
+
539
+ &mdash;
540
+ <div class='inline'><p>a Hash of the object&#39;s attributes for JSON</p>
541
+ </div>
542
+
543
+ </li>
544
+
545
+ </ul>
546
+
547
+ </div><table class="source_code">
548
+ <tr>
549
+ <td>
550
+ <pre class="lines">
551
+
552
+
553
+ 45
554
+ 46
555
+ 47
556
+ 48
557
+ 49
558
+ 50
559
+ 51</pre>
560
+ </td>
561
+ <td>
562
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 45</span>
563
+
564
+ <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
565
+ <span class='lbrace'>{</span>
566
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
567
+ <span class='label'>created_at:</span> <span class='id identifier rubyid_created_at'>created_at</span><span class='comma'>,</span>
568
+ <span class='label'>updated_at:</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
569
+ <span class='rbrace'>}</span>
570
+ <span class='kw'>end</span></pre>
571
+ </td>
572
+ </tr>
573
+ </table>
574
+ </div>
575
+
576
+ <div class="method_details ">
577
+ <h3 class="signature " id="created_at-instance_method">
578
+
579
+ #<strong>created_at</strong> &#x21d2; <tt>DateTime</tt><sup>?</sup>
580
+
581
+
582
+
583
+
584
+
585
+ </h3><div class="docstring">
586
+ <div class="discussion">
587
+ <p>Returns when the resource was created</p>
588
+
589
+
590
+ </div>
591
+ </div>
592
+ <div class="tags">
593
+
594
+ <p class="tag_title">Returns:</p>
595
+ <ul class="return">
596
+
597
+ <li>
598
+
599
+
600
+ <span class='type'>(<tt>DateTime</tt>, <tt>nil</tt>)</span>
601
+
602
+
603
+
604
+ &mdash;
605
+ <div class='inline'><p>when the resource was created</p>
606
+ </div>
607
+
608
+ </li>
609
+
610
+ </ul>
611
+
612
+ </div><table class="source_code">
613
+ <tr>
614
+ <td>
615
+ <pre class="lines">
616
+
617
+
618
+ 32
619
+ 33
620
+ 34
621
+ 35</pre>
622
+ </td>
623
+ <td>
624
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 32</span>
625
+
626
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
627
+ <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>
628
+ <span class='ivar'>@_created_at</span> <span class='op'>||=</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='ivar'>@created_at</span><span class='rparen'>)</span>
629
+ <span class='kw'>end</span></pre>
630
+ </td>
631
+ </tr>
632
+ </table>
633
+ </div>
634
+
635
+ <div class="method_details ">
636
+ <h3 class="signature " id="eql?-instance_method">
637
+
638
+ #<strong>eql?</strong>(other) &#x21d2; <tt>Boolean</tt>
639
+
640
+
641
+
642
+
643
+
644
+ </h3><div class="docstring">
645
+ <div class="discussion">
646
+ <p>Override equality to use id for comparisons</p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
652
+
653
+ <p class="tag_title">Returns:</p>
654
+ <ul class="return">
655
+
656
+ <li>
657
+
658
+
659
+ <span class='type'>(<tt>Boolean</tt>)</span>
660
+
661
+
662
+
663
+ </li>
664
+
665
+ </ul>
666
+
667
+ </div><table class="source_code">
668
+ <tr>
669
+ <td>
670
+ <pre class="lines">
671
+
672
+
673
+ 21
674
+ 22
675
+ 23</pre>
676
+ </td>
677
+ <td>
678
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 21</span>
679
+
680
+ <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
+ <span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
682
+ <span class='kw'>end</span></pre>
683
+ </td>
684
+ </tr>
685
+ </table>
686
+ </div>
687
+
688
+ <div class="method_details ">
689
+ <h3 class="signature " id="hash-instance_method">
690
+
691
+ #<strong>hash</strong> &#x21d2; <tt>Integer</tt>
692
+
693
+
694
+
695
+
696
+
697
+ </h3><div class="docstring">
698
+ <div class="discussion">
699
+ <p>Override equality to use id for comparisons</p>
700
+
701
+
702
+ </div>
703
+ </div>
704
+ <div class="tags">
705
+
706
+ <p class="tag_title">Returns:</p>
707
+ <ul class="return">
708
+
709
+ <li>
710
+
711
+
712
+ <span class='type'>(<tt>Integer</tt>)</span>
713
+
714
+
715
+
716
+ </li>
717
+
718
+ </ul>
719
+
720
+ </div><table class="source_code">
721
+ <tr>
722
+ <td>
723
+ <pre class="lines">
724
+
725
+
726
+ 27
727
+ 28
728
+ 29</pre>
729
+ </td>
730
+ <td>
731
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 27</span>
732
+
733
+ <span class='kw'>def</span> <span class='id identifier rubyid_hash'>hash</span>
734
+ <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span>
735
+ <span class='kw'>end</span></pre>
736
+ </td>
737
+ </tr>
738
+ </table>
739
+ </div>
740
+
741
+ <div class="method_details ">
742
+ <h3 class="signature " id="to_json-instance_method">
743
+
744
+ #<strong>to_json</strong>(*options) &#x21d2; <tt>String</tt>
745
+
746
+
747
+
748
+
749
+
750
+ </h3><div class="docstring">
751
+ <div class="discussion">
752
+ <p>Returns a JSON-encoded String representing the resource</p>
753
+
754
+
755
+ </div>
756
+ </div>
757
+ <div class="tags">
758
+
759
+ <p class="tag_title">Returns:</p>
760
+ <ul class="return">
761
+
762
+ <li>
763
+
764
+
765
+ <span class='type'>(<tt>String</tt>)</span>
766
+
767
+
768
+
769
+ &mdash;
770
+ <div class='inline'><p>a JSON-encoded String representing the resource</p>
771
+ </div>
772
+
773
+ </li>
774
+
775
+ </ul>
776
+
777
+ </div><table class="source_code">
778
+ <tr>
779
+ <td>
780
+ <pre class="lines">
781
+
782
+
783
+ 54
784
+ 55
785
+ 56</pre>
786
+ </td>
787
+ <td>
788
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 54</span>
789
+
790
+ <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
+ <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>
792
+ <span class='kw'>end</span></pre>
793
+ </td>
794
+ </tr>
795
+ </table>
796
+ </div>
797
+
798
+ <div class="method_details ">
799
+ <h3 class="signature " id="updated_at-instance_method">
800
+
801
+ #<strong>updated_at</strong> &#x21d2; <tt>DateTime</tt><sup>?</sup>
802
+
803
+
804
+
805
+
806
+
807
+ </h3><div class="docstring">
808
+ <div class="discussion">
809
+ <p>Returns when the resource was last updated</p>
810
+
811
+
812
+ </div>
813
+ </div>
814
+ <div class="tags">
815
+
816
+ <p class="tag_title">Returns:</p>
817
+ <ul class="return">
818
+
819
+ <li>
820
+
821
+
822
+ <span class='type'>(<tt>DateTime</tt>, <tt>nil</tt>)</span>
823
+
824
+
825
+
826
+ &mdash;
827
+ <div class='inline'><p>when the resource was last updated</p>
828
+ </div>
829
+
830
+ </li>
831
+
832
+ </ul>
833
+
834
+ </div><table class="source_code">
835
+ <tr>
836
+ <td>
837
+ <pre class="lines">
838
+
839
+
840
+ 38
841
+ 39
842
+ 40
843
+ 41</pre>
844
+ </td>
845
+ <td>
846
+ <pre class="code"><span class="info file"># File 'lib/helium/resource.rb', line 38</span>
847
+
848
+ <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
849
+ <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>
850
+ <span class='ivar'>@_updated_at</span> <span class='op'>||=</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='ivar'>@updated_at</span><span class='rparen'>)</span>
851
+ <span class='kw'>end</span></pre>
852
+ </td>
853
+ </tr>
854
+ </table>
855
+ </div>
856
+
857
+ </div>
858
+
859
+ </div>
860
+
861
+ <div id="footer">
862
+ Generated on Mon Aug 22 15:52:20 2016 by
863
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
864
+ 0.9.3 (ruby-2.3.1).
865
+ </div>
866
+
867
+ </div>
868
+ </body>
869
+ </html>