loggable_activity 0.1.56 → 0.1.58

data/docs/LoggableActivity/Configuration.html

@@ -72,8 +72,13 @@
   <h3>Methods</h3>
 
   <ul class="link-list" role="directory">
+    <li ><a href="#method-c-current_user_model_name">::current_user_model_name</a>
+    <li ><a href="#method-c-fetch_current_user_name_from">::fetch_current_user_name_from</a>
     <li ><a href="#method-c-for_class">::for_class</a>
     <li ><a href="#method-c-load_config_file">::load_config_file</a>
+    <li ><a href="#method-c-load_schema">::load_schema</a>
+    <li ><a href="#method-c-loaded-3F">::loaded?</a>
+    <li ><a href="#method-c-validate_config_file">::validate_config_file</a>
   </ul>
 </div>
 
@@ -89,12 +94,30 @@
     
 <p>This class is used to load the configuration file located at config/loggable_activity.yml</p>
 
+<p>When the LoggableActivity::Hook is included in a model it takes the model’s name and find the configuration for that model in the configuration file.</p>
+
   </section>
 
   <section id="5Buntitled-5D" class="documentation-section">
 
 
 
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+
+      <div id="attribute-c-config_data" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">config_data</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+
+        <div class="method-description">
+        <p>@return [Hash]</p>
+        </div>
+      </div>
+    </section>
 
 
      <section id="public-class-5Buntitled-5D-method-details" class="method-section">
@@ -102,6 +125,52 @@
          <h3>Public Class Methods</h3>
        </header>
 
+      <div id="method-c-current_user_model_name" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">current_user_model_name</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>Returns the name of the model to use for the current user.</p>
+
+          <div class="method-source-code" id="current_user_model_name-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 86</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">current_user_model_name</span>
+  <span class="ruby-ivar">@config_data</span>[<span class="ruby-string">&#39;current_user_model_name&#39;</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-c-fetch_current_user_name_from" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">fetch_current_user_name_from</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>Returns the name of the field or method to use for the actor’s display name.</p>
+
+          <div class="method-source-code" id="fetch_current_user_name_from-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 81</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">fetch_current_user_name_from</span>
+  <span class="ruby-ivar">@config_data</span>[<span class="ruby-string">&#39;fetch_current_user_name_from&#39;</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
       <div id="method-c-for_class" class="method-detail ">
         <div class="method-header">
           <div class="method-heading">
@@ -116,27 +185,27 @@
 
 <p>Example:</p>
 
-<pre class="ruby"><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">for_class</span>(<span class="ruby-string">&#39;User&#39;</span>)
+<pre class="ruby"><span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">for_class</span>(<span class="ruby-string">&#39;User&#39;</span>)
 </pre>
 
 <p>Returns:</p>
 
-<pre class="ruby">{
-  <span class="ruby-value">&quot;record_display_name&quot;:</span> <span class="ruby-string">&quot;full_name&quot;</span>,
-  <span class="ruby-value">&quot;loggable_attrs&quot;:</span> [
-    <span class="ruby-string">&quot;first_name&quot;</span>,
-    <span class="ruby-string">&quot;last_name&quot;</span>,
+<pre>{
+  &quot;fetch_record_name_from&quot;: &quot;full_name&quot;,
+  &quot;loggable_attrs&quot;: [
+    &quot;first_name&quot;,
+    &quot;last_name&quot;,
   ],
-  <span class="ruby-value">&quot;auto_log&quot;:</span> [
-    <span class="ruby-string">&quot;create&quot;</span>,
-    <span class="ruby-string">&quot;update&quot;</span>,
-    <span class="ruby-string">&quot;destroy&quot;</span>
-  ]
-}
-</pre>
+  &quot;auto_log&quot;: [
+    &quot;create&quot;,
+    &quot;update&quot;,
+    &quot;destroy&quot;
+  ],
+....
+}</pre>
 
           <div class="method-source-code" id="for_class-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 28</span>
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 76</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">for_class</span>(<span class="ruby-identifier">class_name</span>)
   <span class="ruby-ivar">@config_data</span>[<span class="ruby-identifier">class_name</span>]
 <span class="ruby-keyword">end</span></pre>
@@ -159,9 +228,87 @@
           <p>Loads the configuration file</p>
 
           <div class="method-source-code" id="load_config_file-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 7</span>
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 24</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_config_file</span>(<span class="ruby-identifier">config_file_path</span>)
   <span class="ruby-ivar">@config_data</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">config_file_path</span>)
+  <span class="ruby-identifier">validate_config_file</span>
+<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>
+  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ConfigurationError</span>, <span class="ruby-string">&#39;config/loggable_activity.yaml not found&#39;</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-c-load_schema" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">load_schema</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>Loads the schema file for the configuration file</p>
+
+          <div class="method-source-code" id="load_schema-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 32</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_schema</span>
+  <span class="ruby-identifier">schema_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">__dir__</span>, <span class="ruby-string">&#39;..&#39;</span>, <span class="ruby-string">&#39;schemas&#39;</span>, <span class="ruby-string">&#39;config_schema.json&#39;</span>)
+  <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">schema_path</span>))
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-c-loaded-3F" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">loaded?</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>Returns true if the configuration file has been loaded</p>
+
+          <div class="method-source-code" id="loaded-3F-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 48</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">loaded?</span>
+  <span class="ruby-operator">!</span><span class="ruby-ivar">@config_data</span>.<span class="ruby-identifier">nil?</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-c-validate_config_file" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">validate_config_file</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>Validates the configuration file againss the schema</p>
+
+          <div class="method-source-code" id="validate_config_file-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 38</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">validate_config_file</span>
+  <span class="ruby-identifier">schema</span> = <span class="ruby-identifier">load_schema</span>
+  <span class="ruby-identifier">errors</span> = <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-constant">Validator</span>.<span class="ruby-identifier">fully_validate</span>(<span class="ruby-identifier">schema</span>, <span class="ruby-ivar">@config_data</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">any?</span>
+
+  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ConfigurationError</span>,
+        <span class="ruby-node">&quot;config/loggable_activity.yaml is invalid: #{errors.join(&#39;, &#39;)}&quot;</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
         </div>

data/docs/LoggableActivity/ConfigurationError.html

@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class LoggableActivity::ConfigurationError - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">StandardError
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li class="calls-super" ><a href="#method-c-new">::new</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-LoggableActivity::ConfigurationError">
+  <h1 id="class-LoggableActivity::ConfigurationError" class="class">
+    class LoggableActivity::ConfigurationError
+  </h1>
+
+  <section class="description">
+    
+<p>This class is used to load the configuration file located at config/loggable_activity.yml</p>
+
+<p>This class is used to load the configuration file located at config/loggable_activity.yml</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+      <div id="method-c-new" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">new</span><span
+              class="method-args">(msg = &#39;&#39;)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+            <div class="method-calls-super">
+              Calls superclass method
+              
+            </div>
+
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/configuration.rb, line 10</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">msg</span> = <span class="ruby-string">&#39;&#39;</span>)
+  <span class="ruby-comment"># https://api.loggable_activity.com/msg</span>
+  <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;---------------- LOGGABLE ACTIVITY -----------------&#39;</span>
+  <span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span>
+  <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;----------------------------------------------------&#39;</span>
+  <span class="ruby-keyword">super</span>(<span class="ruby-identifier">msg</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/docs/LoggableActivity/DataOwner.html

@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class LoggableActivity::DataOwner - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">ActiveRecord::Base
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-i-mark_as_deleted-21">#mark_as_deleted!</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-LoggableActivity::DataOwner">
+  <h1 id="class-LoggableActivity::DataOwner" class="class">
+    class LoggableActivity::DataOwner
+  </h1>
+
+  <section class="description">
+    
+<p>This class represends an additional data owner for a record. For it to kick in, the data_owner configuration has to be set to true in the loggable_activity.yaml file.</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+      <div id="method-i-mark_as_deleted-21" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">mark_as_deleted!</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          <p>When a record is deleted, all data owner added to the record is also deleted.</p>
+
+          <div class="method-source-code" id="mark_as_deleted-21-source">
+            <pre><span class="ruby-comment"># File lib/loggable_activity/data_owner.rb, line 15</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mark_as_deleted!</span>
+  <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">mark_as_deleted!</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/docs/LoggableActivity/Encryption.html

@@ -124,7 +124,7 @@
         <div class="method-header">
           <div class="method-heading">
             <span class="method-name">decrypt</span><span
-              class="method-args">(data, encoded_key)</span>
+              class="method-args">(data, secret_key)</span>
             <span class="method-click-advice">click to toggle source</span>
           </div>
         </div>
@@ -134,7 +134,7 @@
 
 <p>Example:</p>
 
-<pre class="ruby"><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">decrypt</span>(<span class="ruby-string">&#39;SOME_ENCRYPTED_STRING&#39;</span>, <span class="ruby-string">&#39;SECRET_KEY&#39;</span>)
+<pre class="ruby"><span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">decrypt</span>(<span class="ruby-string">&#39;SOME_ENCRYPTED_STRING&#39;</span>, <span class="ruby-string">&#39;SECRET_KEY&#39;</span>)
 </pre>
 
 <p>Returns:</p>
@@ -143,15 +143,17 @@
 </pre>
 
           <div class="method-source-code" id="decrypt-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/encryption.rb, line 47</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">decrypt</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">encoded_key</span>)
-  <span class="ruby-keyword">return</span> <span class="ruby-string">&#39;&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">encoded_key</span>.<span class="ruby-identifier">nil?</span>
+            <pre><span class="ruby-comment"># File lib/loggable_activity/encryption.rb, line 44</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">decrypt</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">secret_key</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">&#39;loggable.activity.deleted&#39;</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">secret_key</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-string">&#39;&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">blank?</span>
 
-  <span class="ruby-identifier">encryption_key</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">encoded_key</span>)
+  <span class="ruby-identifier">encryption_key</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">secret_key</span>)
   <span class="ruby-identifier">raise</span> <span class="ruby-constant">EncryptionError</span>, <span class="ruby-node">&quot;Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">==</span> <span class="ruby-value">32</span>
 
   <span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;AES-256-CBC&#39;</span>).<span class="ruby-identifier">decrypt</span>
   <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">encryption_key</span>
+  <span class="ruby-identifier">raise</span> <span class="ruby-constant">EncryptionError</span>, <span class="ruby-string">&#39;Decryption failed: Invalid data length&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">iv_len</span>
 
   <span class="ruby-identifier">raw_data</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">data</span>)
   <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">raw_data</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">iv_len</span>] <span class="ruby-comment"># Extract IV from the beginning of raw_data</span>
@@ -159,9 +161,10 @@
 
   <span class="ruby-identifier">decrypted_data</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&#39;UTF-8&#39;</span>)
 <span class="ruby-keyword">rescue</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span><span class="ruby-operator">::</span><span class="ruby-constant">CipherError</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-constant">EncryptionError</span>, <span class="ruby-node">&quot;Decryption failed: #{e.message}&quot;</span>
+  <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;CipherError Decryption failed: #{e.message}&quot;</span>
+  <span class="ruby-string">&#39;*** DECRYPTION FAILED ***&#39;</span>
 <span class="ruby-keyword">rescue</span> <span class="ruby-constant">EncryptionError</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
-  <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
+  <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;EncryptionError failed: #{e.message}&quot;</span>
   <span class="ruby-string">&#39;*** DECRYPTION FAILED ***&#39;</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -174,7 +177,7 @@
         <div class="method-header">
           <div class="method-heading">
             <span class="method-name">encrypt</span><span
-              class="method-args">(data, encoded_key)</span>
+              class="method-args">(data, secret_key)</span>
             <span class="method-click-advice">click to toggle source</span>
           </div>
         </div>
@@ -184,7 +187,7 @@
 
 <p>Example:</p>
 
-<pre class="ruby"><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">encrypt</span>(<span class="ruby-string">&#39;my secret data&#39;</span>, <span class="ruby-string">&#39;my secret key&#39;</span>)
+<pre class="ruby"><span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">encrypt</span>(<span class="ruby-string">&#39;my secret data&#39;</span>, <span class="ruby-string">&#39;my secret key&#39;</span>)
 </pre>
 
 <p>Returns:</p>
@@ -193,11 +196,12 @@
 </pre>
 
           <div class="method-source-code" id="encrypt-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/encryption.rb, line 22</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">encrypt</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">encoded_key</span>)
-  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">encoded_key</span>.<span class="ruby-identifier">nil?</span>
+            <pre><span class="ruby-comment"># File lib/loggable_activity/encryption.rb, line 18</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">encrypt</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">secret_key</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">secret_key</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span>
 
-  <span class="ruby-identifier">encryption_key</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">encoded_key</span>)
+  <span class="ruby-identifier">encryption_key</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">secret_key</span>)
   <span class="ruby-identifier">raise</span> <span class="ruby-constant">EncryptionError</span>, <span class="ruby-node">&quot;Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">==</span> <span class="ruby-value">32</span>
 
   <span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;AES-256-CBC&#39;</span>).<span class="ruby-identifier">encrypt</span>