docs/OpConnect/Error.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: OpConnect::Error
— Documentation by YARD 0.9.27
</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 = "OpConnect::Error";
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="../_index.html">Index (E)</a> »
<span class='title'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span>
»
<span class="title">Error</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>Exception: OpConnect::Error
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next">OpConnect::Error</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/op_connect/error.rb</dd>
</dl>
</div>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ClientError.html" title="OpConnect::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="ServerError.html" title="OpConnect::ServerError (class)">ServerError</a></span></p>
</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="#from_response-class_method" title="from_response (class method)">.<strong>from_response</strong>(response) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(response = nil) ⇒ Error </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Error.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(response = nil) ⇒ <tt><span class='object_link'><a href="" title="OpConnect::Error (class)">Error</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Error.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/op_connect/error.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_build_error_message'>build_error_message</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="from_response-class_method">
.<strong>from_response</strong>(response) ⇒ <tt><span class='object_link'><a href="Object.html" title="OpConnect::Object (class)">Object</a></span></tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/op_connect/error.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_from_response'>from_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_status'>status</span>
<span class='kw'>when</span> <span class='int'>400</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="BadRequest.html" title="OpConnect::BadRequest (class)">BadRequest</a></span></span>
<span class='kw'>when</span> <span class='int'>401</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Unauthorized.html" title="OpConnect::Unauthorized (class)">Unauthorized</a></span></span>
<span class='kw'>when</span> <span class='int'>403</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Forbidden.html" title="OpConnect::Forbidden (class)">Forbidden</a></span></span>
<span class='kw'>when</span> <span class='int'>404</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NotFound.html" title="OpConnect::NotFound (class)">NotFound</a></span></span>
<span class='kw'>when</span> <span class='int'>413</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PayloadTooLarge.html" title="OpConnect::PayloadTooLarge (class)">PayloadTooLarge</a></span></span>
<span class='kw'>when</span> <span class='int'>400</span><span class='op'>..</span><span class='int'>499</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ClientError.html" title="OpConnect::ClientError (class)">ClientError</a></span></span>
<span class='kw'>when</span> <span class='int'>500</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="InternalServerError.html" title="OpConnect::InternalServerError (class)">InternalServerError</a></span></span>
<span class='kw'>when</span> <span class='int'>503</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ServiceUnavailable.html" title="OpConnect::ServiceUnavailable (class)">ServiceUnavailable</a></span></span>
<span class='kw'>when</span> <span class='int'>500</span><span class='op'>..</span><span class='int'>599</span> <span class='kw'>then</span> <span class='const'><span class='object_link'><a href="../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ServerError.html" title="OpConnect::ServerError (class)">ServerError</a></span></span>
<span class='kw'>end</span><span class='rparen'>)</span>
<span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</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 on Mon Mar 21 03:39:12 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.1.1).
</div>
</div>
</body>
</html>