loggable_activity 0.2.1 → 0.5.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.
- checksums.yaml +4 -4
- data/.rubocop.yml +29 -42
- data/.vscode/commands.json +2 -2
- data/.vscode/terminals.json +8 -8
- data/CHEAT_SHEET.md +31 -0
- data/MIT-LICENSE +21 -0
- data/README.md +31 -45
- data/Rakefile +6 -4
- data/app/assets/config/loggable_activity_manifest.js +4 -0
- data/app/assets/javascripts/loggable_activity/application.js +2 -0
- data/app/assets/stylesheets/loggable_activity/application.scss +20 -0
- data/app/controllers/concerns/.keep +0 -0
- data/app/controllers/loggable_activity/activities_controller.rb +12 -0
- data/app/controllers/loggable_activity/application_controller.rb +6 -0
- data/app/helpers/loggable_activity/activities_helper.rb +17 -0
- data/app/helpers/loggable_activity/application_helper.rb +6 -0
- data/app/jobs/loggable_activity/application_job.rb +6 -0
- data/app/mailers/loggable_activity/application_mailer.rb +8 -0
- data/app/models/loggable_activity/application_record.rb +7 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_first_page.html.erb +14 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_gap.html.erb +8 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_last_page.html.erb +13 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_next_page.html.erb +13 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_page.html.erb +14 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_paginator.html.erb +27 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_prev_page.html.erb +14 -0
- data/app/views/layouts/loggable_activity/application.html.erb +19 -0
- data/app/views/loggable_activity/activities/_activities.html.erb +56 -0
- data/app/views/loggable_activity/activities/index.html.erb +7 -0
- data/app/views/loggable_activity/activities/show.html.erb +2 -0
- data/config/initializers/kaminari_config.rb +14 -0
- data/config/routes.rb +7 -0
- data/{lib/generators/loggable_activity/templates/create_loggable_activities.rb → db/migrate/20240702092648_create_loggable_activity_tables.rb} +18 -10
- data/git-org/HEAD +1 -0
- data/git-org/config +7 -0
- data/git-org/description +1 -0
- data/git-org/hooks/applypatch-msg.sample +15 -0
- data/git-org/hooks/commit-msg.sample +24 -0
- data/git-org/hooks/fsmonitor-watchman.sample +174 -0
- data/git-org/hooks/post-update.sample +8 -0
- data/git-org/hooks/pre-applypatch.sample +14 -0
- data/git-org/hooks/pre-commit.sample +49 -0
- data/git-org/hooks/pre-merge-commit.sample +13 -0
- data/git-org/hooks/pre-push.sample +53 -0
- data/git-org/hooks/pre-rebase.sample +169 -0
- data/git-org/hooks/pre-receive.sample +24 -0
- data/git-org/hooks/prepare-commit-msg.sample +42 -0
- data/git-org/hooks/push-to-checkout.sample +78 -0
- data/git-org/hooks/update.sample +128 -0
- data/git-org/info/exclude +6 -0
- data/lib/loggable_activity/activity.rb +3 -3
- data/lib/{schemas → loggable_activity}/config_schema.json +3 -3
- data/lib/loggable_activity/configuration.rb +51 -75
- data/lib/loggable_activity/data_owner.rb +0 -1
- data/lib/loggable_activity/encryption.rb +16 -7
- data/lib/loggable_activity/encryption_key.rb +4 -7
- data/lib/loggable_activity/engine.rb +27 -0
- data/lib/loggable_activity/error.rb +0 -10
- data/lib/loggable_activity/hooks.rb +10 -5
- data/lib/loggable_activity/payload.rb +8 -11
- data/lib/loggable_activity/sanitizer.rb +6 -2
- data/lib/loggable_activity/services/base_payloads_builder.rb +14 -5
- data/lib/loggable_activity/services/destroy_payloads_builder.rb +2 -1
- data/lib/loggable_activity/services/payloads_builder.rb +9 -2
- data/lib/loggable_activity/services/update_payloads_builder.rb +30 -2
- data/lib/loggable_activity/version.rb +1 -1
- data/lib/loggable_activity.rb +51 -14
- data/lib/tasks/loggable_activity_tasks.rake +6 -0
- metadata +129 -117
- data/.document +0 -1
- data/.nojekyll +0 -1
- data/.rspec +0 -3
- data/CONSIDERTIONS.md +0 -129
- data/GETTING-STARTED.md +0 -119
- data/LICENSE.txt +0 -21
- data/PAYLOAD_EXAMPLE.md +0 -63
- data/ROADMAP.md +0 -23
- data/docs/LoggableActivity/Activity.html +0 -555
- data/docs/LoggableActivity/Configuration.html +0 -330
- data/docs/LoggableActivity/ConfigurationError.html +0 -148
- data/docs/LoggableActivity/DataOwner.html +0 -138
- data/docs/LoggableActivity/Encryption.html +0 -234
- data/docs/LoggableActivity/EncryptionError.html +0 -145
- data/docs/LoggableActivity/EncryptionKey.html +0 -351
- data/docs/LoggableActivity/Error.html +0 -145
- data/docs/LoggableActivity/Hooks.html +0 -759
- data/docs/LoggableActivity/Payload.html +0 -432
- data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +0 -442
- data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +0 -395
- data/docs/LoggableActivity/Services/PayloadsBuilder.html +0 -342
- data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +0 -490
- data/docs/LoggableActivity/Services.html +0 -93
- data/docs/LoggableActivity.html +0 -102
- data/docs/created.rid +0 -14
- data/docs/css/fonts.css +0 -167
- data/docs/css/rdoc.css +0 -687
- 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/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 +0 -99
- data/docs/js/darkfish.js +0 -97
- data/docs/js/navigation.js +0 -105
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +0 -110
- data/docs/js/search_index.js +0 -1
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +0 -229
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +0 -617
- data/help/loggable_activity_help.txt +0 -19
- data/lib/generators/.DS_Store +0 -0
- data/lib/generators/loggable_activity/.DS_Store +0 -0
- data/lib/generators/loggable_activity/install_generator.rb +0 -109
- data/lib/generators/loggable_activity/templates/.DS_Store +0 -0
- data/lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb +0 -30
- data/lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml +0 -36
- data/lib/generators/loggable_activity/templates/config/loggable_activity.yaml +0 -29
- data/lib/generators/loggable_activity/templates/loggable_activity.en.yaml +0 -36
- data/pkg/loggable_activity-0.1.35.gem +0 -0
- data/sig/loggable_activity.rbs +0 -4
- /data/{.rspec_status → app/assets/images/loggable_activity/.keep} +0 -0
- /data/lib/{generators/loggable_activity/templates → loggable_activity/concerns}/current_user.rb +0 -0
|
@@ -1,442 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta charset="UTF-8">
|
|
6
|
-
|
|
7
|
-
<title>class LoggableActivity::Services::BasePayloadsBuilder - 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">Object
|
|
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-c-new">::new</a>
|
|
76
|
-
<li ><a href="#method-i-build_encrypted_payload">#build_encrypted_payload</a>
|
|
77
|
-
<li ><a href="#method-i-build_payload">#build_payload</a>
|
|
78
|
-
<li ><a href="#method-i-changes_to_save">#changes_to_save</a>
|
|
79
|
-
<li ><a href="#method-i-encrypt_attr">#encrypt_attr</a>
|
|
80
|
-
<li ><a href="#method-i-encrypt_attributes">#encrypt_attributes</a>
|
|
81
|
-
<li ><a href="#method-i-encrypt_attrs">#encrypt_attrs</a>
|
|
82
|
-
<li ><a href="#method-i-encrypt_record_name_for_record">#encrypt_record_name_for_record</a>
|
|
83
|
-
<li ><a href="#method-i-encryption_key_for_record">#encryption_key_for_record</a>
|
|
84
|
-
<li ><a href="#method-i-fetch_record_name_for_record">#fetch_record_name_for_record</a>
|
|
85
|
-
<li ><a href="#method-i-saved_changes">#saved_changes</a>
|
|
86
|
-
</ul>
|
|
87
|
-
</div>
|
|
88
|
-
|
|
89
|
-
</div>
|
|
90
|
-
</nav>
|
|
91
|
-
|
|
92
|
-
<main role="main" aria-labelledby="class-LoggableActivity::Services::BasePayloadsBuilder">
|
|
93
|
-
<h1 id="class-LoggableActivity::Services::BasePayloadsBuilder" class="class">
|
|
94
|
-
class LoggableActivity::Services::BasePayloadsBuilder
|
|
95
|
-
</h1>
|
|
96
|
-
|
|
97
|
-
<section class="description">
|
|
98
|
-
|
|
99
|
-
<p>This service class provides the base payloads builder for the loggable activity. Other service modules related to the loggable activity will inherit from this module.</p>
|
|
100
|
-
|
|
101
|
-
</section>
|
|
102
|
-
|
|
103
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
110
|
-
<header>
|
|
111
|
-
<h3>Public Class Methods</h3>
|
|
112
|
-
</header>
|
|
113
|
-
|
|
114
|
-
<div id="method-c-new" class="method-detail ">
|
|
115
|
-
<div class="method-header">
|
|
116
|
-
<div class="method-heading">
|
|
117
|
-
<span class="method-name">new</span><span
|
|
118
|
-
class="method-args">(record, payloads)</span>
|
|
119
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
120
|
-
</div>
|
|
121
|
-
</div>
|
|
122
|
-
|
|
123
|
-
<div class="method-description">
|
|
124
|
-
<p>Initializes the <a href="PayloadsBuilder.html"><code>PayloadsBuilder</code></a> with a record and an initial collection of payloads,</p>
|
|
125
|
-
|
|
126
|
-
<div class="method-source-code" id="new-source">
|
|
127
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 9</span>
|
|
128
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">payloads</span>)
|
|
129
|
-
<span class="ruby-ivar">@record</span> = <span class="ruby-identifier">record</span>
|
|
130
|
-
<span class="ruby-ivar">@payloads</span> = <span class="ruby-identifier">payloads</span>
|
|
131
|
-
<span class="ruby-ivar">@loggable_attrs</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">loggable_attrs</span>
|
|
132
|
-
<span class="ruby-comment"># @relation_config = record.relation_config</span>
|
|
133
|
-
<span class="ruby-ivar">@relations</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">relations</span>
|
|
134
|
-
<span class="ruby-ivar">@auto_log</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">auto_log</span>
|
|
135
|
-
<span class="ruby-comment"># @fetch_record_name_from = record.class.fetch_record_name_from</span>
|
|
136
|
-
<span class="ruby-ivar">@route</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">route</span>
|
|
137
|
-
<span class="ruby-keyword">end</span></pre>
|
|
138
|
-
</div>
|
|
139
|
-
</div>
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
</div>
|
|
143
|
-
|
|
144
|
-
</section>
|
|
145
|
-
|
|
146
|
-
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
|
|
147
|
-
<header>
|
|
148
|
-
<h3>Private Instance Methods</h3>
|
|
149
|
-
</header>
|
|
150
|
-
|
|
151
|
-
<div id="method-i-build_encrypted_payload" class="method-detail ">
|
|
152
|
-
<div class="method-header">
|
|
153
|
-
<div class="method-heading">
|
|
154
|
-
<span class="method-name">build_encrypted_payload</span><span
|
|
155
|
-
class="method-args">(record, options = {})</span>
|
|
156
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
157
|
-
</div>
|
|
158
|
-
</div>
|
|
159
|
-
|
|
160
|
-
<div class="method-description">
|
|
161
|
-
<p>Build a encrypted payload for a record</p>
|
|
162
|
-
|
|
163
|
-
<div class="method-source-code" id="build_encrypted_payload-source">
|
|
164
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 65</span>
|
|
165
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_encrypted_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">options</span> = {})
|
|
166
|
-
<span class="ruby-identifier">encryption_key</span> = <span class="ruby-identifier">encryption_key_for_record</span>(<span class="ruby-identifier">record</span>)
|
|
167
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">deleted?</span>
|
|
168
|
-
|
|
169
|
-
<span class="ruby-identifier">secret_key</span> = <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">secret_key</span>
|
|
170
|
-
<span class="ruby-identifier">encrypted_attrs</span> = <span class="ruby-identifier">encrypt_attributes</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">secret_key</span>)
|
|
171
|
-
|
|
172
|
-
<span class="ruby-identifier">build_payload</span>(
|
|
173
|
-
<span class="ruby-identifier">record</span>,
|
|
174
|
-
<span class="ruby-identifier">encryption_key</span>,
|
|
175
|
-
<span class="ruby-identifier">encrypted_attrs</span>,
|
|
176
|
-
<span class="ruby-identifier">options</span>
|
|
177
|
-
)
|
|
178
|
-
{ <span class="ruby-value">encryption_key:</span>, <span class="ruby-value">encrypted_attrs:</span> }
|
|
179
|
-
<span class="ruby-keyword">end</span></pre>
|
|
180
|
-
</div>
|
|
181
|
-
</div>
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
</div>
|
|
185
|
-
|
|
186
|
-
<div id="method-i-build_payload" class="method-detail ">
|
|
187
|
-
<div class="method-header">
|
|
188
|
-
<div class="method-heading">
|
|
189
|
-
<span class="method-name">build_payload</span><span
|
|
190
|
-
class="method-args">(record, encryption_key, encrypted_attrs, options = {})</span>
|
|
191
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
192
|
-
</div>
|
|
193
|
-
</div>
|
|
194
|
-
|
|
195
|
-
<div class="method-description">
|
|
196
|
-
<p>Builds the payload for a record</p>
|
|
197
|
-
|
|
198
|
-
<div class="method-source-code" id="build_payload-source">
|
|
199
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 82</span>
|
|
200
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">encryption_key</span>, <span class="ruby-identifier">encrypted_attrs</span>, <span class="ruby-identifier">options</span> = {})
|
|
201
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">deleted?</span>
|
|
202
|
-
|
|
203
|
-
<span class="ruby-identifier">related_to_activity_as</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:related_to_activity_as</span>]
|
|
204
|
-
<span class="ruby-identifier">current_payload</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:current_payload</span>]
|
|
205
|
-
<span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:data_owner</span>]
|
|
206
|
-
|
|
207
|
-
<span class="ruby-identifier">secret_key</span> = <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">secret_key</span>
|
|
208
|
-
<span class="ruby-identifier">encrypted_record_name</span> = <span class="ruby-identifier">encrypt_record_name_for_record</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">secret_key</span>)
|
|
209
|
-
<span class="ruby-identifier">payload</span> = <span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Payload</span>.<span class="ruby-identifier">new</span>(
|
|
210
|
-
<span class="ruby-value">encryption_key:</span>,
|
|
211
|
-
<span class="ruby-value">record:</span>,
|
|
212
|
-
<span class="ruby-value">encrypted_record_name:</span>,
|
|
213
|
-
<span class="ruby-value">encrypted_attrs:</span>,
|
|
214
|
-
<span class="ruby-value">related_to_activity_as:</span>,
|
|
215
|
-
<span class="ruby-value">route:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">route</span>,
|
|
216
|
-
<span class="ruby-value">current_payload:</span>,
|
|
217
|
-
<span class="ruby-value">data_owner:</span>
|
|
218
|
-
)
|
|
219
|
-
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">valid?</span>
|
|
220
|
-
<span class="ruby-identifier">error_message</span> = <span class="ruby-node">"Payload validation failed: #{payload.errors.full_messages.join(', ')}"</span>
|
|
221
|
-
<span class="ruby-identifier">raise</span> <span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-identifier">error_message</span>
|
|
222
|
-
<span class="ruby-keyword">end</span>
|
|
223
|
-
|
|
224
|
-
<span class="ruby-ivar">@payloads</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">payload</span>
|
|
225
|
-
<span class="ruby-keyword">end</span></pre>
|
|
226
|
-
</div>
|
|
227
|
-
</div>
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
</div>
|
|
231
|
-
|
|
232
|
-
<div id="method-i-changes_to_save" class="method-detail ">
|
|
233
|
-
<div class="method-header">
|
|
234
|
-
<div class="method-heading">
|
|
235
|
-
<span class="method-name">changes_to_save</span><span
|
|
236
|
-
class="method-args">(record)</span>
|
|
237
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
238
|
-
</div>
|
|
239
|
-
</div>
|
|
240
|
-
|
|
241
|
-
<div class="method-description">
|
|
242
|
-
<p>Fetch the previous and current values for a record.</p>
|
|
243
|
-
|
|
244
|
-
<div class="method-source-code" id="changes_to_save-source">
|
|
245
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 28</span>
|
|
246
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">changes_to_save</span>(<span class="ruby-identifier">record</span>)
|
|
247
|
-
<span class="ruby-identifier">changes</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">changes_to_save</span>
|
|
248
|
-
<span class="ruby-identifier">previous_values</span> = {}
|
|
249
|
-
<span class="ruby-identifier">current_values</span> = {}
|
|
250
|
-
|
|
251
|
-
<span class="ruby-identifier">changes</span>.<span class="ruby-identifier">map</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>
|
|
252
|
-
<span class="ruby-identifier">previous_values</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>]
|
|
253
|
-
<span class="ruby-identifier">current_values</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>[<span class="ruby-value">1</span>]
|
|
254
|
-
<span class="ruby-keyword">end</span>
|
|
255
|
-
[<span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">current_values</span>]
|
|
256
|
-
<span class="ruby-keyword">end</span></pre>
|
|
257
|
-
</div>
|
|
258
|
-
</div>
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
</div>
|
|
262
|
-
|
|
263
|
-
<div id="method-i-encrypt_attr" class="method-detail ">
|
|
264
|
-
<div class="method-header">
|
|
265
|
-
<div class="method-heading">
|
|
266
|
-
<span class="method-name">encrypt_attr</span><span
|
|
267
|
-
class="method-args">(value, secret_key)</span>
|
|
268
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
269
|
-
</div>
|
|
270
|
-
</div>
|
|
271
|
-
|
|
272
|
-
<div class="method-description">
|
|
273
|
-
<p>Encrypt a single attribute.</p>
|
|
274
|
-
|
|
275
|
-
<div class="method-source-code" id="encrypt_attr-source">
|
|
276
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 122</span>
|
|
277
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encrypt_attr</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">secret_key</span>)
|
|
278
|
-
<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-identifier">value</span>, <span class="ruby-identifier">secret_key</span>)
|
|
279
|
-
<span class="ruby-keyword">end</span></pre>
|
|
280
|
-
</div>
|
|
281
|
-
</div>
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
</div>
|
|
285
|
-
|
|
286
|
-
<div id="method-i-encrypt_attributes" class="method-detail ">
|
|
287
|
-
<div class="method-header">
|
|
288
|
-
<div class="method-heading">
|
|
289
|
-
<span class="method-name">encrypt_attributes</span><span
|
|
290
|
-
class="method-args">(record, secret_key)</span>
|
|
291
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
292
|
-
</div>
|
|
293
|
-
</div>
|
|
294
|
-
|
|
295
|
-
<div class="method-description">
|
|
296
|
-
<p>Encrypts the attributes for the record.</p>
|
|
297
|
-
|
|
298
|
-
<div class="method-source-code" id="encrypt_attributes-source">
|
|
299
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 110</span>
|
|
300
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encrypt_attributes</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">secret_key</span>)
|
|
301
|
-
<span class="ruby-identifier">encrypt_attrs</span>(<span class="ruby-identifier">record</span>.<span class="ruby-identifier">attributes</span>, <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">loggable_attrs</span>, <span class="ruby-identifier">secret_key</span>)
|
|
302
|
-
<span class="ruby-keyword">end</span></pre>
|
|
303
|
-
</div>
|
|
304
|
-
</div>
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
</div>
|
|
308
|
-
|
|
309
|
-
<div id="method-i-encrypt_attrs" class="method-detail ">
|
|
310
|
-
<div class="method-header">
|
|
311
|
-
<div class="method-heading">
|
|
312
|
-
<span class="method-name">encrypt_attrs</span><span
|
|
313
|
-
class="method-args">(attrs, loggable_attrs, secret_key)</span>
|
|
314
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
315
|
-
</div>
|
|
316
|
-
</div>
|
|
317
|
-
|
|
318
|
-
<div class="method-description">
|
|
319
|
-
<p>Encrypt one attributes for only loggable_attrs, configured</p>
|
|
320
|
-
|
|
321
|
-
<div class="method-source-code" id="encrypt_attrs-source">
|
|
322
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 115</span>
|
|
323
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encrypt_attrs</span>(<span class="ruby-identifier">attrs</span>, <span class="ruby-identifier">loggable_attrs</span>, <span class="ruby-identifier">secret_key</span>)
|
|
324
|
-
<span class="ruby-identifier">attrs</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">loggable_attrs</span>).<span class="ruby-identifier">transform_values</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
|
325
|
-
<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-identifier">value</span>, <span class="ruby-identifier">secret_key</span>)
|
|
326
|
-
<span class="ruby-keyword">end</span>
|
|
327
|
-
<span class="ruby-keyword">end</span></pre>
|
|
328
|
-
</div>
|
|
329
|
-
</div>
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
</div>
|
|
333
|
-
|
|
334
|
-
<div id="method-i-encrypt_record_name_for_record" class="method-detail ">
|
|
335
|
-
<div class="method-header">
|
|
336
|
-
<div class="method-heading">
|
|
337
|
-
<span class="method-name">encrypt_record_name_for_record</span><span
|
|
338
|
-
class="method-args">(record, secret_key)</span>
|
|
339
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
340
|
-
</div>
|
|
341
|
-
</div>
|
|
342
|
-
|
|
343
|
-
<div class="method-description">
|
|
344
|
-
<p>Encrypts the record name for the record. If the record has a fetch_record_name_from the configuration, it will use that method to fetch the record name. Otherwise, it will use the class name and the record id.</p>
|
|
345
|
-
|
|
346
|
-
<div class="method-source-code" id="encrypt_record_name_for_record-source">
|
|
347
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 44</span>
|
|
348
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encrypt_record_name_for_record</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">secret_key</span>)
|
|
349
|
-
<span class="ruby-identifier">record_name</span> = <span class="ruby-identifier">fetch_record_name_for_record</span>(<span class="ruby-identifier">record</span>) <span class="ruby-operator">||</span> <span class="ruby-node">"#{record.class.name}##{record.id}"</span>
|
|
350
|
-
|
|
351
|
-
<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-identifier">record_name</span>, <span class="ruby-identifier">secret_key</span>)
|
|
352
|
-
<span class="ruby-keyword">end</span></pre>
|
|
353
|
-
</div>
|
|
354
|
-
</div>
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
</div>
|
|
358
|
-
|
|
359
|
-
<div id="method-i-encryption_key_for_record" class="method-detail ">
|
|
360
|
-
<div class="method-header">
|
|
361
|
-
<div class="method-heading">
|
|
362
|
-
<span class="method-name">encryption_key_for_record</span><span
|
|
363
|
-
class="method-args">(record)</span>
|
|
364
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
365
|
-
</div>
|
|
366
|
-
</div>
|
|
367
|
-
|
|
368
|
-
<div class="method-description">
|
|
369
|
-
<p>Returns the encryption key for the record.</p>
|
|
370
|
-
|
|
371
|
-
<div class="method-source-code" id="encryption_key_for_record-source">
|
|
372
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 60</span>
|
|
373
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encryption_key_for_record</span>(<span class="ruby-identifier">record</span>)
|
|
374
|
-
<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">for_record</span>(<span class="ruby-identifier">record</span>)
|
|
375
|
-
<span class="ruby-keyword">end</span></pre>
|
|
376
|
-
</div>
|
|
377
|
-
</div>
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
</div>
|
|
381
|
-
|
|
382
|
-
<div id="method-i-fetch_record_name_for_record" class="method-detail ">
|
|
383
|
-
<div class="method-header">
|
|
384
|
-
<div class="method-heading">
|
|
385
|
-
<span class="method-name">fetch_record_name_for_record</span><span
|
|
386
|
-
class="method-args">(record)</span>
|
|
387
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
388
|
-
</div>
|
|
389
|
-
</div>
|
|
390
|
-
|
|
391
|
-
<div class="method-description">
|
|
392
|
-
<p>Return the record name for the record. If the record has a fetch_record_name_from the configuration,</p>
|
|
393
|
-
|
|
394
|
-
<div class="method-source-code" id="fetch_record_name_for_record-source">
|
|
395
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 52</span>
|
|
396
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_record_name_for_record</span>(<span class="ruby-identifier">record</span>)
|
|
397
|
-
<span class="ruby-identifier">fetch_from</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">fetch_record_name_from</span>
|
|
398
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fetch_from</span>.<span class="ruby-identifier">nil?</span>
|
|
399
|
-
|
|
400
|
-
<span class="ruby-identifier">record</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">fetch_from</span>)
|
|
401
|
-
<span class="ruby-keyword">end</span></pre>
|
|
402
|
-
</div>
|
|
403
|
-
</div>
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
</div>
|
|
407
|
-
|
|
408
|
-
<div id="method-i-saved_changes" class="method-detail ">
|
|
409
|
-
<div class="method-header">
|
|
410
|
-
<div class="method-heading">
|
|
411
|
-
<span class="method-name">saved_changes</span><span
|
|
412
|
-
class="method-args">(record)</span>
|
|
413
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
414
|
-
</div>
|
|
415
|
-
</div>
|
|
416
|
-
|
|
417
|
-
<div class="method-description">
|
|
418
|
-
<p>Returns saved changes for a record.</p>
|
|
419
|
-
|
|
420
|
-
<div class="method-source-code" id="saved_changes-source">
|
|
421
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/services/base_payloads_builder.rb, line 23</span>
|
|
422
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">saved_changes</span>(<span class="ruby-identifier">record</span>)
|
|
423
|
-
[<span class="ruby-identifier">record</span>.<span class="ruby-identifier">saved_changes</span>.<span class="ruby-identifier">transform_values</span>(<span class="ruby-operator">&</span><span class="ruby-value">:first</span>), <span class="ruby-identifier">record</span>.<span class="ruby-identifier">saved_changes</span>.<span class="ruby-identifier">transform_values</span>(<span class="ruby-operator">&</span><span class="ruby-value">:last</span>)]
|
|
424
|
-
<span class="ruby-keyword">end</span></pre>
|
|
425
|
-
</div>
|
|
426
|
-
</div>
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
</div>
|
|
430
|
-
|
|
431
|
-
</section>
|
|
432
|
-
|
|
433
|
-
</section>
|
|
434
|
-
</main>
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
<footer id="validator-badges" role="contentinfo">
|
|
438
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
439
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
|
440
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
441
|
-
</footer>
|
|
442
|
-
|