Skip to content

Commit 7a5261d

Browse files
[FSSDK-8582] chore: prepare for 5.0 release (#346)
* bump version and update changelog * fix license
1 parent 32d0d99 commit 7a5261d

File tree

3 files changed

+64
-2
lines changed

3 files changed

+64
-2
lines changed

CHANGELOG.md

+62
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,67 @@
11
# Optimizely Ruby SDK Changelog
22

3+
## 5.0.0
4+
January 18th, 2024
5+
6+
### New Features
7+
8+
The 5.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs)
9+
([#303](https://github.com/optimizely/ruby-sdk/pull/303),
10+
[#308](https://github.com/optimizely/ruby-sdk/pull/308),
11+
[#310](https://github.com/optimizely/ruby-sdk/pull/310),
12+
[#311](https://github.com/optimizely/ruby-sdk/pull/311),
13+
[#312](https://github.com/optimizely/ruby-sdk/pull/312),
14+
[#314](https://github.com/optimizely/ruby-sdk/pull/314),
15+
[#316](https://github.com/optimizely/ruby-sdk/pull/316)).
16+
You can use ODP, a high-performance [Customer Data Platform (CDP)]( https://www.optimizely.com/optimization-glossary/customer-data-platform/), 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.
17+
18+
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.
19+
20+
This version includes the following changes:
21+
22+
* New API added to `OptimizelyUserContext`:
23+
24+
* `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.
25+
26+
* When an `OptimizelyUserContext` is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.
27+
28+
* New APIs added to `Optimizely::Project`:
29+
30+
* `send_odp_event()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.
31+
32+
For details, refer to our documentation pages:
33+
34+
* [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting)
35+
36+
* [Server SDK Support](https://docs.developers.optimizely.com/feature-experimentation/v1.0/docs/advanced-audience-targeting-for-server-side-sdks)
37+
38+
* [Initialize Ruby SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/initialize-sdk-ruby)
39+
40+
* [OptimizelyUserContext Ruby SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizelyusercontext-ruby)
41+
42+
* [Advanced Audience Targeting segment qualification methods](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-segment-qualification-methods-ruby)
43+
44+
* [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-ruby)
45+
46+
### Logging
47+
48+
* Add warning to polling intervals below 30 seconds ([#338](https://github.com/optimizely/ruby-sdk/pull/338))
49+
* Add warning to duplicate experiment keys ([#343](https://github.com/optimizely/ruby-sdk/pull/343))
50+
51+
### Enhancements
52+
* Removed polling config manager stop restriction, allowing it to be restarted ([#340](https://github.com/optimizely/ruby-sdk/pull/340)).
53+
* Include object id/key in invalid object errors ([#301](https://github.com/optimizely/ruby-sdk/pull/301)).
54+
55+
### Breaking Changes
56+
57+
* Updated required Ruby version from 2.7 -> 3.0
58+
* `Optimizely::Project` initialization arguments have been changed from positional to keyword ([#342](https://github.com/optimizely/ruby-sdk/pull/342)).
59+
* `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.
60+
61+
* `ProjectConfigManager` interface now requires a `sdk_key` method ([#323](https://github.com/optimizely/ruby-sdk/pull/323)).
62+
* `HTTPProjectConfigManager` requires either the `sdk_key` parameter or a datafile containing an sdkKey ([#323](https://github.com/optimizely/ruby-sdk/pull/323)).
63+
* `BatchEventProcessor` is now the default `EventProcessor` when `Optimizely::Project` is instantiated ([#325](https://github.com/optimizely/ruby-sdk/pull/325)).
64+
365
## 5.0.0-beta
466
April 28th, 2023
567

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
same "printed page" as the copyright notice for easier
188188
identification within third-party archives.
189189

190-
Copyright 2016, Optimizely and contributors
190+
© Optimizely 2016
191191

192192
Licensed under the Apache License, Version 2.0 (the "License");
193193
you may not use this file except in compliance with the License.

lib/optimizely/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717
#
1818
module Optimizely
1919
CLIENT_ENGINE = 'ruby-sdk'
20-
VERSION = '5.0.0-beta'
20+
VERSION = '5.0.0'
2121
end

0 commit comments

Comments
 (0)