The SDK clients for Ruby https://bullet-train.io/. Bullet Train allows you to manage feature flags and remote config across multiple projects, environments and organisations.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See running in production for notes on how to deploy the project on a live system.
gem install bullet-train-client
Retrieving feature flags for your project
For full documentation visit https://docs.bullet-train.io
require "bullet-train-ruby-client"
bt = BulletTrain.new("<<Your API KEY>>")
if bt.get_value("font_size")
# Do something awesome with the font size
end
if bt.feature_enabled?("does_not_exist")
#do something
else
#do nothing, or something else
endAvailable Options
| Property | Description | Required | Default Value |
|---|---|---|---|
api_key |
Defines which project environment you wish to get flags for. example ACME Project - Staging. | YES | null |
url |
Use this property to define where you're getting feature flags from, e.g. if you're self hosting. | NO | https://bullet-train-api.dokku1.solidstategroup.com/api/v1/ |
Available Functions
| Property | Description |
|---|---|
init |
Initialise the sdk against a particular environment |
feature_enabled?(key) |
Get the value of a particular feature e.g. bulletTrain.feature_enabled?("powerUserFeature") // true |
feature_enabled?(key, user_id, default = false) |
Get the value of a particular feature for a user e.g. bulletTrain.feature_enabled?("powerUserFeature", 1234) // true |
get_value(key) |
Get the value of a particular feature e.g. bulletTrain.get_value("font_size") // 10 |
get_value(key, user_id, default = nil) |
Get the value of a particular feature for a specificed user e.g. bulletTrain.get_value("font_size", 1234) // 15 |
get_flags() |
Trigger a manual fetch of the environment features, if a user is identified it will fetch their features |
get_flags(user_id) |
Trigger a manual fetch of the environment features with a given user id |
Identifying users
Identifying users allows you to target specific users from the Bullet Train dashboard.
You can include an optional user identifier as part of the hasFeature and getValue methods to retrieve unique user flags and variables.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.
If you have any questions about our projects you can email [email protected].
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent