unleash 4.2.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c185b4a8d20c33f221a482a9f2b58fbf028c019513a89b528a491f738ec1308b
-  data.tar.gz: 8283a887720d6c8f9a72719a8ff4ff800fd88f3941d5f7d5cea83e4ea079a414
+  metadata.gz: 5788566712ad3909e6707041673d359a4d9835b59c79bf0e0fac80c7c8a164ed
+  data.tar.gz: 707f6875e73a10ef24fdce900aa7c179b0762eedda07ce83a41ea5ed76ba494f
 SHA512:
-  metadata.gz: 614df5b819537826bc575a1b6b061ca17561d2108c12e9b32581e458f37ca24beccc83046b1b59c9be0d2f2904087b92f6410f3d31bfa57b176228611a55d96e
-  data.tar.gz: 35528c4f4f5d39db50c13c7266ac620dec6cdb21154b6f0736dea2946e22b81270737d9085144894d7c1b96c858364ce44f5f948ba24f731e2f033ee0677d67c
+  metadata.gz: 5d836f1c130e5db08fdac81f75cb938e93c060f997946ec80bd5819ad098a9b6d7a6d5628f88cd70144899bbe72ac1f5a1e802b4973b6ee0d24eda85e783fab3
+  data.tar.gz: 69280e8af54ba2613ef3ae17206f0dfbd31a958d2595162dab71dd0d4cf5815d4dc3e023160c1edc1dbcaeea77d2cfd5f2e468af28051fe41b51dd77fae0f689

data/.github/workflows/add-to-project.yml

@@ -0,0 +1,14 @@
+name: Add new item to project board
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+      uses: unleash/.github/.github/workflows/add-item-to-project.yml@main
+      secrets: inherit

data/.github/workflows/pull_request.yml

@@ -5,8 +5,21 @@ on:
   pull_request:
 
 jobs:
-  test:
+  lint:
+    name: RuboCop
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "2.7"
+        bundler-cache: true
+    - name: Run RuboCop
+      run: bundle exec rubocop
 
+  test:
     runs-on: ${{ matrix.os }}-latest
 
     strategy:
@@ -18,7 +31,7 @@ jobs:
           - jruby-9.2
           - jruby-9.3
           - 3.1
-          - 3.0
+          - '3.0'
           - 2.7
           - 2.6
           - 2.5
@@ -33,14 +46,7 @@ jobs:
       - 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
+        run: git clone --depth 5 --branch v4.2.2 https://github.com/Unleash/client-specification.git client-specification
       - name: Run tests
         run: bundle exec rake
         env:

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -14,6 +13,7 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock
 
 # Clone of the client-specification
 /client-specification/

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require 'spec_helper'

data/.rubocop.yml

@@ -9,7 +9,7 @@ Naming/PredicateName:
 
 
 Metrics/ClassLength:
-  Max: 125
+  Max: 130
 Layout/LineLength:
   Max: 140
 Metrics/MethodLength:
@@ -34,6 +34,9 @@ Style/StringLiterals:
 Style/RedundantSelf:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/SymbolArray:
   EnforcedStyle: brackets
 Style/WordArray:

data/README.md

@@ -41,7 +41,7 @@ It is **required** to configure:
 - `app_name` with the name of the runninng application.
 - `custom_http_headers` with `{'Authorization': '<API token>'}` when using Unleash v4.0.0 and later.
 
-Please substitute the example `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+Please substitute the example `'https://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.
@@ -50,7 +50,7 @@ It is **highly recommended** to configure:
 ```ruby
 Unleash.configure do |config|
   config.app_name            = 'my_ruby_app'
-  config.url                 = 'http://unleash.herokuapp.com/api'
+  config.url                 = 'https://unleash.herokuapp.com/api'
   config.custom_http_headers = {'Authorization': '<API token>'}
 end
 ```
@@ -58,7 +58,23 @@ 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', custom_http_headers: {'Authorization': '<API token>'})
+UNLEASH = Unleash::Client.new(url: 'https://unleash.herokuapp.com/api', app_name: 'my_ruby_app', custom_http_headers: {'Authorization': '<API token>'})
+```
+
+## Dynamic custom HTTP headers
+If you need custom HTTP headers that change during the lifetime of the client, the `custom_http_headers` can be given as a `Proc`.
+
+```ruby
+Unleash.configure do |config|
+  config.app_name            = 'my_ruby_app'
+  config.url                 = 'https://unleash.herokuapp.com/api'
+  config.custom_http_headers =  proc do
+    {
+      'Authorization': '<API token>',
+      'X-Client-Request-Time': Time.now.iso8601
+    }
+  end
+end
 ```
 
 #### List of Arguments
@@ -74,13 +90,14 @@ Argument | Description | Required? |  Type |  Default Value|
 `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. As of Unleash v4.0.0, the `Authorization` header is required. For example: `{'Authorization': '<API token>'}` | 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/Proc | {} |
 `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. 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::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` |
+`strategies` | Strategies manager that holds all strategies and allows to add custom strategies | N | Unleash::Strategies | `Unleash::Strategies.new` |
 
 For a more in-depth look, please see `lib/unleash/configuration.rb`.
 
@@ -95,7 +112,7 @@ Environment Variable | Description
 require 'unleash'
 require 'unleash/context'
 
-@unleash = Unleash::Client.new(app_name: 'my_ruby_app', url: 'http://unleash.herokuapp.com/api', custom_http_headers: { 'Authorization': '<API token>' })
+@unleash = Unleash::Client.new(app_name: 'my_ruby_app', url: 'https://unleash.herokuapp.com/api', custom_http_headers: { 'Authorization': '<API token>' })
 
 feature_name = "AwesomeFeature"
 unleash_context = Unleash::Context.new
@@ -117,7 +134,7 @@ Put in `config/initializers/unleash.rb`:
 ```ruby
 Unleash.configure do |config|
   config.app_name = Rails.application.class.parent.to_s
-  config.url      = 'http://unleash.herokuapp.com/api'
+  config.url      = 'https://unleash.herokuapp.com/api'
   # config.instance_id = "#{Socket.gethostname}"
   config.logger   = Rails.logger
   config.environment = Rails.env
@@ -156,7 +173,7 @@ Then you may keep the client configuration still in `config/initializers/unleash
 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.url                 = 'https://unleash.herokuapp.com/api'
   config.custom_http_headers = {'Authorization': '<API token>'}
 end
 ```
@@ -204,7 +221,7 @@ on_worker_boot do
   ::UNLEASH = Unleash::Client.new(
     app_name: 'my_rails_app',
     environment: 'development',
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://unleash.herokuapp.com/api',
     custom_http_headers: {'Authorization': '<API token>'},
   )
 end
@@ -230,7 +247,7 @@ PhusionPassenger.on_event(:starting_worker_process) do |forked|
       # config.instance_id = "#{Socket.gethostname}"
       config.logger      = Rails.logger
       config.environment = Rails.env
-      config.url                 = 'http://unleash.herokuapp.com/api'
+      config.url                 = 'https://unleash.herokuapp.com/api'
       config.custom_http_headers = {'Authorization': '<API token>'}
     end
 
@@ -365,11 +382,11 @@ Bootstrap configuration allows the client to be initialized with a predefined se
 Bootstrapping can be configured by providing a bootstrap configuration when initializing the client.
 ```ruby
 @unleash = Unleash::Client.new(
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://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: "https://unleash.herokuapp.com/api/client/features",
         url_headers: {'Authorization': '<API token>'}
     })
 )
@@ -395,7 +412,7 @@ Example usage:
 
 First saving the toggles locally:
 ```shell
-curl -H 'Authorization: <API token>' -XGET 'http://unleash.herokuapp.com/api' > ./default-toggles.json
+curl -H 'Authorization: <API token>' -XGET 'https://unleash.herokuapp.com/api' > ./default-toggles.json
 ```
 
 Now using them on start up:
@@ -408,7 +425,7 @@ custom_boostrapper = lambda {
 
 @unleash = Unleash::Client.new(
     app_name: 'my_ruby_app',
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://unleash.herokuapp.com/api',
     custom_http_headers: { 'Authorization': '<API token>' },
     bootstrap_config: Unleash::Bootstrap::Configuration.new({
         block: custom_boostrapper
@@ -456,6 +473,27 @@ This client comes with the all the required strategies out of the box:
  * UnknownStrategy
  * UserWithIdStrategy
 
+## Custom Strategies
+
+Client allows to add [custom activation strategies](https://docs.getunleash.io/advanced/custom_activation_strategy) using configuration. 
+In order for strategy to work correctly it should support two methods `name` and `is_enabled?`
+
+```ruby
+class MyCustomStrategy
+  def name
+    'muCustomStrategy'
+  end
+  
+  def is_enabled?(params = {}, context = nil)
+    true
+  end
+end
+
+Unleash.configure do |config|
+  config.strategies.add(MyCustomStrategy.new)
+end
+```
+
 ## 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.

data/examples/bootstrap.rb

@@ -7,7 +7,7 @@ require 'unleash/bootstrap/configuration'
 puts ">> START bootstrap.rb"
 
 @unleash = Unleash::Client.new(
-  url: 'http://unleash.herokuapp.com/api',
+  url: 'https://unleash.herokuapp.com/api',
   custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
   app_name: 'bootstrap-test',
   instance_id: 'local-test-cli',

data/examples/simple.rb

@@ -6,7 +6,7 @@ require 'unleash/context'
 puts ">> START simple.rb"
 
 # Unleash.configure do |config|
-#   config.url = 'http://unleash.herokuapp.com/api'
+#   config.url = 'https://unleash.herokuapp.com/api'
 #   config.custom_http_headers = { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' }
 #   config.app_name = 'simple-test'
 #   config.refresh_interval = 2
@@ -18,7 +18,7 @@ puts ">> START simple.rb"
 # or:
 
 @unleash = Unleash::Client.new(
-  url: 'http://unleash.herokuapp.com/api',
+  url: 'https://unleash.herokuapp.com/api',
   custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
   app_name: 'simple-test',
   instance_id: 'local-test-cli',

data/lib/unleash/activation_strategy.rb

@@ -1,9 +1,10 @@
 module Unleash
   class ActivationStrategy
-    attr_accessor :name, :params, :constraints
+    attr_accessor :name, :params, :constraints, :disabled
 
     def initialize(name, params, constraints = [])
       self.name = name
+      self.disabled = false
 
       if params.is_a?(Hash)
         self.params = params
@@ -18,6 +19,7 @@ module Unleash
         self.constraints = constraints
       else
         Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (contraints: #{constraints})"
+        self.disabled = true
         self.constraints = []
       end
     end

data/lib/unleash/client.rb

@@ -12,7 +12,7 @@ module Unleash
     attr_accessor :fetcher_scheduled_executor, :metrics_scheduled_executor
 
     def initialize(*opts)
-      Unleash.configuration ||= Unleash::Configuration.new(*opts)
+      Unleash.configuration = Unleash::Configuration.new(*opts) unless opts.empty?
       Unleash.configuration.validate!
 
       Unleash.logger = Unleash.configuration.logger.clone
@@ -45,7 +45,7 @@ module Unleash
         return default_value
       end
 
-      toggle = Unleash::FeatureToggle.new(toggle_as_hash)
+      toggle = Unleash::FeatureToggle.new(toggle_as_hash, Unleash&.segment_cache)
 
       toggle.is_enabled?(context)
     end
@@ -110,7 +110,7 @@ module Unleash
         'appName': Unleash.configuration.app_name,
         'instanceId': Unleash.configuration.instance_id,
         'sdkVersion': "unleash-client-ruby:" + Unleash::VERSION,
-        'strategies': Unleash::STRATEGIES.keys,
+        'strategies': Unleash.strategies.keys,
         'started': Time.now.iso8601(Unleash::TIME_RESOLUTION),
         'interval': Unleash.configuration.metrics_interval_in_millis
       }

data/lib/unleash/configuration.rb

@@ -20,10 +20,11 @@ module Unleash
       :backup_file,
       :logger,
       :log_level,
-      :bootstrap_config
+      :bootstrap_config,
+      :strategies
 
     def initialize(opts = {})
-      ensure_valid_opts(opts)
+      validate_custom_http_headers!(opts[:custom_http_headers]) if opts.has_key?(:custom_http_headers)
       set_defaults
 
       initialize_default_logger if opts[:logger].nil?
@@ -40,7 +41,8 @@ module Unleash
       return if self.disable_client
 
       raise ArgumentError, "URL and app_name are required parameters." if self.app_name.nil? || self.url.nil?
-      raise ArgumentError, "custom_http_headers must be a hash." unless self.custom_http_headers.is_a?(Hash)
+
+      validate_custom_http_headers!(self.custom_http_headers)
     end
 
     def refresh_backup_file!
@@ -50,8 +52,9 @@ module Unleash
     def http_headers
       {
         'UNLEASH-INSTANCEID' => self.instance_id,
-        'UNLEASH-APPNAME' => self.app_name
-      }.merge(custom_http_headers.dup)
+        'UNLEASH-APPNAME' => self.app_name,
+        'Unleash-Client-Spec' => '4.2.2'
+      }.merge!(generate_custom_http_headers)
     end
 
     def fetch_toggles_uri
@@ -78,12 +81,6 @@ module Unleash
 
     private
 
-    def ensure_valid_opts(opts)
-      unless opts[:custom_http_headers].is_a?(Hash) || opts[:custom_http_headers].nil?
-        raise ArgumentError, "custom_http_headers must be a hash."
-      end
-    end
-
     def set_defaults
       self.app_name         = nil
       self.environment      = 'default'
@@ -99,12 +96,13 @@ module Unleash
       self.backup_file      = nil
       self.log_level        = Logger::WARN
       self.bootstrap_config = nil
+      self.strategies       = Unleash::Strategies.new
 
       self.custom_http_headers = {}
     end
 
     def initialize_default_logger
-      self.logger = Logger.new(STDOUT)
+      self.logger = Logger.new($stdout)
 
       # on default logger, use custom formatter that includes thread_name:
       self.logger.formatter = proc do |severity, datetime, _progname, msg|
@@ -118,6 +116,18 @@ module Unleash
       self
     end
 
+    def validate_custom_http_headers!(custom_http_headers)
+      return if custom_http_headers.is_a?(Hash) || custom_http_headers.respond_to?(:call)
+
+      raise ArgumentError, "custom_http_headers must be a Hash or a Proc."
+    end
+
+    def generate_custom_http_headers
+      return self.custom_http_headers.call if self.custom_http_headers.respond_to?(:call)
+
+      self.custom_http_headers
+    end
+
     def set_option(opt, val)
       __send__("#{opt}=", val)
     rescue NoMethodError

data/lib/unleash/constraint.rb

@@ -1,12 +1,11 @@
 require 'date'
-
 module Unleash
   class Constraint
     attr_accessor :context_name, :operator, :value, :inverted, :case_insensitive
 
     OPERATORS = {
-      IN: ->(context_v, constraint_v){ constraint_v.include? context_v },
-      NOT_IN: ->(context_v, constraint_v){ !constraint_v.include? context_v },
+      IN: ->(context_v, constraint_v){ constraint_v.include? context_v.to_s },
+      NOT_IN: ->(context_v, constraint_v){ !constraint_v.include? context_v.to_s },
       STR_STARTS_WITH: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.start_with? v } },
       STR_ENDS_WITH: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.end_with? v } },
       STR_CONTAINS: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.include? v } },
@@ -19,16 +18,21 @@ module Unleash
       DATE_BEFORE: ->(context_v, constraint_v){ on_valid_date(constraint_v, context_v){ |x, y| (x > y) } },
       SEMVER_EQ: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x == y) } },
       SEMVER_GT: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x < y) } },
-      SEMVER_LT: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x > y) } }
+      SEMVER_LT: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x > y) } },
+      FALLBACK_VALIDATOR: ->(_context_v, _constraint_v){ false }
     }.freeze
 
     LIST_OPERATORS = [:IN, :NOT_IN, :STR_STARTS_WITH, :STR_ENDS_WITH, :STR_CONTAINS].freeze
 
     def initialize(context_name, operator, value = [], inverted: false, case_insensitive: false)
       raise ArgumentError, "context_name is not a String" unless context_name.is_a?(String)
-      raise ArgumentError, "operator does not hold a valid value:" + OPERATORS.keys unless OPERATORS.include? operator.to_sym
 
-      self.validate_constraint_value_type(operator.to_sym, value)
+      unless OPERATORS.include? operator.to_sym
+        Unleash.logger.warn "Operator #{operator} is not a supported operator, " \
+          "falling back to FALLBACK_VALIDATOR which skips this constraint."
+        operator = "FALLBACK_VALIDATOR"
+      end
+      self.log_inconsistent_constraint_configuration(operator.to_sym, value)
 
       self.context_name = context_name
       self.operator = operator.to_sym
@@ -38,8 +42,8 @@ module Unleash
     end
 
     def matches_context?(context)
-      Unleash.logger.debug "Unleash::Constraint matches_context? value: #{self.value} context.get_by_name(#{self.context_name})" \
-        " #{context.get_by_name(self.context_name)} "
+      Unleash.logger.debug "Unleash::Constraint matches_context? value: #{self.value} context.get_by_name(#{self.context_name})"
+
       match = matches_constraint?(context)
       self.inverted ? !match : match
     rescue KeyError
@@ -79,19 +83,25 @@ module Unleash
     end
 
     # This should be a private method but for some reason this fails on Ruby 2.5
-    def validate_constraint_value_type(operator, value)
-      raise ArgumentError, "context_name is not an Array" if LIST_OPERATORS.include?(operator) && value.is_a?(String)
-      raise ArgumentError, "context_name is not a String" if !LIST_OPERATORS.include?(operator) && value.is_a?(Array)
+    def log_inconsistent_constraint_configuration(operator, value)
+      Unleash.logger.warn "value is a String, operator is expecting an Array" if LIST_OPERATORS.include?(operator) && value.is_a?(String)
+      Unleash.logger.warn "value is an Array, operator is expecting a String" if !LIST_OPERATORS.include?(operator) && value.is_a?(Array)
     end
 
     private
 
     def matches_constraint?(context)
+      Unleash.logger.debug "Unleash::Constraint matches_constraint? value: #{self.value} operator: #{self.operator} " \
+        " context.get_by_name(#{self.context_name})"
+
       unless OPERATORS.include?(self.operator)
         Unleash.logger.warn "Invalid constraint operator: #{self.operator}, this should be unreachable. Always returning false."
         false
       end
 
+      # when the operator is NOT_IN and there is no data, return true. In all other cases the operator doesn't match.
+      return self.operator == :NOT_IN unless context.include?(self.context_name)
+
       v = self.value.dup
       context_value = context.get_by_name(self.context_name)
 

data/lib/unleash/context.rb

@@ -33,6 +33,13 @@ module Unleash
       end
     end
 
+    def include?(name)
+      normalized_name = underscore(name)
+      return self.instance_variable_defined? "@#{normalized_name}" if ATTRS.include? normalized_name.to_sym
+
+      self.properties.include?(normalized_name.to_sym) || self.properties.include?(name.to_sym)
+    end
+
     private
 
     # Method to fetch values from hash for two types of keys: string in camelCase and symbol in snake_case

data/lib/unleash/feature_toggle.rb

@@ -9,13 +9,13 @@ module Unleash
   class FeatureToggle
     attr_accessor :name, :enabled, :strategies, :variant_definitions
 
-    def initialize(params = {})
+    def initialize(params = {}, segment_map = {})
       params = {} if params.nil?
 
       self.name       = params.fetch('name', nil)
       self.enabled    = params.fetch('enabled', false)
 
-      self.strategies = initialize_strategies(params)
+      self.strategies = initialize_strategies(params, segment_map)
       self.variant_definitions = initialize_variant_definitions(params)
     end
 
@@ -75,12 +75,14 @@ module Unleash
     end
 
     def strategy_enabled?(strategy, context)
-      r = Unleash::STRATEGIES.fetch(strategy.name.to_sym, :unknown).is_enabled?(strategy.params, context)
+      r = Unleash.strategies.fetch(strategy.name).is_enabled?(strategy.params, context)
       Unleash.logger.debug "Unleash::FeatureToggle.strategy_enabled? Strategy #{strategy.name} returned #{r} with context: #{context}"
       r
     end
 
     def strategy_constraint_matches?(strategy, context)
+      return false if strategy.disabled
+
       strategy.constraints.empty? || strategy.constraints.all?{ |c| c.matches_context?(context) }
     end
 
@@ -128,26 +130,35 @@ module Unleash
       context
     end
 
-    def initialize_strategies(params)
+    def initialize_strategies(params, segment_map)
       params.fetch('strategies', [])
-        .select{ |s| s.has_key?('name') && Unleash::STRATEGIES.has_key?(s['name'].to_sym) }
+        .select{ |s| s.has_key?('name') && Unleash.strategies.includes?(s['name']) }
         .map do |s|
           ActivationStrategy.new(
             s['name'],
             s['parameters'],
-            (s['constraints'] || []).map do |c|
-              Constraint.new(
-                c.fetch('contextName'),
-                c.fetch('operator'),
-                c.fetch('values', nil) || c.fetch('value', nil),
-                inverted: c.fetch('inverted', false),
-                case_insensitive: c.fetch('caseInsensitive', false)
-              )
-            end
+            resolve_constraints(s, segment_map)
           )
         end || []
     end
 
+    def resolve_constraints(strategy, segment_map)
+      segment_constraints = (strategy["segments"] || []).map do |segment_id|
+        segment_map[segment_id]&.fetch("constraints")
+      end
+      (strategy.fetch("constraints", []) + segment_constraints).flatten.map do |constraint|
+        return nil if constraint.nil?
+
+        Constraint.new(
+          constraint.fetch('contextName'),
+          constraint.fetch('operator'),
+          constraint.fetch('value', nil) || constraint.fetch('values', nil),
+          inverted: constraint.fetch('inverted', false),
+          case_insensitive: constraint.fetch('caseInsensitive', false)
+        )
+      end
+    end
+
     def initialize_variant_definitions(params)
       (params.fetch('variants', []) || [])
         .select{ |v| v.is_a?(Hash) && v.has_key?('name') }

data/lib/unleash/strategies.rb

@@ -0,0 +1,80 @@
+require 'unleash/strategy/base'
+Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path }
+
+module Unleash
+  class Strategies
+    def initialize
+      @strategies = {}
+      register_strategies
+    end
+
+    def keys
+      @strategies.keys
+    end
+
+    def includes?(name)
+      @strategies.has_key?(name.to_s)
+    end
+
+    def fetch(name)
+      raise Unleash::Strategy::NotImplemented, "Strategy is not implemented" unless (strategy = @strategies[name.to_s])
+
+      strategy
+    end
+
+    def add(strategy)
+      @strategies[strategy.name] = strategy
+    end
+
+    def []=(key, strategy)
+      warn_deprecated_registration(strategy, 'modifying Unleash::STRATEGIES')
+      @strategies[key.to_s] = strategy
+    end
+
+    def [](key)
+      @strategies[key.to_s]
+    end
+
+    def register_strategies
+      register_base_strategies
+      register_custom_strategies
+    end
+
+    protected
+
+    # Deprecated: Use Unleash.configuration to add custom strategies
+    def register_custom_strategies
+      Unleash::Strategy.constants
+        .select{ |c| Unleash::Strategy.const_get(c).is_a? Class }
+        .reject{ |c| ['NotImplemented', 'Base'].include?(c.to_s) } # Reject abstract classes
+        .map{ |c| Object.const_get("Unleash::Strategy::#{c}") }
+        .reject{ |c| DEFAULT_STRATEGIES.include?(c) } # Reject base classes
+        .each do |c|
+        strategy = c.new
+        warn_deprecated_registration(strategy, 'adding custom class into Unleash::Strategy namespace')
+        self.add(strategy)
+      end
+    end
+
+    def register_base_strategies
+      DEFAULT_STRATEGIES.each{ |c| self.add(c.new) }
+    end
+
+    DEFAULT_STRATEGIES = [
+      Unleash::Strategy::ApplicationHostname,
+      Unleash::Strategy::Default,
+      Unleash::Strategy::FlexibleRollout,
+      Unleash::Strategy::GradualRolloutRandom,
+      Unleash::Strategy::GradualRolloutSessionId,
+      Unleash::Strategy::GradualRolloutUserId,
+      Unleash::Strategy::RemoteAddress,
+      Unleash::Strategy::UserWithId
+    ].freeze
+
+    def warn_deprecated_registration(strategy, method)
+      warn "[DEPRECATED] Registering custom Unleash strategy by #{method} is deprecated.
+             Please use Unleash configuration to register custom strategy: " \
+           "`Unleash.configure {|c| c.strategies.add(#{strategy.class.name}.new) }`"
+    end
+  end
+end

data/lib/unleash/strategy/flexible_rollout.rb

@@ -10,7 +10,7 @@ module Unleash
       # need: params['percentage']
       def is_enabled?(params = {}, context = nil)
         return false unless params.is_a?(Hash)
-        return false unless context.class.name == 'Unleash::Context'
+        return false unless context.instance_of?(Unleash::Context)
 
         stickiness = params.fetch('stickiness', 'default')
         stickiness_id = resolve_stickiness(stickiness, context)

data/lib/unleash/strategy/gradual_rollout_sessionid.rb

@@ -10,7 +10,7 @@ module Unleash
       # need: params['percentage'], params['groupId'], context.user_id,
       def is_enabled?(params = {}, context = nil)
         return false unless params.is_a?(Hash) && params.has_key?('percentage')
-        return false unless context.class.name == 'Unleash::Context'
+        return false unless context.instance_of?(Unleash::Context)
         return false if context.session_id.nil? || context.session_id.empty?
 
         percentage = Integer(params['percentage'] || 0)

data/lib/unleash/strategy/gradual_rollout_userid.rb

@@ -10,7 +10,7 @@ module Unleash
       # need: params['percentage'], params['groupId'], context.user_id,
       def is_enabled?(params = {}, context = nil, _constraints = [])
         return false unless params.is_a?(Hash) && params.has_key?('percentage')
-        return false unless context.class.name == 'Unleash::Context'
+        return false unless context.instance_of?(Unleash::Context)
         return false if context.user_id.nil? || context.user_id.empty?
 
         percentage = Integer(params['percentage'] || 0)

data/lib/unleash/strategy/remote_address.rb

@@ -11,7 +11,7 @@ module Unleash
       def is_enabled?(params = {}, context = nil)
         return false unless params.is_a?(Hash) && params.has_key?(PARAM)
         return false unless params.fetch(PARAM, nil).is_a? String
-        return false unless context.class.name == 'Unleash::Context'
+        return false unless context.instance_of?(Unleash::Context)
 
         remote_address = ipaddr_or_nil_from_str(context.remote_address)
 

data/lib/unleash/strategy/user_with_id.rb

@@ -11,7 +11,7 @@ module Unleash
       def is_enabled?(params = {}, context = nil)
         return false unless params.is_a?(Hash) && params.has_key?(PARAM)
         return false unless params.fetch(PARAM, nil).is_a? String
-        return false unless context.class.name == 'Unleash::Context'
+        return false unless context.instance_of?(Unleash::Context)
 
         params[PARAM].split(",").map(&:strip).include?(context.user_id)
       end

data/lib/unleash/toggle_fetcher.rb

@@ -5,11 +5,12 @@ require 'json'
 
 module Unleash
   class ToggleFetcher
-    attr_accessor :toggle_cache, :toggle_lock, :toggle_resource, :etag, :retry_count
+    attr_accessor :toggle_cache, :toggle_lock, :toggle_resource, :etag, :retry_count, :segment_cache
 
     def initialize
       self.etag = nil
       self.toggle_cache = nil
+      self.segment_cache = nil
       self.toggle_lock = Mutex.new
       self.toggle_resource = ConditionVariable.new
       self.retry_count = 0
@@ -65,24 +66,20 @@ module Unleash
 
     def save!
       Unleash.logger.debug "Will save toggles to disk now"
-      begin
-        backup_file = Unleash.configuration.backup_file
-        backup_file_tmp = "#{backup_file}.tmp"
 
-        self.toggle_lock.synchronize do
-          file = File.open(backup_file_tmp, "w")
+      backup_file = Unleash.configuration.backup_file
+      backup_file_tmp = "#{backup_file}.tmp"
+
+      self.toggle_lock.synchronize do
+        File.open(backup_file_tmp, "w") do |file|
           file.write(self.toggle_cache.to_json)
-          file.close
-          File.rename(backup_file_tmp, backup_file)
         end
-      rescue StandardError => e
-        # This is not really the end of the world. Swallowing the exception.
-        Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
-        Unleash.logger.error "stacktrace: #{e.backtrace}"
-      ensure
-        file&.close if defined?(file)
-        self.toggle_lock.unlock if self.toggle_lock.locked?
+        File.rename(backup_file_tmp, backup_file)
       end
+    rescue StandardError => e
+      # This is not really the end of the world. Swallowing the exception.
+      Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
+      Unleash.logger.error "stacktrace: #{e.backtrace}"
     end
 
     private
@@ -99,9 +96,10 @@ module Unleash
     end
 
     def update_running_client!
-      if Unleash.toggles != self.toggles
+      if Unleash.toggles != self.toggles["features"] || Unleash.segment_cache != self.toggles["segments"]
         Unleash.logger.info "Updating toggles to main client, there has been a change in the server."
-        Unleash.toggles = self.toggles
+        Unleash.toggles = self.toggles["features"]
+        Unleash.segment_cache = self.toggles["segments"]
       end
     end
 
@@ -110,22 +108,15 @@ module Unleash
       backup_file = Unleash.configuration.backup_file
       return nil unless File.exist?(backup_file)
 
-      begin
-        file = File.new(backup_file, "r")
-        file_content = file.read
-
-        backup_as_hash = JSON.parse(file_content)
-        synchronize_with_local_cache!(backup_as_hash)
-        update_running_client!
-      rescue IOError => e
-        Unleash.logger.error "Unable to read the backup_file: #{e}"
-      rescue JSON::ParserError => e
-        Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
-      rescue StandardError => e
-        Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
-      ensure
-        file&.close
-      end
+      backup_as_hash = JSON.parse(File.read(backup_file))
+      synchronize_with_local_cache!(backup_as_hash)
+      update_running_client!
+    rescue IOError => e
+      Unleash.logger.error "Unable to read the backup_file: #{e}"
+    rescue JSON::ParserError => e
+      Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
+    rescue StandardError => e
+      Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
     end
 
     def bootstrap
@@ -137,10 +128,19 @@ module Unleash
       Unleash.configuration.bootstrap_config = nil
     end
 
+    def build_segment_map(segments_array)
+      return {} if segments_array.nil?
+
+      segments_array.map{ |segment| [segment["id"], segment] }.to_h
+    end
+
     # @param response_body [String]
     def get_features(response_body)
       response_hash = JSON.parse(response_body)
-      return response_hash['features'] if response_hash['version'] >= 1
+
+      if response_hash['version'] >= 1
+        return { "features" => response_hash["features"], "segments" => build_segment_map(response_hash["segments"]) }
+      end
 
       raise NotImplemented, "Version of features provided by unleash server" \
         " is unsupported by this client."

data/lib/unleash/variant_definition.rb

@@ -4,7 +4,7 @@ module Unleash
   class VariantDefinition
     attr_accessor :name, :weight, :payload, :overrides, :stickiness
 
-    def initialize(name, weight = 0, payload = nil, stickiness = nil, overrides = [])
+    def initialize(name, weight = 0, payload = nil, stickiness = nil, overrides = []) # rubocop:disable Metrics/ParameterLists
       self.name = name
       self.weight = weight
       self.payload = payload

data/lib/unleash/variant_override.rb

@@ -14,7 +14,7 @@ module Unleash
     end
 
     def matches_context?(context)
-      raise ArgumentError, 'context must be of class Unleash::Context' unless context.class.name == 'Unleash::Context'
+      raise ArgumentError, 'context must be of class Unleash::Context' unless context.instance_of?(Unleash::Context)
 
       context_value =
         case self.context_name

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.2.1".freeze
+  VERSION = "4.4.0".freeze
 end

data/lib/unleash.rb

@@ -1,35 +1,31 @@
 require 'unleash/version'
 require 'unleash/configuration'
-require 'unleash/strategy/base'
+require 'unleash/strategies'
 require 'unleash/context'
 require 'unleash/client'
 require 'logger'
 
-Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path unless path.end_with? '_spec.rb' }
-
 module Unleash
   TIME_RESOLUTION = 3
 
-  STRATEGIES = Unleash::Strategy.constants
-    .select{ |c| Unleash::Strategy.const_get(c).is_a? Class }
-    .reject{ |c| ['NotImplemented', 'Base'].include?(c.to_s) }
-    .map do |c|
-      lowered_c = c.to_s
-      lowered_c[0] = lowered_c[0].downcase
-      [lowered_c.to_sym, Object.const_get("Unleash::Strategy::#{c}").new]
-    end
-    .to_h
-
   class << self
-    attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :logger
+    attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :segment_cache, :logger
   end
 
+  self.configuration = Unleash::Configuration.new
+
+  # Deprecated: Use Unleash.configure to add custom strategies
+  STRATEGIES = self.configuration.strategies
+
   # Support for configuration via yield:
   def self.configure
-    self.configuration ||= Unleash::Configuration.new
     yield(configuration)
 
     self.configuration.validate!
     self.configuration.refresh_backup_file!
   end
+
+  def self.strategies
+    self.configuration.strategies
+  end
 end

data/unleash-client.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-json_expectations", "~> 2.2"
   spec.add_development_dependency "webmock", "~> 3.8"
 
-  spec.add_development_dependency "rubocop", "~> 0.80"
+  spec.add_development_dependency "rubocop", "~> 1.28.2"
   spec.add_development_dependency "simplecov", "~> 0.21.2"
   spec.add_development_dependency "simplecov-lcov", "~> 0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.28.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.28.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/add-to-project.yml"
 - ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rspec"
@@ -175,6 +176,7 @@ files:
 - lib/unleash/metrics.rb
 - lib/unleash/metrics_reporter.rb
 - lib/unleash/scheduled_executor.rb
+- lib/unleash/strategies.rb
 - lib/unleash/strategy/application_hostname.rb
 - lib/unleash/strategy/base.rb
 - lib/unleash/strategy/default.rb
@@ -211,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Unleash feature toggle client.