helium-ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12f81526d2121b547943b1271d19d364a84931f5
-  data.tar.gz: 3f840cf2cb8d044af2859f10d78b654f36289297
+  metadata.gz: efd13da21a667d1b3a55f05bc96bf0e69c04505a
+  data.tar.gz: 70ff7c541b45e2c8d2838ad160b3b705476cc76d
 SHA512:
-  metadata.gz: b1c2f3286d86f1d1bb5372f64a8c03f3650c71ecfc6332c6760cfec1df1100c735cd90b5aba2ee2f85949eedb535a0e8ce91bcd85bb0341b32ec19b3bb59cd02
-  data.tar.gz: 14bdecc56bb990396bcf859aa24290e641b291d6d4d569f8c86cfc43709903b0c0a1c22aa6d969d3089fc5f9fbe9d77daa86dc9e699fb627d19fafc6c88fb299
+  metadata.gz: fe156f3f4d109f2461d03b47217d05052a0bfbe88399929018e39e56ad13d61dc6eb2845e149e8b46fc4fb55cf5b5ad84c915f90bee306d515ccb1ed8b8ab288
+  data.tar.gz: c6635935d39973fd1286dded418c09b0bbba1d2cff181a4abfe6f41bd1a5fb587f5796dbd6d209bef27a001b2200b1602df6ba35809963d1ccd68033d5b0c04e

data/CONTRIBUTING.md

@@ -2,32 +2,10 @@
 
 We value contributions from the community and will do everything we can go get them reviewed in a timely fashion. If you have code to send our way or a bug to report:
 
-* Contributing Code: If you have new code or a bug fix, fork this repo, create a logically-named branch, and submit a PR against this repo. Include a write up of the PR with details on what it does.
+* **Contributing Code**: If you have new code or a bug fix, fork this repo, create a logically-named branch, and [submit a PR against this repo](https://github.com/helium/helium-ruby/issues). Include a write up of the PR with details on what it does.
 
-* Reporting Bugs: Open an issue against this repo with as much detail as you can. At the very least you'll include steps to reproduce the problem.
+* **Reporting Bugs**: Open an issue [against this repo](https://github.com/helium/helium-ruby/issues) with as much detail as you can. At the very least you'll include steps to reproduce the problem.
 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant](http://contributor-covenant.org) Code of Conduct.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant Code of Conduct](http://contributor-covenant.org/). 
 
-Above all, thank you for taking the time to be a part of the Helium community.
-
-## Submitting a Pull Request
-
-1. Check out [the Development section][development] in the README for instructions on setting up the project for local development.
-2. [Fork the repository.][fork]
-3. [Create a topic branch.][branch]
-4. Add specs for your unimplemented feature or bug fix.
-5. Run `rake spec`. If your specs pass, return to step 4.
-6. Implement your feature or bug fix.
-7. Run `rake spec`. If your specs fail, return to step 6.
-8. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 4.
-9. Add documentation for your feature or bug fix.
-10. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 9.
-11. Add, commit, and push your changes. For documentation-only fixes, please
-    add "[ci skip]" to your commit message to avoid needless CI builds.
-12. [Submit a pull request.][pr]
-
-[development]: https://github.com/helium/helium-ruby#development
-[fork]: https://help.github.com/articles/fork-a-repo
-[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
-[pr]: https://help.github.com/articles/using-pull-requests
+Above all, thank you for taking the time to be a part of the Helium community. 

data/CONTRIBUTORS.md

@@ -0,0 +1,4 @@
+**This is a list of people who have contribtuted to helium-ruby:**
+
+- Andrew "Bones" Allen
+- Jared Morrow (of the Canadian Morrows)

data/README.md

@@ -7,6 +7,17 @@
 
 A Ruby gem for building applications with the Helium API. [Helium](https://www.helium.com/) is an integrated platform of smart sensors, communication, edge and cloud compute that enables numerous sensing applications. For more information about the underlying REST API, check out [the Helium docs](https://docs.helium.com/).
 
+
+##  Helium Documentation and Community Support 
+
+
+* **helium-ruby docs** - Documentation for the gem's source can be found [here](https://helium.github.io/helium-ruby/): 
+
+* **Helium Docs** Complete documenation for all parts of Helium can be found at [docs.helium.com](https://docs/helium.com). 
+
+* **chat.helium.com** - If you have questions or ideas about how to use this code - or any part of Helium - head over the [chat.helium.com](https://chat.helium.com). We're standing by to help. 
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,6 +36,7 @@ Or install it yourself as:
 
 ## Usage
 
+
 ### Setup
 
 ```ruby
@@ -258,9 +270,6 @@ client.sensors.first.to_json
 # => "{\"id\":\"08bab58b-d095-4c7c-912c-1f8024d91d95\",\"created_at\":\"2015-08-06T17:28:11+00:00\",\"updated_at\":\"2016-05-30T22:36:50+00:00\",\"name\":\"Marc's Isotope\",\"mac\":\"6081f9fffe00019b\",\"ports\":[\"b\",\"t\"]}"
 ```
 
-## Source Documentation
-Documentation for the gem's source can be found here: https://helium.github.io/helium-ruby/
-
 
 ## Development
 
@@ -274,18 +283,6 @@ We're working toward a v1.0.0 release, which will represent a feature-complete i
 
 Until the v1.0.0 release, the functionality of this gem is subject to change. To prevent breaking changes, you should use the pessimistic version constraint operator (`~>`) in your Gemfile to lock your helium-ruby version to the current minor release. This will allow updates to patch versions.
 
-## Contributing
-
-We value contributions from the community and will do everything we can go get them reviewed in a timely fashion. If you have code to send our way or a bug to report:
-
-* Contributing Code: If you have new code or a bug fix, fork this repo, create a logically-named branch, and submit a PR against this repo. Include a write up of the PR with details on what it does.
-
-* Reporting Bugs: Open an issue against this repo with as much detail as you can. At the very least you'll include steps to reproduce the problem.
-
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) Code of Conduct.
-
-Above all, thank you for taking the time to be a part of the Helium community.
-
 ### Running specs with Guard
 
 To receive system notifications of test status, install `terminal-notifier`:
@@ -299,7 +296,3 @@ $ bundle exec guard
 ```
 
 When you modify any of the files in `lib/`, all specs will run. When you modify a spec file, just that file will be run. You can press `Enter` at the guard prompt to run all tests as well.
-
-## License
-
-The gem is available as open source under the terms of the [BSD License](https://github.com/helium/helium-ruby/blob/master/LICENSE.txt).

data/docs/Helium.html

@@ -106,7 +106,7 @@
       <dt id="VERSION-constant" class="">VERSION =
         
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.4.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.5.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
     
   </dl>
 
@@ -121,7 +121,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:50 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client.html

@@ -252,7 +252,7 @@
   
   
   <h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Client/Elements.html#element-instance_method" title="Helium::Client::Elements#element (method)">#element</a></span>, <span class='object_link'><a href="Client/Elements.html#elements-instance_method" title="Helium::Client::Elements#elements (method)">#elements</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="Client/Elements.html#element-instance_method" title="Helium::Client::Elements#element (method)">#element</a></span>, <span class='object_link'><a href="Client/Elements.html#element_sensors-instance_method" title="Helium::Client::Elements#element_sensors (method)">#element_sensors</a></span>, <span class='object_link'><a href="Client/Elements.html#elements-instance_method" title="Helium::Client::Elements#elements (method)">#elements</a></span></p>
 
   
   
@@ -505,7 +505,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Elements.html

@@ -122,6 +122,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#element_sensors-instance_method" title="#element_sensors (instance method)">#<strong>element_sensors</strong>(element)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -186,6 +208,52 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="element_sensors-instance_method">
+  
+    #<strong>element_sensors</strong>(element)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/elements.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_element_sensors'>element_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/element/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>?include=sensor</span><span class='tstring_end'>&quot;</span></span>
+  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</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>
+  <span class='id identifier rubyid_sensors_data'>sensors_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'>&quot;</span><span class='tstring_content'>included</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+
+  <span class='id identifier rubyid_sensors'>sensors</span> <span class='op'>=</span> <span class='id identifier rubyid_sensors_data'>sensors_data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sensor'>sensor</span><span class='op'>|</span>
+    <span class='const'>Sensor</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_sensor'>sensor</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+
+  <span class='kw'>return</span> <span class='id identifier rubyid_sensors'>sensors</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -223,7 +291,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Http.html

@@ -416,7 +416,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:50 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Labels.html

@@ -447,7 +447,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Organizations.html

@@ -241,7 +241,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Sensors.html

@@ -349,7 +349,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Client/Users.html

@@ -175,7 +175,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:50 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/ClientError.html

@@ -143,7 +143,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Cursor.html

@@ -347,7 +347,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/DataPoint.html

@@ -201,7 +201,7 @@
   
   
   <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>
+  <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>
 
 
   
@@ -759,7 +759,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Element.html

@@ -201,7 +201,7 @@
   
   
   <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>
+  <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>
 
 
   
@@ -257,6 +257,28 @@
     <span class="summary_desc"><div class='inline'><p>A new instance of Element.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#sensors-instance_method" title="#sensors (instance method)">#<strong>sensors</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
 </li>
 
       
@@ -488,16 +510,16 @@
       <pre class="lines">
 
 
-14
-15
-16
-17
 18
 19
-20</pre>
+20
+21
+22
+23
+24</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/element.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/element.rb', line 18</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>
@@ -509,6 +531,36 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="sensors-instance_method">
+  
+    #<strong>sensors</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+13
+14
+15</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/helium/element.rb', line 13</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_sensors'>sensors</span>
+  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_element_sensors'>element_sensors</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -516,7 +568,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>

data/docs/Helium/Error.html

@@ -229,8 +229,7 @@ response message</p>
 17
 18
 19
-20
-21</pre>
+20</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/helium/error.rb', line 10</span>
@@ -239,13 +238,12 @@ response message</p>
   <span class='id identifier rubyid_status'>status</span>  <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
   <span class='id identifier rubyid_message'>message</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'>&quot;</span><span class='tstring_content'>errors</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>detail</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
 
-  <span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span>  <span class='kw'>case</span> <span class='id identifier rubyid_status'>status</span>
-              <span class='kw'>when</span> <span class='int'>401</span>  <span class='kw'>then</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>InvalidApiKey</span>
-              <span class='kw'>else</span> <span class='kw'>self</span>
-              <span class='kw'>end</span>
+  <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span>  <span class='kw'>case</span> <span class='id identifier rubyid_status'>status</span>
+           <span class='kw'>when</span> <span class='int'>401</span>   <span class='kw'>then</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>InvalidApiKey</span>
+           <span class='kw'>else</span> <span class='kw'>self</span>
+           <span class='kw'>end</span>
 
-    <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
+  <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -257,7 +255,7 @@ response message</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 13:22:51 2016 by
+  Generated on Tue Aug 30 08:16:47 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>