https://github.com/splitio/ruby-client
Ruby SDK client for Split Software
https://github.com/splitio/ruby-client
ab-testing control-rollout feature-flags feature-toggle feature-toggles ruby sdk split splitsoftware
Last synced: 3 months ago
JSON representation
Ruby SDK client for Split Software
- Host: GitHub
- URL: https://github.com/splitio/ruby-client
- Owner: splitio
- License: other
- Created: 2015-12-07T23:50:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-10-10T22:36:47.000Z (4 months ago)
- Last Synced: 2025-10-11T04:28:14.147Z (4 months ago)
- Topics: ab-testing, control-rollout, feature-flags, feature-toggle, feature-toggles, ruby, sdk, split, splitsoftware
- Language: Ruby
- Homepage: https://split.io
- Size: 13 MB
- Stars: 26
- Watchers: 20
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Split SDK for Ruby
[](https://github.com/splitio/ruby-client/actions)
[](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
## Overview
This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
[](https://twitter.com/intent/follow?screen_name=splitsoftware)
## Compatibility
The Ruby SDK support Ruby version 2.5.0 or later and JRuby or 9.1.17 o later.
Also the Ruby SDK has been tested as a standalone app as well as using the following web servers:
- Puma
- Passenger
- Unicorn
For other setups, please reach out to [support@split.io](mailto:support@split.io).
## Getting started
Below is a simple example that describes the instantiation and most basic usage of our SDK:
```ruby
require 'splitclient-rb'
split_factory = SplitIoClient::SplitFactory.new('YOUR_SDK_KEY')
split_client = split_factory.client
begin
split_client.block_until_ready
rescue SplitIoClient::SDKBlockerTimeoutExpiredException
puts 'SDK is not ready. Decide whether to continue or abort execution'
end
treatment = split_client.get_treatment('CUSTOMER_ID', 'FEATURE_FLAG_NAME');
if treatment == 'on'
# insert code here to show on treatment
elsif treatment == 'off'
# insert code here to show off treatment
else
# insert your control treatment code here
end
```
For multi-process environments you also need to setup Split Synchronizer. See [Sharing state: Redis integration](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK#sharing-state-redis-integration)
Please refer to [our official docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK) to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.
## Submitting issues
The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/ruby-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
## Contributing
Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
## License
Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
## About Split
Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
Split has built and maintains SDKs for:
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
**Learn more about Split:**
Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.