helium-ruby 0.3.0 → 0.4.0

data/docs/Helium/Sensor.html

@@ -71,11 +71,13 @@
   <dl>
     <dt>Inherits:</dt>
     <dd>
-      <span class="inheritName">Object</span>
+      <span class="inheritName"><span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></span>
       
         <ul class="fullTree">
           <li>Object</li>
           
+            <li class="next"><span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></li>
+          
             <li class="next">Helium::Sensor</li>
           
         </ul>
@@ -111,7 +113,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong>  &#x21d2; Object </a>
+      <a href="#mac-instance_method" title="#mac (instance method)">#<strong>mac</strong>  &#x21d2; Object </a>
     
 
     
@@ -120,6 +122,8 @@
   
   
     
+      <span class="note title readonly">readonly</span>
+    
     
   
   
@@ -128,7 +132,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute created_at.</p>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute mac.</p>
 </div></span>
   
 </li>
@@ -137,7 +141,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong>  &#x21d2; Object </a>
+      <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong>  &#x21d2; Object </a>
     
 
     
@@ -146,6 +150,8 @@
   
   
     
+      <span class="note title readonly">readonly</span>
+    
     
   
   
@@ -154,7 +160,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
 </div></span>
   
 </li>
@@ -163,7 +169,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#mac-instance_method" title="#mac (instance method)">#<strong>mac</strong>  &#x21d2; Object </a>
+      <a href="#ports-instance_method" title="#ports (instance method)">#<strong>ports</strong>  &#x21d2; Object </a>
     
 
     
@@ -172,6 +178,8 @@
   
   
     
+      <span class="note title readonly">readonly</span>
+    
     
   
   
@@ -180,68 +188,34 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute mac.</p>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute ports.</p>
 </div></span>
   
 </li>
 
     
-      <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong>  &#x21d2; Object </a>
-    
-
-    
-  </span>
-  
-  
-  
-    
-    
-  
-  
-  
-  
-  
+  </ul>
 
-  
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
-</div></span>
-  
-</li>
 
-    
-      <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#ports-instance_method" title="#ports (instance method)">#<strong>ports</strong>  &#x21d2; Object </a>
-    
 
-    
-  </span>
-  
-  
-  
-    
-    
-  
-  
-  
   
   
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span></p>
+
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute ports.</p>
-</div></span>
-  
-</li>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
 
-    
-      <li class="public ">
+    <ul class="summary">
+      
+        <li class="public ">
   <span class="summary_signature">
     
-      <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong>  &#x21d2; Object </a>
+      <a href="#as_json-instance_method" title="#as_json (instance method)">#<strong>as_json</strong>  &#x21d2; Object </a>
     
 
     
@@ -249,33 +223,17 @@
   
   
   
-    
-    
-  
   
   
   
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute updated_at.</p>
+    <span class="summary_desc"><div class='inline'><p>TODO can probably generalize this a bit more.</p>
 </div></span>
   
 </li>
 
-    
-  </ul>
-
-
-
-
-  
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
       
         <li class="public ">
   <span class="summary_signature">
@@ -363,7 +321,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>TODO these kinds of methods should be generalized into a Resource object.</p>
+    <span class="summary_desc"><div class='inline'><p>TODO CRUD methods will be generalized into the Resource object.</p>
 </div></span>
   
 </li>
@@ -372,6 +330,17 @@
     </ul>
   
 
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
+  <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>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
@@ -406,21 +375,17 @@
 8
 9
 10
-11
-12
-13</pre>
+11</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 5</span>
 
 <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>
-  <span class='ivar'>@client</span>     <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
-  <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>
-  <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>
-  <span class='ivar'>@mac</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'>mac</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-  <span class='ivar'>@ports</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'>ports</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-  <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>
-  <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>
+  <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>
+
+  <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>
+  <span class='ivar'>@mac</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'>mac</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='ivar'>@ports</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'>ports</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -433,95 +398,11 @@
     <h2>Instance Attribute Details</h2>
     
       
-      <span id="created_at=-instance_method"></span>
+      <span id=""></span>
       <div class="method_details first">
-  <h3 class="signature first" id="created_at-instance_method">
-  
-    #<strong>created_at</strong>  &#x21d2; <tt>Object</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the value of attribute created_at</p>
-
-
-  </div>
-</div>
-<div class="tags">
+  <h3 class="signature first" id="mac-instance_method">
   
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-3
-4
-5</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
-  <span class='ivar'>@created_at</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      
-      <span id="id=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="id-instance_method">
-  
-    #<strong>id</strong>  &#x21d2; <tt>Object</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the value of attribute id</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-3
-4
-5</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
-  <span class='ivar'>@id</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      
-      <span id="mac=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="mac-instance_method">
-  
-    #<strong>mac</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>mac</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -559,11 +440,11 @@
 </div>
     
       
-      <span id="name=-instance_method"></span>
+      <span id=""></span>
       <div class="method_details ">
   <h3 class="signature " id="name-instance_method">
   
-    #<strong>name</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>name</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -601,11 +482,11 @@
 </div>
     
       
-      <span id="ports=-instance_method"></span>
+      <span id=""></span>
       <div class="method_details ">
   <h3 class="signature " id="ports-instance_method">
   
-    #<strong>ports</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>ports</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -642,12 +523,17 @@
 </table>
 </div>
     
-      
-      <span id="updated_at=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="updated_at-instance_method">
+  </div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="as_json-instance_method">
   
-    #<strong>updated_at</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>as_json</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -655,7 +541,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the value of attribute updated_at</p>
+    <p>TODO can probably generalize this a bit more</p>
 
 
   </div>
@@ -669,30 +555,31 @@
       <pre class="lines">
 
 
-3
-4
-5</pre>
+34
+35
+36
+37
+38
+39
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
-  <span class='ivar'>@updated_at</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 34</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
+  <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>
+    <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
+    <span class='label'>mac:</span> <span class='id identifier rubyid_mac'>mac</span><span class='comma'>,</span>
+    <span class='label'>ports:</span> <span class='id identifier rubyid_ports'>ports</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>
     
-  </div>
-
-
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="destroy-instance_method">
+      <div class="method_details ">
+  <h3 class="signature " id="destroy-instance_method">
   
     #<strong>destroy</strong>  &#x21d2; <tt>Object</tt> 
   
@@ -706,12 +593,12 @@
       <pre class="lines">
 
 
-39
-40
-41</pre>
+29
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 39</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_sensor'>delete_sensor</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
@@ -736,19 +623,19 @@
       <pre class="lines">
 
 
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32</pre>
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 13</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_timeseries'>timeseries</span><span class='lparen'>(</span><span class='label'>size:</span> <span class='int'>1000</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>start_time:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_time:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>aggtype:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>aggsize:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_sensor_timeseries'>sensor_timeseries</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span>
@@ -776,7 +663,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>TODO these kinds of methods should be generalized into a Resource object</p>
+    <p>TODO CRUD methods will be generalized into the Resource object</p>
 
 
   </div>
@@ -790,12 +677,12 @@
       <pre class="lines">
 
 
-35
-36
-37</pre>
+25
+26
+27</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 35</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 25</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span><span class='rparen'>)</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update_sensor'>update_sensor</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
@@ -810,7 +697,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 18 10:50:33 2016 by
+  Generated on Mon Aug 22 15:52:20 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.3 (ruby-2.3.1).
 </div>