Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rewindio/eight_ball
Ruby gem for querying feature flags
https://github.com/rewindio/eight_ball
feature-flags feature-toggle feature-toggles ruby ruby-gem ruby-gems ruby-on-rails
Last synced: about 17 hours ago
JSON representation
Ruby gem for querying feature flags
- Host: GitHub
- URL: https://github.com/rewindio/eight_ball
- Owner: rewindio
- License: mit
- Created: 2018-11-27T16:30:41.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T21:31:34.000Z (15 days ago)
- Last Synced: 2024-12-26T07:06:48.890Z (8 days ago)
- Topics: feature-flags, feature-toggle, feature-toggles, ruby, ruby-gem, ruby-gems, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 119 KB
- Stars: 17
- Watchers: 24
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# EightBall
[](https://badge.fury.io/rb/eight_ball) 
EightBall is a feature toggle querying gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'eight_ball'
```
And then execute:
```ruby
bundle
```
Or install it yourself as:
```ruby
gem install eight_ball
```
## Example Usage
```ruby
require 'eight_ball'
# This could be read from the filesystem or be the response from an external service, etc.
json_input = %(
[{
"name": "Feature1",
"enabledFor": [{
"type": "range",
"parameter": "accountId",
"min": 1,
"max": 10
}],
"disabledFor": [{
"type": "list",
"parameter": "accountId",
"values": [2, 3]
}]
}]
)
# Transform the JSON into a list of Features
marshaller = EightBall::Marshallers::Json.new
features = marshaller.unmarshall json_input
# Tell EightBall about these Features
EightBall.provider = EightBall::Providers::Static.new features
# Away you go
EightBall.enabled? "Feature1", { accountId: 4 } # true
EightBall.enabled? "Feature1", { accountId: 2 } # false
```
More examples [here](examples)
## Concepts
### Feature
A Feature is a part of your application that can be enabled or disabled based on various conditions. It has the following attributes:
- `name`: The unique name of the Feature.
- `enabledFor`: An array of Conditions for which the Feature is enabled.
- `disabledFor`: An array of Conditions for which the Feature is disabled.
### Condition
A Condition must either be `true` or `false`. It describes when a Feature is enabled or disabled.
#### Supported Conditions
- [Always](lib/eight_ball/conditions/always.rb): This condition is always satisfied.
- [List](lib/eight_ball/conditions/list.rb): This condition is satisfied if the given value belongs to its list of accepted values.
- [Never](lib/eight_ball/conditions/never.rb): This condition is never satisfied.
- [Range](lib/eight_ball/conditions/range.rb): This condition is satisfied if the given value is within the specified range (inclusive).
### Provider
A Provider is able to give EightBall the list of Features it needs to answer queries.
#### Supported Providers
- [HTTP](lib/eight_ball/providers/http.rb): Connect to a URL and use the given Marshaller to convert the response into a list of Features.
- [Static](lib/eight_ball/providers/static.rb): Once initialized with a list of Features, always provides that same list of Features.
### RefreshPolicies
Some Providers are able to automatically "refresh" their list of Features using a RefreshPolicy.
#### Supported RefreshPolicies
- [Interval](lib/eight_ball/providers/refresh_policies/interval.rb): The data is considered fresh for a given number of seconds, after which it is considered stale and should be refreshed.
### Marshallers
A Marshaller converts Features to and from another format.
#### Supported Marshaller
- [JSON](lib/eight_ball/marshallers/json.rb)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
### Documenting
Documentation is written using [yard](https://yardoc.org/) syntax. You can view the generated docs by running `yard server` and going to `http://127.0.0.1:8808/docs/EightBall`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rewindio/eight_ball.