Ruby SDK 3.0.0

Breaking changes

• Removed all previously deprecated methods and exceptions related to *experiments- (use feature experiments instead):
  • Methods:
    • trigger_experiment
    • get_variation_associated_data
    • get_experiment_list
    • get_experiment_list_for_visitor
  • Exceptions:
    • ExperimentConfigurationNotFound
    • NotTargeted
    • NotAllocated
    • SiteCodeDisabled
• Removed all other methods that were deprecated in 2.x versions:
  • obtain_visitor_code
  • activate_feature
  • obtain_variation_associated_data
  • obtain_feature_variable
  • retrieve_data_from_remote_source
• Changed the following classes, methods, and exceptions:
  • Classes:
    • Renamed ClientConfig to KameleoonClientConfig
    • Renamed ClientFactory to KameleoonClientFactory
    • Renamed Client to KameleoonClient
  • Methods:
    • Renamed get_feature_all_variables method to get_feature_variation_variables
    • Removed make_from_yaml method from KameleoonClientConfig. If you used the method please use read_from_yaml instead.
  • Exceptions:
    • Renamed VisitorCodeNotValid to VisitorCodeInvalid
    • Renamed FeatureConfigurationNotFound to FeatureNotFound
    • Renamed VariationConfigurationNotFound to FeatureVariationNotFound
    • Renamed CredentialsNotFound to ConfigCredentialsInvalid
    • Added SiteCodeIsEmpty exception, which the KameleoonClientFactory.create method raises if the specified site code parameter is nil or empty.
• Changed configuration fields:
  • removed visitor_data_maximum_size field
  • renamed configuration_refresh_interval to refresh_interval_minute
  • renamed default_timeout to default_timeout_millisecond
  • changed client_id and client_secret to required fields. Exception::ConfigCredentialsInvalid is now raised if client_id and client_secret are not specified.
• Added new exception [Exception::FeatureEnvironmentDisabled] indicating that the feature flag is disabled for certain environments. The following methods can throw the new exception:
  • get_feature_variation_key
  • get_feature_variable
  • get_feature_variation_variables
• Removed top_level_domain parameter from get_visitor_code.
• Reworked CustomData:
  • Changed the data type of the id field to Integer
  • Removed the value hash parameter due to the deprecation

Features

• Added new parameters for KameleoonClientConfig:
  • session_duration_minute
  • top_level_domain
• Added set_legal_consent method to determine the types of data Kameleoon includes in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information in the Consent management policy.
• Added new error Exception::SiteCodeIsEmpty which is raised if provided site code is nil or empty.

Bug fixes

• Stability and performance improvements