Ruby

This repository contains the official Ruby OpenFeature provider for accessing your feature flags with GO Feature Flag.

In conjuction with the OpenFeature SDK you will be able to evaluate your feature flags in your Ruby applications.

For documentation related to flags management in GO Feature Flag, refer to the GO Feature Flag documentation website.

Functionalities:

• Manage the integration of the OpenFeature Ruby SDK and GO Feature Flag relay-proxy.

Dependency Setup

Gem Package Manager

Add this line to your application's Gemfile:

gem 'openfeature-go-feature-flag-provider'

And then execute:

bundle install

Or install it yourself as:

gem install openfeature-go-feature-flag-provider

Getting started

Initialize the provider

The OpenFeature::GoFeatureFlag::Provider needs some options to be created and then set in the OpenFeature SDK.

Option	Description
endpoint	(mandatory) The URL to access to the relay-proxy. (example: https://relay.proxy.gofeatureflag.org/)
headers	A Hash object containing the headers to send to the relay-proxy. *(example to send APIKey: {"Authorization" => "Bearer my-api-key"}

The only required option to create a GoFeatureFlagProvider is the URL (endpoint) to your GO Feature Flag relay-proxy instance.

import GOFeatureFlag
import OpenFeature

# ...

options = OpenFeature::GoFeatureFlag::Options.new(endpoint: "http://localhost:1031")
provider = OpenFeature::GoFeatureFlag::Provider.new(options: options)

evaluation_context = OpenFeature::SDK::EvaluationContext.new(targeting_key: "9b9450f8-ab5c-4dcf-872f-feda3f6ccb16")

OpenFeature::SDK.configure do |config|
   config.set_provider(provider)
end
client = OpenFeature::SDK.build_client()

bool_value = client.fetch_boolean_value(
  flag_key: "my-boolean-flag",
  default_value: false,
  evaluation_context: evaluation_context
)

if bool_value 
  puts "The flag is enabled"
else
  puts "The flag is disabled"
end

The evaluation context is the way for the client to specify contextual data that GO Feature Flag uses to evaluate the feature flags, it allows to define rules on the flag.

The targeting_key is mandatory for GO Feature Flag to evaluate the feature flag, it could be the id of a user, a session ID or anything you find relevant to use as identifier during the evaluation.

Evaluate a feature flag

The client is used to retrieve values for the current EvaluationContext. For example, retrieving a boolean value for the flag "my-flag":

client = OpenFeature::SDK.build_client()

bool_value = client.fetch_boolean_value(
  flag_key: "my-boolean-flag",
  default_value: false,
  evaluation_context: evaluation_context
)

GO Feature Flag supports different all OpenFeature supported types of feature flags, it means that you can use all the accessor directly

# Bool
client.fetch_boolean_value(flag_key: 'my-flag', default_value: false, evaluation_context: evaluation_context)

# String
client.fetch_string_value(flag_key: 'my-flag', default_value: "default", evaluation_context: evaluation_context)

# Number
client.fetch_number_value(flag_key: 'my-flag', default_value: 0, evaluation_context: evaluation_context)

# Object
client.fetch_object_value(flag_key: 'my-flag', default_value: {"default" => true}, evaluation_context: evaluation_context)

Features status

Status	Feature	Description
	Remote Evaluation	The provider is calling the remote server to evaluate the feature flags.
	Tracking Flag Evaluation	The provider is tracking all the evaluations of your feature flags and you can export them using an exporter.
	Configuration Change Updates	The provider is able to update the configuration based on the configuration, it means that the provider is able to react to any feature flag change on your configuration.
	Provider Events Reactions	You can add an event handler to the provider to react to the provider events.

ImplementedIn-progressNot implemented yet

Contributing

This project welcomes contributions from the community. If you're interested in contributing, see the contributors' guide for some helpful tips.