mbuzz 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03aa54a68ab1b6e6313d69c910c88aec7241e19d65b72b9cee37a6e187454692
-  data.tar.gz: 3ddce95a2f8795635278785f403daf6a41e15bc31fc01c3990989c20911ebc21
+  metadata.gz: 71d8b00de3facb7fd1290c03f1493edf09586333ad6ea44e1de03ebba375805f
+  data.tar.gz: 69eac0945b4b2630038753770fd398154cc1d407e15e9e8ff0d1770fb53bf95d
 SHA512:
-  metadata.gz: 4ba8606ecbeec460a9145937b8d123c93c455476d92795e9ddf2b291082e57cdce4818cd709a427ed28d125e0ee6766110f0425039c43bfba75328f5da6f756f
-  data.tar.gz: 8d9233587278aaccb19fd5f124e486e1385b626b2eb4db3d7125ab0e64d6b1500117a33fe89e1fad84c846e6a292e6183760013ecb33e16d44082036d2c5a299
+  metadata.gz: 5f0a99184a1860342c7088c1642495d11db115ecbd7571bfffd6f29ea8fc770d6d0ea3d473f1ae7a6681eadb19d8b387ce86968df369d5e785301a1f157b2ad3
+  data.tar.gz: 3ba3d4419fa579e5840a46e398202637f4d7f5b119fbc2815b1cac5db1504f4d0f69a5d68481ad1075bb875d42e0121aa9f06696bf9cc9a254accb9c7a1a0aab

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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).
 
+## [0.10.1] - 2026-09-17
+
+### Fixed — the visitor's IP now reaches mbuzz on session create
+
+- **`POST /api/v1/sessions` now carries `ip`.** The middleware already extracted the visitor's
+  address — it is half of `device_fingerprint = SHA256(ip|user_agent)` — and then dropped it at
+  three points on the way out: `Client.session` had no `ip:` keyword, `SessionRequest#payload`
+  omitted it, and `Middleware::Tracking`'s own call site omitted it too. Events and conversions have
+  always sent one; only sessions did not.
+- **Why it matters.** mbuzz sends Meta's Conversions API `client_ip_address`, which Meta documents
+  as **required** for website events, and a session with no address means the events resolved
+  through it carry none either. Upgrading improves Event Match Quality for anyone using conversion
+  feedback; it changes nothing else.
+- **No API change.** `ip:` is an optional keyword on `Client.session` and both middlewares fill it
+  automatically. Existing callers need no edit.
+
+Found by the SDK integration harness rather than by unit tests: every layer was correct on its own,
+and only a real request through a real app could tell the visitor's address from the app server's.
+
 ## [0.10.0] - 2026-09-08
 
 ### BREAKING — the page snippet is now required

data/lib/mbuzz/client/session_request.rb

@@ -12,7 +12,8 @@ module Mbuzz
       # Response values
       ACCEPTED_STATUS = "accepted"
 
-      def initialize(visitor_id:, session_id:, url:, referrer: nil, device_fingerprint: nil, user_agent: nil, started_at: nil)
+      def initialize(visitor_id:, session_id:, url:, referrer: nil, device_fingerprint: nil,
+                     user_agent: nil, started_at: nil, ip: nil)
         @visitor_id = visitor_id
         @session_id = session_id
         @url = url
@@ -20,6 +21,7 @@ module Mbuzz
         @device_fingerprint = device_fingerprint
         @user_agent = user_agent
         @started_at = started_at
+        @ip = ip
       end
 
       def call
@@ -32,7 +34,8 @@ module Mbuzz
 
       private
 
-      attr_reader :visitor_id, :session_id, :url, :referrer, :device_fingerprint, :user_agent, :started_at
+      attr_reader :visitor_id, :session_id, :url, :referrer, :device_fingerprint, :user_agent,
+        :started_at, :ip
 
       def valid?
         present?(visitor_id) && present?(session_id) && present?(url)
@@ -42,6 +45,11 @@ module Mbuzz
         @response ||= Api.post_with_response(SESSIONS_PATH, { session: payload })
       end
 
+      # `ip` is the visitor's address, which the middleware already extracted to
+      # compute `device_fingerprint` (SHA256(ip|user_agent)). It was computed
+      # and then dropped here until 2026-09-17: mbuzz needs it for Meta's
+      # `client_ip_address`, which Meta documents as required for website
+      # events, and the events/conversions payloads have always carried it.
       def payload
         {
           visitor_id: visitor_id,
@@ -50,6 +58,7 @@ module Mbuzz
           referrer: referrer,
           device_fingerprint: device_fingerprint,
           user_agent: user_agent,
+          ip: ip,
           started_at: started_at || Time.now.utc.iso8601
         }.compact
       end

data/lib/mbuzz/client.rb

@@ -32,7 +32,8 @@ module Mbuzz
       ).call
     end
 
-    def self.session(visitor_id:, session_id:, url:, referrer: nil, device_fingerprint: nil, user_agent: nil, started_at: nil)
+    def self.session(visitor_id:, session_id:, url:, referrer: nil, device_fingerprint: nil,
+                     user_agent: nil, started_at: nil, ip: nil)
       SessionRequest.new(
         visitor_id: visitor_id,
         session_id: session_id,
@@ -40,7 +41,8 @@ module Mbuzz
         referrer: referrer,
         device_fingerprint: device_fingerprint,
         user_agent: user_agent,
-        started_at: started_at
+        started_at: started_at,
+        ip: ip
       ).call
     end
   end

data/lib/mbuzz/middleware/session_endpoint.rb

@@ -93,7 +93,8 @@ module Mbuzz
             url: context[:url],
             referrer: context[:referrer],
             device_fingerprint: context[:device_fingerprint],
-            user_agent: context[:user_agent]
+            user_agent: context[:user_agent],
+            ip: context[:ip]
           )
         rescue StandardError => e
           log_error("Session creation failed: #{e.message}") if Mbuzz.config.debug

data/lib/mbuzz/middleware/tracking.rb

@@ -133,7 +133,8 @@ module Mbuzz
           url: context[:url],
           referrer: context[:referrer],
           device_fingerprint: context[:device_fingerprint],
-          user_agent: context[:user_agent]
+          user_agent: context[:user_agent],
+          ip: context[:ip]
         )
       end
 

data/lib/mbuzz/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbuzz
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - mbuzz team