mbuzz 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa7c025330829c88ab9a75a22ca286d14adc1df7872295c5519df4c89536db9
-  data.tar.gz: 62d6675e5ffe9504e2262f84551c286366acc2ad42b6ca6d224367902d9ec3fb
+  metadata.gz: eb41261b9e19c46609f4e7a8867d73b5a902acecc3db3362b4a47e2cacefa9db
+  data.tar.gz: ce644b10fa63055065960bb72a61eb53077d4bbe110eac40ed5bd6918d2487c1
 SHA512:
-  metadata.gz: eb90968b0d4c17bdc7c5019fa0058c257233bc00e1921f0b70a3dbf885fd8aecd1f9d80ab125d31ab535be5e55a44ecc2e0d46e9cb9c51fef4b9305634241b2f
-  data.tar.gz: cef7cbbc7817a6d7c4eca635594ac9e3b9661d81b33cc7d956376cb9fd763a6d216651e6ec499146e31dca042f024216f3c85c08c6d83f4f31dfb1fff64e8b56
+  metadata.gz: 03bed0944d6ee7286e4f002d05032c8ced19d013da1dae69d429046b1ebad510cae67510d48d9af53fac8a8832a1a1495657c6b671a16976fabb5eb8ec316f3d
+  data.tar.gz: 4a0693caaa53219fbf4368c1b194722889c516e88eea6f7bfe781f7a44293659977e6691901f238f45ef66f08f367d674c2f22e6f8a63e22f3326368e6ae8f10

data/README.md

@@ -121,6 +121,63 @@ Mbuzz.user_id     # Current user ID (from session["user_id"])
 Mbuzz.session_id  # Current session ID (from cookie)
 ```
 
+## Background Jobs
+
+When tracking from background jobs (Sidekiq, GoodJob, etc.), there's no HTTP request context. Rails 7+ handles this automatically via `CurrentAttributes`.
+
+### Rails 7+ (Automatic)
+
+mbuzz uses `ActiveSupport::CurrentAttributes` which Rails automatically serializes into ActiveJob payloads:
+
+```ruby
+# In your controller - just enqueue the job
+class OrdersController < ApplicationController
+  def create
+    @order = Order.create!(order_params)
+    ProcessOrderJob.perform_later(@order.id)
+    # visitor_id is automatically captured and passed to the job
+  end
+end
+
+# In your job - mbuzz just works!
+class ProcessOrderJob < ApplicationJob
+  def perform(order_id)
+    order = Order.find(order_id)
+    # Mbuzz::Current.visitor_id was restored by Rails
+    Mbuzz.conversion("purchase", revenue: order.total)
+  end
+end
+```
+
+**How it works:**
+1. Middleware captures `visitor_id` from cookie into `Mbuzz::Current`
+2. Controller enqueues job
+3. Rails serializes `Mbuzz::Current` into job payload
+4. Job runs → Rails restores `Mbuzz::Current`
+5. `Mbuzz.conversion()` reads from `Current` - works!
+
+### Alternative: Explicit visitor_id
+
+For non-Rails apps or when you need more control:
+
+```ruby
+# Store visitor_id on your model
+class Order < ApplicationRecord
+  before_create { self.mbuzz_visitor_id = Mbuzz.visitor_id }
+end
+
+# Pass explicitly in background job
+class ProcessOrderJob
+  def perform(order_id)
+    order = Order.find(order_id)
+    Mbuzz.conversion("purchase",
+      visitor_id: order.mbuzz_visitor_id,  # Explicit
+      revenue: order.total
+    )
+  end
+end
+```
+
 ## Rack / Sinatra Integration
 
 For non-Rails apps, add the middleware manually:

data/lib/mbuzz/current.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mbuzz
+  # CurrentAttributes for automatic background job context propagation.
+  #
+  # Rails automatically serializes CurrentAttributes into ActiveJob payloads
+  # and restores them when jobs execute. This means visitor_id captured during
+  # the original request is available in background jobs without any manual
+  # passing or database storage.
+  #
+  # How it works:
+  #   1. Middleware captures visitor_id from cookie
+  #   2. Stores in Mbuzz::Current.visitor_id
+  #   3. Controller enqueues background job
+  #   4. Rails serializes Current attributes into job payload
+  #   5. Job runs on different thread/process
+  #   6. Rails restores Current.visitor_id before job executes
+  #   7. Mbuzz.event/conversion reads from Current.visitor_id
+  #
+  # This is why customers don't need to store visitor_id in their database.
+  #
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :visitor_id
+    attribute :user_id
+    attribute :ip
+    attribute :user_agent
+  end
+end

data/lib/mbuzz/middleware/tracking.rb

@@ -18,10 +18,14 @@ module Mbuzz
         env[ENV_VISITOR_ID_KEY] = context[:visitor_id]
         env[ENV_USER_ID_KEY] = context[:user_id]
 
+        store_in_current_attributes(context, request)
+
         RequestContext.with_context(request: request) do
           status, headers, body = @app.call(env)
           set_visitor_cookie(headers, context, request)
           [status, headers, body]
+        ensure
+          reset_current_attributes
         end
       end
 
@@ -90,6 +94,29 @@ module Mbuzz
         options[:secure] = true if request.ssl?
         options
       end
+
+      # Store context in CurrentAttributes for background job propagation
+      def store_in_current_attributes(context, request)
+        return unless defined?(Mbuzz::Current)
+
+        Mbuzz::Current.visitor_id = context[:visitor_id]
+        Mbuzz::Current.user_id = context[:user_id]
+        Mbuzz::Current.ip = extract_ip(request)
+        Mbuzz::Current.user_agent = request.user_agent
+      end
+
+      def reset_current_attributes
+        return unless defined?(Mbuzz::Current)
+
+        Mbuzz::Current.reset
+      end
+
+      def extract_ip(request)
+        forwarded = request.env["HTTP_X_FORWARDED_FOR"]
+        return forwarded.split(",").first.strip if forwarded
+
+        request.ip
+      end
     end
   end
 end

data/lib/mbuzz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mbuzz
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/lib/mbuzz.rb

@@ -9,6 +9,9 @@ require_relative "mbuzz/client"
 require_relative "mbuzz/middleware/tracking"
 require_relative "mbuzz/controller_helpers"
 
+# CurrentAttributes for automatic background job context propagation (Rails only)
+require_relative "mbuzz/current" if defined?(ActiveSupport::CurrentAttributes)
+
 require_relative "mbuzz/railtie" if defined?(Rails::Railtie)
 
 module Mbuzz
@@ -62,18 +65,25 @@ module Mbuzz
   # Context Accessors
   # ============================================================================
 
+  # Returns visitor_id from Current (background jobs) or request context
   def self.visitor_id
-    RequestContext.current&.request&.env&.dig(ENV_VISITOR_ID_KEY) || fallback_visitor_id
+    current_visitor_id || RequestContext.current&.request&.env&.dig(ENV_VISITOR_ID_KEY)
   end
 
-  def self.fallback_visitor_id
-    @fallback_visitor_id ||= Visitor::Identifier.generate
+  def self.user_id
+    current_user_id || RequestContext.current&.request&.env&.dig(ENV_USER_ID_KEY)
   end
-  private_class_method :fallback_visitor_id
 
-  def self.user_id
-    RequestContext.current&.request&.env&.dig(ENV_USER_ID_KEY)
+  # Check Current attributes (for background job support)
+  def self.current_visitor_id
+    defined?(Current) ? Current.visitor_id : nil
+  end
+  private_class_method :current_visitor_id
+
+  def self.current_user_id
+    defined?(Current) ? Current.user_id : nil
   end
+  private_class_method :current_user_id
 
   # ============================================================================
   # 4-Call Model API
@@ -82,20 +92,30 @@ module Mbuzz
   # Track an event (journey step)
   #
   # @param event_type [String] The name of the event
+  # @param visitor_id [String, nil] Explicit visitor ID (required for background jobs)
   # @param properties [Hash] Custom event properties (url, referrer auto-added)
   # @param identifier [Hash, nil] Optional identifier for cross-device identity resolution
   # @return [Hash, false] Result hash on success, false on failure
   #
-  # @example
+  # @example Normal usage (within request context)
   #   Mbuzz.event("add_to_cart", product_id: "SKU-123", price: 49.99)
   #
+  # @example Background job (must pass explicit visitor_id)
+  #   Mbuzz.event("order_processed", visitor_id: order.mbuzz_visitor_id, order_id: order.id)
+  #
   # @example With identifier for cross-device tracking
   #   Mbuzz.event("page_view", identifier: { email: "user@example.com" })
   #
-  def self.event(event_type, identifier: nil, **properties)
+  def self.event(event_type, visitor_id: nil, identifier: nil, **properties)
+    resolved_visitor_id = visitor_id || self.visitor_id
+    resolved_user_id = user_id
+
+    # Must have at least one identifier
+    return false unless resolved_visitor_id || resolved_user_id
+
     Client.track(
-      visitor_id: visitor_id,
-      user_id: user_id,
+      visitor_id: resolved_visitor_id,
+      user_id: resolved_user_id,
       event_type: event_type,
       properties: enriched_properties(properties),
       ip: current_ip,
@@ -113,6 +133,7 @@ module Mbuzz
   # Track a conversion (revenue-generating outcome)
   #
   # @param conversion_type [String] The type of conversion
+  # @param visitor_id [String, nil] Explicit visitor ID (required for background jobs)
   # @param revenue [Numeric, nil] Revenue amount
   # @param user_id [String, nil] User ID for acquisition-linked conversions
   # @param is_acquisition [Boolean] Mark this as the acquisition conversion for this user
@@ -121,9 +142,12 @@ module Mbuzz
   # @param properties [Hash] Custom properties
   # @return [Hash, false] Result hash on success, false on failure
   #
-  # @example Basic conversion
+  # @example Basic conversion (within request context)
   #   Mbuzz.conversion("purchase", revenue: 99.99, order_id: "ORD-123")
   #
+  # @example Background job (must pass explicit visitor_id)
+  #   Mbuzz.conversion("purchase", visitor_id: order.mbuzz_visitor_id, revenue: 99.99)
+  #
   # @example Acquisition conversion (marks signup as THE acquisition moment)
   #   Mbuzz.conversion("signup", user_id: "user_123", is_acquisition: true)
   #
@@ -133,9 +157,14 @@ module Mbuzz
   # @example With identifier for cross-device tracking
   #   Mbuzz.conversion("purchase", identifier: { email: "user@example.com" })
   #
-  def self.conversion(conversion_type, revenue: nil, user_id: nil, is_acquisition: false, inherit_acquisition: false, identifier: nil, **properties)
+  def self.conversion(conversion_type, visitor_id: nil, revenue: nil, user_id: nil, is_acquisition: false, inherit_acquisition: false, identifier: nil, **properties)
+    resolved_visitor_id = visitor_id || self.visitor_id
+
+    # Must have at least one identifier (visitor_id or user_id)
+    return false unless resolved_visitor_id || user_id
+
     Client.conversion(
-      visitor_id: visitor_id,
+      visitor_id: resolved_visitor_id,
       user_id: user_id,
       conversion_type: conversion_type,
       revenue: revenue,
@@ -181,12 +210,26 @@ module Mbuzz
   private_class_method :enriched_properties
 
   def self.current_ip
-    RequestContext.current&.ip
+    current_attributes_ip || RequestContext.current&.ip
   end
   private_class_method :current_ip
 
   def self.current_user_agent
-    RequestContext.current&.user_agent
+    current_attributes_user_agent || RequestContext.current&.user_agent
   end
   private_class_method :current_user_agent
+
+  def self.current_attributes_ip
+    return nil unless defined?(Current)
+
+    Current.ip
+  end
+  private_class_method :current_attributes_ip
+
+  def self.current_attributes_user_agent
+    return nil unless defined?(Current)
+
+    Current.user_agent
+  end
+  private_class_method :current_attributes_user_agent
 end

data/lib/specs/v0.7.0_deterministic_sessions.md

@@ -1,6 +1,13 @@
 # mbuzz SDK v0.7.0 - Deterministic Session IDs
 
-**Status**: Proposed
+> **⚠️ SUPERSEDED**: This spec has been replaced by server-side session resolution.
+> See: `multibuzz/lib/specs/1_visitor_session_tracking_spec.md`
+>
+> **What changed**: Instead of SDKs generating deterministic session IDs using time-buckets,
+> the server now handles all session resolution using IP + User-Agent fingerprinting with
+> a true 30-minute sliding window. SDKs no longer manage session cookies.
+
+**Status**: SUPERSEDED (2026-01-09)
 **Last Updated**: 2025-12-29
 **Breaking Change**: No (backward compatible)
 **Affects**: All SDKs (Ruby, Python, PHP, Node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbuzz
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - mbuzz team
@@ -47,6 +47,7 @@ files:
 - lib/mbuzz/client/track_request.rb
 - lib/mbuzz/configuration.rb
 - lib/mbuzz/controller_helpers.rb
+- lib/mbuzz/current.rb
 - lib/mbuzz/middleware/tracking.rb
 - lib/mbuzz/railtie.rb
 - lib/mbuzz/request_context.rb