RubyGems - pinterest-ruby - Versions diffs - 1.0.0 - Mend

pinterest-ruby 1.0.0

Files changed (150) hide show

data/docs/Pinterest/Errors.html ADDED Viewed

@@ -0,0 +1,377 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Pinterest::Errors
+    &mdash; Documentation by YARD 0.9.7
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "Pinterest::Errors";
+  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> &raquo;
+    <span class='title'><span class='object_link'><a href="../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span>
+     &raquo;
+    <span class="title">Errors</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>Module: Pinterest::Errors
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/pinterest/errors.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>A list of errors returned by the client.</p>
+  </div>
+</div>
+<div class="tags">
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Errors/AuthorizationError.html" title="Pinterest::Errors::AuthorizationError (class)">AuthorizationError</a></span>, <span class='object_link'><a href="Errors/BadRequestError.html" title="Pinterest::Errors::BadRequestError (class)">BadRequestError</a></span>, <span class='object_link'><a href="Errors/BaseError.html" title="Pinterest::Errors::BaseError (class)">BaseError</a></span>, <span class='object_link'><a href="Errors/MethodNotAllowedError.html" title="Pinterest::Errors::MethodNotAllowedError (class)">MethodNotAllowedError</a></span>, <span class='object_link'><a href="Errors/NotFoundError.html" title="Pinterest::Errors::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="Errors/NotImplementedError.html" title="Pinterest::Errors::NotImplementedError (class)">NotImplementedError</a></span>, <span class='object_link'><a href="Errors/PermissionsError.html" title="Pinterest::Errors::PermissionsError (class)">PermissionsError</a></span>, <span class='object_link'><a href="Errors/RateLimitError.html" title="Pinterest::Errors::RateLimitError (class)">RateLimitError</a></span>, <span class='object_link'><a href="Errors/ServerError.html" title="Pinterest::Errors::ServerError (class)">ServerError</a></span>, <span class='object_link'><a href="Errors/TimeoutError.html" title="Pinterest::Errors::TimeoutError (class)">TimeoutError</a></span>
+</p>
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+      <dt id="CODES-constant" class="">CODES =
+        <div class="docstring">
+  <div class="discussion">
+    <p>A dictionary that associates HTTP status codes to error classes.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+  <span class='int'>400</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>BadRequestError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>401</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>AuthorizationError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>403</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PermissionsError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>404</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>NotFoundError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>405</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>MethodNotAllowedError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>408</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TimeoutError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>429</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>RateLimitError</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='int'>501</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>NotImplementedError</span><span class='tstring_end'>&quot;</span></span>
+<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+  </dl>
+    <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="#class_for_code-class_method" title="class_for_code (class method)">.<strong>class_for_code</strong>(status)  &#x21d2; Class </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Get the class for a HTTP status code.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#create-class_method" title="create (class method)">.<strong>create</strong>(response)  &#x21d2; BaseError </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new error.</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="class_for_code-class_method">
+    .<strong>class_for_code</strong>(status)  &#x21d2; <tt>Class</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Get the class for a HTTP status code.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>status</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The HTTP status code.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Class</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The class.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+89
+90
+91
+92</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/errors.rb', line 89</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class_for_code'>class_for_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../Pinterest.html" title="Pinterest (module)">Pinterest</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Pinterest::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="#CODES-constant" title="Pinterest::Errors::CODES (constant)">CODES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ServerError</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>::Pinterest::Errors::</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_klass'>klass</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="create-class_method">
+    .<strong>create</strong>(response)  &#x21d2; <tt><span class='object_link'><a href="Errors/BaseError.html" title="Pinterest::Errors::BaseError (class)">BaseError</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new error.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>response</span>
+        <span class='type'>(<tt>Faraday::Response</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The network response.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="Errors/BaseError.html" title="Pinterest::Errors::BaseError (class)">BaseError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>A error object.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+78
+79
+80
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pinterest/errors.rb', line 78</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</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='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>error</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>message</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_class_for_code'>class_for_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Thu Jan 12 16:28:12 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.7 (ruby-2.3.0).
+</div>
+    </div>
+  </body>
+</html>