RubyGems - utopia - Versions diffs - 2.2.0 → 2.3.0 - Mend

utopia 2.2.0 → 2.3.0

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 (290) hide show

data/docs/code/Utopia/Exceptions/Mailer.html ADDED Viewed

@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Utopia::Exceptions::Mailer
+    &mdash; Documentation by YARD 0.9.12
+</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 = "Utopia::Exceptions::Mailer";
+  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 (M)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Utopia.html" title="Utopia (module)">Utopia</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Exceptions.html" title="Utopia::Exceptions (module)">Exceptions</a></span></span>
+     &raquo;
+    <span class="title">Mailer</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: Utopia::Exceptions::Mailer
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Utopia::Exceptions::Mailer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/utopia/exceptions/mailer.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>A middleware which catches all exceptions raised from the app it wraps and sends a useful email with the exception, stacktrace, and contents of the environment.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+      <dt id="LOCAL_SMTP-constant" class="">LOCAL_SMTP =
+        <div class="docstring">
+  <div class="discussion">
+    <p>A basic local non-authenticated SMTP server.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+      </dt>
+      <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:smtp</span><span class='comma'>,</span> <span class='lbrace'>{</span>
+	<span class='symbol'>:address</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>localhost</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+	<span class='symbol'>:port</span> <span class='op'>=&gt;</span> <span class='int'>25</span><span class='comma'>,</span>
+	<span class='symbol'>:enable_starttls_auto</span> <span class='op'>=&gt;</span> <span class='kw'>false</span>
+<span class='rbrace'>}</span><span class='rbracket'>]</span></pre></dd>
+      <dt id="DEFAULT_FROM-constant" class="">DEFAULT_FROM =
+      </dt>
+      <dd><pre class="code"><span class='lparen'>(</span><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>USER</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rack</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@localhost</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      <dt id="DEFAULT_SUBJECT-constant" class="">DEFAULT_SUBJECT =
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%{exception} [PID %{pid} : %{cwd}]</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+  </dl>
+    <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="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(env)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#freeze-instance_method" title="#freeze (instance method)">#<strong>freeze</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(app, to: &quot;postmaster&quot;, from: DEFAULT_FROM, subject: DEFAULT_SUBJECT, delivery_method: LOCAL_SMTP, dump_environment: false)  &#x21d2; Mailer </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>A new instance of Mailer.</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>(app, to: &quot;postmaster&quot;, from: DEFAULT_FROM, subject: DEFAULT_SUBJECT, delivery_method: LOCAL_SMTP, dump_environment: false)  &#x21d2; <tt><span class='object_link'><a href="" title="Utopia::Exceptions::Mailer (class)">Mailer</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of Mailer</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>to</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The address to email error reports to.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>from</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The from address for error reports.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>subject</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The subject template which can access attributes defined by <code>#attributes_for</code>.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>delivery_method</span>
+        <span class='type'>(<tt>Object</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The delivery method as required by the mail gem.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>dump_environment</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Attach <code>env</code> as <code>environment.yaml</code> to the error report.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+43
+44
+45
+46
+47
+48
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utopia/exceptions/mailer.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_app'>app</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>postmaster</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>from:</span> <span class='const'><span class='object_link'><a href="#DEFAULT_FROM-constant" title="Utopia::Exceptions::Mailer::DEFAULT_FROM (constant)">DEFAULT_FROM</a></span></span><span class='comma'>,</span> <span class='label'>subject:</span> <span class='const'><span class='object_link'><a href="#DEFAULT_SUBJECT-constant" title="Utopia::Exceptions::Mailer::DEFAULT_SUBJECT (constant)">DEFAULT_SUBJECT</a></span></span><span class='comma'>,</span> <span class='label'>delivery_method:</span> <span class='const'><span class='object_link'><a href="#LOCAL_SMTP-constant" title="Utopia::Exceptions::Mailer::LOCAL_SMTP (constant)">LOCAL_SMTP</a></span></span><span class='comma'>,</span> <span class='label'>dump_environment:</span> <span class='kw'>false</span><span class='rparen'>)</span>
+	<span class='ivar'>@app</span> <span class='op'>=</span> <span class='id identifier rubyid_app'>app</span>
+	<span class='ivar'>@to</span> <span class='op'>=</span> <span class='id identifier rubyid_to'>to</span>
+	<span class='ivar'>@from</span> <span class='op'>=</span> <span class='id identifier rubyid_from'>from</span>
+	<span class='ivar'>@subject</span> <span class='op'>=</span> <span class='id identifier rubyid_subject'>subject</span>
+	<span class='ivar'>@delivery_method</span> <span class='op'>=</span> <span class='id identifier rubyid_delivery_method'>delivery_method</span>
+	<span class='ivar'>@dump_environment</span> <span class='op'>=</span> <span class='id identifier rubyid_dump_environment'>dump_environment</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="call-instance_method">
+    #<strong>call</strong>(env)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+65
+66
+67
+68
+69
+70
+71
+72
+73</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utopia/exceptions/mailer.rb', line 65</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
+	<span class='kw'>begin</span>
+		<span class='kw'>return</span> <span class='ivar'>@app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
+	<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_exception'>exception</span>
+		<span class='id identifier rubyid_send_notification'>send_notification</span> <span class='id identifier rubyid_exception'>exception</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span>
+		<span class='id identifier rubyid_raise'>raise</span>
+	<span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="freeze-instance_method">
+    #<strong>freeze</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utopia/exceptions/mailer.rb', line 53</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='kw'>return</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_frozen?'>frozen?</span>
+	<span class='ivar'>@to</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='ivar'>@from</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='ivar'>@subject</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='ivar'>@delivery_method</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='ivar'>@dump_environment</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+	<span class='kw'>super</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Sat Mar 24 21:17:21 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.5.0).
+</div>
+    </div>
+  </body>
+</html>