openpanel-sdk 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '083d26faea6cfd6409f2dd051882a65440d39ba638fa933090842671e590d249'
-  data.tar.gz: 61b14a1cca68ad9363b22ec0e42e7024de4f49ad9c9647c1dc0f81aa4be18783
+  metadata.gz: 16d0c70749e9b13369c48b6fce17861da507dfb98213a9c5caa9a408d7398ef9
+  data.tar.gz: a853ae76dae3f2b801c6841d8a949e558feeb2c5d0df391a92c80a0802f2b760
 SHA512:
-  metadata.gz: f72d5f1c63a79f88b7db5772f18a7e08a05b007c96803a146cdb91b7ceacaba25768725db2725fa82e2892ff937be5ea4d59c9b7b66bfcb220d445b57fe8ae21
-  data.tar.gz: 03d23b49a753dd1305a41569bfc39fc344f6603cb60647e17b468ae2bb5cb69780f71684aa48e9f979d593b4e050fcc86a4e8b21df707169ea6b711df175f6e9
+  metadata.gz: 5e86fcb48012bbefe587e9f5170bdd7d3509f6d84bf90dc2214a1a54b5975c7e0e9be7dc2527091ab8d29386b8f83acb75a23291b53ff40cbd1652527ccce2b6
+  data.tar.gz: 6418589ef60bf5716f5054db667a0af6fcc29dff087c9a86ae99da3a5ca997aa182bea4e5e428b1e34e39709eb7745d54aadbbfca2d3ac5199f1bd4d76614983

data/README.md

@@ -1,6 +1,6 @@
 # Openpanel::SDK
 
-OpenPanel SDK for Ruby
+[OpenPanel](https://openpanel.dev/) SDK for Ruby
 
 ## Installation
 
@@ -18,7 +18,7 @@ gem install openpanel-sdk
 
 ## Usage example
 
-Use the gem by adding the following line to the Gemfile:
+### Simple example
 
 ```ruby
 tracker = OpenPanel::SDK::Tracker.new
@@ -32,15 +32,91 @@ tracker.increment_property identify_user, 'test_property', 1
 tracker.decrement_property identify_user, 'test_property', 1
 ```
 
-## Development
+See [spec](spec) for more.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Rails example
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Now imagine you have a Rails app, you can add the following to your `application_controller.rb`:
+
+```ruby
+before_action :set_openpanel_tracker
+
+protected
+
+def set_openpanel_tracker
+  @openpanel_tracker = OpenPanel::SDK::Tracker.new({ env: Rails.env.to_s }, disabled: Rails.env.development?)
+  @openpanel_tracker.set_header "x-client-ip", request.ip
+  @openpanel_tracker.set_header "user-agent", request.user_agent
+end
+```
+
+then you can use `@openpanel_tracker` in your controllers to track events:
+
+```ruby
+@openpanel_tracker.track 'test_event', payload: { name: 'test' }
+```
+
+or to identify users:
+
+```ruby
+def identify_user_from_app_user(user, properties: {})
+  iu = OpenPanel::SDK::IdentifyUser.new
+  iu.profile_id = user.id.to_s
+  iu.email = user.email
+  iu.first_name = user.first_name
+  iu.last_name = user.last_name
+  iu.properties = properties
+
+  iu
+end
+
+iu = identify_user_from_app_user current_user
+response = @openpanel_tracker.identify iu
+# Faraday::Response
+``````
+
+Don't forget to set your env vars in `.env` file:
+
+```
+OPENPANEL_TRACK_URL=https://api.openpanel.dev/track
+OPENPANEL_CLIENT_ID=<YOUR_CLIENT_ID>
+OPENPANEL_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
+```
+
+as shown in [.env_sample](.env_sample)
+
+### Filtering events
+
+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
+filter = lambda { |payload|
+  true if payload[:name] == 'test'
+}
+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/[USERNAME]/openpanel-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tstaetter/openpanel-sdk.
 
 ## License
 

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.6'
+    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.6
+  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