sentry-sanitizer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2531529a81144119d0073bb8cadf32b44b98bf7704e78e5bdb7005db626a57b
-  data.tar.gz: 0cad872dcaff97f50a97739794b9c625bcad81aad616c6fb2f59b568fd3b938c
+  metadata.gz: aa6e89bd5636947019b12574187eb515d000a6d93bd48c3895bf3bf24e7564ca
+  data.tar.gz: 9a69894f2ed6903496162584c1ccb920d0e5a6ab3f75dc333c6c12dead8fc031
 SHA512:
-  metadata.gz: 9ecae6a901360c2a74f81e4d682ce6531bd98bf411aa6a68b84617b85dec1d90bcec41c730a4dfecc2e534afc8676ddeb3247c24b5f33e5dbb6f0e230bbed354
-  data.tar.gz: ec6e59364de9fd75d8a02f879c4449259ecbd4e895f9bcfe35d3be8cde4b5907aab4e9f3af634b5deee2c8137e2fd50c624c7960bf0978005ee30a4f22f38ffb
+  metadata.gz: 54510f582c6e9434700ce3db8735566bd4ef1af3b2fd2caaaeb1cb016503d2a84a22ad39d3637ba34fbb95ad86274508c72badb56a4b458278ef7afbd64f52f2
+  data.tar.gz: fdd38c2cce91b32436522520d318f7c0c7f54f87777c1bcdfc80e77109ff43518807adf560aed42c99a8b4bf4cc2abdcd806a56f6a9328836e6b159da0ae5deb

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    sentry-sanitizer (0.2.0)
+      sentry-ruby (~> 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    sentry-ruby (4.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      faraday (>= 1.0)
+      sentry-ruby-core (= 4.2.0)
+    sentry-ruby-core (4.2.0)
+      concurrent-ruby
+      faraday
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  pry-byebug
+  rack
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sentry-sanitizer!
+
+BUNDLED WITH
+   2.1.4

data/Rakefile

@@ -1,9 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-require "bundler/gem_helper"
-Bundler::GemHelper.install_tasks(name: "sentry-sanitizer")
-
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/sentry/sanitizer/cleaner.rb

@@ -1,60 +1,83 @@
 module Sentry
   module Sanitizer
     class Cleaner
-      HOOK = ->(event, hint) do
-        Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(event)
-
-        event
-      end.freeze
-
       DEFAULT_MASK = '[FILTERED]'.freeze
       DEFAULT_SENSITIVE_HEADERS = %w[
         Authorization
         X-Xsrf-Token
       ].freeze
 
-      private_constant :SENSITIVE_HEADERS
+      private_constant :DEFAULT_SENSITIVE_HEADERS
 
       def initialize(config)
         @fields = config.fields || []
-        @http_headers = config.http_headers || []
-        @cookies = config.cookies || false
+        @http_headers = config.http_headers || false
+        @do_cookies = config.cookies || false
       end
 
       def call(event)
         if event.is_a?(Sentry::Event)
-          event.request = sanitize_request(event.request) if event.request
-          event.extra = sanitize_hash(event.extra) if event.extra
+          sanitize_request(event, :object) if event.request
+          event.extra = sanitize_data(event.extra)
+        elsif event.is_a?(Hash)
+          sanitize_request(event, :stringified_hash) if event['request']
+          sanitize_request(event, :symbolized_hash) if event[:request]
+          event['extra'] = sanitize_data(event['extra']) if event['extra']
+          event[:extra] = sanitize_data(event[:extra]) if event[:extra]
         end
       end
 
-      def sanitize_request(request)
-        request.data = sanitize_hash(request.data) if fields
-        request.headers = sanitize_headers(request.headers) if http_headers
-        request.cookies = sanitize_cookies(request.cookies) if cookies
+      def sanitize_request(event, type)
+        case type
+        when :object
+          event.request.data = sanitize_data(event.request.data)
+          event.request.headers = sanitize_headers(event.request.headers)
+          event.request.cookies = sanitize_cookies(event.request.cookies)
+        when :stringified_hash
+          event['request']['data'] = sanitize_data(event['request']['data'])
+          event['request']['headers'] = sanitize_headers(event['request']['headers'])
+          event['request']['cookies'] = sanitize_cookies(event['request']['cookies'])
+        when :symbolized_hash
+          event[:request][:data] = sanitize_data(event[:request][:data])
+          event[:request][:headers] = sanitize_headers(event[:request][:headers])
+          event[:request][:cookies] = sanitize_cookies(event[:request][:cookies])
+        end
       end
 
-      def sanitize_hash(hash)
-        return if hash.blank?
+      def sanitize_data(hash)
+        return hash unless hash.is_a? Hash
+        return hash unless fields.size.positive?
 
         sanitize_value(hash, nil)
       end
 
       private
 
-      attr_reader :fields, :http_headers, :cookies
+      attr_reader :fields, :http_headers, :do_cookies
 
       # Sanitize specified headers
       def sanitize_headers(headers)
-        headers.keys.select { |key| key.match?(sensitive_headers) }.each do |key|
-          headers[key] = DEFAULT_MASK
-        end
+        case headers
+        when TrueClass
+          headers.transform_values { DEFAULT_MASK }
+        when Hash
+          return headers unless http_headers.size.positive?
 
-        headers
+          headers.keys.select { |key| key.match?(sensitive_headers) }.each do |key|
+            headers[key] = DEFAULT_MASK
+          end
+
+          headers
+        else
+          headers
+        end
       end
 
       # Sanitize all cookies
       def sanitize_cookies(cookies)
+        return cookies unless cookies.is_a? Hash
+        return cookies unless do_cookies
+
         cookies.transform_values { DEFAULT_MASK }
       end
 

data/lib/sentry/sanitizer/configuration.rb

@@ -1,54 +1,24 @@
+require 'sentry/configuration'
 require 'sentry/sanitizer/cleaner'
+require 'sentry/sanitizer/configuration_mixin'
 
 module Sentry
   # Monkey-patching Sentry::Configuration
   class Configuration
-    # Allow adding multiple hooks for this extension
-    def before_send=(value)
-      super
+    # Add sanitizing configuration
+    attr_reader :sanitize
 
-      return value if value == false
+    # Patch before_send method so it could support more than one call
+    prepend Sentry::Sanitizer::ConfigurationMixin
 
-      @before_send_hook_list ||= []
-      @before_send_hook_list << value
-
-      @before_send = ->(event, hint) {
-        @before_send_hook_list.each do |hook|
-          event = hook.call(event, hint)
-        end
-      }
-    end
-
-    def sanitize
+    add_post_initialization_callback do
       @sanitize ||= Sentry::Sanitizer::Configuration.new
-    end
 
-    def sanitize_fields=(fields)
-      unless fields.is_a? Array
-        raise ArgumentError, 'sanitize_fields must be array'
-      end
+      self.before_send = ->(event, hint) do
+        Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(event)
 
-      sanitize.fields = fields
-    end
-
-    def sanitize_http_headers(headers)
-      unless headers.is_a? Array
-        raise ArgumentError, 'sanitize_http_headers must be array'
+        event
       end
-
-      sanitize.http_headers = headers
-    end
-
-    def sanitize_cookies(cookies)
-      unless [TrueClass, FalseClass].include?(cookies.class)
-        raise ArgumentError, 'sanitize_cookies must be boolean'
-      end
-
-      sanitize.cookies = cookies
-    end
-
-    add_post_initialization_callback do
-      self.before_send = Sentry::Sanitizer::Cleaner::HOOK if sanitize.configured?
     end
   end
 
@@ -59,6 +29,30 @@ module Sentry
       def configured?
         [fields, http_headers, cookies].any? { |setting| !setting.nil? }
       end
+
+      def fields=(fields)
+        unless fields.is_a? Array
+          raise ArgumentError, 'sanitize_fields must be array'
+        end
+
+        @fields = fields
+      end
+
+      def http_headers=(headers)
+        unless [Array, TrueClass, FalseClass].include?(headers.class)
+          raise ArgumentError, 'sanitize_http_headers must be array'
+        end
+
+        @http_headers = headers
+      end
+
+      def cookies=(cookies)
+        unless [TrueClass, FalseClass].include?(cookies.class)
+          raise ArgumentError, 'sanitize_cookies must be boolean'
+        end
+
+        @cookies = cookies
+      end
     end
   end
 end

data/lib/sentry/sanitizer/configuration_mixin.rb

@@ -0,0 +1,25 @@
+module Sentry
+  module Sanitizer
+    module ConfigurationMixin
+      # Allow adding multiple hooks for this extension
+      def before_send=(value)
+        unless value == false || value.respond_to?(:call)
+          raise ArgumentError, "before_send must be callable (or false to disable)"
+        end
+
+        return value if value == false
+
+        @before_send_hook_list ||= []
+        @before_send_hook_list << value
+
+        @before_send = ->(event, hint) {
+          @before_send_hook_list.each do |hook|
+            event = hook.call(event, hint)
+          end
+
+          event
+        }
+      end
+    end
+  end
+end

data/lib/sentry/sanitizer/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Sanitizer
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/sentry-sanitizer.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'pry-byebug'
 
   spec.add_runtime_dependency 'sentry-ruby', '~> 4.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Valentine Kiselev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +105,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,6 +115,7 @@ files:
 - lib/sentry/sanitizer.rb
 - lib/sentry/sanitizer/cleaner.rb
 - lib/sentry/sanitizer/configuration.rb
+- lib/sentry/sanitizer/configuration_mixin.rb
 - lib/sentry/sanitizer/version.rb
 - sentry-sanitizer.gemspec
 homepage: https://github.com/mrexox/sentry-sanitizer