shopcircle-orbit 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3113ae248462ed96c7df563092cd89e421a4517c0ed6420c2abd5ab18ac9c34
-  data.tar.gz: f07313a22f1ab5c037f135b42576ee08db436c1e47c72fb4c35e96f33fed276b
+  metadata.gz: d9d216746a4630244fb0e572da6096aa4e0755e8dd51149b633d6f052b3e4b1c
+  data.tar.gz: d81da736f6c0964d9b30ee64d35c1408577686bb01ca2c0226f4f26ff6d99503
 SHA512:
-  metadata.gz: 6227c6ba47b0bd858fae94ce5a745b41e4b0277defe81cfd5c4b789401cc9e2316f1b9343051ec8fe0a5d88a7f588bcee91f80f7ced013260a4688c55fc6e002
-  data.tar.gz: 828d277ae8d56cf8742dd9648223dea7153917454175ddd07dae3465f3c24ac4f3e7a64222afe948db5d524a509ef012a11a9a83d9ec0697df05a190f58c4bb1
+  metadata.gz: 927f107a154501f0db7616e3bdda426826e808142240ff42c344b4f0d574259d8c05d8b21f935c48d610b8dc475b2c97617620e0164eeee0930411132ae62ff4
+  data.tar.gz: cab6c08b1f6f39018c9139f4517e6630036c61d595a8a1c08a97fedace37e28d072c4601744a69da3ca4c4d90197eb25dc017cdd377e836f7ec0591c7b7d21a7

data/README.md

@@ -162,11 +162,25 @@ class OrderTest < ActiveSupport::TestCase
 end
 ```
 
-## Rails Middleware
+## Page / screen views
 
-The SDK automatically inserts Rack middleware that tracks `page_view` events for HTML GET requests. Asset paths, XHR, and JSON requests are excluded.
+Page views are the `screen_view` event — that's what the dashboard counts under Pages, pageviews and bounce rate. There are three ways to capture them:
 
-To disable:
+1. **Auto (Rails middleware).** The SDK automatically inserts Rack middleware that tracks `screen_view` for full HTML GET requests (server-rendered navigations). Asset paths, XHR/AJAX and JSON requests are excluded.
+
+2. **AJAX / Turbo / Hotwire / SPA frontends.** These route changes happen in the browser and never reach Rails, so the middleware can't see them. Track those with the browser JS SDK — it hooks the History API and emits `screen_view` on every route change:
+
+   ```js
+   new ShopCircleOrbit({ clientId: "YOUR_CLIENT_ID", trackScreenViews: true })
+   ```
+
+3. **Manual (server-side).** To record a screen view yourself (a rendered view, a non-GET flow, or a path the middleware skips), emit the canonical event:
+
+   ```ruby
+   ShopCircle::Orbit.track("screen_view", path: "/pricing")
+   ```
+
+To disable the auto middleware:
 
 ```ruby
 # config/application.rb

data/lib/shopcircle/orbit/rails/middleware.rb

@@ -3,8 +3,13 @@
 module ShopCircle
   module Orbit
     module Rails
-      # Rack middleware that auto-tracks page_view events for HTML page requests.
-      # Skips assets, XHR, and non-GET requests.
+      # Rack middleware that auto-tracks screen_view events for full HTML page
+      # requests (server-rendered navigations). Skips assets, XHR/AJAX, and non-GET
+      # requests — client-side SPA/AJAX/Turbo route changes are not visible to the
+      # server, so track those with the browser JS SDK (trackScreenViews) instead.
+      #
+      # Emits "screen_view" (the platform's canonical page/screen-view event) so it
+      # is counted in Pages, pageviews, bounce rate and journeys.
       #
       # Opt out by removing from the middleware stack:
       #
@@ -33,7 +38,7 @@ module ShopCircle
                 props[:ip] = request.ip
                 props[:referrer] = request.referrer
               end
-              ShopCircle::Orbit.track("page_view", props)
+              ShopCircle::Orbit.track("screen_view", props)
             end
           rescue StandardError => e
             ShopCircle::Orbit.configuration.resolved_logger.warn("[shopcircle-orbit] Tracking error: #{e.message}")

data/lib/shopcircle/orbit/version.rb

@@ -2,6 +2,6 @@
 
 module ShopCircle
   module Orbit
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopcircle-orbit
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - ShopCircle