openpanel-sdk 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9777c4309f179a7458c3db1aa7faa136689ba9952830614c109ff29634950f1a
-  data.tar.gz: 827f2e8b345398fc176eb122b2d1eaa0aec28d0179c9ad94a01bd8b613572754
+  metadata.gz: 23f101cbdcbec005b038d9f8dd1452b4d1d4b6cd835fe5b2a02c00876d386a16
+  data.tar.gz: 20cea0702b357dbb44668d0b9a24f04375482bd66fe7f974cfb14e78d8237bba
 SHA512:
-  metadata.gz: 79e882b70b392f8e475057be327696ccc79b4fca5bfbe48d78baffb3deaf9a5781cedb52cb6bc8d55ffeaa8a4e4ef3a3b9624943cd4d2322c151cc32d9a97b5c
-  data.tar.gz: 9b0814453c46b72f92c37a077804ccaaf413cd1e0e15bf23c4de31a51e0bb99f8a45f9ef7e3a7c00f577c7a3fded802fea3372f6cdb6ca1baab3e00e2fd1f77f
+  metadata.gz: 1d5d4ff649654fff8094f9d3a50190b095c89b977a7dddf5d1f0192c47006988fb3c3fc4bc3368791c21e2261dee5eacfabb327f1896dd6e6acbfc0750d63853
+  data.tar.gz: 05e9b1ce5f442555f7be902639ff14a89058234b66d337812547b66d7250f106e775e0d25ee58b5938d89652ebd7a77e810388fbbd98fc24e887545806bdb4b8

data/lib/openpanel/sdk/identify_user.rb

@@ -2,6 +2,12 @@
 
 module OpenPanel
   module SDK
+    # Identify user payload class. Use this class to identify a user in OpenPanel.
+    # @attr profile_id [String] user profile ID
+    # @attr email [String] user email address
+    # @attr first_name [String] user first name
+    # @attr last_name [String] user last name
+    # @attr properties [Hash] user properties
     class IdentifyUser
       attr_accessor :profile_id, :email, :first_name, :last_name, :properties
 

data/lib/openpanel/sdk/tracker.rb

@@ -6,6 +6,8 @@ module OpenPanel
   module SDK
     class OpenPanelError < StandardError; end
 
+    # OpenPanel SDK tracker class. Use this class to track events in OpenPanel by using
+    # the OpenPanel backend API.
     class Tracker
       TRACKING_TYPE_IDENTIFY = 'identify'
       TRACKING_TYPE_TRACK = 'track'
@@ -14,12 +16,10 @@ module OpenPanel
 
       attr_reader :headers, :global_properties
 
-      ##############################
       # Initialize OpenPanel tracker
       # @param global_props [Hash] global properties to send with every `track` and `identify` event
       # @param disabled [Boolean] disable sending tracking events, defaults to false
-      ##############################
-      def initialize(global_props: {}, disabled: false)
+      def initialize(global_props, disabled: false)
         @headers = {
           'Content-Type' => 'application/json',
           'openpanel-client-id' => ENV['OPENPANEL_CLIENT_ID'],
@@ -29,22 +29,18 @@ module OpenPanel
         @global_properties = global_props
       end
 
-      ##############################
       # Set custom header for OpenPanel request
       # @param key [String] header key
       # @param value [String] header value
-      ##############################
       def set_header(key, value)
         @headers[key] = value
       end
 
-      ##############################
       # Track events in OpenPanel
       # https://openpanel.dev/docs/api/track
       # @param event [String] name of event
       # @param tracking_type [String]
       # @param payload [Hash] event payload
-      ##############################
       def track(event, tracking_type: TRACKING_TYPE_TRACK, payload: {})
         payload = global_properties.merge(payload) unless global_properties.empty?
         payload = { type: tracking_type, payload: { name: event, properties: payload } }
@@ -52,11 +48,9 @@ module OpenPanel
         send_request payload: payload
       end
 
-      ##############################
       # Identify user in OpenPanel
       # https://openpanel.dev/docs/api/track
       # @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,
@@ -66,12 +60,10 @@ module OpenPanel
         send_request payload: payload
       end
 
-      ##############################
       # Decrement property in OpenPanel
-      # @param user [User] user to identify
+      # @param user [OpenPanel::SDK::IdentifyUser] user to identify
       # @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 }
@@ -79,12 +71,10 @@ module OpenPanel
         send_request payload: payload
       end
 
-      ##############################
       # Decrement property in OpenPanel
-      # @param user [User] user to identify
+      # @param user [OpenPanel::SDK::IdentifyUser] user to identify
       # @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 }
@@ -94,13 +84,11 @@ module OpenPanel
 
       private
 
-      ##############################
       # Send request to OpenPanel API
       # @param url [String] API endpoint URL
       # @param payload [Hash] request payload
       # @return [Faraday::Response] The Faraday plain response object
       # @raise [OpenPanel::SDK::OpenPanelError] if request fails
-      ##############################
       def send_request(url: ENV['OPENPANEL_TRACK_URL'], payload: {})
         return if @disabled
 

data/lib/openpanel/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenPanel
   module SDK
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openpanel-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Thomas Stätter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-29 00:00:00.000000000 Z
+date: 2025-11-30 00:00:00.000000000 Z
 dependencies: []
 description: OpenPanel SDK for Ruby
 email: