sinaliza 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc89fcab6f596adbd552ed8b28da09bba68fc38afc1d784855ebe95361b077ce
-  data.tar.gz: eb6b974f6c9701a96b8aca56364e562ace77804aa939c87e5ca808a26efbe7e9
+  metadata.gz: d645f68aef485dbc199b994b47c4f3434e89cb9101615d4b2806d0203033a340
+  data.tar.gz: 428eed5415abc8bf3f7866e6e4903162e417c0b6eceee8e7a4e233bc7374fdaa
 SHA512:
-  metadata.gz: 1d60d7c5c5d669fb061882336df233956bea2fed3517e6a9e95756f27e0e70103e3601f743e27b3e41f85c9b281b6ee26d5ca2ee6fb9482bf52a4a2c278d9f39
-  data.tar.gz: 7b40ff04f632e503bc099a8cb68c9e75dbdde24680085fa65d882cc2767e7d6426ab8ec07dfec667fa3b65e03f28314a3df0c69ebde6a0cdd4b0fb79e24c3d50
+  metadata.gz: d03113b99053374a9b758acc715ed5f370aa7a3bef568d782c5abfaf7b109b7255d3f0586c26fd74d436635bb74132d03d3d9fa525897e739bce8a0be0b5acc5
+  data.tar.gz: 5ff4559f655c0e3182f0d7ad4170326bae7cae2b8736f70318bd84f8331dacbf8bdda8616743d2c632ebc0c2c734d203e2a89997c5104bbea151b66d22338938

data/README.md

@@ -154,6 +154,61 @@ Events are recorded with `source: "controller"`. Request context (IP address, us
 
 The actor is resolved by calling the method defined in `Sinaliza.configuration.actor_method` (default: `current_user`).
 
+### Interceptors
+
+Interceptors let you automatically record events whenever a specific method is called — without modifying the original code. They are stored in the database and can be managed at runtime through the dashboard or programmatically.
+
+```ruby
+# Create an interceptor that tracks every call to User#send_welcome_email
+Sinaliza::Interceptor.create!(
+  target_class: "User",
+  method_name: "send_welcome_email",
+  method_type: "instance",
+  event_name: "user.welcome_email_sent"
+)
+
+# Track a class method
+Sinaliza::Interceptor.create!(
+  target_class: "Report",
+  method_name: "generate_monthly",
+  method_type: "class",
+  event_name: "report.monthly_generated"
+)
+```
+
+Each interceptor can optionally capture:
+
+| Option                   | Description                              | Default |
+|--------------------------|------------------------------------------|---------|
+| `capture_args`           | Log method arguments in metadata         | `false` |
+| `capture_return`         | Log the return value in metadata         | `false` |
+| `capture_execution_time` | Log execution time (ms) in metadata      | `false` |
+
+```ruby
+# Interceptor with full instrumentation
+Sinaliza::Interceptor.create!(
+  target_class: "PaymentGateway",
+  method_name: "charge",
+  method_type: "instance",
+  event_name: "payment.charged",
+  capture_args: true,
+  capture_return: true,
+  capture_execution_time: true
+)
+```
+
+Interceptors can be toggled on and off without removing them:
+
+```ruby
+interceptor = Sinaliza::Interceptor.find_by(event_name: "user.welcome_email_sent")
+interceptor.deactivate!  # stops recording events
+interceptor.activate!    # resumes recording events
+```
+
+Events recorded by interceptors have `source: "interceptor"`.
+
+The dashboard includes an **Interceptors** section where you can create, edit, toggle, and delete interceptors through a web interface.
+
 ### Query scopes
 
 ```ruby
@@ -188,15 +243,31 @@ The engine mounts a monitor dashboard at your chosen path. It provides:
 
 ### Protecting the dashboard
 
-The gem does not include authentication. Protect access via route constraints in your host app:
+The gem does not include authentication. Protect access via route constraints in your host app.
+
+**With Devise:**
 
 ```ruby
 # config/routes.rb
 authenticate :user, ->(u) { u.admin? } do
   mount Sinaliza::Engine => "/sinaliza"
 end
+```
+
+**Without Devise:**
+
+```ruby
+# app/constraints/admin_constraint.rb
+class AdminConstraint
+  def matches?(request)
+    user_id = request.session[:user_id]
+    return false unless user_id
+
+    User.find_by(id: user_id)&.admin?
+  end
+end
 
-# or with a simple constraint
+# config/routes.rb
 mount Sinaliza::Engine => "/sinaliza", constraints: AdminConstraint.new
 ```