togglr-sdk 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff652d531c0ed02ec75cf399743544e157fdd142a9ce2000847b0d1ba4d855cc
-  data.tar.gz: f90b18e8a8be739e557e6d21b6d2dda227dadcd417828374ba33e26b1ea9f5c4
+  metadata.gz: dfbbf2759ec78ebca965b0a80d91cbd85a438f482d2c942d02345b9ad8bb51ee
+  data.tar.gz: 5ae06a50fb62a913ed453c3924f6a6921dc3788bd932052bbd723c940975d293
 SHA512:
-  metadata.gz: d802ffa645e880e88d67c69c08346f9ce27a2547a0ed5ba8ec717ea9c29e58f034906ea5e29c73b41ba50e3fcc73d1e220f9525464dbb6b491b56412a1aa8397
-  data.tar.gz: f0b93fc6b700bc6b26a42b6295bb4daf8bf2138b08af990ea0ae4142d6cdcaf6b7b22ef384e9ac7642475fe9b39d43b20222cab489dd14f7c471c90e334425a1
+  metadata.gz: ce36f78850636242c0f88c3d00213628e562f111c483d0ede4ef1b6ae64332caca90dcda0894ba019ce18e32438931a73b24a21f8e5e1ed1733ac974c9c61622
+  data.tar.gz: fe7f9725f634425c6e09f8e5938263b35c4730f9099201c1a267212e154baf3f6e5d65fa82d0945bcf3f8c27c8ae6e297a54c1a581c7c088fcce0a7bbbe9e5e1

data/lib/togglr/client.rb

@@ -125,6 +125,14 @@ module Togglr
       health.healthy?
     end
 
+    # Track an event for analytics
+    def track_event(feature_key, event)
+      error = track_event_with_retries(feature_key, event)
+      raise error if error
+
+      nil # Success - event queued for processing
+    end
+
     def close
       @cache&.clear
     end
@@ -260,5 +268,35 @@ module Togglr
         'last_error_at' => api_health.last_error_at
       })
     end
+
+    def track_event_with_retries(feature_key, event)
+      with_retries(max_tries: @config.retries + 1) do
+        error = track_event_single(feature_key, event)
+        raise error if error
+
+        nil # Success
+      end
+    end
+
+    def track_event_single(feature_key, event)
+      track_request = TogglrClient::TrackRequest.new(event.to_h)
+
+      @api_client.track_feature_event(feature_key, track_request)
+      # Success - event queued for processing
+      nil
+    rescue TogglrClient::ApiError => e
+      case e.code
+      when 401
+        UnauthorizedError.new('Authentication required')
+      when 400
+        BadRequestError.new('Bad request')
+      when 404
+        FeatureNotFoundError.new("Feature #{feature_key} not found")
+      when 500
+        InternalServerError.new('Internal server error')
+      else
+        APIError.new(e.code.to_s, e.message, e.code)
+      end
+    end
   end
 end

data/lib/togglr/track_event.rb

@@ -0,0 +1,80 @@
+module Togglr
+  class TrackEvent
+    # Event types
+    SUCCESS = 'success'.freeze
+    FAILURE = 'failure'.freeze
+    ERROR = 'error'.freeze
+
+    attr_reader :variant_key, :event_type, :reward, :context, :created_at, :dedup_key
+
+    def initialize(variant_key, event_type, options = {})
+      @variant_key = variant_key
+      @event_type = event_type
+      @reward = options[:reward]
+      @context = options[:context] || RequestContext.new
+      @created_at = options[:created_at]
+      @dedup_key = options[:dedup_key]
+    end
+
+    def self.new(variant_key, event_type, options = {})
+      instance = allocate
+      instance.send(:initialize, variant_key, event_type, options)
+      instance
+    end
+
+    def with_reward(reward)
+      @reward = reward
+      self
+    end
+
+    def with_context(key, value)
+      @context.set(key, value)
+      self
+    end
+
+    def with_contexts(contexts)
+      contexts.each { |key, value| @context.set(key, value) }
+      self
+    end
+
+    def with_request_context(context)
+      @context = context
+      self
+    end
+
+    def with_created_at(created_at)
+      @created_at = created_at
+      self
+    end
+
+    def with_dedup_key(dedup_key)
+      @dedup_key = dedup_key
+      self
+    end
+
+    def to_h
+      result = {
+        'variant_key' => @variant_key,
+        'event_type' => @event_type,
+        'context' => @context.to_h
+      }
+
+      result['reward'] = @reward if @reward
+      result['created_at'] = @created_at.iso8601 if @created_at
+      result['dedup_key'] = @dedup_key if @dedup_key
+
+      result
+    end
+
+    def to_s
+      "#<Togglr::TrackEvent variant_key=#{@variant_key.inspect} " \
+      "event_type=#{@event_type.inspect} reward=#{@reward.inspect} " \
+      "context=#{@context.inspect} created_at=#{@created_at.inspect} " \
+      "dedup_key=#{@dedup_key.inspect}>"
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/togglr/version.rb

@@ -1,3 +1,3 @@
 module Togglr
-  VERSION = '1.0.5'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/togglr-client/api/default_api.rb

@@ -280,5 +280,79 @@ module TogglrClient
       end
       return data, status_code, headers
     end
+
+    # Track event for a feature (impression / conversion / error / custom)
+    # Send a feedback event related to a feature evaluation. Events are written to TimescaleDB (hypertable) and used for analytics, auto-disable and training MAB algorithms. The project is derived from the API key. 
+    # @param feature_key [String] 
+    # @param track_request [TrackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def track_feature_event(feature_key, track_request, opts = {})
+      track_feature_event_with_http_info(feature_key, track_request, opts)
+      nil
+    end
+
+    # Track event for a feature (impression / conversion / error / custom)
+    # Send a feedback event related to a feature evaluation. Events are written to TimescaleDB (hypertable) and used for analytics, auto-disable and training MAB algorithms. The project is derived from the API key. 
+    # @param feature_key [String] 
+    # @param track_request [TrackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def track_feature_event_with_http_info(feature_key, track_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.track_feature_event ...'
+      end
+      # verify the required parameter 'feature_key' is set
+      if @api_client.config.client_side_validation && feature_key.nil?
+        fail ArgumentError, "Missing the required parameter 'feature_key' when calling DefaultApi.track_feature_event"
+      end
+      # verify the required parameter 'track_request' is set
+      if @api_client.config.client_side_validation && track_request.nil?
+        fail ArgumentError, "Missing the required parameter 'track_request' when calling DefaultApi.track_feature_event"
+      end
+      # resource path
+      local_var_path = '/sdk/v1/features/{feature_key}/track'.sub('{' + 'feature_key' + '}', CGI.escape(feature_key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(track_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.track_feature_event",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#track_feature_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/togglr-client/models/track_request.rb

@@ -0,0 +1,332 @@
+=begin
+#SDK API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TogglrClient
+  # Event sent from SDK. SDK SHOULD send an impression event for each evaluation (recommended). Conversions / errors / custom events are used to update algorithm statistics. 
+  class TrackRequest
+    # Variant key returned by evaluate (e.g. \"A\", \"v2\").
+    attr_accessor :variant_key
+
+    # Type of event (e.g. \"success\", \"failure\", \"error\").
+    attr_accessor :event_type
+
+    # Numeric reward associated with event (e.g. 1.0 for conversion). Default 0.
+    attr_accessor :reward
+
+    # Arbitrary context passed by SDK (user id, session, metadata).
+    attr_accessor :context
+
+    # Event timestamp. If omitted, server time will be used.
+    attr_accessor :created_at
+
+    # Optional idempotency key to deduplicate duplicate events from SDK retries.
+    attr_accessor :dedup_key
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'variant_key' => :'variant_key',
+        :'event_type' => :'event_type',
+        :'reward' => :'reward',
+        :'context' => :'context',
+        :'created_at' => :'created_at',
+        :'dedup_key' => :'dedup_key'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'variant_key' => :'String',
+        :'event_type' => :'String',
+        :'reward' => :'Float',
+        :'context' => :'Hash<String, Object>',
+        :'created_at' => :'Time',
+        :'dedup_key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogglrClient::TrackRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TogglrClient::TrackRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'variant_key')
+        self.variant_key = attributes[:'variant_key']
+      else
+        self.variant_key = nil
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'reward')
+        self.reward = attributes[:'reward']
+      end
+
+      if attributes.key?(:'context')
+        if (value = attributes[:'context']).is_a?(Hash)
+          self.context = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'dedup_key')
+        self.dedup_key = attributes[:'dedup_key']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @variant_key.nil?
+        invalid_properties.push('invalid value for "variant_key", variant_key cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @variant_key.nil?
+      return false if @event_type.nil?
+      event_type_validator = EnumAttributeValidator.new('String', ["success", "failure", "error"])
+      return false unless event_type_validator.valid?(@event_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variant_key Value to be assigned
+    def variant_key=(variant_key)
+      if variant_key.nil?
+        fail ArgumentError, 'variant_key cannot be nil'
+      end
+
+      @variant_key = variant_key
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_type Object to be assigned
+    def event_type=(event_type)
+      validator = EnumAttributeValidator.new('String', ["success", "failure", "error"])
+      unless validator.valid?(event_type)
+        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      end
+      @event_type = event_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          variant_key == o.variant_key &&
+          event_type == o.event_type &&
+          reward == o.reward &&
+          context == o.context &&
+          created_at == o.created_at &&
+          dedup_key == o.dedup_key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [variant_key, event_type, reward, context, created_at, dedup_key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TogglrClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/togglr-client.rb

@@ -29,6 +29,7 @@ require 'togglr-client/models/evaluate_response'
 require 'togglr-client/models/feature_error_report'
 require 'togglr-client/models/feature_health'
 require 'togglr-client/models/health_response'
+require 'togglr-client/models/track_request'
 
 # APIs
 require 'togglr-client/api/default_api'

data/lib/togglr.rb

@@ -2,6 +2,7 @@ require_relative 'togglr/version'
 require_relative 'togglr/config'
 require_relative 'togglr/client'
 require_relative 'togglr/request_context'
+require_relative 'togglr/track_event'
 require_relative 'togglr/errors'
 require_relative 'togglr/cache'
 require_relative 'togglr/logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togglr-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Roman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-09 00:00:00.000000000 Z
+date: 2025-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -107,6 +107,7 @@ files:
 - lib/togglr-client/models/feature_error_report.rb
 - lib/togglr-client/models/feature_health.rb
 - lib/togglr-client/models/health_response.rb
+- lib/togglr-client/models/track_request.rb
 - lib/togglr-client/version.rb
 - lib/togglr.rb
 - lib/togglr/cache.rb
@@ -118,6 +119,7 @@ files:
 - lib/togglr/models.rb
 - lib/togglr/options.rb
 - lib/togglr/request_context.rb
+- lib/togglr/track_event.rb
 - lib/togglr/version.rb
 - spec/examples.txt
 - spec/spec_helper.rb