shep 0.1.0.pre.alpha0 → 0.2.1.pre.alpha0

data/doc/Shep/Error/Caller.html

@@ -105,8 +105,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Error caused by using the interface incorrectly. <em>Not</em> the same as incorrect input data (usually)</p>
+    <p>Error caused by using the interface incorrectly.  <em>Not</em> the same
+as incorrect input data (usually)</p>
 
 
   </div>
@@ -137,9 +137,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:30 2023 by
+  Generated on Thu Jun 15 10:09:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/Shep/Error/Http.html

@@ -107,10 +107,10 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Thrown when the HTTP library returns an error response.</p>
+    <p>Thrown when the HTTP library returns an error response.</p>
 
-<p>Basically the same meaning as Error::Server but also includes the response object for your perusal.</p>
+<p>Basically the same meaning as Error::Server but also includes
+the response object for your perusal.</p>
 
 
   </div>
@@ -118,10 +118,14 @@
 <div class="tags">
   
 
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="RateLimit.html" title="Shep::Error::RateLimit (class)">RateLimit</a></span></p>
 </div>
 
 
 
+
   <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
   <ul class="summary">
     
@@ -147,8 +151,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute response.</p>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute response.</p>
 </div></span>
   
 </li>
@@ -186,8 +189,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of Http.</p>
+    <span class="summary_desc"><div class='inline'><p>A new instance of Http.</p>
 </div></span>
   
 </li>
@@ -223,8 +225,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns a new instance of Http.</p>
+    <p>Returns a new instance of Http.</p>
 
 
   </div>
@@ -238,18 +239,18 @@
       <pre class="lines">
 
 
-40
-41
-42
 43
 44
 45
 46
 47
-48</pre>
+48
+49
+50
+51</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 40</span>
+      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 43</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='rparen'>)</span>
   <span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HTTP Error </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -283,8 +284,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns the value of attribute response.</p>
+    <p>Returns the value of attribute response.</p>
 
 
   </div>
@@ -298,12 +298,12 @@
       <pre class="lines">
 
 
-39
-40
-41</pre>
+42
+43
+44</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 39</span>
+      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 42</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
   <span class='ivar'>@response</span>
@@ -319,9 +319,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:30 2023 by
+  Generated on Thu Jun 15 10:09:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/Shep/Error/RateLimit.html

@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: Shep::Error::RateLimit
+  
+    &mdash; Documentation by YARD 0.9.34
+  
+</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 = "Shep::Error::RateLimit";
+  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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Shep.html" title="Shep (module)">Shep</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Error.html" title="Shep::Error (class)">Error</a></span></span>
+     &raquo; 
+    <span class="title">RateLimit</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: Shep::Error::RateLimit
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Http.html" title="Shep::Error::Http (class)">Http</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">RuntimeError</li>
+          
+            <li class="next"><span class='object_link'><a href="../Error.html" title="Shep::Error (class)">Shep::Error</a></span></li>
+          
+            <li class="next"><span class='object_link'><a href="Server.html" title="Shep::Error::Server (class)">Server</a></span></li>
+          
+            <li class="next"><span class='object_link'><a href="Http.html" title="Shep::Error::Http (class)">Http</a></span></li>
+          
+            <li class="next">Shep::Error::RateLimit</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/shep/exceptions.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Thrown when the HTTP operation fails because a rate limit was
+reached.  <code>Session.rate_limit</code> will <strong>probably</strong> return the
+correct reset time, but no promises at this time.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+  <h2>Instance Attribute Summary</h2>
+  
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Http.html" title="Shep::Error::Http (class)">Http</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Http.html#response-instance_method" title="Shep::Error::Http#response (method)">#response</a></span></p>
+
+
+
+  
+  
+  
+  
+  
+  
+  <h2>Method Summary</h2>
+  
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Http.html" title="Shep::Error::Http (class)">Http</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Http.html#initialize-instance_method" title="Shep::Error::Http#initialize (method)">#initialize</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Http.html#initialize-instance_method" title="Shep::Error::Http#initialize (method)">Shep::Error::Http</a></span></p>
+  
+</div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jun 15 10:09:20 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.0.3).
+</div>
+
+    </div>
+  </body>
+</html>

data/doc/Shep/Error/Remote.html

@@ -105,8 +105,7 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Error caused by network issues.</p>
+    <p>Error caused by network issues.</p>
 
 
   </div>
@@ -133,9 +132,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:30 2023 by
+  Generated on Thu Jun 15 10:09:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/Shep/Error/Server.html

@@ -105,8 +105,9 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Thrown when the server doesn’t like what we did. (Different from Error::Remote because this assumes the server is working correctly.)</p>
+    <p>Thrown when the server doesn&#39;t like what we did.  (Different
+from Error::Remote because this assumes the server is working
+correctly.)</p>
 
 
   </div>
@@ -137,9 +138,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:30 2023 by
+  Generated on Thu Jun 15 10:09:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/Shep/Error/Type.html

@@ -107,8 +107,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Error caused by assigning a value of the wrong type to an <code>Entity</code> field.</p>
+    <p>Error caused by assigning a value of the wrong type to an
+<code>Entity</code> field.</p>
 
 
   </div>
@@ -150,8 +150,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of Type.</p>
+    <span class="summary_desc"><div class='inline'><p>A new instance of Type.</p>
 </div></span>
   
 </li>
@@ -187,8 +186,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns a new instance of Type.</p>
+    <p>Returns a new instance of Type.</p>
 
 
   </div>
@@ -202,12 +200,12 @@
       <pre class="lines">
 
 
-21
-22
-23</pre>
+24
+25
+26</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/shep/exceptions.rb', line 24</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_boxdesc'>boxdesc</span><span class='comma'>,</span> <span class='id identifier rubyid_got'>got</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_want'>want</span><span class='rparen'>)</span>
   <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_boxdesc'>boxdesc</span><span class='embexpr_end'>}</span><span class='tstring_content'> expects </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_want'>want</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>,</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>; got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_got'>got</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -223,9 +221,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:30 2023 by
+  Generated on Thu Jun 15 10:09:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/Shep/Error.html

@@ -103,8 +103,11 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Base class for exceptions originating from Shep. Use this to trap all Shep exceptions at once.</p>
+    <p>Base class for exceptions originating from Shep.  Use this to trap
+all Shep exceptions at once.</p>
+
+<p>Note that Shep usually does not trap exceptions thrown by
+Net::HTTP and friends; you will need to trap those separately.</p>
 
 
   </div>
@@ -122,7 +125,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Error/Caller.html" title="Shep::Error::Caller (class)">Caller</a></span>, <span class='object_link'><a href="Error/Http.html" title="Shep::Error::Http (class)">Http</a></span>, <span class='object_link'><a href="Error/Remote.html" title="Shep::Error::Remote (class)">Remote</a></span>, <span class='object_link'><a href="Error/Server.html" title="Shep::Error::Server (class)">Server</a></span>, <span class='object_link'><a href="Error/Type.html" title="Shep::Error::Type (class)">Type</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Error/Caller.html" title="Shep::Error::Caller (class)">Caller</a></span>, <span class='object_link'><a href="Error/Http.html" title="Shep::Error::Http (class)">Http</a></span>, <span class='object_link'><a href="Error/RateLimit.html" title="Shep::Error::RateLimit (class)">RateLimit</a></span>, <span class='object_link'><a href="Error/Remote.html" title="Shep::Error::Remote (class)">Remote</a></span>, <span class='object_link'><a href="Error/Server.html" title="Shep::Error::Server (class)">Server</a></span>, <span class='object_link'><a href="Error/Type.html" title="Shep::Error::Type (class)">Type</a></span>
     
   
 </p>
@@ -139,9 +142,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:29 2023 by
+  Generated on Thu Jun 15 10:09:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.1.0).
+  0.9.34 (ruby-3.0.3).
 </div>
 
     </div>