some more docs

ceberz · Mar 7, 2012 · d22577c · d22577c
1 parent 026bb0a
commit d22577c
Show file tree

Hide file tree

Showing 33 changed files with 374 additions and 224 deletions.
diff --git a/.yardoc/checksums b/.yardoc/checksums
@@ -1,11 +1,11 @@
 lib/riaction.rb dd83c27c1316ce70e4d5bb9aa2d126f6cfc9d861
 lib/riaction/railtie.rb 13e4d474afcbaa065c9f287a3d162b14c9879827
 lib/riaction/version.rb 264747da6cacfd2f8186c6c2ab4f1a668c9e0f63
-lib/riaction/riaction.rb db9cebd4ec6f2b4559a50490cbe7a7bdc8e5e617
-lib/riaction/constants.rb 458b6b0dc98bf9ee3b2e2e56ed8c1b65e6818fa0
+lib/riaction/riaction.rb 959359e794a937f9272add18734171304000553b
+lib/riaction/constants.rb 3770b204697e3bf3f649d797ce2100c7bd9ad252
 lib/rspec/matchers/riaction.rb cfee977b937126ec92bebf643001671779428d19
-lib/riaction/event_performer.rb 167554caa6e993ab6c669ee8c9799da3fae4c860
+lib/riaction/event_performer.rb e4f5cf51475317713a0dfa92f159ee5b69b979b8
 lib/riaction/profile_creator.rb 29f4cf5ebadf3d22158fb2ad2d36a69bda5b68e3
-lib/riaction/crud_event_callback.rb 85af7b455a412a27a428003afd6acde3503439ce
-lib/riaction/profile_creation_callback.rb 3c56bfce338de416aef0c0328aa1f8892885ccef
+lib/riaction/crud_event_callback.rb d03b7cfed24abc9c45cc0f3a06373ded9a9f767a
+lib/riaction/profile_creation_callback.rb 3ca1be07c164b1d4597c285535706cf0a2681fee
 lib/generators/riaction/riaction_generator.rb deb5895bd9ecdaa15c49dc81b6172e2333b89b0b
diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat
diff --git a/doc/Riaction.html b/doc/Riaction.html
@@ -73,7 +73,7 @@
 
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/riaction/railtie.rb<span class="defines">,<br />
-  lib/riaction/version.rb,<br /> lib/riaction/riaction.rb,<br /> lib/riaction/constants.rb,<br /> lib/riaction/event_performer.rb,<br /> lib/riaction/profile_creator.rb,<br /> lib/riaction/crud_event_callback.rb,<br /> lib/riaction/profile_creation_callback.rb</span>
+  lib/riaction/version.rb,<br /> lib/riaction/riaction.rb,<br /> lib/riaction/constants.rb,<br /> lib/riaction/profile_creator.rb,<br /> lib/riaction/crud_event_callback.rb,<br /> lib/riaction/profile_creation_callback.rb</span>
 </dd>
 
 </dl>
@@ -87,7 +87,7 @@ <h2>Defined Under Namespace</h2>
 
 
 
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Riaction/ConfigurationError.html" title="Riaction::ConfigurationError (class)">ConfigurationError</a></span>, <span class='object_link'><a href="Riaction/Constants.html" title="Riaction::Constants (class)">Constants</a></span>, <span class='object_link'><a href="Riaction/CrudEventCallback.html" title="Riaction::CrudEventCallback (class)">CrudEventCallback</a></span>, <span class='object_link'><a href="Riaction/EventPerformer.html" title="Riaction::EventPerformer (class)">EventPerformer</a></span>, <span class='object_link'><a href="Riaction/NoEventDefined.html" title="Riaction::NoEventDefined (class)">NoEventDefined</a></span>, <span class='object_link'><a href="Riaction/NoProfileDefined.html" title="Riaction::NoProfileDefined (class)">NoProfileDefined</a></span>, <span class='object_link'><a href="Riaction/ProfileCreationCallback.html" title="Riaction::ProfileCreationCallback (class)">ProfileCreationCallback</a></span>, <span class='object_link'><a href="Riaction/ProfileCreator.html" title="Riaction::ProfileCreator (class)">ProfileCreator</a></span>, <span class='object_link'><a href="Riaction/Railtie.html" title="Riaction::Railtie (class)">Railtie</a></span>, <span class='object_link'><a href="Riaction/RuntimeError.html" title="Riaction::RuntimeError (class)">RuntimeError</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Riaction/ConfigurationError.html" title="Riaction::ConfigurationError (class)">ConfigurationError</a></span>, <span class='object_link'><a href="Riaction/Constants.html" title="Riaction::Constants (class)">Constants</a></span>, <span class='object_link'><a href="Riaction/CrudEventCallback.html" title="Riaction::CrudEventCallback (class)">CrudEventCallback</a></span>, <span class='object_link'><a href="Riaction/NoEventDefined.html" title="Riaction::NoEventDefined (class)">NoEventDefined</a></span>, <span class='object_link'><a href="Riaction/NoProfileDefined.html" title="Riaction::NoProfileDefined (class)">NoProfileDefined</a></span>, <span class='object_link'><a href="Riaction/ProfileCreationCallback.html" title="Riaction::ProfileCreationCallback (class)">ProfileCreationCallback</a></span>, <span class='object_link'><a href="Riaction/ProfileCreator.html" title="Riaction::ProfileCreator (class)">ProfileCreator</a></span>, <span class='object_link'><a href="Riaction/Railtie.html" title="Riaction::Railtie (class)">Railtie</a></span>, <span class='object_link'><a href="Riaction/RuntimeError.html" title="Riaction::RuntimeError (class)">RuntimeError</a></span>
 
 
 </p>
@@ -115,7 +115,7 @@ <h2>Constant Summary</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Mar  6 21:35:45 2012 by 
+  Generated on Tue Mar  6 22:00:20 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

diff --git a/doc/Riaction/ConfigurationError.html b/doc/Riaction/ConfigurationError.html
@@ -107,7 +107,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Mar  6 21:35:45 2012 by 
+  Generated on Tue Mar  6 22:00:20 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

diff --git a/doc/Riaction/Constants.html b/doc/Riaction/Constants.html
@@ -123,7 +123,9 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>sets the default actions to be considered as part of riaction.</p>
+</div></span>
 
 </li>
 
@@ -144,7 +146,10 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>sets the default number of attempts to retry a action incase of an internal
+error.</p>
+</div></span>
 
 </li>
 
@@ -186,7 +191,9 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>sets the valid supported identifiers.</p>
+</div></span>
 
 </li>
 
@@ -207,18 +214,29 @@ <h2>Class Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>sets the default actions to be considered as part of riaction</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-3
 4
-5</pre>
+5
+6</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 3</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 4</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_crud_actions'>crud_actions</span>
   <span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbracket'>[</span><span class='symbol'>:create</span><span class='comma'>,</span> <span class='symbol'>:update</span><span class='comma'>,</span> <span class='symbol'>:destroy</span><span class='rbracket'>]</span>
@@ -235,18 +253,30 @@ <h2>Class Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>sets the default number of attempts to retry a action incase of an internal
+error</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-7
-8
-9</pre>
+9
+10
+11</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 7</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 9</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_retry_attempts_for_internal_error'>retry_attempts_for_internal_error</span>
   <span class='int'>3</span>
@@ -269,14 +299,14 @@ <h2>Class Method Details</h2>
       <pre class="lines">
 
 
-15
-16
-17
-18
-19</pre>
+19
+20
+21
+22
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 15</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_riaction_options'>riaction_options</span>
   <span class='lbrace'>{</span>
@@ -295,18 +325,47 @@ <h2>Class Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>sets the valid supported identifiers</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+<h3>Returns:</h3>
+<ul class="return">
+
+    <li>
+
+
+        <span class='type'></span>
+
+
+
+
+        <div class='inline'>
+<p>returns an array of symbols</p>
+</div>
+
+    </li>
+
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-11
-12
-13</pre>
+15
+16
+17</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 11</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/constants.rb', line 15</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_supported_identifier_types'>supported_identifier_types</span>
   <span class='lbracket'>[</span><span class='symbol'>:email</span><span class='comma'>,</span><span class='symbol'>:username</span><span class='comma'>,</span><span class='symbol'>:custom</span><span class='comma'>,</span><span class='symbol'>:facebook</span><span class='comma'>,</span><span class='symbol'>:twitter</span><span class='comma'>,</span><span class='symbol'>:salesforce</span><span class='rbracket'>]</span>
@@ -321,7 +380,7 @@ <h2>Class Method Details</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Mar  6 21:35:45 2012 by 
+  Generated on Tue Mar  6 22:00:20 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

diff --git a/doc/Riaction/CrudEventCallback.html b/doc/Riaction/CrudEventCallback.html
@@ -123,7 +123,10 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+created.</p>
+</div></span>
 
 </li>
 
@@ -144,7 +147,10 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+destroyed.</p>
+</div></span>
 
 </li>
 
@@ -165,7 +171,10 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+updated.</p>
+</div></span>
 
 </li>
 
@@ -254,20 +263,32 @@ <h2>Instance Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+created</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-10
 11
 12
 13
-14</pre>
+14
+15</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_after_create'>after_create</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_riaction_log_event?'>riaction_log_event?</span><span class='lparen'>(</span><span class='ivar'>@event_name</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_riactionless?'>riactionless?</span>
@@ -286,20 +307,32 @@ <h2>Instance Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+destroyed</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-22
-23
-24
 25
-26</pre>
+26
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 22</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 25</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_after_destroy'>after_destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_riaction_log_event?'>riaction_log_event?</span><span class='lparen'>(</span><span class='ivar'>@event_name</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_riactionless?'>riactionless?</span>
@@ -318,20 +351,32 @@ <h2>Instance Method Details</h2>
 
 
 
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+
+<p>Enqueues a Riaction::EventPerformer object in resque after a model has been
+updated</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-16
-17
 18
 19
-20</pre>
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 16</span>
+      <pre class="code"><span class="info file"># File 'lib/riaction/crud_event_callback.rb', line 18</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_after_update'>after_update</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>            
   <span class='kw'>if</span> <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_riaction_log_event?'>riaction_log_event?</span><span class='lparen'>(</span><span class='ivar'>@event_name</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_riactionless?'>riactionless?</span>
@@ -348,7 +393,7 @@ <h2>Instance Method Details</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Mar  6 21:35:45 2012 by 
+  Generated on Tue Mar  6 22:00:20 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>