flu-rails 1.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ccc91aa5396a70d42d46300b5d7fc48321a3c3d3bea32e77d88b0b4a542e35
-  data.tar.gz: e71784f540b50b412469fb10af164b30942d29190fe2a9e9d7b0725a41b713bd
+  metadata.gz: a35d15acbcbab2206e789f346ef7c97cd92d4cdc9bed53fe6fb0025256fec3b6
+  data.tar.gz: 5114f719bf9565182eada52d5ccd3c3a1e219ad2bc26e41c288ee7ff0ab58573
 SHA512:
-  metadata.gz: e85087d058f0ce9e3cb32c7e7a3dc97471f158b9c973f491a66ccdb33f47f84c78cc78a364a16b3345dd0f036e57a1c686495c57ae2eb60e7decdb153c2a0e9f
-  data.tar.gz: a15ad5ed11e2c3a2a3cade60e643b4b21b5583196d3c52429b2ae09fdec8445f7ab282f013899218add3c95af4b9a655331fe8a24b9565ab408d969cc8e5fffb
+  metadata.gz: a26ad7a3c9274ac803f842b509dcd81eebbc735812347c4473432cbbcb016355c6d7bc7440fe95070f4e53e708d8617849fad2a8c72ffb2443c64445682e2e5f
+  data.tar.gz: 9364931b1ee248a8a43b18089149ba1db00bc4e91fcbd9a7325cae5e7f009493ff9a5ae3b3226d52bf794e17c85d05503811421850a9793f948912a2f5e82b5b

data/CHANGELOG.md

@@ -5,6 +5,40 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [8.0.0] - 2026-07-31
+
+**Fixed**
+
+* Fix tracking a controller request raising `ActionController::UnfilteredParameters`. Controller params
+  reach `EventFactory` as unpermitted `ActionController::Parameters`, on which `to_h` raises
+  (Rails >= 5.1). The unsafe hash is now used, which is what a read-only tracker needs. This broke
+  `track_requests` entirely, and went unnoticed because its specs are disabled (`xit`).
+* Fix `Flu.init` raising `configuration.application_name must not be nil` on a stock Rails application.
+
+**Changed**
+
+* **Breaking**: `flu-rails` now supports Rails 8 exclusively.
+* Drop the pre-Rails-8 compatibility shims that this makes dead code:
+    * `flu_changes_depending_on_active_record_version`
+    * the `Zeitwerk::Loader.eager_load_all` fallback in `Util::ExportService`
+* Restore `activesupport` as a runtime dependency
+* Require the ActiveSupport core extensions that are actually used
+
+**Publishing**
+
+* Add a `Rakefile` (`bundler/gem_tasks` + an `rspec` task), so that `rake release` builds, tags and publishes the gem. `rake` becomes a development dependency.
+* Add `.github/workflows/release.yml`: pushing a `v*` tag checks that the tag matches `Flu::VERSION`,
+  runs the specs, then builds and pushes the gem through RubyGems' Trusted Publishing. No RubyGems
+  API key is stored in the repository — a short-lived GitHub OIDC token is exchanged for a scoped
+  RubyGems credential.
+
+**Verified**
+
+* Verified against Rails 8.1 on a real application: railtie boot, `ActiveRecord` and
+  `ActionController::Base`/`API` tracking through the full Rack stack, request id propagation from a
+  controller into its entity-change events, uploaded file mapping and user-agent rejection — with
+  every framework deprecator set to `:raise`. No deprecation is triggered.
+
 ### [1.2.0] - 2026-07-31
 
 * Declare `required_ruby_version` as `>= 3.2`

data/MIT-LICENSE

@@ -1,20 +1,21 @@
-Copyright 2018 
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2026 Commuty SA
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -16,7 +16,7 @@ For now, events are generated from:
 Add the gem to your project's Gemfile:
 
   ```ruby
-  gem "flu-rails", git: "https://github.com/crepesourcing/flu-rails.git"
+  gem "flu-rails"
   ```
 
 Then, create an initializer into your Rails app (`config/initializers/flu-rails.rb`)
@@ -38,20 +38,16 @@ Each configuration is detailed below.
 ## Requirements
 
 * Ruby >= 3.2 (tested against 3.2, 3.3 and 3.4)
-* Tested with Rails 8 (`activerecord` and `actionpack`)
+* Rails 8 only (`activerecord`, `actionpack` and `activesupport` are runtime dependencies,
+  constrained to `~> 8.0`). `flu-rails` extends `ActiveRecord::Base` and `ActionController::Base`, so it requires Rails.
 * Tested with RabbitMQ 3.5.8
 
 ## Usage
 
 ### Start up
 
-If your application does not include `Railties`, `flu-rails` can be started as followed:
-  ```
-  Flu.init
-  Flu.start
-  ```
-
-`flu-rails` startup waits until its RabbitMQ exchange is connected.
+`flu-rails` starts automatically through its `Railtie`: there is nothing to call by hand.
+Its startup waits until its RabbitMQ exchange is connected.
 
 ### Track changes on an ActiveRecord model
 
@@ -90,7 +86,7 @@ For instance:
 
 ### Track requests to a Rails Controller action
 
-All subclasses of `ActionController::Base` or `ActionController::API` (Rails 5) that call `track_requests` are "tracked". _E.g._:
+All subclasses of `ActionController::Base` or `ActionController::API` that call `track_requests` are "tracked". _E.g._:
 
   ```ruby
   class ApplicationController < ActionController::Base
@@ -167,7 +163,7 @@ All options have a default value. However, all of them can be changed in your in
 | `auto_connect_to_exchange` | `true`| Boolean | Optional | Thanks to `Railties`, `flu-rails` starts automatically when the Rails app boots. However, this can be useful to not connect RabbitMQ at start up. To do so, set `auto_connect_to_exchange` to `false`.  | `false` |
 | `default_ignored_model_changes` | `[:password, :password_confirmation, :created_at, :updated_at]` | Boolean | Optional | By default, all these attributes will be ignored from model changes when creating an event. For instance, this means that timestamp fields (`created_at` and `updated_at`) are not monitored when they change. | `[]` |
 | `default_ignored_request_params` | `[:password, :password_confirmation, :controller, :action]` | Boolean | Optional | By default, all these parameters will be ignored from controller request's `params` when creating an event. | `false` |
-| `application_name` | `Rails.application.class.parent_name.to_s.camelize` | String | Required | Is used as `emitter` for each event created by `flu-rails`, if not overriden by the `track_met`. | `my_app` |
+| `application_name` | `Rails.application.class.module_parent_name`, resolved on startup | String | Required | Is used as `emitter` for each event created by `flu-rails`, if not overriden by the `track_met`. | `my_app` |
 | `bunny_options` | `{}` | Hash of symbols | Optional | Additional options to add when connecting the RabbitMQ broker. This overrides the existing options with the same name. | `{ verify_peer: true }` |
 
 ## How to execute tests
@@ -270,3 +266,23 @@ For instance, calling the action `destroy` of `CountryController` will emit this
 ## Side-notes
 
 * `assocations` node contains `belongs_to` associations only.
+
+
+## How to release a new version
+
+Releases are published to [RubyGems](https://rubygems.org/gems/flu-rails) by GitHub Actions
+(`.github/workflows/release.yml`), through [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/):
+no API key is stored in this repository, the workflow exchanges a short-lived GitHub OIDC token for a
+scoped RubyGems credential.
+
+1. Update `Flu::VERSION` in `lib/flu-rails/version.rb` and the `CHANGELOG.md`
+2. Commit and push these changes to `master`
+3. Tag the commit and push the tag:
+
+```
+  $ git tag -a v8.0.0 -m "Version 8.0.0"
+  $ git push origin v8.0.0
+```
+
+The workflow then checks that the tag matches `Flu::VERSION`, runs the tests, builds the gem
+and pushes it. It only publishes tags starting with `v`.

data/lib/flu-rails/action_controller_extender.rb

@@ -1,3 +1,6 @@
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/time/zones"
+
 module Flu
   class ActionControllerExtender
     def self.extend_controllers(event_factory, event_publisher, logger)

data/lib/flu-rails/active_record_extender.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/object/try"
+
 module Flu
   class ActiveRecordExtender
     def self.extend_models(event_factory, event_publisher)
@@ -8,8 +10,8 @@ module Flu
           self.flu_ignored_model_changes    = options.fetch(:ignored_model_changes, []).map(&:to_s)
           self.flu_overriden_emitter_lambda = options.fetch(:emitter, nil)
         
-          after_create   { flu_track_entity_change(:create, flu_changes_depending_on_active_record_version, event_factory) }
-          after_update   { flu_track_entity_change(:update, flu_changes_depending_on_active_record_version, event_factory) }
+          after_create   { flu_track_entity_change(:create, saved_changes, event_factory) }
+          after_update   { flu_track_entity_change(:update, saved_changes, event_factory) }
           after_destroy  { flu_track_entity_change(:destroy, { "id" => [id, nil] }, event_factory) }
           after_commit   { flu_commit_changes(event_factory, event_publisher) }
           after_rollback { flu_rollback_changes }
@@ -55,10 +57,6 @@ module Flu
           end
         end
 
-        def flu_changes_depending_on_active_record_version
-          respond_to?(:saved_changes) ? saved_changes : changes
-        end
-
         def flu_changes
           @flu_changes ||= []
         end

data/lib/flu-rails/event_factory.rb

@@ -1,4 +1,7 @@
 require "securerandom"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/time/zones"
 require_relative "event"
 
 module Flu
@@ -71,12 +74,17 @@ module Flu
         response_code:   response.status,
         user_agent:      request.user_agent,
         duration:        Time.zone.now - request_start_time,
-        params:          params.except(*ignored_request_params).except(*@default_ignored_request_params).to_h
+        params:          extract_params(params, ignored_request_params)
       }
     end
 
     private
 
+    def extract_params(params, ignored_request_params)
+      remaining = params.except(*ignored_request_params).except(*@default_ignored_request_params)
+      remaining.respond_to?(:to_unsafe_h) ? remaining.to_unsafe_h.to_h : remaining.to_h
+    end
+
     def deep_camelize(value)
       case value
       when Array

data/lib/flu-rails/util.rb

@@ -42,8 +42,7 @@ module Flu
       end
 
       def find_all_entity_types
-        eager_loaded = Rails.application.eager_load!
-        Zeitwerk::Loader.eager_load_all if !eager_loaded && defined?(Zeitwerk)
+        Rails.application.eager_load!
         ActiveRecord::Base.descendants
       end
 

data/lib/flu-rails/version.rb

@@ -1,3 +1,3 @@
 module Flu
-  VERSION = "1.2.0"
+  VERSION = "8.0.0"
 end

data/lib/flu-rails.rb

@@ -1,5 +1,6 @@
 require "logger"
 require "json"
+require "active_support/core_ext/module/introspection"
 require_relative "flu-rails/version"
 require_relative "flu-rails/event"
 require_relative "flu-rails/event_factory"
@@ -33,6 +34,7 @@ module Flu
   end
 
   def self.init
+    @configuration.application_name ||= default_application_name
     raise "configuration.application_name must not be nil" if @configuration.application_name.nil?
     @logger          = @configuration.logger
     @event_factory   = Flu::EventFactory.new(@configuration)
@@ -40,6 +42,15 @@ module Flu
     extend_models_and_controllers
   end
 
+  def self.default_application_name
+    if defined?(Rails) && Rails.respond_to?(:application)
+      application = Rails.application
+      application.nil? ? nil : application.class.module_parent_name
+    else
+      nil
+    end
+  end
+
   def self.create_event_publisher(configuration)
     if is_testing_environment?
       logger.info("Loading Flu with a dummy event publisher (this will not connect any exchange)")
@@ -79,7 +90,7 @@ module Flu
       config.auto_connect_to_exchange       = true
       config.default_ignored_model_changes  = [:password, :password_confirmation, :created_at, :updated_at]
       config.default_ignored_request_params = [:password, :password_confirmation, :controller, :action]
-      config.application_name               = defined?(Rails) ? Rails.application.class.module_parent_name : nil
+      config.application_name               = nil
       config.bunny_options                  = {}
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flu-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Loïc Vigneron
@@ -12,75 +12,89 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: rabbitmq_http_api_client
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :development
+        version: '1.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rabbitmq_http_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Track your application events and publish them to RabbitMQ.
 test_files: []