v.5.0.1

5.0.1

February 8th, 2024

The 5.0.1 minor release introduces update of metadata in gemspec.

5.0.0

5.0.0

January 18th, 2024

New Features

The 5.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#303, #308, #310, #311, #312, #314, #316). You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetch_qualified_segments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.

  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to Optimizely::Project:

  • send_odp_event(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Server SDK Support

• Initialize Ruby SDK

• OptimizelyUserContext Ruby SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

Logging

• Add warning to polling intervals below 30 seconds (#338)
• Add warning to duplicate experiment keys (#343)

Enhancements

• Removed polling config manager stop restriction, allowing it to be restarted (#340).
• Include object id/key in invalid object errors (#301).

Breaking Changes

• Updated required Ruby version from 2.7 -> 3.0

• Optimizely::Project initialization arguments have been changed from positional to keyword (#342).

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when Optimizely::Project is instantiated.

• ProjectConfigManager interface now requires a sdk_key method (#323).

• HTTPProjectConfigManager requires either the sdk_key parameter or a datafile containing an sdkKey (#323).

• BatchEventProcessor is now the default EventProcessor when Optimizely::Project is instantiated (#325).

5.0.0-beta

5.0.0-beta

April 28th, 2023

New Features

The 5.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#303, #308, #310, #311, #312, #314, #316). You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetch_qualified_segments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.

  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to Optimizely::Project:

  • send_odp_event(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Server SDK Support

• Initialize Ruby SDK

• OptimizelyUserContext Ruby SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when Optimizely::Project is instantiated.

• ProjectConfigManager interface now requires a sdk_key method (#323).

• HTTPProjectConfigManager requires either the sdk_key parameter or a datafile containing an sdkKey (#323).

• BatchEventProcessor is now the default EventProcessor when Optimizely::Project is instantiated (#325).

4.0.1

4.0.1

March 13th, 2023

We updated our README.md and other non-functional code to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack. (#327)

4.0.0

4.0.0

August 4, 2022

Breaking Changes:

• Changed official supported versions of Ruby to 2.7, 3.0 and 3.1

3.10.1

3.10.1

February 2, 2022

Enhancements:

• Generate OptimizelyConfig object on API Call instead of SDK initialization to make the initialization faster (#296).

3.10.0

3.10.0

January 11, 2022

New Features

• Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface (#287, #288, #289, #290, #291, #293):

  • setForcedDecision
  • getForcedDecision
  • removeForcedDecision
  • removeAllForcedDecisions

• For details, refer to our documentation pages: OptimizelyUserContext and Forced Decision methods.

3.9.0

3.9.0

September 16, 2021

New Features:

• Add new public properties to OptimizelyConfig. (#285)
  • sdkKey
  • environmentKey
  • attributes
  • audiences
  • events
  • experimentRules and deliveryRules to OptimizelyFeature
  • audiences to OptimizelyExperiment
• For details, refer to our documentation page: https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyconfig-ruby.

Deprecated:

• OptimizelyFeature.experimentsMap of OptimizelyConfig is deprecated as of this release. Please use OptimizelyFeature.experimentRules and OptimizelyFeature.deliveryRules. (#285)

Release 3.8.1

3.8.1

August 2nd, 2021

Bug Fixes:

• Fixed duplicate experiment key issue with multiple feature flags. While trying to get variation from the variationKeyMap, it was unable to find because the latest experimentKey was overriding the previous one. (#282)

Release 3.8.0

3.8.0

February 16th, 2021

New Features:

• Introducing a new primary interface for retrieving feature flag status, configuration and associated experiment decisions for users (#274, #279). The new OptimizelyUserContext class is instantiated with create_user_context and exposes the following APIs to get OptimizelyDecision:

  • set_attribute
  • decide
  • decide_all
  • decide_for_keys
  • track_event

• For details, refer to our documentation page: https://docs.developers.optimizely.com/full-stack/v4.0/docs/ruby-sdk.