blouson 4.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: debaa94dc33912dc0432b49d4f73e3b3753ad5a335d14d7aff5be862790f5aec
-  data.tar.gz: 64ee1c8a595e0101e87c5316554a3b937188fd2d82cb9c5eb66aacf53b394496
+  metadata.gz: adc6299d9334a783b803177c762f1263d3c1d405afac264dc9a411489d8c46ce
+  data.tar.gz: 50f19f86deb3f1c5b2e15d0e857f58505f50c0e5e84ecd855e10b1b018cfcfaf
 SHA512:
-  metadata.gz: 46fed87bbd604f81ec7e5c599efc89681db1d0a25fe7be3d3249d1b1ae6e08cf5cf81fb26429be086caf1221b4e776f7433fea4cc37853704d5a624085a44829
-  data.tar.gz: e87e60345dd41be9c51274f2ac718c77bc9a4b5e88300bad64daaa8fd70b5af6f5ddc21f7d910a9bbcad134834acbe672ed6bf2bca9e50d5cbda016d08fcd564
+  metadata.gz: 0edfa038be2f40514ea2056e3373c7e5203776a44e180bc7df113a4ea4cf7575aff72ca5dd777f6f1dfbde6b85015a2837a62537be1a9b6be1d37d91967bc885
+  data.tar.gz: d00e5fdb01fdcec9e6c46b6d5e079f826b6ae1b20ec2744f12cf5aa79833d933bced087196a4da7ce23f2198d8245ca10396b6f59cf858440b6d8250b155ee82

data/.github/workflows/ci.yml

@@ -11,25 +11,21 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.0'
           - '3.1'
           - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
         gemfile:
-          - rails_7.0
           - rails_7.1
           - rails_7.2
           - rails_8.0
+          - rails_8.1
         exclude:
-          - ruby: '3.0'
-            gemfile: rails_7.2
-          - ruby: '3.0'
-            gemfile: rails_8.0
           - ruby: '3.1'
             gemfile: rails_8.0
-          - ruby: '3.4'
-            gemfile: rails_7.0
+          - ruby: '3.1'
+            gemfile: rails_8.1
     name: Run test with Ruby ${{ matrix.ruby }} and Gemfile ${{ matrix.gemfile }}
     services:
       mysql:
@@ -47,7 +43,7 @@ jobs:
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.gitignore

@@ -8,6 +8,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/.bundle/config
 
 # rspec failure tracking
 .rspec_status

data/Appraisals

@@ -1,8 +1,3 @@
-appraise 'rails-7.0' do
-  gem 'rails', '~> 7.0.0'
-  gem 'concurrent-ruby', '1.3.4'
-end
-
 appraise 'rails-7.1' do
   gem 'rails', '~> 7.1.0'
 end
@@ -15,4 +10,8 @@ appraise 'rails-8.0' do
   gem 'rails', '~> 8.0.0'
 end
 
+appraise 'rails-8.1' do
+  gem 'rails', '~> 8.1.0'
+end
+
 # vim: set ft=ruby:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 6.0.0 (2026-03-31)
+- [Breaking change] Drop `to_hash` in SentryParameterFilter to support sentry-ruby v6. This change also drops support for sentry-ruby <= v5. Please upgrade the gem and update your Sentry initializer if it uses `filter.process(event.to_hash)`.
+- [Breaking change] Remove sentry-raven support
+- Add Ruby 4.0 to CI
+
+# 5.0.0 (2026-01-23)
+- [Breaking change] Drop support for Ruby 3.0
+- [Breaking change] Drop support for Rails 7.0
+- Support Rails 8.1
+- Fix version matching errors; Blouson::SensitiveQueryFilter::AbstractAdapterFilter was not loaded with Rails 8.0
+
 # 4.0.0 (2025-02-04)
 - [Breaking change] Drop support for arproxy v0. Please update >= v1
 - [Breaking change] Drop support for Ruby 2.7

data/README.md

@@ -7,7 +7,7 @@ Blouson is a filter tool for Rails to conceal sensitive data from various logs.
 - HTTP Request parameters in Rails log
 - SQL query in Rails log
 - Exception messages in `ActiveRecord::StatementInvalid`
-- Sentry Raven parameters
+- Sentry parameters
 - Mail parameters in Rails log
 
 ## Installation
@@ -81,28 +81,13 @@ Sentry.init do |config|
   filter = Blouson::SentryParameterFilter.new(filter_pattern, secure_headers)
 
   config.before_send = lambda do |event, _hint|
-    filter.process(event.to_hash)
+    filter.process(event)
   end
 end
 
 ```
 
-### RavenParameterFilterProcessor
-Blouson provides an [Raven-Ruby](https://github.com/getsentry/raven-ruby) processor to conceal sensitive data from query string, request body, request headers and cookie values.
-
-```ruby
-require 'blouson/raven_parameter_filter_processor'
-
-filter_pattern = Rails.application.config.filter_parameters
-secure_headers = %w(secret_token)
-
-Raven.configure do |config|
-  ...
-  config.processors << Blouson::RavenParameterFilterProcessor.create(filter_pattern, secure_headers)
-  ...
-end
-```
-
+**Note:** Since sentry-ruby v6, `event.to_hash` is no longer available. Pass `event` directly to `filter.process` instead of `filter.process(event.to_hash)`.
 
 ### SensitiveMailLogFilter
 ActionMailer outputs email address, all headers, and body text to the log when sending email.

data/blouson.gemspec

@@ -21,13 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 7.0.0'
+  spec.add_dependency 'rails', '>= 7.1.0'
 
   spec.add_development_dependency 'arproxy', '>= 1.0.0'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'sentry-raven'
-  spec.add_development_dependency 'sentry-ruby'
+  spec.add_development_dependency 'sentry-ruby', '>= 6.0'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency "bundler", ">= 1.14"

data/gemfiles/{rails_7.0.gemfile → rails_8.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.0.0"
-gem "concurrent-ruby", "1.3.4"
+gem "rails", "~> 8.1.0"
 
 gemspec path: "../"

data/lib/blouson/engine.rb

@@ -19,9 +19,15 @@ module Blouson
           ActiveRecord::StatementInvalid.class_eval do
             prepend Blouson::SensitiveQueryFilter::StatementInvalidErrorFilter
           end
-          if Rails::VERSION::MAJOR >= 7 && Rails::VERSION::MINOR >= 1 && defined?(Mysql2::Error)
+          if ActiveRecord.gem_version >= Gem::Version.new('7.1') && defined?(Mysql2::Error)
             ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
-              prepend Blouson::SensitiveQueryFilter::AbstractAdapterFilter
+              if ActiveRecord.gem_version >= Gem::Version.new('8.1')
+                prepend Blouson::SensitiveQueryFilter::AbstractAdapterFilter81
+              elsif ActiveRecord.gem_version >= Gem::Version.new('8.0')
+                prepend Blouson::SensitiveQueryFilter::AbstractAdapterFilter80
+              else
+                prepend Blouson::SensitiveQueryFilter::AbstractAdapterFilter71
+              end
             end
           end
         end

data/lib/blouson/sensitive_query_filter.rb

@@ -26,17 +26,7 @@ module Blouson
           end
         end
 
-        if connection_pool
-          # Rails >= 7.1
-          #
-          # - https://github.com/rails/rails/pull/48295
-          super(message, sql: sql, binds: binds, connection_pool: connection_pool)
-        else
-          # Rails >= 6.0
-          #
-          # - https://github.com/rails/rails/pull/34468
-          super(message, sql: sql, binds: binds)
-        end
+        super(message, sql:, binds:, connection_pool:)
       end
 
       def set_query(sql, binds)
@@ -62,13 +52,25 @@ module Blouson
       end
     end
 
-    module AbstractAdapterFilter
+    module AbstractAdapterFilter71
+      # https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L1133
       def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil, async: false, &block)
-        if Rails::VERSION::MAJOR >= 8
-          super(sql, name, binds, type_casted_binds, async: false, &block)
-        else
-          super(sql, name, binds, type_casted_binds, statement_name, async: false, &block)
+        super(sql, name, binds, type_casted_binds, statement_name, async:, &block)
+      rescue ActiveRecord::RecordNotUnique, Mysql2::Error => ex
+        if ex.cause.is_a?(Mysql2::Error)
+          ex.cause.extend(Mysql2Filter)
+        elsif $!.is_a?(Mysql2::Error)
+          $!.extend(Mysql2Filter)
         end
+        raise ex
+      end
+      private :log
+    end
+
+    module AbstractAdapterFilter80
+      # https://github.com/rails/rails/blob/v8.0.0/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L1128
+      def log(sql, name = "SQL", binds = [], type_casted_binds = [], async: false, &block)
+        super(sql, name, binds, type_casted_binds, async:, &block)
       rescue ActiveRecord::RecordNotUnique, Mysql2::Error => ex
         if ex.cause.is_a?(Mysql2::Error)
           ex.cause.extend(Mysql2Filter)
@@ -77,7 +79,21 @@ module Blouson
         end
         raise ex
       end
+      private :log
+    end
 
+    module AbstractAdapterFilter81
+      # https://github.com/rails/rails/blob/v8.1.0/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L1200
+      def log(sql, name = "SQL", binds = [], type_casted_binds = [], async: false, allow_retry: false, &block)
+        super(sql, name, binds, type_casted_binds, async:, allow_retry:, &block)
+      rescue ActiveRecord::RecordNotUnique, Mysql2::Error => ex
+        if ex.cause.is_a?(Mysql2::Error)
+          ex.cause.extend(Mysql2Filter)
+        elsif $!.is_a?(Mysql2::Error)
+          $!.extend(Mysql2Filter)
+        end
+        raise ex
+      end
       private :log
     end
   end

data/lib/blouson/sentry_parameter_filter.rb

@@ -1,13 +1,7 @@
 module Blouson
   class SentryParameterFilter
     def initialize(filters, header_filters = [])
-      # ActionDispatch::Http::ParameterFilter is deprecated and will be removed from Rails 6.1.
-      parameter_filter_klass = if defined?(ActiveSupport::ParameterFilter)
-                                 ActiveSupport::ParameterFilter
-                               else
-                                 ActionDispatch::Http::ParameterFilter
-                               end
-      @parameter_filter = parameter_filter_klass.new(filters)
+      @parameter_filter = ActiveSupport::ParameterFilter.new(filters)
       @header_filters = header_filters.map(&:downcase)
     end
 
@@ -23,53 +17,58 @@ module Blouson
     private
 
     def process_request_body(event)
-      if event[:request] && event[:request][:data].present?
-        data = event[:request][:data]
-        if data.is_a?(String)
-          # Maybe JSON request
-          begin
-            data = JSON.parse(data)
-            event[:request][:data] = JSON.dump(@parameter_filter.filter(data))
-          rescue JSON::ParserError => e
-            # Record parser error to extra field
-            event[:extra]['BlousonError'] = e.message
-          end
-        else
-          event[:request][:data] = @parameter_filter.filter(data)
+      req = event.request
+      return unless req && req.data.present?
+
+      data = req.data
+      if data.is_a?(String)
+        # Maybe JSON request
+        begin
+          data = JSON.parse(data)
+          req.data = JSON.dump(@parameter_filter.filter(data))
+        rescue JSON::ParserError => e
+          # Record parser error to extra field
+          event.extra['BlousonError'] = e.message
         end
+      else
+        req.data = @parameter_filter.filter(data)
       end
     end
 
     def process_query_string(event)
-      if event[:request] && event[:request][:query_string].present?
-        query    = Rack::Utils.parse_query(event[:request][:query_string])
-        filtered = @parameter_filter.filter(query)
+      req = event.request
+      return unless req && req.query_string.present?
 
-        event[:request][:query_string] = Rack::Utils.build_query(filtered)
-      end
+      query    = Rack::Utils.parse_query(req.query_string)
+      filtered = @parameter_filter.filter(query)
+
+      req.query_string = Rack::Utils.build_query(filtered)
     end
 
     def process_request_header(event)
-      if event[:request] && event[:request][:headers]
-        headers = event[:request][:headers]
-        headers.each_key do |k|
-          if @header_filters.include?(k.downcase)
-            headers[k] = 'FILTERED'
-          end
+      req = event.request
+      return unless req && req.headers
+
+      req.headers.each_key do |k|
+        if @header_filters.include?(k.downcase)
+          req.headers[k] = 'FILTERED'
         end
       end
     end
 
     def process_cookie(event)
-      if (cookies = event.dig(:request, :cookies))
-        event[:request][:cookies] = @parameter_filter.filter(cookies)
+      req = event.request
+      return unless req
+
+      if req.cookies
+        req.cookies = @parameter_filter.filter(req.cookies)
       end
 
-      if event[:request] && event[:request][:headers] && event[:request][:headers]['Cookie']
-        cookies  = Hash[event[:request][:headers]['Cookie'].split('; ').map { |pair| pair.split('=', 2) }]
+      if req.headers && req.headers['Cookie']
+        cookies  = Hash[req.headers['Cookie'].split('; ').map { |pair| pair.split('=', 2) }]
         filtered = @parameter_filter.filter(cookies)
 
-        event[:request][:headers]['Cookie'] = filtered.map { |pair| pair.join('=') }.join('; ')
+        req.headers['Cookie'] = filtered.map { |pair| pair.join('=') }.join('; ')
       end
     end
   end

data/lib/blouson/version.rb

@@ -1,3 +1,3 @@
 module Blouson
-  VERSION = "4.0.0"
+  VERSION = "6.0.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: blouson
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Cookpad Inc.
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: arproxy
   requirement: !ruby/object:Gem::Requirement
@@ -65,34 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sentry-raven
-  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
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -168,13 +154,12 @@ files:
 - bin/console
 - bin/setup
 - blouson.gemspec
-- gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - lib/blouson.rb
 - lib/blouson/engine.rb
-- lib/blouson/raven_parameter_filter_processor.rb
 - lib/blouson/sensitive_mail_log_filter.rb
 - lib/blouson/sensitive_params_silencer.rb
 - lib/blouson/sensitive_query_filter.rb
@@ -200,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Filter tools to mask sensitive data in various logs
 test_files: []

data/lib/blouson/raven_parameter_filter_processor.rb

@@ -1,88 +0,0 @@
-module Blouson
-  class RavenParameterFilterProcessor
-    def self.create(filters, header_filters)
-      Class.new(Raven::Processor) do
-        @filters = filters
-        @header_filters = header_filters.map(&:downcase)
-
-        def self.filters
-          @filters
-        end
-
-        def self.header_filters
-          @header_filters
-        end
-
-        def initialize(client = nil)
-          # ActionDispatch::Http::ParameterFilter is deprecated and will be removed from Rails 6.1.
-          parameter_filter_klass = if defined?(ActiveSupport::ParameterFilter)
-              ActiveSupport::ParameterFilter
-            else
-              ActionDispatch::Http::ParameterFilter
-            end
-          @parameter_filter = parameter_filter_klass.new(self.class.filters)
-        end
-
-        def process(value)
-          process_query_string(value)
-          process_request_body(value)
-          process_request_header(value)
-          process_cookie(value)
-        ensure
-          return value
-        end
-
-        def process_request_body(value)
-          if value[:request] && value[:request][:data].present?
-            data = value[:request][:data]
-            if data.is_a?(String)
-              # Maybe JSON request
-              begin
-                data = JSON.parse(data)
-                value[:request][:data] = JSON.dump(@parameter_filter.filter(data))
-              rescue JSON::ParserError => e
-                # Record parser error to extra field
-                value[:extra]['BlousonError'] = e.message
-              end
-            else
-              value[:request][:data] = @parameter_filter.filter(data)
-            end
-          end
-        end
-
-        def process_query_string(value)
-          if value[:request] && value[:request][:query_string].present?
-            query    = Rack::Utils.parse_query(value[:request][:query_string])
-            filtered = @parameter_filter.filter(query)
-
-            value[:request][:query_string] = Rack::Utils.build_query(filtered)
-          end
-        end
-
-        def process_request_header(value)
-          if value[:request] && value[:request][:headers]
-            headers = value[:request][:headers]
-            headers.each_key do |k|
-              if self.class.header_filters.include?(k.downcase)
-                headers[k] = 'FILTERED'
-              end
-            end
-          end
-        end
-
-        def process_cookie(value)
-          if (cookies = value.dig(:request, :cookies))
-            value[:request][:cookies] = @parameter_filter.filter(cookies)
-          end
-
-          if value[:request] && value[:request][:headers] && value[:request][:headers]['Cookie']
-            cookies  = Hash[value[:request][:headers]['Cookie'].split('; ').map { |pair| pair.split('=', 2) }]
-            filtered = @parameter_filter.filter(cookies)
-
-            value[:request][:headers]['Cookie'] = filtered.map { |pair| pair.join('=') }.join('; ')
-          end
-        end
-      end
-    end
-  end
-end