RubyGems - outboxer - Versions diffs - 0.1.2 → 0.1.5 - Mend

outboxer 0.1.2 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml +4 -4
data/README.md +5 -4
data/Rakefile +5 -1
data/generators/outboxer/templates/bin/publisher.rb +0 -2
data/lib/outboxer/exception.rb +9 -0
data/lib/outboxer/message.rb +19 -0
data/lib/outboxer/outboxable.rb +21 -0
data/lib/outboxer/publisher.rb +4 -4
data/lib/outboxer/version.rb +1 -1
data/lib/outboxer.rb +4 -6
data/outboxer.gemspec +2 -2
metadata +6 -28
data/doc/Outboxer/Models/Exception.html +0 -124
data/doc/Outboxer/Models/Message.html +0 -144
data/doc/Outboxer/Models/Outboxable/ClassMethods.html +0 -105
data/doc/Outboxer/Models/Outboxable.html +0 -265
data/doc/Outboxer/Models.html +0 -119
data/doc/Outboxer/Publisher/Args.html +0 -310
data/doc/Outboxer/Publisher.html +0 -384
data/doc/Outboxer/Railtie.html +0 -124
data/doc/Outboxer.html +0 -150
data/doc/_index.html +0 -211
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -497
data/doc/file.README.html +0 -180
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -17
data/doc/index.html +0 -180
data/doc/js/app.js +0 -314
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -99
data/doc/top-level-namespace.html +0 -110
data/lib/outboxer/models/exception.rb +0 -11
data/lib/outboxer/models/message.rb +0 -21
data/lib/outboxer/models/outboxable.rb +0 -23

data/doc/Outboxer/Publisher.html DELETED Viewed

@@ -1,384 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Outboxer::Publisher
-    &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 = "Outboxer::Publisher";
-  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 (P)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span>
-     &raquo;
-    <span class="title">Publisher</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: Outboxer::Publisher
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/outboxer/publisher.rb</dd>
-  </dl>
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Publisher/Args.html" title="Outboxer::Publisher::Args (class)">Args</a></span>
-</p>
-    <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="#publish-class_method" title="publish (class method)">.<strong>publish</strong>(poll: 1, backoff: -&gt;(current_backoff) { [current_backoff * 2, 5 * 60].min }) {|args| ... } &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>This method initiates the publishing process.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#stop-class_method" title="stop (class method)">.<strong>stop</strong>  &#x21d2; void </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Stops the publishing process.</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="publish-class_method">
-    .<strong>publish</strong>(poll: 1, backoff: -&gt;(current_backoff) { [current_backoff * 2, 5 * 60].min }) {|args| ... } &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>This method initiates the publishing process. It dequeues the messages one by one and yields to a block that should contain the publishing logic.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>poll</span>
-        <span class='type'>(<tt>Integer</tt>)</span>
-        <em class="default">(defaults to: <tt>1</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>Sleep time in seconds between polling the queue when it&#39;s empty.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>backoff</span>
-        <span class='type'>(<tt>Proc</tt>)</span>
-        <em class="default">(defaults to: <tt>-&gt;(current_backoff) { [current_backoff * 2, 5 * 60].min }</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>A Proc that takes the current backoff time and returns the new backoff time.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Yield Parameters:</p>
-<ul class="yieldparam">
-    <li>
-        <span class='name'>args</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Publisher/Args.html" title="Outboxer::Publisher::Args (class)">Args</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>An Args object containing the message to publish and a logger.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/outboxer/publisher.rb', line 23</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_publish'>publish</span><span class='lparen'>(</span><span class='label'>poll:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>backoff:</span> <span class='tlambda'>-&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_current_backoff'>current_backoff</span><span class='rparen'>)</span> <span class='tlambeg'>{</span> <span class='lbracket'>[</span><span class='id identifier rubyid_current_backoff'>current_backoff</span> <span class='op'>*</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>5</span> <span class='op'>*</span> <span class='int'>60</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='ivar'>@publishing</span> <span class='op'>=</span> <span class='kw'>true</span>
-  <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_connection_pool'>connection_pool</span><span class='period'>.</span><span class='id identifier rubyid_with_connection'>with_connection</span> <span class='kw'>do</span>
-    <span class='kw'>while</span> <span class='ivar'>@publishing</span>
-      <span class='id identifier rubyid_outboxer_message'>outboxer_message</span> <span class='op'>=</span> <span class='id identifier rubyid_dequeue'>dequeue</span><span class='lparen'>(</span><span class='label'>backoff:</span> <span class='id identifier rubyid_backoff'>backoff</span><span class='rparen'>)</span>
-      <span class='kw'>if</span> <span class='id identifier rubyid_outboxer_message'>outboxer_message</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-        <span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_poll'>poll</span>
-        <span class='kw'>next</span>
-      <span class='kw'>end</span>
-      <span class='kw'>begin</span>
-        <span class='kw'>yield</span> <span class='const'><span class='object_link'><a href="Publisher/Args.html" title="Outboxer::Publisher::Args (class)">Args</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_outboxer_message'>outboxer_message</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='ivar'>@logger</span><span class='rparen'>)</span>
-      <span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_exception'>exception</span>
-        <span class='id identifier rubyid_failed'>failed</span><span class='lparen'>(</span>
-          <span class='label'>outboxer_message:</span> <span class='id identifier rubyid_outboxer_message'>outboxer_message</span><span class='comma'>,</span>
-          <span class='label'>backoff:</span> <span class='id identifier rubyid_backoff'>backoff</span><span class='comma'>,</span>
-          <span class='label'>exception:</span> <span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
-        <span class='kw'>next</span>
-      <span class='kw'>end</span>
-      <span class='id identifier rubyid_published'>published</span><span class='lparen'>(</span>
-        <span class='label'>outboxer_message:</span> <span class='id identifier rubyid_outboxer_message'>outboxer_message</span><span class='comma'>,</span>
-        <span class='label'>backoff:</span> <span class='id identifier rubyid_backoff'>backoff</span><span class='rparen'>)</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="stop-class_method">
-    .<strong>stop</strong>  &#x21d2; <tt>void</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-  <div class="note notetag">
-    <strong>Note:</strong>
-    <div class='inline'>
-<p>This method will stop the current message publishing process It is a safe way to interrupt the publishing process at any point.</p>
-</div>
-  </div>
-<p class="note returns_void">This method returns an undefined value.</p>
-<p>Stops the publishing process.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-120
-121
-122</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/outboxer/publisher.rb', line 120</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span>
-  <span class='ivar'>@publishing</span> <span class='op'>=</span> <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Sat Aug  5 04:37:46 2023 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-2.7.8).
-</div>
-    </div>
-  </body>
-</html>

data/doc/Outboxer/Railtie.html DELETED Viewed

@@ -1,124 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: Outboxer::Railtie
-    &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 = "Outboxer::Railtie";
-  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="../Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span>
-     &raquo;
-    <span class="title">Railtie</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: Outboxer::Railtie
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Rails::Railtie</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Rails::Railtie</li>
-            <li class="next">Outboxer::Railtie</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/outboxer/railtie.rb</dd>
-  </dl>
-</div>
-</div>
-      <div id="footer">
-  Generated on Sat Aug  5 04:37:46 2023 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-2.7.8).
-</div>
-    </div>
-  </body>
-</html>

data/doc/Outboxer.html DELETED Viewed

@@ -1,150 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Outboxer
-    &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 = "Outboxer";
-  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 (O)</a> &raquo;
-    <span class="title">Outboxer</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: Outboxer
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/outboxer.rb<span class="defines">,<br />
-  lib/outboxer/railtie.rb,<br /> lib/outboxer/version.rb,<br /> lib/outboxer/publisher.rb,<br /> lib/outboxer/models/message.rb,<br /> lib/outboxer/models/exception.rb,<br /> lib/outboxer/models/outboxable.rb</span>
-</dd>
-  </dl>
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Outboxer/Models.html" title="Outboxer::Models (module)">Models</a></span>, <span class='object_link'><a href="Outboxer/Publisher.html" title="Outboxer::Publisher (module)">Publisher</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Outboxer/Railtie.html" title="Outboxer::Railtie (class)">Railtie</a></span>
-</p>
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-    <dl class="constants">
-        <dt id="Outboxable-constant" class="">Outboxable =
-        </dt>
-        <dd><pre class="code"><span class='const'><span class='object_link'><a href="Outboxer/Models.html" title="Outboxer::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Outboxer/Models/Outboxable.html" title="Outboxer::Models::Outboxable (module)">Outboxable</a></span></span></pre></dd>
-        <dt id="Message-constant" class="">Message =
-        </dt>
-        <dd><pre class="code"><span class='const'><span class='object_link'><a href="Outboxer/Models.html" title="Outboxer::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Outboxer/Models/Message.html" title="Outboxer::Models::Message (class)">Message</a></span></span></pre></dd>
-        <dt id="Exception-constant" class="">Exception =
-        </dt>
-        <dd><pre class="code"><span class='const'><span class='object_link'><a href="Outboxer/Models.html" title="Outboxer::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Outboxer/Models/Exception.html" title="Outboxer::Models::Exception (class)">Exception</a></span></span></pre></dd>
-        <dt id="VERSION-constant" class="">VERSION =
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
-    </dl>
-</div>
-      <div id="footer">
-  Generated on Sat Aug  5 04:37:46 2023 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-2.7.8).
-</div>
-    </div>
-  </body>
-</html>