openpanel-sdk 0.2.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1490e90b00f3ec620cab8d9e1f515f891277b31f6b41e2045b59a0dc84033703
-  data.tar.gz: a2ae3d2835687b58cd1ce7fc9a3d83a0a79a1f5c8d4416ffb89146e2c2036e93
+  metadata.gz: 65ba974f53cd9624e174c3c685817508ea1ba03312328a9df4082bb72df19cd2
+  data.tar.gz: 8538967b530f9a31c800dd592962c3002b26fac7c8b976636a69d3bda08f5c7a
 SHA512:
-  metadata.gz: 1aa139b760d803cb25f62867735f8b14a36ddd71cbb7bf14d4e622886c6e21cb3ef48e180397e88f395a6429a286663dc3df67759a869fbd082ece14899c97d7
-  data.tar.gz: de64238db6154e72328e97abbd32bd24db6be790634fc0ef12b23355609a69c9bbef6bea84064e121e275c8fb119839f037383ba3ebb18ea4acc4a0f4e1f67de
+  metadata.gz: f8603c88e4e62c22976a745fafb22b9ef29fc3ba7e8f2979d4c49bf3ee56003f2e929ff592ebc6b4683fc55aa66100ec17653dbf65b26b6e039a7e70fdbad5c5
+  data.tar.gz: dc30332f7b940f5d49a49ef070ef2c91c7a5fed4836cf5b54b21b0aa81263288a0249f75b71df41f5febd59aad7d520233061f884c6ca5183d7f5024a30d230a

data/README.md

@@ -27,7 +27,7 @@ identify_user = OpenPanel::SDK::IdentifyUser.new
 # ... set user props
 
 tracker.identify identify_user
-tracker.track 'test_event', payload: { name: 'test' }
+tracker.track('test_event', profile_id: profile_id, payload: { name: 'test' })
 tracker.increment_property identify_user, 'test_property', 1
 tracker.decrement_property identify_user, 'test_property', 1
 ```
@@ -53,7 +53,7 @@ end
 then you can use `@openpanel_tracker` in your controllers to track events:
 
 ```ruby
-@openpanel_tracker.track 'test_event', payload: { name: 'test' }
+@openpanel_tracker.track('test_event', profile_id: profile_id, payload: { name: 'test' })
 ```
 
 or to identify users:

data/lib/openpanel/sdk/tracker.rb

@@ -39,16 +39,17 @@ module OpenPanel
       # Track events in OpenPanel
       # https://openpanel.dev/docs/api/track
       # @param event [String] name of event
+      # @param profile_id [String] (optional) user profile ID
       # @param tracking_type [String]
       # @param payload [Hash] event payload
       # @param filter [Lambda] pass in a lambda to filter events. If the lambda returns true, the event won't be tracked.
       # @return [Faraday::Response | nil] The Faraday plain response object or nil, if the event was filtered out
       # @raise [OpenPanel::SDK::OpenPanelError] if the request fails or the event filter is not a method or lambda
-      def track(event, tracking_type: TRACKING_TYPE_TRACK, payload: {}, filter: ->(_payload) { false })
+      def track(event, profile_id: '', tracking_type: TRACKING_TYPE_TRACK, payload: {}, filter: ->(_payload) { false })
         return if filter.call(payload)
 
         payload = global_properties.merge(payload) unless global_properties.empty?
-        payload = { type: tracking_type, payload: { name: event, properties: payload } }
+        payload = { type: tracking_type, payload: { name: event, profileId: profile_id, properties: payload } }
 
         send_request payload: payload
       rescue StandardError => e
@@ -72,7 +73,7 @@ module OpenPanel
       # @param property [String] property to increment
       # @param value [Integer] value to increment by
       def increment_property(user, property = 'visits', value = 1)
-        payload = { profileId: user.profile_id, property: property, value: value }
+        payload = { property: property, value: value, profileId: user.profile_id }
         payload = { type: TRACKING_TYPE_INCREMENT, payload: payload }
 
         send_request payload: payload
@@ -83,7 +84,7 @@ module OpenPanel
       # @param property [String] property to increment
       # @param value [Integer] value to decrement by
       def decrement_property(user, property = 'visits', value = 1)
-        payload = { profileId: user.profile_id, property: property, value: value }
+        payload = { property: property, value: value, profileId: user.profile_id }
         payload = { type: TRACKING_TYPE_DECREMENT, payload: payload }
 
         send_request payload: payload
@@ -94,7 +95,7 @@ module OpenPanel
       # @param amount [Integer] amount of revenue
       # @param properties [Hash] additional properties to track
       def revenue(user:, amount:, properties: {})
-        payload = { name: "revenue", properties: { profileId: user.profile_id, revenue: amount }.merge(properties) }
+        payload = { profileId: user.profile_id, name: 'revenue', properties: { revenue: amount }.merge(properties) }
         payload = { type: TRACKING_TYPE_TRACK, payload: payload }
 
         send_request payload: payload

data/lib/openpanel/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenPanel
   module SDK
-    VERSION = '0.2.9'
+    VERSION = '0.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openpanel-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Thomas Stätter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-05 00:00:00.000000000 Z
+date: 2025-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday