gruf 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: defce64f3e996f49960608b16a3fe150b05b35d1
-  data.tar.gz: 55d6938b28ee5b33da930464b1ae63435c3b464e
+  metadata.gz: 6c3c699dd26122a8e6fb4d74ea2c86b3c4d52900
+  data.tar.gz: 41f9f4833353086c36421a155dd66076416d9e00
 SHA512:
-  metadata.gz: 7dbc5c72f2176307f162f9236d21895a280ecb1179254ff5e962884defe4eb3cacf44ebb7cd0972f050f4e06d6eba86e80a6742440341e0b6c86873a1e1b4a7a
-  data.tar.gz: 4de77df215be0635943e407e78a984ede342e825c2ba31c28a6f0adc660a7f5a8919473c95a69c4dc1b7d11baebcd52b7742a5174899113dbca3d7f80fd261ef
+  metadata.gz: ce500f6213a21560ff8a7dc0b2e8f8e5b64d0f93ebf29b5474c9ad1ba557994504d6fc67100eef18f1feac0a4aa422e7a7ba795bf25d49f88be05af175bbc019
+  data.tar.gz: 548b0fff743db41630cc4aae899a1886a5be5a591bac0f8a4170a35205cead1db0ff9daef2c2c944b907a4c535071b5a4c9f08ff49cf43080bdc72fd8411dd19

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 1.2.3
+
+- Support nested blacklist parameters in path.to.key format
+
 ### 1.2.2
 
 - Pin Google Protobuf to 3.3.x due to failures in protobuf in Ruby at 3.4.x

data/README.md

@@ -320,7 +320,7 @@ It comes with a few more options as well:
 | ------ | ----------- | ------- |
 | formatter | The formatter to use. By default `:plain` and `:logstash` are supported. | `:plain` |
 | log_parameters | If set to true, will log parameters in the response | `false` |
-| blacklist | An array of parameter key names to redact from logging | `[]` |
+| blacklist | An array of parameter key names to redact from logging, in path.to.key format | `[]` |
 | redacted_string | The string to use for redacted parameters. | `REDACTED` |
 
 It's important to maintain a safe blacklist should you decide to log parameters; gruf does no 

data/lib/gruf/instrumentation/request_logging/hook.rb

@@ -124,11 +124,13 @@ module Gruf
         # @return [Hash] The sanitized params in hash form
         #
         def sanitize(params = {})
-          blacklist = options.fetch(:blacklist, []).map(&:to_s)
+          blacklists = options.fetch(:blacklist, []).map(&:to_s)
           redacted_string = options.fetch(:redacted_string, 'REDACTED')
-          params.each do |param, _value|
-            params[param] = redacted_string if blacklist.include?(param.to_s)
+          blacklists.each do |blacklist|
+            parts = blacklist.split('.').map(&:to_sym)
+            redact!(parts, 0, params, redacted_string)
           end
+          params
         end
 
         ##
@@ -139,6 +141,45 @@ module Gruf
         def options
           super().fetch(:request_logging, {})
         end
+
+        ##
+        # Helper method to recursively redact based on the black list
+        #
+        # @param [Array] The blacklist. ex. 'data.schema' -> [:data, :schema]
+        # @param [Integer] The current index of the blacklist
+        # @param [Hash] The hash of parameters to sanitize
+        # @param [String] The custom redact string
+        # @return [Nil]
+        #
+        def redact!(parts, i, params, redacted_string)
+          return if i >= parts.size || !params.key?(parts[i])
+          if i == parts.size - 1
+            if params[parts[i]].is_a? Hash
+              hash_deep_redact!(params[parts[i]], redacted_string)
+            else
+              params[parts[i]] = redacted_string
+            end
+            return
+          end
+          redact!(parts, i + 1, params[parts[i]], redacted_string)
+        end
+
+        ##
+        # Helper method to recursively redact the value of all hash keys
+        #
+        # @param [Hash] Part of the hash of parameters to sanitize
+        # @param [String] The custom redact string
+        # @return [Nil]
+        #
+        def hash_deep_redact!(hash, redacted_string)
+          hash.keys.each do |key|
+            if hash[key].is_a? Hash
+              hash_deep_redact!(hash[key], redacted_string)
+            else
+              hash[key] = redacted_string
+            end
+          end
+        end
       end
     end
   end

data/lib/gruf/version.rb

@@ -15,5 +15,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler