docs/Helium/Client/Http.html in helium-ruby-0.21.0 vs docs/Helium/Client/Http.html in helium-ruby-0.22.0
- old
+ new
@@ -96,12 +96,10 @@
<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>
- <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</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>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>helium-ruby</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span></pre></dd>
</dl>
@@ -274,10 +272,33 @@
<li class="public ">
<span class="summary_signature">
+ <a href="#stream_from-instance_method" title="#stream_from (instance method)">#<strong>stream_from</strong>(path, opts = {}) {|Helium::Resource| ... } ⇒ Object </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>Stream data from the provided path.</p>
+</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>
@@ -318,18 +339,18 @@
<tr>
<td>
<pre class="lines">
-39
-40
-41
-42
-43</pre>
+63
+64
+65
+66
+67</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 39</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</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_end'>"</span></span>
<span class='id identifier rubyid_url'>url</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_version</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@api_version</span>
<span class='id identifier rubyid_url'>url</span>
@@ -352,17 +373,17 @@
<tr>
<td>
<pre class="lines">
+32
+33
34
-35
-36
-37</pre>
+35</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 34</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 32</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>
@@ -384,16 +405,16 @@
<tr>
<td>
<pre class="lines">
-10
-11
-12</pre>
+8
+9
+10</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 10</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 8</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>
@@ -414,20 +435,20 @@
<tr>
<td>
<pre class="lines">
+12
+13
14
15
16
17
-18
-19
-20</pre>
+18</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 12</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_cursor_klass'>cursor_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'>:cursor_klass</span><span class='comma'>,</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>Cursor</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>
@@ -452,16 +473,16 @@
<tr>
<td>
<pre class="lines">
-26
-27
-28</pre>
+24
+25
+26</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 26</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 24</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>
@@ -482,16 +503,16 @@
<tr>
<td>
<pre class="lines">
-22
-23
-24</pre>
+20
+21
+22</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 22</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 20</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>
@@ -512,61 +533,223 @@
<tr>
<td>
<pre class="lines">
-30
-31
-32</pre>
+28
+29
+30</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 30</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</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'>:put</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">
+ <h3 class="signature " id="stream_from-instance_method">
- #<strong>url_for</strong>(path) ⇒ <tt>Object</tt>
+ #<strong>stream_from</strong>(path, opts = {}) {|Helium::Resource| ... } ⇒ <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>
+ <p>Stream data from the provided path</p>
</div>
</div>
<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+ <li>
+
+ <span class='name'>path</span>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>a relative path</p>
+</div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>opts</span>
+
+
+ <span class='type'>(<tt>Hash</tt>)</span>
+
+
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+
+ —
+ <div class='inline'><p>a customizable set of options</p>
+</div>
+
+ </li>
+
+</ul>
+
+
+
+
+
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
+ <ul class="option">
+
+ <li>
+ <span class="name">:klass</span>
+ <span class="type">(<tt>Class</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>a class to be initialized with received data</p>
+</div>
+
+ </li>
+
+ <li>
+ <span class="name">:params</span>
+ <span class="type">(<tt>Hash</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>a hash of params to be used as query params</p>
+</div>
+
+ </li>
+
+ </ul>
+
+
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="../Resource.html" title="Helium::Resource (class)">Helium::Resource</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>accepts logic to perform on the initialized Helium::Resource class</p>
+</div>
+
+ </li>
+
+</ul>
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
+42
+43
+44
+45
+46
47
48
49
50
51
-52</pre>
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 47</span>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 42</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_stream_from'>stream_from</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='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</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>
+ <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_generate_request'>generate_request</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='lbrace'>{</span>
+ <span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span>
+ <span class='label'>content_type:</span> <span class='symbol'>:stream</span><span class='comma'>,</span>
+ <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span>
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
+
+ <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_on_body'>on_body</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_chunk'>chunk</span><span class='op'>|</span>
+ <span class='kw'>if</span> <span class='id identifier rubyid_chunk'>chunk</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>data:</span><span class='regexp_end'>/</span></span>
+ <span class='id identifier rubyid_json_string'>json_string</span> <span class='op'>=</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='lbracket'>[</span><span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>{</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='op'>..</span><span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_rindex'>rindex</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>}</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbracket'>]</span>
+ <span class='id identifier rubyid_json_data'>json_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_json_string'>json_string</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
+ <span class='id identifier rubyid_object'>object</span> <span class='op'>=</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='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_json_data'>json_data</span><span class='rparen'>)</span>
+ <span class='kw'>yield</span> <span class='id identifier rubyid_object'>object</span>
+ <span class='kw'>end</span>
+ <span class='kw'>end</span>
+
+ <span class='id identifier rubyid_run_request'>run_request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</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">
+
+
+71
+72
+73
+74
+75
+76</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/helium/client/http.rb', line 71</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>
@@ -579,10 +762,10 @@
</div>
</div>
<div id="footer">
- Generated on Thu Jan 12 15:58:34 2017 by
+ Generated on Mon Feb 13 09:17:41 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.5 (ruby-2.3.1).
</div>
</div>
\ No newline at end of file