Skip to content

Commit

Permalink
Bump to 2.0 for General Availability. (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeproeng37 authored Apr 12, 2018
1 parent a80d4ac commit 619f3bc
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
## 2.0.0
April 12th, 2018

This major release of the Optimizely SDK introduces APIs for Feature Management. It also introduces some breaking changes listed below.

### New Features
* Introduces the `is_feature_enabled` API to determine whether to show a feature to a user or not.
```
enabled = optimizely_client.is_feature_enabled('my_feature_key', 'user_1', user_attributes)
```

* You can also get all the enabled features for the user by calling the following method which returns a list of strings representing the feature keys:
```
enabled_features = optimizely_client.get_enabled_features('user_1', user_attributes)
```

* Introduces Feature Variables to configure or parameterize your feature. There are four variable types: `Integer`, `String`, `Double`, `Boolean`.
```
string_variable = optimizely_client.get_feature_variable_string('my_feature_key', 'string_variable_key', 'user_1')
integer_variable = optimizely_client.get_feature_variable_integer('my_feature_key', 'integer_variable_key', 'user_1')
double_variable = optimizely_client.get_feature_variable_double('my_feature_key', 'double_variable_key', 'user_1')
boolean_variable = optimizely_client.get_feature_variable_boolean('my_feature_key', 'boolean_variable_key', 'user_1')
```

### Breaking changes
* The `track` API with revenue value as a stand-alone parameter has been removed. The revenue value should be passed in as an entry of the event tags map. The key for the revenue tag is `revenue` and will be treated by Optimizely as the key for analyzing revenue data in results.
```
event_tags = {
'revenue'=> 1200
}
optimizely_client.track('event_key', 'user_id', user_attributes, event_tags)
```

## 2.0.0.beta1
March 29th, 2018

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ The SDK is available through [RubyGems](https://rubygems.org/gems/optimizely-sdk
gem install optimizely-sdk
```

### Feature Management Access
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely account executive.

### Using the SDK
See the Optimizely Full Stack [developer documentation](http://developers.optimizely.com/server/reference/index.html) to learn how to set up your first Full Stack project and use the SDK.

Expand Down
2 changes: 1 addition & 1 deletion lib/optimizely/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
#
module Optimizely
CLIENT_ENGINE = 'ruby-sdk'
VERSION = '2.0.0.beta1'
VERSION = '2.0.0'
end

0 comments on commit 619f3bc

Please sign in to comment.