loggable_activity 0.5.4 → 0.5.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +10 -0
- data/CHANGELOG.md +12 -3
- data/GETTING-STARTED.md +61 -0
- data/README.md +4 -7
- data/app/views/loggable_activity/activities/_activities.html.slim +6 -6
- data/docker-compose.yml +27 -0
- data/docs/CHANGELOG_md.html +318 -0
- data/docs/CHEAT_SHEET_md.html +168 -0
- data/docs/CODE_OF_CONDUCT_md.html +250 -0
- data/docs/CreateLoggableActivities.html +175 -0
- data/docs/CreateLoggableActivityTables.html +173 -0
- data/docs/GETTING-STARTED_md.html +211 -0
- data/docs/Gemfile.html +153 -0
- data/docs/Gemfile_lock.html +438 -0
- data/docs/LoggableActivity/ActivitiesController.html +160 -0
- data/docs/LoggableActivity/ActivitiesHelper.html +158 -0
- data/docs/LoggableActivity/Activity.html +565 -0
- data/docs/LoggableActivity/ApplicationController.html +97 -0
- data/docs/LoggableActivity/ApplicationHelper.html +91 -0
- data/docs/LoggableActivity/ApplicationJob.html +97 -0
- data/docs/LoggableActivity/ApplicationMailer.html +97 -0
- data/docs/LoggableActivity/ApplicationRecord.html +97 -0
- data/docs/LoggableActivity/Configuration.html +237 -0
- data/docs/LoggableActivity/ConfigurationError.html +142 -0
- data/docs/LoggableActivity/CurrentActor.html +166 -0
- data/docs/LoggableActivity/DataOwner.html +138 -0
- data/docs/LoggableActivity/Encryption.html +321 -0
- data/docs/LoggableActivity/EncryptionError.html +142 -0
- data/docs/LoggableActivity/EncryptionKey.html +399 -0
- data/docs/LoggableActivity/Engine.html +108 -0
- data/docs/LoggableActivity/Error.html +142 -0
- data/docs/LoggableActivity/Generators/InstallGenerator.html +212 -0
- data/docs/LoggableActivity/Generators.html +91 -0
- data/docs/LoggableActivity/Hooks.html +841 -0
- data/docs/LoggableActivity/Payload.html +430 -0
- data/docs/LoggableActivity/Sanitizer.html +134 -0
- data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +472 -0
- data/docs/LoggableActivity/Services/CustomPayloadsBuilder.html +225 -0
- data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +396 -0
- data/docs/LoggableActivity/Services/PayloadsBuilder.html +348 -0
- data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +540 -0
- data/docs/LoggableActivity/Services.html +93 -0
- data/docs/LoggableActivity.html +173 -0
- data/docs/MIT-LICENSE.html +132 -0
- data/docs/Object.html +110 -0
- data/docs/README_md.html +186 -0
- data/docs/Rakefile.html +134 -0
- data/docs/app/assets/config/loggable_activity_manifest_js.html +126 -0
- data/docs/app/assets/javascripts/loggable_activity/application_js.html +124 -0
- data/docs/app/assets/stylesheets/loggable_activity/activities_scss.html +154 -0
- data/docs/app/assets/stylesheets/loggable_activity/application_scss.html +142 -0
- data/docs/app/views/layouts/loggable_activity/application_html_slim.html +145 -0
- data/docs/app/views/loggable_activity/activities/_activities_html_slim.html +159 -0
- data/docs/created.rid +74 -0
- data/docs/css/fonts.css +167 -0
- data/docs/css/rdoc.css +687 -0
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/git-org/HEAD.html +126 -0
- data/docs/git-org/config.html +128 -0
- data/docs/git-org/description.html +126 -0
- data/docs/git-org/hooks/applypatch-msg_sample.html +128 -0
- data/docs/git-org/hooks/commit-msg_sample.html +138 -0
- data/docs/git-org/hooks/fsmonitor-watchman_sample.html +302 -0
- data/docs/git-org/hooks/post-update_sample.html +128 -0
- data/docs/git-org/hooks/pre-applypatch_sample.html +128 -0
- data/docs/git-org/hooks/pre-commit_sample.html +174 -0
- data/docs/git-org/hooks/pre-merge-commit_sample.html +133 -0
- data/docs/git-org/hooks/pre-push_sample.html +161 -0
- data/docs/git-org/hooks/pre-rebase_sample.html +282 -0
- data/docs/git-org/hooks/pre-receive_sample.html +144 -0
- data/docs/git-org/hooks/prepare-commit-msg_sample.html +136 -0
- data/docs/git-org/hooks/push-to-checkout_sample.html +178 -0
- data/docs/git-org/hooks/update_sample.html +226 -0
- data/docs/git-org/info/exclude.html +126 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +166 -0
- data/docs/js/darkfish.js +97 -0
- data/docs/js/navigation.js +105 -0
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +110 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +229 -0
- data/docs/js/searcher.js.gz +0 -0
- data/docs/lib/loggable_activity/config_schema_json.html +205 -0
- data/docs/lib/tasks/loggable_activity_tasks_rake.html +128 -0
- data/docs/table_of_contents.html +954 -0
- data/lib/generators/loggable_activity/install/install_generator.rb +68 -0
- data/lib/generators/loggable_activity/install/templates/create_loggable_activities.rb +45 -0
- data/lib/generators/loggable_activity/install/templates/loggable_activity.en.yml +32 -0
- data/lib/generators/loggable_activity/install/templates/loggable_activity.rb +27 -0
- data/lib/generators/loggable_activity/install/templates/loggable_activity.yml +103 -0
- data/lib/loggable_activity/activity.rb +4 -4
- data/lib/loggable_activity/concerns/current_actor.rb +25 -0
- data/lib/loggable_activity/config_schema.json +2 -13
- data/lib/loggable_activity/configuration.rb +0 -10
- data/lib/loggable_activity/encryption.rb +33 -12
- data/lib/loggable_activity/encryption_key.rb +1 -1
- data/lib/loggable_activity/error.rb +3 -3
- data/lib/loggable_activity/hooks.rb +74 -18
- data/lib/loggable_activity/payload.rb +6 -4
- data/lib/loggable_activity/services/base_payloads_builder.rb +2 -1
- data/lib/loggable_activity/services/custom_payloads_builder.rb +55 -0
- data/lib/loggable_activity/version.rb +1 -1
- data/lib/loggable_activity.rb +5 -2
- metadata +121 -111
- data/lib/loggable_activity/concerns/current_user.rb +0 -26
|
@@ -0,0 +1,430 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class LoggableActivity::Payload - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="class">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
|
62
|
+
<h3>Parent</h3>
|
|
63
|
+
|
|
64
|
+
<p class="link">ActiveRecord::Base
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- Method Quickref -->
|
|
71
|
+
<div id="method-list-section" class="nav-section">
|
|
72
|
+
<h3>Methods</h3>
|
|
73
|
+
|
|
74
|
+
<ul class="link-list" role="directory">
|
|
75
|
+
<li ><a href="#method-i-attrs">#attrs</a>
|
|
76
|
+
<li ><a href="#method-i-decrypt_attr">#decrypt_attr</a>
|
|
77
|
+
<li ><a href="#method-i-decrypted_attrs">#decrypted_attrs</a>
|
|
78
|
+
<li ><a href="#method-i-decrypted_from_to_attr">#decrypted_from_to_attr</a>
|
|
79
|
+
<li ><a href="#method-i-decrypted_update_attrs">#decrypted_update_attrs</a>
|
|
80
|
+
<li ><a href="#method-i-deleted-3F">#deleted?</a>
|
|
81
|
+
<li ><a href="#method-i-deleted_attrs">#deleted_attrs</a>
|
|
82
|
+
<li ><a href="#method-i-payload_route">#payload_route</a>
|
|
83
|
+
<li ><a href="#method-i-record_display_name">#record_display_name</a>
|
|
84
|
+
<li ><a href="#method-i-secret_key">#secret_key</a>
|
|
85
|
+
</ul>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
</nav>
|
|
90
|
+
|
|
91
|
+
<main role="main" aria-labelledby="class-LoggableActivity::Payload">
|
|
92
|
+
<h1 id="class-LoggableActivity::Payload" class="class">
|
|
93
|
+
class LoggableActivity::Payload
|
|
94
|
+
</h1>
|
|
95
|
+
|
|
96
|
+
<section class="description">
|
|
97
|
+
|
|
98
|
+
<p>This class represents a payload in the log, containing encrypted data of one record in the database. When the record is deleted, the encryption key for the payload is also deleted. Payloads come in different types, each serving a specific purpose.</p>
|
|
99
|
+
|
|
100
|
+
</section>
|
|
101
|
+
|
|
102
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<section class="constants-list">
|
|
106
|
+
<header>
|
|
107
|
+
<h3>Constants</h3>
|
|
108
|
+
</header>
|
|
109
|
+
<dl>
|
|
110
|
+
<dt id="DECRYPT_ATTRS_TYPES">DECRYPT_ATTRS_TYPES
|
|
111
|
+
<dd><p>Enumeration for different payload types</p>
|
|
112
|
+
<dt id="DECRYPT_UPDATE_ATTRS_TYPES">DECRYPT_UPDATE_ATTRS_TYPES
|
|
113
|
+
<dd><p>Enumeration for different updatepayload types</p>
|
|
114
|
+
</dl>
|
|
115
|
+
</section>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
120
|
+
<header>
|
|
121
|
+
<h3>Public Instance Methods</h3>
|
|
122
|
+
</header>
|
|
123
|
+
|
|
124
|
+
<div id="method-i-attrs" class="method-detail ">
|
|
125
|
+
<div class="method-header">
|
|
126
|
+
<div class="method-heading">
|
|
127
|
+
<span class="method-name">attrs</span><span
|
|
128
|
+
class="method-args">()</span>
|
|
129
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
130
|
+
</div>
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
<div class="method-description">
|
|
134
|
+
<p>Returns the decrypted attrs.</p>
|
|
135
|
+
|
|
136
|
+
<p>@return [Hash] The decrypted attributes.</p>
|
|
137
|
+
|
|
138
|
+
<p>Example:</p>
|
|
139
|
+
|
|
140
|
+
<pre>payload.attrs
|
|
141
|
+
|
|
142
|
+
Returns:
|
|
143
|
+
{ "street" => "Machu Picchu", "city" => "Cusco" }</pre>
|
|
144
|
+
|
|
145
|
+
<div class="method-source-code" id="attrs-source">
|
|
146
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 65</span>
|
|
147
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attrs</span>
|
|
148
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">deleted_attrs</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">nil?</span>
|
|
149
|
+
|
|
150
|
+
<span class="ruby-keyword">case</span> <span class="ruby-identifier">related_to_activity_as</span>
|
|
151
|
+
<span class="ruby-keyword">when</span> <span class="ruby-operator">*</span><span class="ruby-constant">DECRYPT_ATTRS_TYPES</span>
|
|
152
|
+
<span class="ruby-identifier">decrypted_attrs</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">public_attrs:</span>)
|
|
153
|
+
<span class="ruby-keyword">when</span> <span class="ruby-operator">*</span><span class="ruby-constant">DECRYPT_UPDATE_ATTRS_TYPES</span>
|
|
154
|
+
<span class="ruby-identifier">decrypted_update_attrs</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">public_attrs</span>[<span class="ruby-string">'changes'</span>]
|
|
155
|
+
<span class="ruby-keyword">else</span>
|
|
156
|
+
{ <span class="ruby-value">public_attrs:</span> }
|
|
157
|
+
<span class="ruby-keyword">end</span>
|
|
158
|
+
<span class="ruby-keyword">end</span></pre>
|
|
159
|
+
</div>
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<div id="method-i-deleted-3F" class="method-detail ">
|
|
166
|
+
<div class="method-header">
|
|
167
|
+
<div class="method-heading">
|
|
168
|
+
<span class="method-name">deleted?</span><span
|
|
169
|
+
class="method-args">()</span>
|
|
170
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
171
|
+
</div>
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
<div class="method-description">
|
|
175
|
+
<p>Check if the record has been deleted.</p>
|
|
176
|
+
|
|
177
|
+
<p>@return [Boolean] True if the record has been deleted.</p>
|
|
178
|
+
|
|
179
|
+
<div class="method-source-code" id="deleted-3F-source">
|
|
180
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 105</span>
|
|
181
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deleted?</span>
|
|
182
|
+
<span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">deleted?</span>
|
|
183
|
+
<span class="ruby-keyword">end</span></pre>
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
<div id="method-i-payload_route" class="method-detail ">
|
|
191
|
+
<div class="method-header">
|
|
192
|
+
<div class="method-heading">
|
|
193
|
+
<span class="method-name">payload_route</span><span
|
|
194
|
+
class="method-args">()</span>
|
|
195
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
|
|
199
|
+
<div class="method-description">
|
|
200
|
+
<p>Returns the route for the payload unless the encryption_key is deleted.</p>
|
|
201
|
+
|
|
202
|
+
<p>Example:</p>
|
|
203
|
+
|
|
204
|
+
<pre class="ruby"><span class="ruby-identifier">payload</span>.<span class="ruby-identifier">payload_route</span>
|
|
205
|
+
</pre>
|
|
206
|
+
|
|
207
|
+
<p>@return [String] The route for the payload.</p>
|
|
208
|
+
|
|
209
|
+
<div class="method-source-code" id="payload_route-source">
|
|
210
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 84</span>
|
|
211
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">payload_route</span>
|
|
212
|
+
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">deleted?</span>
|
|
213
|
+
|
|
214
|
+
<span class="ruby-identifier">route</span>
|
|
215
|
+
<span class="ruby-keyword">end</span></pre>
|
|
216
|
+
</div>
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
<div id="method-i-record_display_name" class="method-detail ">
|
|
223
|
+
<div class="method-header">
|
|
224
|
+
<div class="method-heading">
|
|
225
|
+
<span class="method-name">record_display_name</span><span
|
|
226
|
+
class="method-args">()</span>
|
|
227
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
228
|
+
</div>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
<div class="method-description">
|
|
232
|
+
<p>Returns the display name for the record.</p>
|
|
233
|
+
|
|
234
|
+
<p>Example:</p>
|
|
235
|
+
|
|
236
|
+
<pre class="ruby"><span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_display_name</span>
|
|
237
|
+
</pre>
|
|
238
|
+
|
|
239
|
+
<p>@return [String] The display name for the record.</p>
|
|
240
|
+
|
|
241
|
+
<div class="method-source-code" id="record_display_name-source">
|
|
242
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 96</span>
|
|
243
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_display_name</span>
|
|
244
|
+
<span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">'loggable_activity.activity.deleted'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">deleted?</span>
|
|
245
|
+
|
|
246
|
+
<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-identifier">encrypted_record_name</span>, <span class="ruby-identifier">secret_key</span>)
|
|
247
|
+
<span class="ruby-keyword">end</span></pre>
|
|
248
|
+
</div>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
</section>
|
|
255
|
+
|
|
256
|
+
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
|
|
257
|
+
<header>
|
|
258
|
+
<h3>Private Instance Methods</h3>
|
|
259
|
+
</header>
|
|
260
|
+
|
|
261
|
+
<div id="method-i-decrypt_attr" class="method-detail ">
|
|
262
|
+
<div class="method-header">
|
|
263
|
+
<div class="method-heading">
|
|
264
|
+
<span class="method-name">decrypt_attr</span><span
|
|
265
|
+
class="method-args">(value)</span>
|
|
266
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
267
|
+
</div>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
<div class="method-description">
|
|
271
|
+
<p>Decrypts a single attribute.</p>
|
|
272
|
+
|
|
273
|
+
<p>@param value [String] The encrypted value to decrypt. @return [String] The decrypted value.</p>
|
|
274
|
+
|
|
275
|
+
<div class="method-source-code" id="decrypt_attr-source">
|
|
276
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 158</span>
|
|
277
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decrypt_attr</span>(<span class="ruby-identifier">value</span>)
|
|
278
|
+
<span class="ruby-comment"># return 'loggable_activity.attr.deleted' if secret_key.nil?</span>
|
|
279
|
+
<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-identifier">value</span>, <span class="ruby-identifier">secret_key</span>)
|
|
280
|
+
<span class="ruby-keyword">end</span></pre>
|
|
281
|
+
</div>
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
<div id="method-i-decrypted_attrs" class="method-detail ">
|
|
288
|
+
<div class="method-header">
|
|
289
|
+
<div class="method-heading">
|
|
290
|
+
<span class="method-name">decrypted_attrs</span><span
|
|
291
|
+
class="method-args">()</span>
|
|
292
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
293
|
+
</div>
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
<div class="method-description">
|
|
297
|
+
<p>Decrypts all attributes.</p>
|
|
298
|
+
|
|
299
|
+
<p>@return [Hash] The decrypted attributes.</p>
|
|
300
|
+
|
|
301
|
+
<div class="method-source-code" id="decrypted_attrs-source">
|
|
302
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 150</span>
|
|
303
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decrypted_attrs</span>
|
|
304
|
+
<span class="ruby-identifier">encrypted_attrs</span>.<span class="ruby-identifier">transform_keys</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>).<span class="ruby-identifier">transform_values</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">decrypt_attr</span>(<span class="ruby-identifier">value</span>) }
|
|
305
|
+
<span class="ruby-keyword">end</span></pre>
|
|
306
|
+
</div>
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</div>
|
|
311
|
+
|
|
312
|
+
<div id="method-i-decrypted_from_to_attr" class="method-detail ">
|
|
313
|
+
<div class="method-header">
|
|
314
|
+
<div class="method-heading">
|
|
315
|
+
<span class="method-name">decrypted_from_to_attr</span><span
|
|
316
|
+
class="method-args">(change)</span>
|
|
317
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
318
|
+
</div>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
<div class="method-description">
|
|
322
|
+
<p>Decrypts ‘from’ and ‘to’ attributes.</p>
|
|
323
|
+
|
|
324
|
+
<p>@param change [Hash] The change hash containing ‘from’ and ‘to’ values. @return [Hash] The decrypted ‘from’ and ‘to’ values.</p>
|
|
325
|
+
|
|
326
|
+
<div class="method-source-code" id="decrypted_from_to_attr-source">
|
|
327
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 139</span>
|
|
328
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decrypted_from_to_attr</span>(<span class="ruby-identifier">change</span>)
|
|
329
|
+
<span class="ruby-identifier">change</span>.<span class="ruby-identifier">to_h</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
|
330
|
+
<span class="ruby-identifier">from</span> = <span class="ruby-identifier">decrypt_attr</span>(<span class="ruby-identifier">value</span>[<span class="ruby-string">'from'</span>])
|
|
331
|
+
<span class="ruby-identifier">to</span> = <span class="ruby-identifier">decrypt_attr</span>(<span class="ruby-identifier">value</span>[<span class="ruby-string">'to'</span>])
|
|
332
|
+
[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>, { <span class="ruby-value">from:</span>, <span class="ruby-value">to:</span> }]
|
|
333
|
+
<span class="ruby-keyword">end</span>
|
|
334
|
+
<span class="ruby-keyword">end</span></pre>
|
|
335
|
+
</div>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
<div id="method-i-decrypted_update_attrs" class="method-detail ">
|
|
342
|
+
<div class="method-header">
|
|
343
|
+
<div class="method-heading">
|
|
344
|
+
<span class="method-name">decrypted_update_attrs</span><span
|
|
345
|
+
class="method-args">()</span>
|
|
346
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
347
|
+
</div>
|
|
348
|
+
</div>
|
|
349
|
+
|
|
350
|
+
<div class="method-description">
|
|
351
|
+
<p>Decrypts the ‘from’ and ‘to’ attributes in the update payload.</p>
|
|
352
|
+
|
|
353
|
+
<p>@return [Array<Hash>] The array of decrypted changes.</p>
|
|
354
|
+
|
|
355
|
+
<div class="method-source-code" id="decrypted_update_attrs-source">
|
|
356
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 128</span>
|
|
357
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decrypted_update_attrs</span>
|
|
358
|
+
<span class="ruby-comment"># return encrypted_attrs</span>
|
|
359
|
+
<span class="ruby-identifier">encrypted_attrs</span>[<span class="ruby-string">'changes'</span>].<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">change</span><span class="ruby-operator">|</span>
|
|
360
|
+
<span class="ruby-identifier">decrypted_from_to_attr</span>(<span class="ruby-identifier">change</span>)
|
|
361
|
+
<span class="ruby-keyword">end</span>
|
|
362
|
+
<span class="ruby-keyword">end</span></pre>
|
|
363
|
+
</div>
|
|
364
|
+
</div>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
<div id="method-i-deleted_attrs" class="method-detail ">
|
|
370
|
+
<div class="method-header">
|
|
371
|
+
<div class="method-heading">
|
|
372
|
+
<span class="method-name">deleted_attrs</span><span
|
|
373
|
+
class="method-args">()</span>
|
|
374
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
375
|
+
</div>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
<div class="method-description">
|
|
379
|
+
<p>Helper method to handle deleted attributes.</p>
|
|
380
|
+
|
|
381
|
+
<p>@return [Hash] The hash with deleted attributes.</p>
|
|
382
|
+
|
|
383
|
+
<div class="method-source-code" id="deleted_attrs-source">
|
|
384
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 121</span>
|
|
385
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deleted_attrs</span>
|
|
386
|
+
<span class="ruby-identifier">encrypted_attrs</span>.<span class="ruby-identifier">transform_keys</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>).<span class="ruby-identifier">transform_values!</span> { <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">'loggable_activity.activity.deleted'</span>) }
|
|
387
|
+
<span class="ruby-keyword">end</span></pre>
|
|
388
|
+
</div>
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</div>
|
|
393
|
+
|
|
394
|
+
<div id="method-i-secret_key" class="method-detail ">
|
|
395
|
+
<div class="method-header">
|
|
396
|
+
<div class="method-heading">
|
|
397
|
+
<span class="method-name">secret_key</span><span
|
|
398
|
+
class="method-args">()</span>
|
|
399
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
400
|
+
</div>
|
|
401
|
+
</div>
|
|
402
|
+
|
|
403
|
+
<div class="method-description">
|
|
404
|
+
<p>Retrieves the encryption key for the payload.</p>
|
|
405
|
+
|
|
406
|
+
<p>@return [String, nil] The encryption key.</p>
|
|
407
|
+
|
|
408
|
+
<div class="method-source-code" id="secret_key-source">
|
|
409
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/payload.rb, line 114</span>
|
|
410
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">secret_key</span>
|
|
411
|
+
<span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">secret_key</span>
|
|
412
|
+
<span class="ruby-keyword">end</span></pre>
|
|
413
|
+
</div>
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
</div>
|
|
418
|
+
|
|
419
|
+
</section>
|
|
420
|
+
|
|
421
|
+
</section>
|
|
422
|
+
</main>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<footer id="validator-badges" role="contentinfo">
|
|
426
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
427
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.7.0.
|
|
428
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
429
|
+
</footer>
|
|
430
|
+
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>module LoggableActivity::Sanitizer - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="module">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
<!-- Method Quickref -->
|
|
65
|
+
<div id="method-list-section" class="nav-section">
|
|
66
|
+
<h3>Methods</h3>
|
|
67
|
+
|
|
68
|
+
<ul class="link-list" role="directory">
|
|
69
|
+
<li ><a href="#method-c-run">::run</a>
|
|
70
|
+
</ul>
|
|
71
|
+
</div>
|
|
72
|
+
|
|
73
|
+
</div>
|
|
74
|
+
</nav>
|
|
75
|
+
|
|
76
|
+
<main role="main" aria-labelledby="module-LoggableActivity::Sanitizer">
|
|
77
|
+
<h1 id="module-LoggableActivity::Sanitizer" class="module">
|
|
78
|
+
module LoggableActivity::Sanitizer
|
|
79
|
+
</h1>
|
|
80
|
+
|
|
81
|
+
<section class="description">
|
|
82
|
+
|
|
83
|
+
<p>This module is responsible for sanitizing activities. When an encryption keys deleted_at field is set, the key is deleted.</p>
|
|
84
|
+
|
|
85
|
+
</section>
|
|
86
|
+
|
|
87
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
94
|
+
<header>
|
|
95
|
+
<h3>Public Class Methods</h3>
|
|
96
|
+
</header>
|
|
97
|
+
|
|
98
|
+
<div id="method-c-run" class="method-detail ">
|
|
99
|
+
<div class="method-header">
|
|
100
|
+
<div class="method-heading">
|
|
101
|
+
<span class="method-name">run</span><span
|
|
102
|
+
class="method-args">()</span>
|
|
103
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
104
|
+
</div>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<div class="method-description">
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<div class="method-source-code" id="run-source">
|
|
111
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/sanitizer.rb, line 7</span>
|
|
112
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">run</span>
|
|
113
|
+
<span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">EncryptionKey</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">'delete_at < ?'</span>, <span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">now</span>).<span class="ruby-identifier">find_in_batches</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">batch</span><span class="ruby-operator">|</span>
|
|
114
|
+
<span class="ruby-identifier">batch</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-value">:delete</span>)
|
|
115
|
+
<span class="ruby-keyword">end</span>
|
|
116
|
+
<span class="ruby-keyword">end</span></pre>
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
</section>
|
|
124
|
+
|
|
125
|
+
</section>
|
|
126
|
+
</main>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<footer id="validator-badges" role="contentinfo">
|
|
130
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
131
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.7.0.
|
|
132
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
133
|
+
</footer>
|
|
134
|
+
|