helium-ruby 0.3.0 → 0.4.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.
@@ -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::User</li>
80
82
 
81
83
  </ul>
@@ -108,32 +110,6 @@
108
110
  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
109
111
  <ul class="summary">
110
112
 
111
- <li class="public ">
112
- <span class="summary_signature">
113
-
114
- <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
115
-
116
-
117
-
118
- </span>
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- <span class="summary_desc"><div class='inline'><p>Returns the value of attribute created_at.</p>
132
- </div></span>
133
-
134
- </li>
135
-
136
-
137
113
  <li class="public ">
138
114
  <span class="summary_signature">
139
115
 
@@ -146,6 +122,8 @@
146
122
 
147
123
 
148
124
 
125
+ <span class="note title readonly">readonly</span>
126
+
149
127
 
150
128
 
151
129
 
@@ -163,7 +141,7 @@
163
141
  <li class="public ">
164
142
  <span class="summary_signature">
165
143
 
166
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
144
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
167
145
 
168
146
 
169
147
 
@@ -172,6 +150,8 @@
172
150
 
173
151
 
174
152
 
153
+ <span class="note title readonly">readonly</span>
154
+
175
155
 
176
156
 
177
157
 
@@ -180,42 +160,34 @@
180
160
 
181
161
 
182
162
 
183
- <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 name.</p>
184
164
  </div></span>
185
165
 
186
166
  </li>
187
167
 
188
168
 
189
- <li class="public ">
190
- <span class="summary_signature">
191
-
192
- <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
193
-
169
+ </ul>
170
+
171
+
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 name.</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,17 @@
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>
204
+ <span class="summary_desc"><div class='inline'><p>TODO can probably generalize this a bit more.</p>
236
205
  </div></span>
237
206
 
238
207
  </li>
239
208
 
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
209
 
254
210
  <li class="public ">
255
211
  <span class="summary_signature">
@@ -279,6 +235,17 @@
279
235
  </ul>
280
236
 
281
237
 
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
248
+ <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>
282
249
  <div id="constructor_details" class="method_details_list">
283
250
  <h2>Constructor Details</h2>
284
251
 
@@ -312,20 +279,16 @@
312
279
  7
313
280
  8
314
281
  9
315
- 10
316
- 11
317
- 12</pre>
282
+ 10</pre>
318
283
  </td>
319
284
  <td>
320
285
  <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 5</span>
321
286
 
322
287
  <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>
323
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
324
- <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>
325
- <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>
326
- <span class='ivar'>@email</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'>email</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
327
- <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>
328
- <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>
288
+ <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>
289
+
290
+ <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>
291
+ <span class='ivar'>@email</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'>email</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
329
292
  <span class='kw'>end</span></pre>
330
293
  </td>
331
294
  </tr>
@@ -338,53 +301,11 @@
338
301
  <h2>Instance Attribute Details</h2>
339
302
 
340
303
 
341
- <span id="created_at=-instance_method"></span>
304
+ <span id=""></span>
342
305
  <div class="method_details first">
343
- <h3 class="signature first" id="created_at-instance_method">
306
+ <h3 class="signature first" id="email-instance_method">
344
307
 
345
- #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
346
-
347
-
348
-
349
-
350
-
351
- </h3><div class="docstring">
352
- <div class="discussion">
353
- <p>Returns the value of attribute created_at</p>
354
-
355
-
356
- </div>
357
- </div>
358
- <div class="tags">
359
-
360
-
361
- </div><table class="source_code">
362
- <tr>
363
- <td>
364
- <pre class="lines">
365
-
366
-
367
- 3
368
- 4
369
- 5</pre>
370
- </td>
371
- <td>
372
- <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 3</span>
373
-
374
- <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
375
- <span class='ivar'>@created_at</span>
376
- <span class='kw'>end</span></pre>
377
- </td>
378
- </tr>
379
- </table>
380
- </div>
381
-
382
-
383
- <span id="email=-instance_method"></span>
384
- <div class="method_details ">
385
- <h3 class="signature " id="email-instance_method">
386
-
387
- #<strong>email</strong> &#x21d2; <tt>Object</tt>
308
+ #<strong>email</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
388
309
 
389
310
 
390
311
 
@@ -422,11 +343,11 @@
422
343
  </div>
423
344
 
424
345
 
425
- <span id="id=-instance_method"></span>
346
+ <span id=""></span>
426
347
  <div class="method_details ">
427
- <h3 class="signature " id="id-instance_method">
348
+ <h3 class="signature " id="name-instance_method">
428
349
 
429
- #<strong>id</strong> &#x21d2; <tt>Object</tt>
350
+ #<strong>name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
430
351
 
431
352
 
432
353
 
@@ -434,7 +355,7 @@
434
355
 
435
356
  </h3><div class="docstring">
436
357
  <div class="discussion">
437
- <p>Returns the value of attribute id</p>
358
+ <p>Returns the value of attribute name</p>
438
359
 
439
360
 
440
361
  </div>
@@ -455,62 +376,25 @@
455
376
  <td>
456
377
  <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 3</span>
457
378
 
458
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
459
- <span class='ivar'>@id</span>
379
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
380
+ <span class='ivar'>@name</span>
460
381
  <span class='kw'>end</span></pre>
461
382
  </td>
462
383
  </tr>
463
384
  </table>
464
385
  </div>
465
386
 
466
-
467
- <span id="name=-instance_method"></span>
468
- <div class="method_details ">
469
- <h3 class="signature " id="name-instance_method">
470
-
471
- #<strong>name</strong> &#x21d2; <tt>Object</tt>
472
-
473
-
474
-
475
-
476
-
477
- </h3><div class="docstring">
478
- <div class="discussion">
479
- <p>Returns the value of attribute name</p>
480
-
481
-
482
387
  </div>
483
- </div>
484
- <div class="tags">
485
-
486
-
487
- </div><table class="source_code">
488
- <tr>
489
- <td>
490
- <pre class="lines">
491
388
 
492
389
 
493
- 3
494
- 4
495
- 5</pre>
496
- </td>
497
- <td>
498
- <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 3</span>
390
+ <div id="instance_method_details" class="method_details_list">
391
+ <h2>Instance Method Details</h2>
499
392
 
500
- <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
501
- <span class='ivar'>@name</span>
502
- <span class='kw'>end</span></pre>
503
- </td>
504
- </tr>
505
- </table>
506
- </div>
507
393
 
508
-
509
- <span id="updated_at=-instance_method"></span>
510
- <div class="method_details ">
511
- <h3 class="signature " id="updated_at-instance_method">
394
+ <div class="method_details first">
395
+ <h3 class="signature first" id="as_json-instance_method">
512
396
 
513
- #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
397
+ #<strong>as_json</strong> &#x21d2; <tt>Object</tt>
514
398
 
515
399
 
516
400
 
@@ -518,7 +402,7 @@
518
402
 
519
403
  </h3><div class="docstring">
520
404
  <div class="discussion">
521
- <p>Returns the value of attribute updated_at</p>
405
+ <p>TODO can probably generalize this a bit more</p>
522
406
 
523
407
 
524
408
  </div>
@@ -532,15 +416,21 @@
532
416
  <pre class="lines">
533
417
 
534
418
 
535
- 3
536
- 4
537
- 5</pre>
419
+ 13
420
+ 14
421
+ 15
422
+ 16
423
+ 17
424
+ 18</pre>
538
425
  </td>
539
426
  <td>
540
- <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 3</span>
427
+ <pre class="code"><span class="info file"># File 'lib/helium/user.rb', line 13</span>
541
428
 
542
- <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
543
- <span class='ivar'>@updated_at</span>
429
+ <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
430
+ <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>
431
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
432
+ <span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span>
433
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
544
434
  <span class='kw'>end</span></pre>
545
435
  </td>
546
436
  </tr>
@@ -549,11 +439,10 @@
549
439
 
550
440
  </div>
551
441
 
552
-
553
442
  </div>
554
443
 
555
444
  <div id="footer">
556
- Generated on Thu Aug 18 10:50:33 2016 by
445
+ Generated on Mon Aug 22 15:52:20 2016 by
557
446
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
558
447
  0.9.3 (ruby-2.3.1).
559
448
  </div>
@@ -173,7 +173,7 @@
173
173
  </div>
174
174
 
175
175
  <div id="footer">
176
- Generated on Thu Aug 18 10:50:33 2016 by
176
+ Generated on Mon Aug 22 15:52:19 2016 by
177
177
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
178
178
  0.9.3 (ruby-2.3.1).
179
179
  </div>
data/docs/_index.html CHANGED
@@ -115,6 +115,28 @@
115
115
  </ul>
116
116
 
117
117
 
118
+ <ul id="alpha_E" class="alpha">
119
+ <li class="letter">E</li>
120
+ <ul>
121
+
122
+ <li>
123
+ <span class='object_link'><a href="Helium/Element.html" title="Helium::Element (class)">Element</a></span>
124
+
125
+ <small>(Helium)</small>
126
+
127
+ </li>
128
+
129
+ <li>
130
+ <span class='object_link'><a href="Helium/Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span>
131
+
132
+ <small>(Helium::Client)</small>
133
+
134
+ </li>
135
+
136
+ </ul>
137
+ </ul>
138
+
139
+
118
140
  <ul id="alpha_H" class="alpha">
119
141
  <li class="letter">H</li>
120
142
  <ul>
@@ -135,6 +157,28 @@
135
157
  </ul>
136
158
 
137
159
 
160
+ <ul id="alpha_L" class="alpha">
161
+ <li class="letter">L</li>
162
+ <ul>
163
+
164
+ <li>
165
+ <span class='object_link'><a href="Helium/Label.html" title="Helium::Label (class)">Label</a></span>
166
+
167
+ <small>(Helium)</small>
168
+
169
+ </li>
170
+
171
+ <li>
172
+ <span class='object_link'><a href="Helium/Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span>
173
+
174
+ <small>(Helium::Client)</small>
175
+
176
+ </li>
177
+
178
+ </ul>
179
+ </ul>
180
+
181
+
138
182
  <ul id="alpha_O" class="alpha">
139
183
  <li class="letter">O</li>
140
184
  <ul>
@@ -157,6 +201,24 @@
157
201
  </ul>
158
202
 
159
203
 
204
+ <ul id="alpha_R" class="alpha">
205
+ <li class="letter">R</li>
206
+ <ul>
207
+
208
+ <li>
209
+ <span class='object_link'><a href="Helium/Resource.html" title="Helium::Resource (class)">Resource</a></span>
210
+
211
+ <small>(Helium)</small>
212
+
213
+ </li>
214
+
215
+ </ul>
216
+ </ul>
217
+
218
+
219
+ </td><td valign='top' width="33%">
220
+
221
+
160
222
  <ul id="alpha_S" class="alpha">
161
223
  <li class="letter">S</li>
162
224
  <ul>
@@ -216,7 +278,7 @@
216
278
  </div>
217
279
 
218
280
  <div id="footer">
219
- Generated on Thu Aug 18 10:50:33 2016 by
281
+ Generated on Mon Aug 22 15:52:19 2016 by
220
282
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
221
283
  0.9.3 (ruby-2.3.1).
222
284
  </div>