helium-ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efd13da21a667d1b3a55f05bc96bf0e69c04505a
-  data.tar.gz: 70ff7c541b45e2c8d2838ad160b3b705476cc76d
+  metadata.gz: 6ed4e6a8fbcc7e5ebe36c22b65f36e41566c2e83
+  data.tar.gz: 94ec6f609f280d06f018a6ed4ecaa92b3f308c17
 SHA512:
-  metadata.gz: fe156f3f4d109f2461d03b47217d05052a0bfbe88399929018e39e56ad13d61dc6eb2845e149e8b46fc4fb55cf5b5ad84c915f90bee306d515ccb1ed8b8ab288
-  data.tar.gz: c6635935d39973fd1286dded418c09b0bbba1d2cff181a4abfe6f41bd1a5fb587f5796dbd6d209bef27a001b2200b1602df6ba35809963d1ccd68033d5b0c04e
+  metadata.gz: 2efa549a8da0fe3b299822e9e1e69ece72edfd2198efebc4ba2f5696910cd6adea2305d6a966d5a4b5f8e4338bb722e6e984b14b3dec7e18015fec6221e0c06e
+  data.tar.gz: 103c4aaafc6a18d10974648d0f0d2e6c8964f9a3a1d6ebd5dcc608aff3c2920aec2af526aa00dcc1878654c4b59e041407f664376158a7ce2698ba69c0833256

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.5.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.7.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
     
   </dl>
 
@@ -121,7 +121,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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

@@ -119,13 +119,33 @@
   
 </p>
 
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+    
+      <dt id="API_VERSION-constant" class="">API_VERSION =
+        
+      </dt>
+      <dd><pre class="code"><span class='int'>1</span></pre></dd>
+    
+      <dt id="HOST-constant" class="">HOST =
+        
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api.helium.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+    
+      <dt id="PROTOCOL-constant" class="">PROTOCOL =
+        
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+    
+  </dl>
 
 
-  <h2>Constant Summary</h2>
+
+  
   
   <h3 class="inherited">Constants included
      from <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Client/Http.html#API_VERSION-constant" title="Helium::Client::Http::API_VERSION (constant)">Http::API_VERSION</a></span>, <span class='object_link'><a href="Client/Http.html#BASE_HTTP_HEADERS-constant" title="Helium::Client::Http::BASE_HTTP_HEADERS (constant)">Http::BASE_HTTP_HEADERS</a></span>, <span class='object_link'><a href="Client/Http.html#HOST-constant" title="Helium::Client::Http::HOST (constant)">Http::HOST</a></span>, <span class='object_link'><a href="Client/Http.html#PROTOCOL-constant" title="Helium::Client::Http::PROTOCOL (constant)">Http::PROTOCOL</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="Client/Http.html#BASE_HTTP_HEADERS-constant" title="Helium::Client::Http::BASE_HTTP_HEADERS (constant)">Http::BASE_HTTP_HEADERS</a></span></p>
 
 
   <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
@@ -307,7 +327,7 @@
   
   
   <h3 class="inherited">Methods included from <span class='object_link'><a href="Client/Http.html" title="Helium::Client::Http (module)">Http</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Client/Http.html#delete-instance_method" title="Helium::Client::Http#delete (method)">#delete</a></span>, <span class='object_link'><a href="Client/Http.html#get-instance_method" title="Helium::Client::Http#get (method)">#get</a></span>, <span class='object_link'><a href="Client/Http.html#paginated_get-instance_method" title="Helium::Client::Http#paginated_get (method)">#paginated_get</a></span>, <span class='object_link'><a href="Client/Http.html#patch-instance_method" title="Helium::Client::Http#patch (method)">#patch</a></span>, <span class='object_link'><a href="Client/Http.html#post-instance_method" title="Helium::Client::Http#post (method)">#post</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="Client/Http.html#base_url-instance_method" title="Helium::Client::Http#base_url (method)">#base_url</a></span>, <span class='object_link'><a href="Client/Http.html#delete-instance_method" title="Helium::Client::Http#delete (method)">#delete</a></span>, <span class='object_link'><a href="Client/Http.html#get-instance_method" title="Helium::Client::Http#get (method)">#get</a></span>, <span class='object_link'><a href="Client/Http.html#paginated_get-instance_method" title="Helium::Client::Http#paginated_get (method)">#paginated_get</a></span>, <span class='object_link'><a href="Client/Http.html#patch-instance_method" title="Helium::Client::Http#patch (method)">#patch</a></span>, <span class='object_link'><a href="Client/Http.html#post-instance_method" title="Helium::Client::Http#post (method)">#post</a></span>, <span class='object_link'><a href="Client/Http.html#url_for-instance_method" title="Helium::Client::Http#url_for (method)">#url_for</a></span></p>
 
   
   
@@ -347,17 +367,19 @@
       <pre class="lines">
 
 
-20
-21
-22
-23</pre>
+24
+25
+26
+27
+28</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 24</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:api_key</span><span class='rparen'>)</span>
-  <span class='ivar'>@debug</span>   <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:debug</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
+  <span class='ivar'>@api_key</span>  <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:api_key</span><span class='rparen'>)</span>
+  <span class='ivar'>@api_host</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:host</span><span class='comma'>,</span> <span class='const'>HOST</span><span class='rparen'>)</span>
+  <span class='ivar'>@debug</span>    <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:debug</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -396,12 +418,12 @@
       <pre class="lines">
 
 
-18
-19
-20</pre>
+22
+23
+24</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 18</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 22</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
   <span class='ivar'>@api_key</span>
@@ -455,12 +477,12 @@
       <pre class="lines">
 
 
-29
-30
-31</pre>
+34
+35
+36</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 29</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 34</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_debug?'>debug?</span>
   <span class='ivar'>@debug</span> <span class='op'>==</span> <span class='kw'>true</span>
@@ -485,12 +507,12 @@
       <pre class="lines">
 
 
-25
-26
-27</pre>
+30
+31
+32</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client.rb', line 30</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;Helium::Client @debug=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@debug</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span>
@@ -505,7 +527,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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

@@ -291,7 +291,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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

@@ -94,21 +94,6 @@
   <h2>Constant Summary</h2>
   <dl class="constants">
     
-      <dt id="API_VERSION-constant" class="">API_VERSION =
-        
-      </dt>
-      <dd><pre class="code"><span class='int'>1</span></pre></dd>
-    
-      <dt id="HOST-constant" class="">HOST =
-        
-      </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api.helium.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-    
-      <dt id="PROTOCOL-constant" class="">PROTOCOL =
-        
-      </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-    
       <dt id="BASE_HTTP_HEADERS-constant" class="">BASE_HTTP_HEADERS =
         
       </dt>
@@ -137,6 +122,28 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#base_url-instance_method" title="#base_url (instance method)">#<strong>base_url</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path)  &#x21d2; Object </a>
     
 
@@ -241,6 +248,29 @@
   
     <span class="summary_desc"><div class='inline'></div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#url_for-instance_method" title="#url_for (instance method)">#<strong>url_for</strong>(path)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Contructs a proper url given a path.</p>
+</div></span>
+  
 </li>
 
       
@@ -254,9 +284,9 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="delete-instance_method">
+  <h3 class="signature first" id="base_url-instance_method">
   
-    #<strong>delete</strong>(path)  &#x21d2; <tt>Object</tt> 
+    #<strong>base_url</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -268,13 +298,43 @@
       <pre class="lines">
 
 
-33
 34
 35
 36</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 33</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 34</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>PROTOCOL</span><span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_host</span><span class='embexpr_end'>}</span><span class='tstring_content'>/v</span><span class='embexpr_beg'>#{</span><span class='const'>API_VERSION</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="delete-instance_method">
+  
+    #<strong>delete</strong>(path)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+29
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
@@ -300,12 +360,12 @@
       <pre class="lines">
 
 
-14
-15
-16</pre>
+10
+11
+12</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 10</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
@@ -330,15 +390,15 @@
       <pre class="lines">
 
 
+14
+15
+16
+17
 18
-19
-20
-21
-22
-23</pre>
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 18</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 14</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_paginated_get'>paginated_get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_klass'>klass</span>  <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:klass</span><span class='rparen'>)</span>
@@ -366,12 +426,12 @@
       <pre class="lines">
 
 
-29
-30
-31</pre>
+25
+26
+27</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 29</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 25</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
@@ -396,12 +456,12 @@
       <pre class="lines">
 
 
-25
-26
-27</pre>
+21
+22
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
@@ -409,6 +469,53 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="url_for-instance_method">
+  
+    #<strong>url_for</strong>(path)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Contructs a proper url given a path. If the path is already a full url
+it will simply pass through</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+40
+41
+42
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 40</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_url_for'>url_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_path'>path</span> <span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^http</span><span class='regexp_end'>/</span></span>
+
+  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -416,7 +523,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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 Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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 Tue Aug 30 08:16:47 2016 by
+  Generated on Wed Aug 31 12:32:54 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>