Giter VIP home page Giter VIP logo

configcat / ruby-sdk Goto Github PK

View Code? Open in Web Editor NEW
9.0 5.0 3.0 390 KB

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.

Home Page: https://configcat.com/docs/sdk-reference/ruby

License: MIT License

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

ruby-sdk's Introduction

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 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 the ConfigCat Dashboard to get your SDK Key:

SDK-KEY

4. Create a ConfigCat client instance:

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

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

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

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.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome. For more info please read the Contribution Guideline.

About ConfigCat

ruby-sdk's People

Contributors

adams85 avatar configcat-developer avatar kp-cat avatar laliconfigcat avatar sigewuzhere avatar z4kn4fein avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

ruby-sdk's Issues

Flag overrides parameter is not working in v6+

Describe the bug

Using the flag_overrides parameter on v6+ of this gem causes an error:

NoMethodError (undefined method `create_data_source' for #<ConfigCat::LocalDictionaryDataSource:0x00000001135fd020 @_override_behaviour=0, 
# removed our configuration details ...

      @_override_data_source = options.flag_overrides.create_data_source(@log)
                                                        ^^^^^^^^^^^^^^^^^^^):

To reproduce

Initialise a config cat client with the flag_overrides parameter set.

Failing spec: #26

Expected behavior

This used to override local feature flags when using offline settings. E.g:

flag_overrides = LocalDictionaryDataSource.new(
      { some_feature: "yes" },
      OverrideBehaviour::LOCAL_ONLY,
    )
    client = ConfigCatClient.get("test", ConfigCatOptions.new(flag_overrides: flag_overrides))

can't override ConfigCatClient via webmock (bypassing via cache?)

Describe the bug

Can't seem to override config in testing my rails app. I have webmock set-up to mock external HTTP calls and I did need to mock the configcat request to get my tests running initially.

To reproduce

As per suggestion in docs, I created a Singleton via an initializer:

# config/initializers/configcat.rb
require 'configcat'
require 'singleton'

class FeatureFlagConfig
  include Singleton
  def initialize
    @client = ConfigCat.create_client(ENV["CONFIGCAT_KEY"])
  end

  def get_value(flag)
  	@client.get_value(flag, false)
  end

  def refresh
    @client.force_refresh
  end
end

i create a stub as per webmock

require 'webmock'
include WebMock::API

def stub_configcat_config
	stub_request(
		:get, 
		"https://cdn-global.configcat.com/configuration-files/#{ENV['CONFIGCAT_KEY']}/config_v5.json"
	).to_return(
		status: 200,
		body: {
		  "f": {
		    "my_feature": {
		      "v": false,
		    }
		  }
		}.to_json
	)
end

within my rails_helper.rb, I add a before hook

  config.before(:each, type: :request) do
    WebMock.disable_net_connect!(allow: '127.0.0.1')
    stub_configcat_config
    FeatureFlagConfig.instance.refresh
puts FeatureFlagConfig.instance.get_value('my_feature')
  end

If i now run 15 or 20 specs, while it's running, toggle the feature flag. It will show the returned value change from true to false (or V.V.) during the run.

Expected behavior

I expected the value I provided in my http mock_request to pverride the result. I guess somehow the caching is bypassing webmock. I anticipate this would cause problems in CI. I also want to avoid using a different Client / caching strategy for the test environment

Screenshots

bundle exec rspec spec/requests/
{"my_feature"=>false}
.{"my_feature"=>false}
.{"my_feature"=>false}
.{"my_feature"=>false}
.{"my_feature"=>false}
.{"my_feature"=>false}
.{"my_feature"=>false}
.*{"my_feature"=>true}
F{"my_feature"=>true}
.{"my_feature"=>true}
.{"my_feature"=>true}
F{"my_feature"=>true}
.**{"my_feature"=>true}
F{"my_feature"=>true}
.{"my_feature"=>true}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.