Skip to content
No description, website, or topics provided.
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
media readme01.png Oct 2, 2019
samples remove ; from comment Oct 8, 2019
spec
.gitignore
.travis.yml
DEPLOY.md Update DEPLOY.md Oct 1, 2019
Gemfile Prepare ci Sep 25, 2019
LICENSE
README.md Update README.md Oct 19, 2019
Rakefile
configcat.gemspec coveralls code coverage Oct 19, 2019

README.md

ConfigCat SDK for Ruby

https://configcat.com
ConfigCat SDK for Ruby provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Management Console even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Build Status Coverage Status Gem version License

Getting started

1. Install the package with RubyGems

gem install configcat

2. Import configcat to your application

require 'configcat'

3. Go to Connect your application tab to get your API Key:

API-KEY

4. Create a ConfigCat client instance:

configcat_client = ConfigCat.create_client("#YOUR-API-KEY#")

We strongly recommend using the ConfigCat Client as a Singleton object in your application.

5. Get your setting value

isMyAwesomeFeatureEnabled = configcat_client.get_value("isMyAwesomeFeatureEnabled", false)
if isMyAwesomeFeatureEnabled
    do_the_new_thing()
else
    do_the_old_thing()
end

6. Stop ConfigCat client on application exit

configcat_client.stop()

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the get_value() function.

Read more about Targeting here.

user = ConfigCat::User.new("#USER-IDENTIFIER#")

isMyAwesomeFeatureEnabled = configcat_client.get_value("isMyAwesomeFeatureEnabled", false, user)
if isMyAwesomeFeatureEnabled
    do_the_new_thing()
else
    do_the_old_thing()
end

Sample/Demo app

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Support

If you need help how to use this SDK feel free to to contact the ConfigCat Staff on https://configcat.com. We're happy to help.

Contributing

Contributions are welcome.

About ConfigCat

You can’t perform that action at this time.