Getting started with Ruby SDK

This is legacy documentation

CloudBees Feature Management is now part of CloudBees Unify. For current feature management documentation, go to CloudBees Unify Feature management.

This documentation covers the original CloudBees Feature Management product (formerly Rollout.io), which is end-of-life. It remains available only for existing customers who are migrating to CloudBees Unify.

Support during the extension period

Because CloudBees Feature Management is an end-of-life product, support during the extension period is limited to critical items only:

Critical security fixes: High-impact security issues are in scope and will be addressed.
Critical bug fixes: Reviewed case by case; resolution is not guaranteed.
General support, enhancements, and non-critical fixes: Not provided for end-of-life products during the extension period.

This coverage is consistent with the CloudBees end-of-life policy in the support Terms & Conditions.

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. Copy your environment key from App settings > Environments > 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-rollout▼

Add 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, :page, :percentage

  def initialize
    # Define the feature flags
    @enableTutorial = Rox::Server::RoxFlag.new(false)
    @titleColors = Rox::Server::RoxString.new('red', ['red', 'blue', 'green'])
    @page = Rox::Server::RoxInt.new(1, [1, 2, 3])
    @percentage = Rox::Server::RoxDouble.new(99.9, [10.5, 50.0, 99.9])
  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"}"

# String flag example
puts "titleColors is #{flags.titleColors.value}"

# Int flag example
puts "page is #{flags.page.value}"

# Double flag example
puts "percentage is #{flags.percentage.value}"▼

Container class registration and environment key setup

You cannot call Rox.setup() twice in the same runtime.

Run your application

Running the application

The flag name is automatically added to the CloudBees Feature Management dashboard after running the application.