docs/Helium/Client/Http.html in helium-ruby-0.6.0 vs docs/Helium/Client/Http.html in helium-ruby-0.7.0
- old
+ new
@@ -92,25 +92,10 @@
<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'>'</span><span class='tstring_content'>api.helium.com</span><span class='tstring_end'>'</span></span></pre></dd>
-
- <dt id="PROTOCOL-constant" class="">PROTOCOL =
-
- </dt>
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https</span><span class='tstring_end'>'</span></span></pre></dd>
-
<dt id="BASE_HTTP_HEADERS-constant" class="">BASE_HTTP_HEADERS =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Accept</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
@@ -135,10 +120,32 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
+ <a href="#base_url-instance_method" title="#base_url (instance method)">#<strong>base_url</strong> ⇒ 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) ⇒ Object </a>
</span>
@@ -242,23 +249,46 @@
<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) ⇒ Object </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>Contructs a proper url given a path.</p>
+</div></span>
+
+</li>
+
+
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<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) ⇒ <tt>Object</tt>
+ #<strong>base_url</strong> ⇒ <tt>Object</tt>
@@ -266,18 +296,48 @@
<tr>
<td>
<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'>"</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'>"</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) ⇒ <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>
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>204</span>
<span class='kw'>end</span></pre>
</td>
@@ -298,16 +358,16 @@
<tr>
<td>
<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>
<span class='kw'>end</span></pre>
</td>
@@ -328,19 +388,19 @@
<tr>
<td>
<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>
<span class='id identifier rubyid_params'>params</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'>:params</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -364,16 +424,16 @@
<tr>
<td>
<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>
<span class='kw'>end</span></pre>
</td>
@@ -394,30 +454,77 @@
<tr>
<td>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
+ <div class="method_details ">
+ <h3 class="signature " id="url_for-instance_method">
+
+ #<strong>url_for</strong>(path) ⇒ <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'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+ <span class='tstring'><span class='tstring_beg'>"</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'>"</span></span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
</div>
+
+ </div>
+</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>
</div>
\ No newline at end of file