openpanel-sdk 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d0c70749e9b13369c48b6fce17861da507dfb98213a9c5caa9a408d7398ef9
-  data.tar.gz: a853ae76dae3f2b801c6841d8a949e558feeb2c5d0df391a92c80a0802f2b760
+  metadata.gz: 2ed28b122a54f1cb96f072f3fb05a3a585839e4a9552fff33fac915535c85e24
+  data.tar.gz: 124097e8b635c96795e7a37c4e6f6b7cff1307e876335f6e1b1b636a7b37948a
 SHA512:
-  metadata.gz: 5e86fcb48012bbefe587e9f5170bdd7d3509f6d84bf90dc2214a1a54b5975c7e0e9be7dc2527091ab8d29386b8f83acb75a23291b53ff40cbd1652527ccce2b6
-  data.tar.gz: 6418589ef60bf5716f5054db667a0af6fcc29dff087c9a86ae99da3a5ca997aa182bea4e5e428b1e34e39709eb7745d54aadbbfca2d3ac5199f1bd4d76614983
+  metadata.gz: 522d0719dc0b69c3a311379842a775d77070d92363178bacc4e21dba44f76d3560bf9e554ee3b95d0fe6fac9a1655553e3daa24214720bd2dd95a1e7a2beab10
+  data.tar.gz: fe6633f06c03c4363d315a839e048d4b8028de43e6eebbaf72f1bfa30a067e75ed3a6083b64b7df5bca022173ed84dfdbc00e981fe950533ea2d89e861c8fbe7

data/README.md

@@ -103,7 +103,7 @@ response = tracker.track('test_event', payload: { name: 'test' }, filter: filter
 Revenue tracking is done easily:
 
 ```ruby
-response = tracker.revenue user, 100, { currency: 'EUR' }
+response = tracker.revenue user: user, amount: 100, properties: { currency: 'EUR' }
 # Faraday::Response
 ```
 

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
@@ -60,9 +61,9 @@ module OpenPanel
       # @param user [OpenPanel::SDK::IdentifyUser] user to identify
       def identify(user)
         properties = user.properties.merge(global_properties) unless global_properties.empty?
-        payload = { profileId: user.profile_id, firstName: user.first_name, lastName: user.last_name,
+        payload = { firstName: user.first_name, lastName: user.last_name,
                     email: user.email, properties: properties }
-        payload = { type: TRACKING_TYPE_IDENTIFY, payload: payload }
+        payload = { type: TRACKING_TYPE_IDENTIFY, profileId: user.profile_id, payload: payload }
 
         send_request payload: payload
       end
@@ -72,8 +73,8 @@ 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 = { type: TRACKING_TYPE_INCREMENT, payload: payload }
+        payload = { property: property, value: value }
+        payload = { type: TRACKING_TYPE_INCREMENT, profileId: user.profile_id, payload: payload }
 
         send_request payload: payload
       end
@@ -83,8 +84,8 @@ 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 = { type: TRACKING_TYPE_DECREMENT, payload: payload }
+        payload = { property: property, value: value }
+        payload = { type: TRACKING_TYPE_DECREMENT, profileId: user.profile_id, payload: payload }
 
         send_request payload: payload
       end
@@ -93,9 +94,9 @@ module OpenPanel
       # @param user [OpenPanel::SDK::IdentifyUser] user to identify
       # @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 = { type: TRACKING_TYPE_TRACK, payload: payload }
+      def revenue(user:, amount:, properties: {})
+        payload = { name: 'revenue', properties: { revenue: amount }.merge(properties) }
+        payload = { type: TRACKING_TYPE_TRACK, profileId: user.profile_id, payload: payload }
 
         send_request payload: payload
       end

data/lib/openpanel/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenPanel
   module SDK
-    VERSION = '0.2.8'
+    VERSION = '0.3.0'
   end
 end

metadata

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