openpanel-sdk 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9149a6bb20d0f7a786a13c8df94d1e204c4028f8b0cc6d5973bf7128077ab5e0
-  data.tar.gz: 50d8f08fd9c660b7462931e532d20f7a7ef34876fd04e69d9578d61501ed0b23
+  metadata.gz: 16d0c70749e9b13369c48b6fce17861da507dfb98213a9c5caa9a408d7398ef9
+  data.tar.gz: a853ae76dae3f2b801c6841d8a949e558feeb2c5d0df391a92c80a0802f2b760
 SHA512:
-  metadata.gz: afee0d0630f91baea9fb9c99147999312815db98650407f99a83991f7eb804c6b04e832b42e8266d693396473e9bcc62a212ef32b34b5fe786326ff91fa7c933
-  data.tar.gz: 55be90c0bdfb3c2ea6177593324265312499e79f7b3e0c9ced5894ed0b11542c7cdfdcded733b3dcfed75e49143b6482eb8b97b777606b784a4110c735ea0623
+  metadata.gz: 5e86fcb48012bbefe587e9f5170bdd7d3509f6d84bf90dc2214a1a54b5975c7e0e9be7dc2527091ab8d29386b8f83acb75a23291b53ff40cbd1652527ccce2b6
+  data.tar.gz: 6418589ef60bf5716f5054db667a0af6fcc29dff087c9a86ae99da3a5ca997aa182bea4e5e428b1e34e39709eb7745d54aadbbfca2d3ac5199f1bd4d76614983

data/README.md

@@ -87,7 +87,7 @@ as shown in [.env_sample](.env_sample)
 
 ### Filtering events
 
-Filters are used to prevent sending events to OpenPanel in certain cases.π
+Filters are used to prevent sending events to OpenPanel in certain cases.
 You can filter events by passing a `filter` lambda expression to the `track` method:
 
 ```ruby
@@ -98,6 +98,22 @@ response = tracker.track('test_event', payload: { name: 'test' }, filter: filter
 # response is nil
 ``````
 
+### Revenue tracking
+
+Revenue tracking is done easily:
+
+```ruby
+response = tracker.revenue user, 100, { currency: 'EUR' }
+# Faraday::Response
+```
+
+If you need to add the device ID, you can fetch it from the SDK:
+
+```ruby
+device_id = tracker.device_id
+# <Some-fancy-id>
+``````
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tstaetter/openpanel-sdk.

data/lib/openpanel/sdk/tracker.rb

@@ -89,6 +89,37 @@ module OpenPanel
         send_request payload: payload
       end
 
+      # Track revenue in 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 }
+
+        send_request payload: payload
+      end
+
+      def fetch_device_id
+        return if @disabled
+
+        url = "#{ENV['OPENPANEL_TRACK_URL']}/device-id"
+        response = Faraday.get url, {}, @headers
+
+        case response.status
+        when 401
+          raise OpenPanel::SDK::OpenPanelError, 'Unauthorized'
+        when 429
+          raise OpenPanel::SDK::OpenPanelError, 'Too many requests'
+        when 500
+          raise OpenPanel::SDK::OpenPanelError, 'Internal server error'
+        else
+          JSON.parse(response.body, symbolize_names: true)[:deviceId]
+        end
+      rescue StandardError => e
+        raise OpenPanel::SDK::OpenPanelError, e.message
+      end
+
       private
 
       # Send request to OpenPanel API

data/lib/openpanel/sdk/version.rb

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

metadata

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