<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::Internet — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Discorb::Internet"; relpath = '../'; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../a_index.html">Index (I)</a> » <span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class="title">Internet</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: Discorb::Internet </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">Discorb::Internet</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/internet.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>A class to handle internet requests. This class is internal use only.</p> </div> </div> <div class="tags"> </div> <h2> Class Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#multipart-class_method" title="multipart (class method)">.<strong>multipart</strong>(payload, files) ⇒ Array[String, String] </a> </span> <span class="summary_desc"><div class='inline'><p>A helper method to send multipart/form-data requests.</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"> <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, headers: nil, audit_log_reason: nil, **kwargs) ⇒ Array[Net::HTTPResponse, Hash], Array[Net::HTTPResponse, nil] </a> </span> <span class="summary_desc"><div class='inline'><p>Execute a DELETE request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(path, headers: nil, audit_log_reason: nil, **kwargs) ⇒ Array[Net::HTTPResponse, Hash], Array[Net::HTTPResponse, nil] </a> </span> <span class="summary_desc"><div class='inline'><p>Execute a GET request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#patch-instance_method" title="#patch (instance method)">#<strong>patch</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ Array[Net::HTTPResponse, Hash], Array[Net::HTTPResponse, nil] </a> </span> <span class="summary_desc"><div class='inline'><p>Execute a PATCH request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#post-instance_method" title="#post (instance method)">#<strong>post</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ Array[Net::HTTPResponse, Hash], Array[Net::HTTPResponse, nil] </a> </span> <span class="summary_desc"><div class='inline'><p>Execute a POST request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ Array[Net::HTTPResponse, Hash], Array[Net::HTTPResponse, nil] </a> </span> <span class="summary_desc"><div class='inline'><p>Execute a PUT request.</p> </div></span> </li> </ul> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="multipart-class_method"> .<strong>multipart</strong>(payload, files) ⇒ <tt>Array[String, String]</tt> </h3><div class="docstring"> <div class="discussion"> <p>A helper method to send multipart/form-data requests.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>payload</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The payload to send.</p> </div> </li> <li> <span class='name'>files</span> <span class='type'>(<tt>Array<<span class='object_link'><a href="File.html" title="Discorb::File (class)">Discorb::File</a></span>></tt>)</span> — <div class='inline'><p>The files to send.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[String, String]</tt>)</span> — <div class='inline'><p>The boundary and body.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 194</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_multipart'>multipart</span><span class='lparen'>(</span><span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='id identifier rubyid_files'>files</span><span class='rparen'>)</span> <span class='id identifier rubyid_boundary'>boundary</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DiscorbBySevenC7CMultipartFormData</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_str_payloads'>str_payloads</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='heredoc_beg'><<~HTTP</span><span class='rbracket'>]</span> <span class='tstring_content'> Content-Disposition: form-data; name="payload_json" </span><span class='tstring_content'> Content-Type: application/json </span><span class='tstring_content'> </span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_payload'>payload</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='heredoc_end'> HTTP </span> <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_single_file'>single_file</span><span class='op'>|</span> <span class='id identifier rubyid_str_payloads'>str_payloads</span> <span class='op'><<</span> <span class='heredoc_beg'><<~HTTP</span> <span class='tstring_content'> Content-Disposition: form-data; name="file"; filename="</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_single_file'>single_file</span><span class='period'>.</span><span class='id identifier rubyid_filename'>filename</span><span class='embexpr_end'>}</span><span class='tstring_content'>" </span><span class='tstring_content'> Content-Type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_single_file'>single_file</span><span class='period'>.</span><span class='id identifier rubyid_content_type'>content_type</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_content'> </span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_single_file'>single_file</span><span class='period'>.</span><span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='heredoc_end'> HTTP </span> <span class='kw'>end</span> <span class='lbracket'>[</span><span class='id identifier rubyid_boundary'>boundary</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_boundary'>boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str_payloads'>str_payloads</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n--</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_boundary'>boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n--</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_boundary'>boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>--</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</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="delete-instance_method"> #<strong>delete</strong>(path, headers: nil, audit_log_reason: nil, **kwargs) ⇒ <tt>Array[Net::HTTPResponse, Hash]</tt>, <tt>Array[Net::HTTPResponse, nil]</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <p>Execute a DELETE request.</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>The path to the resource.</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The headers to send with the request.</p> </div> </li> <li> <span class='name'>audit_log_reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The audit log reason to send with the request.</p> </div> </li> <li> <span class='name'>kwargs</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The keyword arguments.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, Hash]</tt>)</span> — <div class='inline'><p>The response and as JSON.</p> </div> </li> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, nil]</tt>)</span> — <div class='inline'><p>The response was 204.</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span> — <div class='inline'><p>The request was failed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 164</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='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_task'>task</span><span class='op'>|</span> <span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_get_path'>get_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_headers'>get_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='kw'>nil</span> <span class='kw'>else</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_rd'>rd</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_test_error'>test_error</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>429</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_task'>task</span><span class='period'>.</span><span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>else</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span> <span class='kw'>end</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get-instance_method"> #<strong>get</strong>(path, headers: nil, audit_log_reason: nil, **kwargs) ⇒ <tt>Array[Net::HTTPResponse, Hash]</tt>, <tt>Array[Net::HTTPResponse, nil]</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <p>Execute a GET request.</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>The path to the resource.</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The headers to send with the request.</p> </div> </li> <li> <span class='name'>audit_log_reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The audit log reason to send with the request.</p> </div> </li> <li> <span class='name'>kwargs</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The keyword arguments.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, Hash]</tt>)</span> — <div class='inline'><p>The response and as JSON.</p> </div> </li> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, nil]</tt>)</span> — <div class='inline'><p>The response was 204.</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span> — <div class='inline'><p>The request was failed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 32</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='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_task'>task</span><span class='op'>|</span> <span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_get_path'>get_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_headers'>get_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='kw'>nil</span> <span class='kw'>else</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_rd'>rd</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_test_error'>test_error</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>429</span><span class='tstring_end'>"</span></span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_log'>log</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Ratelimit exceeded for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>, trying again in </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> seconds.</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_task'>task</span><span class='period'>.</span><span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='rparen'>)</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='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>else</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span> <span class='kw'>end</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="inspect-instance_method"> #<strong>inspect</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 182 183 184</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 182</span> <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> client=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@client</span><span class='embexpr_end'>}</span><span class='tstring_content'>></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="patch-instance_method"> #<strong>patch</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ <tt>Array[Net::HTTPResponse, Hash]</tt>, <tt>Array[Net::HTTPResponse, nil]</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <p>Execute a PATCH request.</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>The path to the resource.</p> </div> </li> <li> <span class='name'>body</span> <span class='type'>(<tt>String</tt>, <tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'><p>The body of the request.</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The headers to send with the request.</p> </div> </li> <li> <span class='name'>audit_log_reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The audit log reason to send with the request.</p> </div> </li> <li> <span class='name'>kwargs</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The keyword arguments.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, Hash]</tt>)</span> — <div class='inline'><p>The response and as JSON.</p> </div> </li> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, nil]</tt>)</span> — <div class='inline'><p>The response was 204.</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span> — <div class='inline'><p>The request was failed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 99</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_body'>body</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_task'>task</span><span class='op'>|</span> <span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_get_path'>get_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_body'>get_body</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_headers'>get_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='kw'>nil</span> <span class='kw'>else</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_rd'>rd</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_test_error'>test_error</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>429</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_task'>task</span><span class='period'>.</span><span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='rparen'>)</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_body'>body</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>else</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span> <span class='kw'>end</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="post-instance_method"> #<strong>post</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ <tt>Array[Net::HTTPResponse, Hash]</tt>, <tt>Array[Net::HTTPResponse, nil]</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <p>Execute a POST request.</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>The path to the resource.</p> </div> </li> <li> <span class='name'>body</span> <span class='type'>(<tt>String</tt>, <tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'><p>The body of the request.</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The headers to send with the request.</p> </div> </li> <li> <span class='name'>audit_log_reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The audit log reason to send with the request.</p> </div> </li> <li> <span class='name'>kwargs</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The keyword arguments.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, Hash]</tt>)</span> — <div class='inline'><p>The response and as JSON.</p> </div> </li> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, nil]</tt>)</span> — <div class='inline'><p>The response was 204.</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span> — <div class='inline'><p>The request was failed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 66</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_body'>body</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_task'>task</span><span class='op'>|</span> <span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_get_path'>get_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_body'>get_body</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_headers'>get_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='kw'>nil</span> <span class='kw'>else</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_rd'>rd</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_test_error'>test_error</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>429</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_task'>task</span><span class='period'>.</span><span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='rparen'>)</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_body'>body</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>else</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span> <span class='kw'>end</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="put-instance_method"> #<strong>put</strong>(path, body = "", headers: nil, audit_log_reason: nil, **kwargs) ⇒ <tt>Array[Net::HTTPResponse, Hash]</tt>, <tt>Array[Net::HTTPResponse, nil]</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <p>Execute a PUT request.</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>The path to the resource.</p> </div> </li> <li> <span class='name'>body</span> <span class='type'>(<tt>String</tt>, <tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'><p>The body of the request.</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The headers to send with the request.</p> </div> </li> <li> <span class='name'>audit_log_reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The audit log reason to send with the request.</p> </div> </li> <li> <span class='name'>kwargs</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The keyword arguments.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, Hash]</tt>)</span> — <div class='inline'><p>The response and as JSON.</p> </div> </li> <li> <span class='type'>(<tt>Array[Net::HTTPResponse, nil]</tt>)</span> — <div class='inline'><p>The response was 204.</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span> — <div class='inline'><p>The request was failed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/internet.rb', line 132</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_body'>body</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_task'>task</span><span class='op'>|</span> <span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_get_path'>get_path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_body'>get_body</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_get_headers'>get_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_rd'>rd</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='kw'>nil</span> <span class='kw'>else</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_rd'>rd</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_test_error'>test_error</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>429</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_task'>task</span><span class='period'>.</span><span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:retry_after</span><span class='rbracket'>]</span><span class='rparen'>)</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_body'>body</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_audit_log_reason'>audit_log_reason</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>else</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span> <span class='kw'>end</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/5bbfb4d90cb927c27f3e9c25b29d739224986cd6"><code>5bbfb4d90cb927c27f3e9c25b29d739224986cd6</code></a>, version (main), with YARD 0.9.26. </div> </div> </body> </html>