Getting started with Ruby SDK
On this page
This section describes how to set up and install the Ruby SDK and how to deploy a feature flag.
Step 1 - Setting up
The following are prerequisites for installing the Ruby SDK:
-
Create a CloudBees Feature Management account. See Signup Page to create an account.
-
Get your environment key.
-
Get the key from App Settings > Environment > Key.
-
Step 2 - Installing the Ruby SDK
Add the CloudBees Feature Management Ruby library to your application by running the following commands:
# Add the SDK to your application
$ gem install rox-rolloutAdd the following lines of code to your application:
# Import SDK
require 'rox/server/rox_server'
# Create Roxflags in the Flags container class
class Flags
attr_accessor :enableTutorial, :titleColors
def initialize
# Define the feature flags
@enableTutorial = Rox::Server::RoxFlag.new(false)
@titleColors = Rox::Server::RoxVariant.new('red', ['red', 'blue', 'green'])
end
end
flags = Flags.new
# Register the flags container
Rox::Server::RoxServer.register('', flags)
# Setup the environment key
Rox::Server::RoxServer.setup("<ROLLOUT-ENV-KEY>").join
# Boolean flag example
puts "enableTutorial is #{flags.enableTutorial.enabled? ? "enabled" : "disabled"}"
# Multivariate flag example
puts "titleColors is #{flags.titleColors.value}"|
Container class registration and environment key setup
|