loggable_activity 0.2.1 → 0.5.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +29 -42
- data/.vscode/commands.json +2 -2
- data/.vscode/terminals.json +8 -8
- data/CHANGELOG.md +9 -0
- data/CHEAT_SHEET.md +31 -0
- data/MIT-LICENSE +21 -0
- data/README.md +1 -1
- data/Rakefile +6 -4
- data/app/assets/config/loggable_activity_manifest.js +2 -0
- data/app/assets/javascripts/loggable_activity/application.js +1 -0
- data/app/assets/stylesheets/loggable_activity/activities.scss +25 -0
- data/app/assets/stylesheets/loggable_activity/application.scss +16 -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/pico/_first_page.html.erb +13 -0
- data/app/views/kaminari/pico/_gap.html.erb +8 -0
- data/app/views/kaminari/pico/_last_page.html.erb +12 -0
- data/app/views/kaminari/pico/_next_page.html.erb +13 -0
- data/app/views/kaminari/pico/_page.html.erb +14 -0
- data/app/views/kaminari/pico/_paginator.html.erb +27 -0
- data/app/views/kaminari/pico/_prev_page.html.erb +14 -0
- data/app/views/layouts/loggable_activity/application.html.slim +20 -0
- data/app/views/loggable_activity/activities/_activities.html.slim +28 -0
- data/app/views/loggable_activity/activities/index.html.erb +6 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_first_page.html.erb +13 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_gap.html.erb +8 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_last_page.html.erb +13 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_next_page.html.erb +13 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_page.html.erb +14 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_paginator.html.erb +27 -0
- data/app/views/loggable_activity/bootstrap/kaminari/_prev_page.html.erb +13 -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 +4 -3
- data/lib/{schemas → loggable_activity}/config_schema.json +3 -10
- data/lib/loggable_activity/configuration.rb +48 -77
- 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 +22 -0
- data/lib/loggable_activity/error.rb +0 -10
- data/lib/loggable_activity/hooks.rb +10 -15
- 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 +12 -5
- data/lib/loggable_activity/services/update_payloads_builder.rb +34 -6
- data/lib/loggable_activity/version.rb +1 -1
- data/lib/loggable_activity.rb +51 -14
- data/lib/tasks/loggable_activity_tasks.rake +6 -0
- data/loggable_activity-0.5.0.gem +0 -0
- metadata +129 -109
- 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,351 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
|
7
|
-
<title>class LoggableActivity::EncryptionKey - 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-c-create_encryption_key">::create_encryption_key</a>
|
76
|
-
<li ><a href="#method-c-for_record">::for_record</a>
|
77
|
-
<li ><a href="#method-c-for_record_by_type_and_id">::for_record_by_type_and_id</a>
|
78
|
-
<li ><a href="#method-c-random_key">::random_key</a>
|
79
|
-
<li ><a href="#method-i-deleted-3F">#deleted?</a>
|
80
|
-
<li ><a href="#method-i-mark_as_deleted-21">#mark_as_deleted!</a>
|
81
|
-
</ul>
|
82
|
-
</div>
|
83
|
-
|
84
|
-
</div>
|
85
|
-
</nav>
|
86
|
-
|
87
|
-
<main role="main" aria-labelledby="class-LoggableActivity::EncryptionKey">
|
88
|
-
<h1 id="class-LoggableActivity::EncryptionKey" class="class">
|
89
|
-
class LoggableActivity::EncryptionKey
|
90
|
-
</h1>
|
91
|
-
|
92
|
-
<section class="description">
|
93
|
-
|
94
|
-
<p>This class represents the encryption key used to unlock the data for one payload. When deleted, only the encryption_key field is deleted.</p>
|
95
|
-
|
96
|
-
</section>
|
97
|
-
|
98
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
105
|
-
<header>
|
106
|
-
<h3>Public Class Methods</h3>
|
107
|
-
</header>
|
108
|
-
|
109
|
-
<div id="method-c-create_encryption_key" class="method-detail ">
|
110
|
-
<div class="method-header">
|
111
|
-
<div class="method-heading">
|
112
|
-
<span class="method-name">create_encryption_key</span><span
|
113
|
-
class="method-args">(record_type, record_id)</span>
|
114
|
-
<span class="method-click-advice">click to toggle source</span>
|
115
|
-
</div>
|
116
|
-
</div>
|
117
|
-
|
118
|
-
<div class="method-description">
|
119
|
-
<p>Creates an encryption key for a record, optionally using a parent key.</p>
|
120
|
-
|
121
|
-
<pre>@param record_type [String] The type of the record.
|
122
|
-
@param record_id [Integer] The ID of the record.
|
123
|
-
@param parent_key [::LoggableActivity::EncryptionKey, nil] The parent encryption key, if any.
|
124
|
-
@return [::LoggableActivity::EncryptionKey] The created encryption key.</pre>
|
125
|
-
|
126
|
-
<p>Example:</p>
|
127
|
-
|
128
|
-
<pre class="ruby"><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">create_encryption_key</span>(<span class="ruby-string">'User'</span>, <span class="ruby-value">1</span>)
|
129
|
-
</pre>
|
130
|
-
|
131
|
-
<p>Returns:</p>
|
132
|
-
|
133
|
-
<pre class="ruby">{
|
134
|
-
<span class="ruby-value">:id</span> <span class="ruby-operator">=></span> <span class="ruby-value">39</span>,
|
135
|
-
<span class="ruby-value">:parent_key_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">38</span>,
|
136
|
-
<span class="ruby-value">:key</span> <span class="ruby-operator">=></span> <span class="ruby-string">"a8f4774e7f42eb253045a4db7de7b79e"</span>,
|
137
|
-
<span class="ruby-value">:record_type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"User"</span>,
|
138
|
-
<span class="ruby-value">:record_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>
|
139
|
-
}
|
140
|
-
</pre>
|
141
|
-
|
142
|
-
<div class="method-source-code" id="create_encryption_key-source">
|
143
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 100</span>
|
144
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create_encryption_key</span>(<span class="ruby-identifier">record_type</span>, <span class="ruby-identifier">record_id</span>)
|
145
|
-
<span class="ruby-identifier">create</span>(<span class="ruby-value">record_type:</span>, <span class="ruby-value">record_id:</span>, <span class="ruby-value">secret_key:</span> <span class="ruby-identifier">random_key</span>)
|
146
|
-
<span class="ruby-keyword">end</span></pre>
|
147
|
-
</div>
|
148
|
-
</div>
|
149
|
-
|
150
|
-
|
151
|
-
</div>
|
152
|
-
|
153
|
-
<div id="method-c-for_record" class="method-detail ">
|
154
|
-
<div class="method-header">
|
155
|
-
<div class="method-heading">
|
156
|
-
<span class="method-name">for_record</span><span
|
157
|
-
class="method-args">(record)</span>
|
158
|
-
<span class="method-click-advice">click to toggle source</span>
|
159
|
-
</div>
|
160
|
-
</div>
|
161
|
-
|
162
|
-
<div class="method-description">
|
163
|
-
<p>Returns an encryption key for a record, optionally using a parent key.</p>
|
164
|
-
|
165
|
-
<pre>@param record [ActiveRecord::Base] The record for which to get the encryption key.
|
166
|
-
@param parent_key [::LoggableActivity::EncryptionKey, nil] The parent encryption key, if any.
|
167
|
-
@return [::LoggableActivity::EncryptionKey] The encryption key for the record.</pre>
|
168
|
-
|
169
|
-
<p>Example:</p>
|
170
|
-
|
171
|
-
<pre class="ruby"><span class="ruby-identifier">user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value">1</span>)
|
172
|
-
<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">user</span>)
|
173
|
-
</pre>
|
174
|
-
|
175
|
-
<p>Returns:</p>
|
176
|
-
|
177
|
-
<pre class="ruby">{
|
178
|
-
<span class="ruby-value">:id</span> <span class="ruby-operator">=></span> <span class="ruby-value">39</span>,
|
179
|
-
<span class="ruby-value">:parent_key_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">38</span>,
|
180
|
-
<span class="ruby-value">:key</span> <span class="ruby-operator">=></span> <span class="ruby-string">"a8f4774e7f42eb253045a4db7de7b79e"</span>,
|
181
|
-
<span class="ruby-value">:record_type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"User"</span>,
|
182
|
-
<span class="ruby-value">:record_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>
|
183
|
-
}
|
184
|
-
</pre>
|
185
|
-
|
186
|
-
<div class="method-source-code" id="for_record-source">
|
187
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 72</span>
|
188
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">for_record</span>(<span class="ruby-identifier">record</span>)
|
189
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">nil?</span>
|
190
|
-
|
191
|
-
<span class="ruby-identifier">encryption_key</span> = <span class="ruby-identifier">find_by</span>(<span class="ruby-value">record:</span>)
|
192
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">encryption_key</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">encryption_key</span>
|
193
|
-
|
194
|
-
<span class="ruby-identifier">create_encryption_key</span>(<span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">record</span>.<span class="ruby-identifier">id</span>)
|
195
|
-
<span class="ruby-keyword">end</span></pre>
|
196
|
-
</div>
|
197
|
-
</div>
|
198
|
-
|
199
|
-
|
200
|
-
</div>
|
201
|
-
|
202
|
-
<div id="method-c-for_record_by_type_and_id" class="method-detail ">
|
203
|
-
<div class="method-header">
|
204
|
-
<div class="method-heading">
|
205
|
-
<span class="method-name">for_record_by_type_and_id</span><span
|
206
|
-
class="method-args">(record_type, record_id)</span>
|
207
|
-
<span class="method-click-advice">click to toggle source</span>
|
208
|
-
</div>
|
209
|
-
</div>
|
210
|
-
|
211
|
-
<div class="method-description">
|
212
|
-
<p>Returns an encryption key for a record by its type and ID, optionally using a parent key.</p>
|
213
|
-
|
214
|
-
<pre>@param record_type [String] The type of the record.
|
215
|
-
@param record_id [Integer] The ID of the record.
|
216
|
-
@param parent_key [::LoggableActivity::EncryptionKey, nil] The parent encryption key, if any.
|
217
|
-
@return [::LoggableActivity::EncryptionKey] The encryption key for the record.</pre>
|
218
|
-
|
219
|
-
<p>Example:</p>
|
220
|
-
|
221
|
-
<pre class="ruby"><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_by_type_and_id</span>(<span class="ruby-string">'User'</span>, <span class="ruby-value">1</span>)
|
222
|
-
</pre>
|
223
|
-
|
224
|
-
<p>Returns:</p>
|
225
|
-
|
226
|
-
<pre class="ruby">{
|
227
|
-
<span class="ruby-value">:id</span> <span class="ruby-operator">=></span> <span class="ruby-value">39</span>,
|
228
|
-
<span class="ruby-value">:parent_key_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">38</span>,
|
229
|
-
<span class="ruby-value">:key</span> <span class="ruby-operator">=></span> <span class="ruby-string">"a8f4774e7f42eb253045a4db7de7b79e"</span>,
|
230
|
-
<span class="ruby-value">:record_type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"User"</span>,
|
231
|
-
<span class="ruby-value">:record_id</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>
|
232
|
-
}
|
233
|
-
</pre>
|
234
|
-
|
235
|
-
<div class="method-source-code" id="for_record_by_type_and_id-source">
|
236
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 46</span>
|
237
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">for_record_by_type_and_id</span>(<span class="ruby-identifier">record_type</span>, <span class="ruby-identifier">record_id</span>)
|
238
|
-
<span class="ruby-identifier">encryption_key</span> = <span class="ruby-identifier">find_by</span>(<span class="ruby-value">record_type:</span>, <span class="ruby-value">record_id:</span>)
|
239
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">encryption_key</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">encryption_key</span>
|
240
|
-
|
241
|
-
<span class="ruby-identifier">create_encryption_key</span>(<span class="ruby-identifier">record_type</span>, <span class="ruby-identifier">record_id</span>)
|
242
|
-
<span class="ruby-keyword">end</span></pre>
|
243
|
-
</div>
|
244
|
-
</div>
|
245
|
-
|
246
|
-
|
247
|
-
</div>
|
248
|
-
|
249
|
-
<div id="method-c-random_key" class="method-detail ">
|
250
|
-
<div class="method-header">
|
251
|
-
<div class="method-heading">
|
252
|
-
<span class="method-name">random_key</span><span
|
253
|
-
class="method-args">()</span>
|
254
|
-
<span class="method-click-advice">click to toggle source</span>
|
255
|
-
</div>
|
256
|
-
</div>
|
257
|
-
|
258
|
-
<div class="method-description">
|
259
|
-
<p>Generates a random encryption key.</p>
|
260
|
-
|
261
|
-
<pre>@return [String] The generated encryption key.</pre>
|
262
|
-
|
263
|
-
<p>Example:</p>
|
264
|
-
|
265
|
-
<pre class="ruby"><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">random_key</span>
|
266
|
-
</pre>
|
267
|
-
|
268
|
-
<p>Returns:</p>
|
269
|
-
|
270
|
-
<pre class="ruby"><span class="ruby-string">"a8f4774e7f42eb253045a4db7de7b79e"</span>
|
271
|
-
</pre>
|
272
|
-
|
273
|
-
<div class="method-source-code" id="random_key-source">
|
274
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 114</span>
|
275
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">random_key</span>
|
276
|
-
<span class="ruby-comment"># Generate 32 random bytes (256 bits) directly</span>
|
277
|
-
<span class="ruby-identifier">encryption_key</span> = <span class="ruby-constant">SecureRandom</span>.<span class="ruby-identifier">random_bytes</span>(<span class="ruby-value">32</span>)
|
278
|
-
<span class="ruby-comment"># Encode the key in Base64 to ensure it's in a transferable format</span>
|
279
|
-
<span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">encryption_key</span>).<span class="ruby-identifier">strip</span>
|
280
|
-
<span class="ruby-keyword">end</span></pre>
|
281
|
-
</div>
|
282
|
-
</div>
|
283
|
-
|
284
|
-
|
285
|
-
</div>
|
286
|
-
|
287
|
-
</section>
|
288
|
-
|
289
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
290
|
-
<header>
|
291
|
-
<h3>Public Instance Methods</h3>
|
292
|
-
</header>
|
293
|
-
|
294
|
-
<div id="method-i-deleted-3F" class="method-detail ">
|
295
|
-
<div class="method-header">
|
296
|
-
<div class="method-heading">
|
297
|
-
<span class="method-name">deleted?</span><span
|
298
|
-
class="method-args">()</span>
|
299
|
-
<span class="method-click-advice">click to toggle source</span>
|
300
|
-
</div>
|
301
|
-
</div>
|
302
|
-
|
303
|
-
<div class="method-description">
|
304
|
-
<p>check if the encryption key is deleted</p>
|
305
|
-
|
306
|
-
<div class="method-source-code" id="deleted-3F-source">
|
307
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 23</span>
|
308
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deleted?</span>
|
309
|
-
<span class="ruby-identifier">secret_key</span>.<span class="ruby-identifier">nil?</span>
|
310
|
-
<span class="ruby-keyword">end</span></pre>
|
311
|
-
</div>
|
312
|
-
</div>
|
313
|
-
|
314
|
-
|
315
|
-
</div>
|
316
|
-
|
317
|
-
<div id="method-i-mark_as_deleted-21" class="method-detail ">
|
318
|
-
<div class="method-header">
|
319
|
-
<div class="method-heading">
|
320
|
-
<span class="method-name">mark_as_deleted!</span><span
|
321
|
-
class="method-args">()</span>
|
322
|
-
<span class="method-click-advice">click to toggle source</span>
|
323
|
-
</div>
|
324
|
-
</div>
|
325
|
-
|
326
|
-
<div class="method-description">
|
327
|
-
<p>Marks the encryption key as deleted by updating the key to nil.</p>
|
328
|
-
|
329
|
-
<div class="method-source-code" id="mark_as_deleted-21-source">
|
330
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/encryption_key.rb, line 18</span>
|
331
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mark_as_deleted!</span>
|
332
|
-
<span class="ruby-identifier">update</span>(<span class="ruby-value">secret_key:</span> <span class="ruby-keyword">nil</span>)
|
333
|
-
<span class="ruby-keyword">end</span></pre>
|
334
|
-
</div>
|
335
|
-
</div>
|
336
|
-
|
337
|
-
|
338
|
-
</div>
|
339
|
-
|
340
|
-
</section>
|
341
|
-
|
342
|
-
</section>
|
343
|
-
</main>
|
344
|
-
|
345
|
-
|
346
|
-
<footer id="validator-badges" role="contentinfo">
|
347
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
348
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
349
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
350
|
-
</footer>
|
351
|
-
|
@@ -1,145 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
|
7
|
-
<title>class LoggableActivity::Error - 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">StandardError
|
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 class="calls-super" ><a href="#method-c-new">::new</a>
|
76
|
-
</ul>
|
77
|
-
</div>
|
78
|
-
|
79
|
-
</div>
|
80
|
-
</nav>
|
81
|
-
|
82
|
-
<main role="main" aria-labelledby="class-LoggableActivity::Error">
|
83
|
-
<h1 id="class-LoggableActivity::Error" class="class">
|
84
|
-
class LoggableActivity::Error
|
85
|
-
</h1>
|
86
|
-
|
87
|
-
<section class="description">
|
88
|
-
|
89
|
-
<p><a href="Error.html"><code>Error</code></a> class for loggable activity.</p>
|
90
|
-
|
91
|
-
</section>
|
92
|
-
|
93
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
100
|
-
<header>
|
101
|
-
<h3>Public Class Methods</h3>
|
102
|
-
</header>
|
103
|
-
|
104
|
-
<div id="method-c-new" class="method-detail ">
|
105
|
-
<div class="method-header">
|
106
|
-
<div class="method-heading">
|
107
|
-
<span class="method-name">new</span><span
|
108
|
-
class="method-args">(msg = '')</span>
|
109
|
-
<span class="method-click-advice">click to toggle source</span>
|
110
|
-
</div>
|
111
|
-
</div>
|
112
|
-
|
113
|
-
<div class="method-description">
|
114
|
-
|
115
|
-
<div class="method-calls-super">
|
116
|
-
Calls superclass method
|
117
|
-
|
118
|
-
</div>
|
119
|
-
|
120
|
-
<div class="method-source-code" id="new-source">
|
121
|
-
<pre><span class="ruby-comment"># File lib/loggable_activity/error.rb, line 6</span>
|
122
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">msg</span> = <span class="ruby-string">''</span>)
|
123
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-string">'---------------- LOGGABLE ACTIVITY -----------------'</span>
|
124
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span>
|
125
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-string">'----------------------------------------------------'</span>
|
126
|
-
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">msg</span>)
|
127
|
-
<span class="ruby-keyword">end</span></pre>
|
128
|
-
</div>
|
129
|
-
</div>
|
130
|
-
|
131
|
-
|
132
|
-
</div>
|
133
|
-
|
134
|
-
</section>
|
135
|
-
|
136
|
-
</section>
|
137
|
-
</main>
|
138
|
-
|
139
|
-
|
140
|
-
<footer id="validator-badges" role="contentinfo">
|
141
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
142
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
143
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
144
|
-
</footer>
|
145
|
-
|