Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/configcat/ruby-sdk

ConfigCat SDK for Ruby. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
https://github.com/configcat/ruby-sdk

configcat configuration configuration-management feature-flag feature-flags feature-toggle feature-toggles remote-config ruby

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/configcat/ruby-sdk
Owner: configcat
License: mit
Created: 2019-09-13T20:31:16.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-22T19:47:11.000Z (7 months ago)
Last Synced: 2024-05-22T20:50:13.559Z (7 months ago)
Topics: configcat, configuration, configuration-management, feature-flag, feature-flags, feature-toggle, feature-toggles, remote-config, ruby
Language: Ruby
Homepage: https://configcat.com/docs/sdk-reference/ruby
Size: 381 KB
Stars: 9
Watchers: 5
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# 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 Dashboard 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.

[![Ruby CI](https://github.com/configcat/ruby-sdk/actions/workflows/ruby-ci.yml/badge.svg?branch=master)](https://github.com/configcat/ruby-sdk/actions/workflows/ruby-ci.yml)
[![Coverage Status](https://img.shields.io/codecov/c/github/ConfigCat/ruby-sdk.svg)](https://codecov.io/gh/ConfigCat/ruby-sdk)
[![Gem version](https://badge.fury.io/rb/configcat.svg)](https://rubygems.org/gems/configcat)
![License](https://img.shields.io/github/license/configcat/ruby-sdk.svg)

## Getting started
### 1. Install the package with `RubyGems`
```bash
gem install configcat
```

### 2. Import `configcat` to your application
```ruby
require 'configcat'
```

### 3. Go to the ConfigCat Dashboard to get your *SDK Key*:
![SDK-KEY](https://raw.githubusercontent.com/ConfigCat/ruby-sdk/master/media/readme02-3.png "SDK-KEY")

### 4. Create a *ConfigCat* client instance:
```ruby
configcat_client = ConfigCat.get("#YOUR-SDK-KEY#")
```
> We strongly recommend using the *ConfigCat Client* as a Singleton object in your application. The `ConfigCat.get` static factory method constructs singleton client instances for your SDK keys.

### 5. Get your setting value
```ruby
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
```ruby
configcat_client.close
```

## 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](https://configcat.com/docs/advanced/targeting/).
```ruby
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 apps
* [Sample Console Apps](https://github.com/configcat/ruby-sdk/tree/master/samples)

## 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](https://configcat.com/docs/sdk-reference/ruby/).

## Need help?
https://configcat.com/support

## Contributing
Contributions are welcome. For more info please read the [Contribution Guideline](CONTRIBUTING.md).

## About ConfigCat
- [Official ConfigCat SDKs for other platforms](https://github.com/configcat)
- [Documentation](https://configcat.com/docs)
- [Blog](https://configcat.com/blog)