shep 0.1.0.pre.alpha0 → 0.2.0.pre.alpha0

data/doc/Shep.html

@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/shep.rb<span class="defines">,<br />
-  lib/shep/exceptions.rb,<br /> lib/shep/entity_base.rb,<br /> lib/shep/entities.rb,<br /> lib/shep/session.rb</span>
+  lib/shep/version.rb,<br /> lib/shep/exceptions.rb,<br /> lib/shep/entity_base.rb,<br /> lib/shep/entities.rb,<br /> lib/shep/session.rb</span>
 </dd>
   </dl>
   
@@ -87,8 +87,7 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>SHEP: Simple Http intErface to Pmastodon</p>
+    <p>SHEP: Simple Http intErface to Pmastodon</p>
 
 
   </div>
@@ -107,6 +106,22 @@
   
 </p>
 
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="Version-constant" class="">Version =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.2.0-alpha0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+      
+    </dl>
+  
+
 
 
 
@@ -118,9 +133,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:29 2023 by
+  Generated on Sat Jun 10 19:16:28 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/_index.html

@@ -60,7 +60,7 @@
   <ul id="files" class="index_inline_list">
   
   
-    <li class="r1"><a href="file.README.html" title="README">README</a></li>
+    <li class="r1"><a href="index.html" title="README">README</a></li>
     
   
   </ul>
@@ -191,6 +191,13 @@
           <li class="letter">R</li>
           <ul>
             
+              <li>
+                <span class='object_link'><a href="Shep/Error/RateLimit.html" title="Shep::Error::RateLimit (class)">RateLimit</a></span>
+                
+                  <small>(Shep::Error)</small>
+                
+              </li>
+            
               <li>
                 <span class='object_link'><a href="Shep/Error/Remote.html" title="Shep::Error::Remote (class)">Remote</a></span>
                 
@@ -290,9 +297,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:28 2023 by
+  Generated on Sat Jun 10 19:16:28 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/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_Shep' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Shep.html" title="Shep (module)">Shep</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Shep::Entity' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Shep/Entity.html" title="Shep::Entity (class)">Entity</a></span> &lt; Object<small class='search_info'>Shep</small></div><ul><li id='object_Shep::Entity::Account' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Account.html" title="Shep::Entity::Account (class)">Account</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Context' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Context.html" title="Shep::Entity::Context (class)">Context</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::CustomEmoji' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/CustomEmoji.html" title="Shep::Entity::CustomEmoji (class)">CustomEmoji</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::MediaAttachment' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/MediaAttachment.html" title="Shep::Entity::MediaAttachment (class)">MediaAttachment</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Notification' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Notification.html" title="Shep::Entity::Notification (class)">Notification</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status.html" title="Shep::Entity::Status (class)">Status</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::StatusSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/StatusSource.html" title="Shep::Entity::StatusSource (class)">StatusSource</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Application' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Application.html" title="Shep::Entity::Status_Application (class)">Status_Application</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Mention' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Mention.html" title="Shep::Entity::Status_Mention (class)">Status_Mention</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Tag' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Tag.html" title="Shep::Entity::Status_Tag (class)">Status_Tag</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li></ul></li><li id='object_Shep::Error' class='collapsed even'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Shep/Error.html" title="Shep::Error (class)">Error</a></span> &lt; RuntimeError<small class='search_info'>Shep</small></div><ul><li id='object_Shep::Error::Caller' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Caller.html" title="Shep::Error::Caller (class)">Caller</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Http.html" title="Shep::Error::Http (class)">Http</a></span> &lt; Server<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Remote' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Remote.html" title="Shep::Error::Remote (class)">Remote</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Server' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Server.html" title="Shep::Error::Server (class)">Server</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Type' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Type.html" title="Shep::Error::Type (class)">Type</a></span> &lt; Caller<small class='search_info'>Shep::Error</small></div></li></ul></li><li id='object_Shep::Session' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Shep/Session.html" title="Shep::Session (class)">Session</a></span> &lt; Object<small class='search_info'>Shep</small></div></li></ul></li>
+<li id='object_Shep' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Shep.html" title="Shep (module)">Shep</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Shep::Entity' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Shep/Entity.html" title="Shep::Entity (class)">Entity</a></span> &lt; Object<small class='search_info'>Shep</small></div><ul><li id='object_Shep::Entity::Account' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Account.html" title="Shep::Entity::Account (class)">Account</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Context' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Context.html" title="Shep::Entity::Context (class)">Context</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::CustomEmoji' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/CustomEmoji.html" title="Shep::Entity::CustomEmoji (class)">CustomEmoji</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::MediaAttachment' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/MediaAttachment.html" title="Shep::Entity::MediaAttachment (class)">MediaAttachment</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Notification' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Notification.html" title="Shep::Entity::Notification (class)">Notification</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status.html" title="Shep::Entity::Status (class)">Status</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::StatusSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/StatusSource.html" title="Shep::Entity::StatusSource (class)">StatusSource</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Application' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Application.html" title="Shep::Entity::Status_Application (class)">Status_Application</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Mention' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Mention.html" title="Shep::Entity::Status_Mention (class)">Status_Mention</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li><li id='object_Shep::Entity::Status_Tag' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Entity/Status_Tag.html" title="Shep::Entity::Status_Tag (class)">Status_Tag</a></span> &lt; Entity<small class='search_info'>Shep::Entity</small></div></li></ul></li><li id='object_Shep::Error' class='collapsed even'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Shep/Error.html" title="Shep::Error (class)">Error</a></span> &lt; RuntimeError<small class='search_info'>Shep</small></div><ul><li id='object_Shep::Error::Caller' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Caller.html" title="Shep::Error::Caller (class)">Caller</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Http.html" title="Shep::Error::Http (class)">Http</a></span> &lt; Server<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::RateLimit' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/RateLimit.html" title="Shep::Error::RateLimit (class)">RateLimit</a></span> &lt; Http<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Remote' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Remote.html" title="Shep::Error::Remote (class)">Remote</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Server' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Server.html" title="Shep::Error::Server (class)">Server</a></span> &lt; Error<small class='search_info'>Shep::Error</small></div></li><li id='object_Shep::Error::Type' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Shep/Error/Type.html" title="Shep::Error::Type (class)">Type</a></span> &lt; Caller<small class='search_info'>Shep::Error</small></div></li></ul></li><li id='object_Shep::Session' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Shep/Session.html" title="Shep::Session (class)">Session</a></span> &lt; Object<small class='search_info'>Shep</small></div></li></ul></li>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -57,32 +57,35 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><div id='filecontents'>
-<h1 id="label-Shep-3A+Simple+Http+intErface+to+Pmastodon">Shep: Simple Http intErface to Pmastodon</h1>
+      <div id="content"><div id='filecontents'><h1 id="shep-simple-http-interface-to-pmastodon">Shep: Simple Http intErface to Pmastodon</h1>
 
-<p>Shep is a library that provides access to the Mastodon web API. It is an alternative to the <a href="https://rubygems.org/gems/mastodon-api/versions/2.0.0">official Mastodon API Gem</a>.</p>
+<p>Shep is a library that provides access to the Mastodon web API.  It is
+an alternative to the
+<a href="https://rubygems.org/gems/mastodon-api/versions/2.0.0">official Mastodon API Gem</a>.</p>
 
 <p>Pros:</p>
-<ul><li>
-<p>It has no dependencies other than stock Ruby 3.0.x or later. (It’s  also been seen to work on JRuby-9.4.2.0.)</p>
-</li><li>
-<p>Its unit tests do not require a dedicated Mastodon instance and will  work with just a scratch user account (and partially without even  that).</p>
-</li><li>
-<p>It’s a bit more “batteries included” than the official gem tries to  do more for you.</p>
-</li><li>
-<p>It supports <a href="https://docs.joinmastodon.org/methods/statuses/#context">Contexts</a>.</p>
-</li></ul>
+
+<ul>
+<li>It has no dependencies other than stock Ruby 3.0.x or later.  (It&#39;s
+also been seen to work on JRuby-9.4.2.0.)</li>
+<li>Its unit tests do not require a dedicated Mastodon instance and will
+work with just a scratch user account (and partially without even
+that).</li>
+<li>It&#39;s a bit more &quot;batteries included&quot; than the official gem tries to
+do more for you.</li>
+<li>It supports <a href="https://docs.joinmastodon.org/methods/statuses/#context">Contexts</a>.</li>
+</ul>
 
 <p>Cons:</p>
-<ul><li>
-<p>It supports much less of the API than the offical gem.</p>
-</li><li>
-<p>Its author thinks metaprogramming is cool.</p>
-</li></ul>
 
-<h2 id="label-Some+Quick+Examples-3A">Some Quick Examples:</h2>
+<ul>
+<li>It supports much less of the API than the offical gem.</li>
+<li>Its author thinks metaprogramming is cool.</li>
+</ul>
+
+<h2 id="some-quick-examples">Some Quick Examples:</h2>
 
-<p>Here’s the canonical use case, retrieving cat pictures:</p>
+<p>Here&#39;s the canonical use case, retrieving cat pictures:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>shep</span><span class='tstring_end'>&#39;</span></span>
 
@@ -118,40 +121,56 @@
 
 <p>It can also be used for other things.</p>
 
-<h2 id="label-Installation">Installation</h2>
+<h2 id="installation">Installation</h2>
 
 <p>The usual way to install Shep is via gem:</p>
 
-<pre class="code ruby"><code class="ruby">$ gem install shep
+<pre class="code ruby"><code class="ruby">$ gem install shep --pre
 </code></pre>
 
 <p>Alternately, you can fetch this repo and add it to your Ruby path.</p>
 
-<p>If you wish to develop Shep, you’ll also need Rake, YARD, and RSpec.</p>
+<p>If you wish to develop Shep, you&#39;ll also need Rake, YARD, and RSpec.</p>
+
+<h2 id="testing">Testing</h2>
 
-<h2 id="label-Testing">Testing</h2>
+<p>The tests are somewhat clever in that if there isn&#39;t a Mastodon
+instance available or if you don&#39;t have a writable account on it, it
+will still try to run tests that don&#39;t need those things.</p>
 
-<p>The tests are somewhat clever in that if there isn’t a Mastodon instance available or if you don’t have a writable account on it, it will still try to run tests that don’t need those things.</p>
+<p>On they other hand, some of the tests will fail if (e.g.) an account
+doesn&#39;t have enough statuses with attached pictures.  I&#39;ve tried to
+document this when it happens.  Usually, a test will fail rather than
+let a part of the code go untested.</p>
 
-<p>On they other hand, some of the tests will fail if (e.g.) an account doesn’t have enough statuses with attached pictures. I’ve tried to document this when it happens. Usually, a test will fail rather than let a part of the code go untested.</p>
+<p>The tests get credentials from the environment.  Normally, I run
+<code>rake test</code> from a script that first sets those variables to useful
+values.</p>
 
-<p>The tests get credentials from the environment. Normally, I run <code>rake test</code> from a script that first sets those variables to useful values.</p>
+<p>The file <code>run_rake_test.example.sh</code> documents these variables and what
+they do.</p>
 
-<p>The file <code>run_rake_test.example.sh</code> documents these variables and what they do.</p>
+<p>There are also a number of tricky tests (e.g. for rate-limit-reached
+cases) that need to be explicitly invoked using rspec tags.  See
+<code>spec/session_zzz_tricky.rb</code> for details.</p>
 
-<h2 id="label-License+and+Warranty">License and Warranty</h2>
+<h2 id="license-and-warranty">License and Warranty</h2>
 
-<p>Shep is available under the terms of the GNU Affero GPL Version 3 plus an exemption that allows you to release programs that use it under your own terms.</p>
+<p>Shep is available under the terms of the GNU Affero GPL Version 3 plus
+an exemption that allows you to release programs that use it under
+your own terms.</p>
 
-<p>It is offered <strong>WITHOUT WARRANTY OF ANY KIND</strong>. If it breaks, you get to keep the pieces.</p>
+<p>It is offered <strong>WITHOUT WARRANTY OF ANY KIND</strong>.  If it breaks, you get to keep
+the pieces.</p>
 
-<p>While it is not legally required or enforcable, you are nontheless honour-bound to use Shep only for good and never for evil.</p>
+<p>While it is not legally required or enforcable, you are nontheless
+honour-bound to use Shep only for good and never for evil.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Jun  4 13:40:29 2023 by
+  Generated on Sat Jun 10 19:16:28 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/file_list.html

@@ -45,7 +45,7 @@
         
 
   <li id="object_README" class="odd">
-    <div class="item"><span class="object_link"><a href="file.README.html" title="README">README</a></span></div>
+    <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
   </li>