mifrill / rollout_percentage

RolloutPercentage

The implementation of user-percentages feature but without required object https://github.com/fetlife/rollout#user-percentages

Installation

Add this line to your application's Gemfile:

gem 'rollout_percentage'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rollout_percentage

Usage

Rollout Client example

Simple implementation with redis-rb

require 'redis'

class RolloutClient
  attr_accessor :redis

  def initialize(**args)
    self.redis = Redis.new(args)
  end

  def get(key)
    redis.get(key)
  end

  def set(key, value)
    redis.set(key, value)
  end
end

Manage percentage by rails console:

rollout_client = RolloutClient.new(url: url)

feature_flag - @symbol percentage_enabling - @integer

rollout_client.set(feature_flag, percentage_enabling)
rollout_client.get(feature_flag)

RolloutPercentage usage example:

RolloutPercentage.new(feature_flag: feature_flag, rollout_client: rollout_client).perform
  # => returns the boolean randomized by percentage

RolloutPercentage.new(feature_flag: :feature_flag, rollout_client: rollout_client).perform do
  # => some block code here which should be run on randomized by percentage
end

Development

After checking out the repo, run bundle install to install dependencies. Then, run rake spec to run the tests.

To install this gem onto your local machine, run rake install. To release a new version, update the version number (RolloutPercentage::VERSION) in lib/rollout_percentage.rb, and then run rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Mifrill/rollout_percentage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RolloutPercentage project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.