unleash 3.2.5 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1535ef477a380d94767952c3d4a660ab029bf78100f7d30246ff211517172f2
-  data.tar.gz: b357d2bda18a9b1378988d4467b78cbe02129b519578272da7fd0259cada97d0
+  metadata.gz: 93e6312bc93458378b877b6e949274295a1e0037af2cf8206d94b9e2852727eb
+  data.tar.gz: ecb08a7c1a4e9b0b63fad299649632443a99f7b8e4752b486970d7656b862e46
 SHA512:
-  metadata.gz: e1fe0ae8b8ff86fdbe3c0d9a68b0d559112a9d568bcb8762f946d191b33ee8bdcd25bad63983d6b507269534309690fc2f858c5989b287004e5df2a3b8755e36
-  data.tar.gz: 8e05aeb05427eaa6e0391703aa524902c3094be21c176a374093ec5263b2a2fcc4b9bce4ab2fb9627d18ecf822dfbd1f8cfecaaba8a9517ae96f9efd687ab1a8
+  metadata.gz: eef06ea5a86751e6cfe68306a1d7f7e6c49fb0641c4916ddbdda30b4c1bec51a1349487dc156851229c4d496fe67cac96f0e5c875027998d0252bf154f2e02c9
+  data.tar.gz: 6fdf04c5e92b1de875ada2035b9fb495e80cf5138f4cd0171bd6686026a1280857c855ccdaa9bd15a915509f5bac4f9da50d08368f7de663c0a762b8654a3112

data/.github/workflows/pull_request.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        ruby-version:
+          - jruby-9.2
+          - jruby-9.3
+          - 3.1
+          - 3.0
+          - 2.7
+          - 2.6
+          - 2.5
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Download test cases
+        run: git clone --depth 5 --branch v4.1.0 https://github.com/Unleash/client-specification.git client-specification
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          rubocop_version: gemfile
+          rubocop_extensions: rubocop-rspec:gemfile
+          reporter: github-pr-review # Default is github-pr-check
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.test_number }}
+          parallel: true
+      - name: Notify Slack of pipeline completion
+        uses: 8398a7/action-slack@v3
+        if: ${{ github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name }}
+        with:
+          status: ${{ job.status }}
+          text: Built on ${{ matrix.os }} - Ruby ${{ matrix.ruby-version }}
+          fields: repo,message,commit,author,action,eventName,ref,workflow,job,took
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+

data/.gitignore

@@ -9,6 +9,9 @@
 /tmp/
 /vendor
 
+# IntelliJ
+.idea/
+
 # rspec failure tracking
 .rspec_status
 

data/.rubocop.yml

@@ -7,24 +7,24 @@ Naming/PredicateName:
   AllowedMethods:
     - is_enabled?
 
+
 Metrics/ClassLength:
-  Max: 120
+  Max: 125
 Layout/LineLength:
   Max: 140
 Metrics/MethodLength:
   Max: 20
 Metrics/BlockLength:
-  Max: 100
+  Max: 110
   Exclude:
-    - 'spec/unleash/client_spec.rb'
-    - 'spec/unleash/feature_toggle_spec.rb'
+    - 'spec/**/*.rb'
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 30
 Metrics/CyclomaticComplexity:
   Max: 9
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 10
 
 Style/Documentation:
   Enabled: false
@@ -51,6 +51,12 @@ Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
+Style/EmptyElse:
+  Exclude:
+    - 'lib/unleash/strategy/flexible_rollout.rb'
+
+Style/DoubleNegation:
+  Enabled: false
 
 Style/IfInsideElse:
   Exclude:
@@ -60,6 +66,61 @@ Style/Next:
   Exclude:
     - 'lib/unleash/scheduled_executor.rb'
 
+
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+#Style/ClassEqualityComparison:
+#  Enabled: true
+Style/CombinableLoops:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+#Style/GlobalStdStream:
+#  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/KeywordParametersOrder:
+  Enabled: true
+#Style/OptionalBooleanParameter:
+#  Enabled: false
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/RedundantSelfAssignment:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/SoleNestedConditional:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+#  EnforcedStyleForMultiline: consistent_comma
+
+Layout/BeginEndAlignment:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
@@ -68,3 +129,50 @@ Layout/SpaceBeforeBlockBraces:
   Exclude:
     - 'unleash-client.gemspec'
     - 'spec/**/*.rb'
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRequire:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/EmptyFile:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Enabled: true
+Lint/IdentityComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: false
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/RedundantSafeNavigation:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Enabled: true
+Lint/UselessTimes:
+  Enabled: true

data/README.md

@@ -1,7 +1,7 @@
 # Unleash::Client
 
-[![Build Status](https://travis-ci.org/Unleash/unleash-client-ruby.svg?branch=master)](https://travis-ci.org/Unleash/unleash-client-ruby)
-[![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-client-ruby/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash-client-ruby?branch=master)
+![Build Status](https://github.com/Unleash/unleash-client-ruby/actions/workflows/pull_request.yml/badge.svg?branch=main)
+[![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-client-ruby/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-client-ruby?branch=main)
 [![Gem Version](https://badge.fury.io/rb/unleash.svg)](https://badge.fury.io/rb/unleash)
 
 Unleash client so you can roll out your features with confidence.
@@ -10,18 +10,20 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
+  * MRI 3.1
   * MRI 3.0
   * MRI 2.7
   * MRI 2.6
   * MRI 2.5
-  * jruby
+  * jruby 9.3
+  * jruby 9.2
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 3.2.5'
+gem 'unleash', '~> 4.0.0'
 ```
 
 And then execute:
@@ -34,22 +36,29 @@ Or install it yourself as:
 
 ## Configure
 
-It is **required** to configure the `url` of the unleash server and `app_name` with the name of the runninng application. Please substitute the sample `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+It is **required** to configure:
+- `url` of the unleash server
+- `app_name` with the name of the runninng application.
+- `custom_http_headers` with `{'Authorization': '<API token>'}` when using Unleash v4.0.0 and later.
 
-It is **highly recommended** to configure the `instance_id` parameter as well.
+Please substitute the example `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+
+It is **highly recommended** to configure:
+- `instance_id` parameter with a unique identifier for the running instance.
 
 
 ```ruby
 Unleash.configure do |config|
-  config.url         = 'http://unleash.herokuapp.com/api'
-  config.app_name    = 'my_ruby_app'
+  config.app_name            = 'my_ruby_app'
+  config.url                 = 'http://unleash.herokuapp.com/api'
+  config.custom_http_headers = {'Authorization': '<API token>'}
 end
 ```
 
 or instantiate the client with the valid configuration:
 
 ```ruby
-UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
+UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app', custom_http_headers: {'Authorization': '<API token>'})
 ```
 
 #### List of Arguments
@@ -60,19 +69,25 @@ Argument | Description | Required? |  Type |  Default Value|
 `app_name` | Name of your program. | Y | String | N/A |
 `instance_id` | Identifier for the running instance of program. Important so you can trace back to where metrics are being collected from. **Highly recommended be be set.** | N | String | random UUID |
 `environment` | Environment the program is running on. Could be for example `prod` or `dev`. Not yet in use. | N | String | `default` |
+`project_name` | Name of the project to retrieve features from. If not set, all feature flags will be retrieved. | N | String | nil |
 `refresh_interval` | How often the unleash client should check with the server for configuration changes. | N | Integer |  15 |
-`metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 10 |
+`metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 60 |
 `disable_client` | Disables all communication with the Unleash server, effectively taking it *offline*. If set, `is_enabled?` will always answer with the `default_value` and configuration validation is skipped. Defeats the entire purpose of using unleash, but can be useful in when running tests. | N | Boolean | `false` |
 `disable_metrics` | Disables sending metrics to Unleash server. | N | Boolean | `false` |
-`custom_http_headers` | Custom headers to send to Unleash. | N | Hash | {} |
+`custom_http_headers` | Custom headers to send to Unleash. As of Unleash v4.0.0, the `Authorization` header is required. For example: `{'Authorization': '<API token>'}` | N | Hash | {} |
 `timeout` | How long to wait for the connection to be established or wait in reading state (open_timeout/read_timeout) | N | Integer | 30 |
-`retry_limit` | How many consecutive failures in connecting to the Unleash server are allowed before giving up. Use `Float::INFINITY` if you would like it to never give up. | N | Numeric | 5 |
+`retry_limit` | How many consecutive failures in connecting to the Unleash server are allowed before giving up. The default is to retry indefinitely. | N | Float::INFINITY | 5 |
 `backup_file` | Filename to store the last known state from the Unleash server. Best to not change this from the default. | N | String | `Dir.tmpdir + "/unleash-#{app_name}-repo.json` |
 `logger` | Specify a custom `Logger` class to handle logs for the Unleash client. | N | Class | `Logger.new(STDOUT)` |
-`log_level` | Change the log level for the `Logger` class. Constant from `Logger::Severity`. | N | Constant | `Logger::ERROR` |
+`log_level` | Change the log level for the `Logger` class. Constant from `Logger::Severity`. | N | Constant | `Logger::WARN` |
+`bootstrap_config` | Bootstrap config on how to loaded data on start-up. This is useful for loading large states on startup without (or before) hitting the network. | N | Unleash::Bootstrap::Configuration | `nil` |
 
-For in a more in depth look, please see `lib/unleash/configuration.rb`.
+For a more in-depth look, please see `lib/unleash/configuration.rb`.
 
+Environment Variable | Description
+---------|---------
+`UNLEASH_BOOTSTRAP_FILE` | File to read bootstrap data from
+`UNLEASH_BOOTSTRAP_URL` | URL to read bootstrap data from
 
 ## Usage in a plain Ruby Application
 
@@ -80,7 +95,7 @@ For in a more in depth look, please see `lib/unleash/configuration.rb`.
 require 'unleash'
 require 'unleash/context'
 
-@unleash = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
+@unleash = Unleash::Client.new(app_name: 'my_ruby_app', url: 'http://unleash.herokuapp.com/api', custom_http_headers: { 'Authorization': '<API token>' })
 
 feature_name = "AwesomeFeature"
 unleash_context = Unleash::Context.new
@@ -101,37 +116,145 @@ Put in `config/initializers/unleash.rb`:
 
 ```ruby
 Unleash.configure do |config|
-  config.url      = 'http://unleash.herokuapp.com/api'
   config.app_name = Rails.application.class.parent.to_s
+  config.url      = 'http://unleash.herokuapp.com/api'
   # config.instance_id = "#{Socket.gethostname}"
   config.logger   = Rails.logger
   config.environment = Rails.env
 end
 
 UNLEASH = Unleash::Client.new
+
+# Or if preferred:
+# Rails.configuration.unleash = Unleash::Client.new
+```
+For `config.instance_id` use a string with a unique identification for the running instance.
+For example: it could be the hostname, if you only run one App per host.
+Or the docker container id, if you are running in docker.
+If it is not set the client will generate an unique UUID for each execution.
+
+To have it available in the `rails console` command as well, also add to the file above:
+```ruby
+Rails.application.console do
+  UNLEASH = Unleash::Client.new
+  # or
+  # Rails.configuration.unleash = Unleash::Client.new
+end
+```
+
+#### Add Initializer if using [Puma in clustered mode](https://github.com/puma/puma#clustered-mode)
+
+That is, multiple workers configured in `puma.rb`:
+```ruby
+workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+```
+
+##### with `preload_app!`
+
+Then you may keep the client configuration still in `config/initializers/unleash.rb`:
+```ruby
+Unleash.configure do |config|
+  config.app_name    = Rails.application.class.parent.to_s
+  config.environment = Rails.env
+  config.url                 = 'http://unleash.herokuapp.com/api'
+  config.custom_http_headers = {'Authorization': '<API token>'}
+end
+```
+
+But you must ensure that the unleash client is instantiated only after the process is forked.
+This is done by creating the client inside the `on_worker_boot` code block in `puma.rb` as below:
+
+```ruby
+#...
+preload_app!
+#...
+
+on_worker_boot do
+  # ...
+
+  ::UNLEASH = Unleash::Client.new
+end
+
+on_worker_shutdown do
+  ::UNLEASH.shutdown
+end
 ```
-For `config.instance_id` use a string with a unique identification for the running instance. For example: it could be the hostname, if you only run one App per host. Or the docker container id, if you are running in docker. If it is not set the client will generate an unique UUID for each execution.
 
+##### without `preload_app!`
 
-#### Add Initializer if using [Puma](https://github.com/puma/puma)
+By not using `preload_app!`:
+- the `Rails` constant will NOT be available.
+- but phased restarts will be possible.
 
-In `puma.rb` ensure that the unleash client is configured and instantiated as below, inside the `on_worker_boot` code block:
+You need to ensure that in `puma.rb`:
+- loading unleash sdk with `require 'unleash'` explicitly, as it will not be pre-loaded.
+- all parameters must be explicitly set in the `on_worker_boot` block, as `config/initializers/unleash.rb` is not read.
+- there are no references to `Rails` constant, as that is not yet available.
 
+Example for `puma.rb`:
 ```ruby
+require 'unleash'
+
+#...
+# no preload_app!
+
 on_worker_boot do
   # ...
 
-  Unleash.configure do |config|
-    config.url      = 'http://unleash.herokuapp.com/api'
-    config.app_name = Rails.application.class.parent.to_s
-    config.environment = Rails.env
+  ::UNLEASH = Unleash::Client.new(
+    app_name: 'my_rails_app',
+    environment: 'development',
+    url: 'http://unleash.herokuapp.com/api',
+    custom_http_headers: {'Authorization': '<API token>'},
+  )
+end
+
+on_worker_shutdown do
+  ::UNLEASH.shutdown
+end
+```
+
+Note that we also added shutdown hooks in `on_worker_shutdown`, to ensure a clean shutdown.
+
+#### Add Initializer if using [Phusion Passenger](https://github.com/phusion/passenger)
+
+The unleash client needs to be configured and instantiated inside the `PhusionPassenger.on_event(:starting_worker_process)` code block due to [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#smart-spawning-caveats):
+
+The initializer in `config/initializers/unleash.rb` should look like:
+
+```ruby
+PhusionPassenger.on_event(:starting_worker_process) do |forked|
+  if forked
+    Unleash.configure do |config|
+      config.app_name    = Rails.application.class.parent.to_s
+      # config.instance_id = "#{Socket.gethostname}"
+      config.logger      = Rails.logger
+      config.environment = Rails.env
+      config.url                 = 'http://unleash.herokuapp.com/api'
+      config.custom_http_headers = {'Authorization': '<API token>'}
+    end
+
+    UNLEASH = Unleash::Client.new
   end
-  Rails.configuration.unleash = Unleash::Client.new
 end
 ```
 
-Instead of the configuration in `config/initializers/unleash.rb`.
+#### Add Initializer hooks when using within [Sidekiq](https://github.com/mperham/sidekiq)
+
+Note that in this case we require that the code block for `Unleash.configure` is set beforehand.
+For example in `config/initializers/unleash.rb`.
 
+```ruby
+Sidekiq.configure_server do |config|
+  config.on(:startup) do
+    UNLEASH = Unleash::Client.new
+  end
+
+  config.on(:shutdown) do
+    UNLEASH.shutdown
+  end
+end
+```
 
 #### Set Unleash::Context
 
@@ -172,7 +295,8 @@ if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
 end
 ```
 
-If the feature is not found in the server, it will by default return false. However you can override that by setting the default return value to `true`:
+If the feature is not found in the server, it will by default return false.
+However you can override that by setting the default return value to `true`:
 
 ```ruby
 if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context, true
@@ -180,6 +304,40 @@ if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context, true
 end
 ```
 
+Another possibility is to send a block, [Lambda](https://ruby-doc.org/core-3.0.1/Kernel.html#method-i-lambda) or [Proc](https://ruby-doc.org/core-3.0.1/Proc.html#method-i-yield)
+to evaluate the default value:
+
+```ruby
+net_check_proc = proc do |feature_name, context|
+  context.remote_address.starts_with?("10.0.0.")
+end
+
+if UNLEASH.is_enabled?("AwesomeFeature", @unleash_context, &net_check_proc)
+  puts "AwesomeFeature is enabled by default if you are in the 10.0.0.* network."
+end
+```
+
+or
+
+```ruby
+awesomeness = 10
+@unleash_context.properties[:coolness] = 10
+
+if UNLEASH.is_enabled?("AwesomeFeature", @unleash_context) { |feat, ctx| awesomeness >= 6 && ctx.properties[:coolness] >= 8 }
+  puts "AwesomeFeature is enabled by default if both the user has a high enought coolness and the application has a high enough awesomeness"
+end
+```
+
+Note:
+- The block/lambda/proc can use feature name and context as an arguments.
+- The client will evaluate the fallback function once per call of `is_enabled()`.
+  Please keep this in mind when creating your fallback function!
+- The returned value of the block should be a boolean.
+  However the client will coerce the result to boolean via `!!`.
+- If both a `default_value` and `fallback_function` are supplied,
+  the client will define the default value by `OR`ing the default value and the output of the fallback function.
+
+
 Alternatively by using `if_enabled` you can send a code block to be executed as a parameter:
 
 ```ruby
@@ -188,6 +346,8 @@ UNLEASH.if_enabled "AwesomeFeature", @unleash_context, true do
 end
 ```
 
+Note: `if_enabled` only supports `default_value`, but not `fallback_function`.
+
 ##### Variations
 
 If no variant is found in the server, use the fallback variant.
@@ -199,6 +359,65 @@ variant = UNLEASH.get_variant "ColorVariants", @unleash_context, fallback_varian
 puts "variant color is: #{variant.payload.fetch('color')}"
 ```
 
+## Bootstrapping
+
+Bootstrap configuration allows the client to be initialized with a predefined set of toggle states.
+Bootstrapping can be configured by providing a bootstrap configuration when initializing the client.
+```ruby
+@unleash = Unleash::Client.new(
+    url: 'http://unleash.herokuapp.com/api',
+    app_name: 'my_ruby_app',
+    custom_http_headers: { 'Authorization': '<API token>' },
+    bootstrap_config: Unleash::Bootstrap::Configuration.new({
+        url: "http://unleash.herokuapp.com/api/client/features",
+        url_headers: {'Authorization': '<API token>'}
+    })
+)
+```
+The `Bootstrap::Configuration` initializer takes a hash with one of the following options specified:
+
+* `file_path` - An absolute or relative path to a file containing a JSON string of the response body from the Unleash server. This can also be set though the `UNLEASH_BOOTSTRAP_FILE` environment variable.
+* `url` - A url pointing to an Unleash server's features endpoint, the code sample above is illustrative. This can also be set though the `UNLEASH_BOOTSTRAP_URL` environment variable.
+* `url_headers` - Headers for the GET http request to the `url` above. Only used if the `url` parameter is also set. If this option isn't set then the bootstrapper will use the same url headers as the Unleash client.
+* `data` - A raw JSON string as returned by the Unleash server.
+* `block` - A lambda containing custom logic if you need it, an example is provided below.
+
+You should only specify one type of bootstrapping since only one will be invoked and the others will be ignored.
+The order of preference is as follows:
+
+- Select a data bootstrapper if it exists.
+- If no data bootstrapper exists, select the block bootstrapper.
+- If no block bootstrapper exists, select the file bootstrapper from either parameters or the specified environment variable.
+- If no file bootstrapper exists, then check for a URL bootstrapper from either the parameters or the specified environment variable.
+
+
+Example usage:
+
+First saving the toggles locally:
+```shell
+curl -H 'Authorization: <API token>' -XGET 'http://unleash.herokuapp.com/api' > ./default-toggles.json
+```
+
+Now using them on start up:
+
+```ruby
+
+custom_boostrapper = lambda {
+  File.read('./default-toggles.json')
+}
+
+@unleash = Unleash::Client.new(
+    app_name: 'my_ruby_app',
+    url: 'http://unleash.herokuapp.com/api',
+    custom_http_headers: { 'Authorization': '<API token>' },
+    bootstrap_config: Unleash::Bootstrap::Configuration.new({
+        block: custom_boostrapper
+    })
+)
+```
+
+This example could be easily achieved with a file bootstrapper, this is just to illustrate the usage of custom bootstrapping.
+Be aware that the client initializer will block until bootstrapping is complete.
 
 #### Client methods
 
@@ -211,6 +430,7 @@ Method Name | Description | Return Type |
 `shutdown` | Save metrics to disk, flush metrics to server, and then kill ToggleFetcher and MetricsReporter threads. A safe shutdown. Not really useful in long running applications, like web applications. | nil |
 `shutdown!` | Kill ToggleFetcher and MetricsReporter threads immediately. | nil |
 
+For the full method signatures, please see [client.rb](lib/unleash/client.rb)
 
 ## Local test client
 
@@ -228,6 +448,7 @@ This client comes with the all the required strategies out of the box:
 
  * ApplicationHostnameStrategy
  * DefaultStrategy
+ * FlexibleRolloutStrategy
  * GradualRolloutRandomStrategy
  * GradualRolloutSessionIdStrategy
  * GradualRolloutUserIdStrategy
@@ -235,7 +456,6 @@ This client comes with the all the required strategies out of the box:
  * UnknownStrategy
  * UserWithIdStrategy
 
-
 ## 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.