rails_surrogate_key_logging 0.1.0 → 0.2.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/lib/surrogate_key_logging/action_controller/params.rb +34 -0
- data/lib/surrogate_key_logging/action_dispatch/params_filter.rb +42 -0
- data/lib/surrogate_key_logging/action_dispatch/query_string_filter.rb +56 -0
- data/lib/surrogate_key_logging/action_dispatch/request.rb +5 -3
- data/lib/surrogate_key_logging/action_dispatch.rb +2 -0
- data/lib/surrogate_key_logging/active_record/attributes.rb +1 -5
- data/lib/surrogate_key_logging/engine.rb +0 -6
- data/lib/surrogate_key_logging/version.rb +1 -1
- data/lib/surrogate_key_logging.rb +5 -1
- data/rails_surrogate_key_logging.gemspec +4 -4
- metadata +29 -3
- data/lib/surrogate_key_logging/middleware.rb +0 -17
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 51ed41b166599e90b95c595ecbd87fb3812dbeca4087dec61f4a6d4efc03793f
|
|
4
|
+
data.tar.gz: 5389b994867bac68b6edaeaf90e2af777af74634bfea2d505378bb8f5ec55432
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 799c109ed078447639c5c06f2f6f20ba9d27d5fa1674b61cfc9f8ac96f0d033fe9c01b8472f03676e2852752ae42ca108b2b5b3f13093f22d03d5ae222b1eb4f
|
|
7
|
+
data.tar.gz: 2c06278e7a1744f49bd90e88682b82d69b40f502a5af20b69fb0bc1e264110996806a7a340cdd2ab63c5e1cbbbb9a329ff1483273ff8d46fc2c75cc1c6e4b502
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'active_support/concern'
|
|
4
|
+
|
|
5
|
+
module SurrogateKeyLogging
|
|
6
|
+
module ActionController
|
|
7
|
+
module Params
|
|
8
|
+
extend ActiveSupport::Concern
|
|
9
|
+
|
|
10
|
+
class_methods do
|
|
11
|
+
def surrogate_params(*params, action: '*')
|
|
12
|
+
@surrogate_params ||= ActiveSupport::HashWithIndifferentAccess.new {|h,k| h[k] = [] }
|
|
13
|
+
params.each do |param|
|
|
14
|
+
param = param.to_s
|
|
15
|
+
@surrogate_params[action] << param
|
|
16
|
+
if param.include?('.')
|
|
17
|
+
dots = param.split('.')
|
|
18
|
+
@surrogate_params[action] << [dots.first, dots[1..-1].map{|p| "[#{p}]"}].compact.join('')
|
|
19
|
+
@surrogate_params[action] << URI.encode_www_form_component(@surrogate_params[action].last)
|
|
20
|
+
@surrogate_params[action] << dots.map{|p| "[#{p}]"}.join('')
|
|
21
|
+
@surrogate_params[action] << URI.encode_www_form_component(@surrogate_params[action].last)
|
|
22
|
+
elsif param.include?('[') && param.include?(']')
|
|
23
|
+
@surrogate_params[action] << URI.encode_www_form_component(param)
|
|
24
|
+
else
|
|
25
|
+
@surrogate_params[action] << param
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
@surrogate_params
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SurrogateKeyLogging
|
|
4
|
+
module ActionDispatch
|
|
5
|
+
class ParamsFilter
|
|
6
|
+
|
|
7
|
+
class << self
|
|
8
|
+
def call(params, req = nil)
|
|
9
|
+
new(params, req).filtered
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
attr_reader :params, :req
|
|
14
|
+
|
|
15
|
+
def initialize(params, req = nil)
|
|
16
|
+
@params = params
|
|
17
|
+
@req = req
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def filterable_params
|
|
21
|
+
@filterable_params ||= if req.controller_class.respond_to?(:surrogate_params)
|
|
22
|
+
surrogate_params = req.controller_class.surrogate_params
|
|
23
|
+
surrogate_params[params[:action]] + surrogate_params['*']
|
|
24
|
+
else
|
|
25
|
+
[]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def params_filter
|
|
30
|
+
return @params_filter if @params_filter
|
|
31
|
+
attrs = SurrogateKeyLogging.parameter_filter.instance_variable_get(:@filters).dup
|
|
32
|
+
attrs += filterable_params
|
|
33
|
+
@params_filter = SurrogateKeyLogging.filter_for_attributes(attrs)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def filtered
|
|
37
|
+
@filtered ||= params_filter.filter params
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SurrogateKeyLogging
|
|
4
|
+
module ActionDispatch
|
|
5
|
+
class QueryStringFilter
|
|
6
|
+
|
|
7
|
+
class << self
|
|
8
|
+
def call(qs, req = nil)
|
|
9
|
+
new(qs, req).filtered
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
attr_reader :qs, :req
|
|
14
|
+
|
|
15
|
+
def initialize(qs, req = nil)
|
|
16
|
+
@qs = qs
|
|
17
|
+
@req = req
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def path_params
|
|
21
|
+
@path_params ||= begin
|
|
22
|
+
req.routes.recognize_path_with_request(req, req.path, {})
|
|
23
|
+
rescue
|
|
24
|
+
{}
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def controller_class
|
|
29
|
+
@controller_class = req.controller_class_for(path_params[:controller])
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
def filterable_params
|
|
33
|
+
@filterable_params ||= if controller_class.respond_to?(:surrogate_params)
|
|
34
|
+
surrogate_params = controller_class.surrogate_params
|
|
35
|
+
surrogate_params[path_params[:action]] + surrogate_params['*']
|
|
36
|
+
else
|
|
37
|
+
[]
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def params_filter
|
|
42
|
+
return @params_filter if @params_filter
|
|
43
|
+
attrs = SurrogateKeyLogging.parameter_filter.instance_variable_get(:@filters).dup
|
|
44
|
+
attrs += filterable_params
|
|
45
|
+
@params_filter = SurrogateKeyLogging.filter_for_attributes(attrs)
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def filtered
|
|
49
|
+
@filtered ||= qs.gsub(::ActionDispatch::Request::PAIR_RE) do |_|
|
|
50
|
+
params_filter.filter(::Regexp.last_match(1) => ::Regexp.last_match(2)).first.join('=')
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -4,10 +4,12 @@ module SurrogateKeyLogging
|
|
|
4
4
|
module ActionDispatch
|
|
5
5
|
module Request
|
|
6
6
|
|
|
7
|
+
def filtered_parameters
|
|
8
|
+
@filtered_parameters ||= ParamsFilter.call(super, self)
|
|
9
|
+
end
|
|
10
|
+
|
|
7
11
|
def filtered_query_string
|
|
8
|
-
|
|
9
|
-
SurrogateKeyLogging.filter_parameters(::Regexp.last_match(1) => ::Regexp.last_match(2)).first.join('=')
|
|
10
|
-
end
|
|
12
|
+
QueryStringFilter.call(super, self)
|
|
11
13
|
end
|
|
12
14
|
|
|
13
15
|
end
|
|
@@ -7,13 +7,9 @@ module SurrogateKeyLogging
|
|
|
7
7
|
module Attributes
|
|
8
8
|
extend ActiveSupport::Concern
|
|
9
9
|
|
|
10
|
-
included do
|
|
11
|
-
surrogate_parent_names model_name.singular, model_name.plural
|
|
12
|
-
end
|
|
13
|
-
|
|
14
10
|
class_methods do
|
|
15
11
|
def surrogate_parent_names(*names)
|
|
16
|
-
@surrogate_parent_names ||= []
|
|
12
|
+
@surrogate_parent_names ||= [model_name.singular, model_name.plural]
|
|
17
13
|
names.each do |name|
|
|
18
14
|
@surrogate_parent_names << name.to_sym
|
|
19
15
|
surrogate_attributes.each do |attr|
|
|
@@ -49,7 +49,11 @@ module SurrogateKeyLogging
|
|
|
49
49
|
end
|
|
50
50
|
|
|
51
51
|
def parameter_filter
|
|
52
|
-
@parameter_filter ||=
|
|
52
|
+
@parameter_filter ||= filter_for_attributes(surrogate_attributes)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
def filter_for_attributes(attrs)
|
|
56
|
+
::ActiveSupport::ParameterFilter.new(attrs, mask: key_manager)
|
|
53
57
|
end
|
|
54
58
|
|
|
55
59
|
def key_store
|
|
@@ -27,8 +27,8 @@ Gem::Specification.new do |s|
|
|
|
27
27
|
|
|
28
28
|
s.required_ruby_version = '>= 2.7.0'
|
|
29
29
|
|
|
30
|
-
s.add_dependency('actionpack', '>= 6.0.0')
|
|
31
|
-
s.add_dependency('activerecord', '>= 6.0.0')
|
|
32
|
-
s.add_dependency('activesupport', '>= 6.0.0')
|
|
33
|
-
s.add_dependency('railties', '>= 6.0.0')
|
|
30
|
+
s.add_dependency('actionpack', '>= 6.0.0', '< 7.0.0')
|
|
31
|
+
s.add_dependency('activerecord', '>= 6.0.0', '< 7.0.0')
|
|
32
|
+
s.add_dependency('activesupport', '>= 6.0.0', '< 7.0.0')
|
|
33
|
+
s.add_dependency('railties', '>= 6.0.0', '< 7.0.0')
|
|
34
34
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rails_surrogate_key_logging
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Taylor Yelverton
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-01-
|
|
11
|
+
date: 2023-01-24 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: actionpack
|
|
@@ -17,6 +17,9 @@ dependencies:
|
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
19
|
version: 6.0.0
|
|
20
|
+
- - "<"
|
|
21
|
+
- !ruby/object:Gem::Version
|
|
22
|
+
version: 7.0.0
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -24,6 +27,9 @@ dependencies:
|
|
|
24
27
|
- - ">="
|
|
25
28
|
- !ruby/object:Gem::Version
|
|
26
29
|
version: 6.0.0
|
|
30
|
+
- - "<"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: 7.0.0
|
|
27
33
|
- !ruby/object:Gem::Dependency
|
|
28
34
|
name: activerecord
|
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -31,6 +37,9 @@ dependencies:
|
|
|
31
37
|
- - ">="
|
|
32
38
|
- !ruby/object:Gem::Version
|
|
33
39
|
version: 6.0.0
|
|
40
|
+
- - "<"
|
|
41
|
+
- !ruby/object:Gem::Version
|
|
42
|
+
version: 7.0.0
|
|
34
43
|
type: :runtime
|
|
35
44
|
prerelease: false
|
|
36
45
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -38,6 +47,9 @@ dependencies:
|
|
|
38
47
|
- - ">="
|
|
39
48
|
- !ruby/object:Gem::Version
|
|
40
49
|
version: 6.0.0
|
|
50
|
+
- - "<"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: 7.0.0
|
|
41
53
|
- !ruby/object:Gem::Dependency
|
|
42
54
|
name: activesupport
|
|
43
55
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -45,6 +57,9 @@ dependencies:
|
|
|
45
57
|
- - ">="
|
|
46
58
|
- !ruby/object:Gem::Version
|
|
47
59
|
version: 6.0.0
|
|
60
|
+
- - "<"
|
|
61
|
+
- !ruby/object:Gem::Version
|
|
62
|
+
version: 7.0.0
|
|
48
63
|
type: :runtime
|
|
49
64
|
prerelease: false
|
|
50
65
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -52,6 +67,9 @@ dependencies:
|
|
|
52
67
|
- - ">="
|
|
53
68
|
- !ruby/object:Gem::Version
|
|
54
69
|
version: 6.0.0
|
|
70
|
+
- - "<"
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: 7.0.0
|
|
55
73
|
- !ruby/object:Gem::Dependency
|
|
56
74
|
name: railties
|
|
57
75
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -59,6 +77,9 @@ dependencies:
|
|
|
59
77
|
- - ">="
|
|
60
78
|
- !ruby/object:Gem::Version
|
|
61
79
|
version: 6.0.0
|
|
80
|
+
- - "<"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: 7.0.0
|
|
62
83
|
type: :runtime
|
|
63
84
|
prerelease: false
|
|
64
85
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -66,6 +87,9 @@ dependencies:
|
|
|
66
87
|
- - ">="
|
|
67
88
|
- !ruby/object:Gem::Version
|
|
68
89
|
version: 6.0.0
|
|
90
|
+
- - "<"
|
|
91
|
+
- !ruby/object:Gem::Version
|
|
92
|
+
version: 7.0.0
|
|
69
93
|
description: ''
|
|
70
94
|
email: rubygems@yelvert.io
|
|
71
95
|
executables: []
|
|
@@ -77,7 +101,10 @@ files:
|
|
|
77
101
|
- lib/surrogate_key_logging.rb
|
|
78
102
|
- lib/surrogate_key_logging/action_controller.rb
|
|
79
103
|
- lib/surrogate_key_logging/action_controller/log_subscriber.rb
|
|
104
|
+
- lib/surrogate_key_logging/action_controller/params.rb
|
|
80
105
|
- lib/surrogate_key_logging/action_dispatch.rb
|
|
106
|
+
- lib/surrogate_key_logging/action_dispatch/params_filter.rb
|
|
107
|
+
- lib/surrogate_key_logging/action_dispatch/query_string_filter.rb
|
|
81
108
|
- lib/surrogate_key_logging/action_dispatch/request.rb
|
|
82
109
|
- lib/surrogate_key_logging/active_record.rb
|
|
83
110
|
- lib/surrogate_key_logging/active_record/attributes.rb
|
|
@@ -89,7 +116,6 @@ files:
|
|
|
89
116
|
- lib/surrogate_key_logging/key_store.rb
|
|
90
117
|
- lib/surrogate_key_logging/key_store/active_record.rb
|
|
91
118
|
- lib/surrogate_key_logging/key_store/base.rb
|
|
92
|
-
- lib/surrogate_key_logging/middleware.rb
|
|
93
119
|
- lib/surrogate_key_logging/version.rb
|
|
94
120
|
- lib/tasks/key_store/active_record.rake
|
|
95
121
|
- lib/tasks/surrogate_key_logging.rake
|