unleash 3.2.5 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1535ef477a380d94767952c3d4a660ab029bf78100f7d30246ff211517172f2
-  data.tar.gz: b357d2bda18a9b1378988d4467b78cbe02129b519578272da7fd0259cada97d0
+  metadata.gz: 4ce69a2f4588a0d5e459e76aa8d78894497736f484ae20f5d987d50b34aced50
+  data.tar.gz: 24222c2c023197dc4f283ee4e09316f233245b2e82ca4c9ad934fe5519de75d5
 SHA512:
-  metadata.gz: e1fe0ae8b8ff86fdbe3c0d9a68b0d559112a9d568bcb8762f946d191b33ee8bdcd25bad63983d6b507269534309690fc2f858c5989b287004e5df2a3b8755e36
-  data.tar.gz: 8e05aeb05427eaa6e0391703aa524902c3094be21c176a374093ec5263b2a2fcc4b9bce4ab2fb9627d18ecf822dfbd1f8cfecaaba8a9517ae96f9efd687ab1a8
+  metadata.gz: 6e056f24c5f840b211f04bc3c605ccf0846d1ff8717cc824d1e50307e636f28c50f91a8fe85f648de9f16377d5441d5feea459a15ad1eae00c35a6238ebb0355
+  data.tar.gz: 51b49947d4aea7d1901bf0083ef366604b5d1cd7859cab1cfaceacc420fb056c4188dd4512c1a7feddc5f9711e0c5ad2660e91c1e681cd57e47307f29948790c

data/.github/workflows/pull_request.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        ruby-version:
+          - jruby
+          - 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.0.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

@@ -14,17 +14,19 @@ Layout/LineLength:
 Metrics/MethodLength:
   Max: 20
 Metrics/BlockLength:
-  Max: 100
+  Max: 110
   Exclude:
+    - 'spec/unleash/configuration_spec.rb'
     - 'spec/unleash/client_spec.rb'
+    - 'spec/unleash/context_spec.rb'
     - 'spec/unleash/feature_toggle_spec.rb'
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 28
 Metrics/CyclomaticComplexity:
   Max: 9
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 10
 
 Style/Documentation:
   Enabled: false
@@ -51,6 +53,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 +68,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 +131,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

@@ -21,7 +21,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 3.2.5'
+gem 'unleash', '~> 4.0.0'
 ```
 
 And then execute:
@@ -34,22 +34,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,16 +67,17 @@ 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 | 30 |
 `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 |
 `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` |
 
 For in a more in depth look, please see `lib/unleash/configuration.rb`.
 
@@ -80,7 +88,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,8 +109,8 @@ 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
@@ -122,9 +130,10 @@ 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.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
   Rails.configuration.unleash = Unleash::Client.new
 end
@@ -132,6 +141,28 @@ end
 
 Instead of the configuration in `config/initializers/unleash.rb`.
 
+#### 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
+end
+```
 
 #### Set Unleash::Context
 
@@ -180,6 +211,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 +253,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.
@@ -211,6 +278,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 +296,7 @@ This client comes with the all the required strategies out of the box:
 
  * ApplicationHostnameStrategy
  * DefaultStrategy
+ * FlexibleRolloutStrategy
  * GradualRolloutRandomStrategy
  * GradualRolloutSessionIdStrategy
  * GradualRolloutUserIdStrategy

data/bin/unleash-client

@@ -12,11 +12,13 @@ options = {
   url: 'http://localhost:4242',
   demo: false,
   disable_metrics: true,
+  custom_http_headers: {},
   sleep: 0.1
 }
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{__FILE__} [options] feature [key1=val1] [key2=val2]"
+  opts.banner = "Usage: #{__FILE__} [options] feature [contextKey1=val1] [contextKey2=val2] \n\n" \
+  "Where contextKey1 could be user_id, session_id, remote_address or any field in the Context class (or any property within it).\n"
 
   opts.on("-V", "--variant", "Fetch variant for feature") do |v|
     options[:variant] = v
@@ -46,6 +48,13 @@ OptionParser.new do |opts|
     options[:sleep] = s
   end
 
+  opts.on("-H", "--http-headers='Authorization: *:developement.secretstring'",
+          "Adds http headers to all requests on the unleash server. Use multiple times for multiple headers.") do |h|
+    http_header_as_hash = [h].to_h{ |l| l.split(": ") }.transform_keys(&:to_sym)
+
+    options[:custom_http_headers].merge!(http_header_as_hash)
+  end
+
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -70,10 +79,11 @@ log_level = \
   url: options[:url],
   app_name: 'unleash-client-ruby-cli',
   disable_metrics: options[:metrics],
+  custom_http_headers: options[:custom_http_headers],
   log_level: log_level
 )
 
-context_params = ARGV.map{ |e| e.split("=") }.map{ |k, v| [k.to_sym, v] }.to_h
+context_params = ARGV.to_h{ |l| l.split("=") }.transform_keys(&:to_sym)
 context_properties = context_params.reject{ |k, _v| [:user_id, :session_id, :remote_address].include? k }
 context_params.select!{ |k, _v| [:user_id, :session_id, :remote_address].include? k }
 context_params.merge!(properties: context_properties) unless context_properties.nil?
@@ -97,12 +107,12 @@ if options[:demo]
   end
 elsif options[:variant]
   variant = @unleash.get_variant(feature_name, unleash_context)
-  puts " For feature \'#{feature_name}\' got variant \'#{variant}\'"
+  puts " For feature '#{feature_name}' got variant '#{variant}'"
 else
   if @unleash.is_enabled?(feature_name, unleash_context)
-    puts " \'#{feature_name}\' is enabled according to unleash"
+    puts " '#{feature_name}' is enabled according to unleash"
   else
-    puts " \'#{feature_name}\' is disabled according to unleash"
+    puts " '#{feature_name}' is disabled according to unleash"
   end
 end
 

data/examples/simple.rb

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

data/lib/unleash/client.rb

@@ -28,9 +28,15 @@ module Unleash
       start_metrics unless Unleash.configuration.disable_metrics
     end
 
-    def is_enabled?(feature, context = nil, default_value = false)
+    def is_enabled?(feature, context = nil, default_value_param = false, &fallback_blk)
       Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} with context #{context}"
 
+      default_value = if block_given?
+                        default_value_param || !!fallback_blk.call(feature, context)
+                      else
+                        default_value_param
+                      end
+
       if Unleash.configuration.disable_client
         Unleash.logger.warn "unleash_client is disabled! Always returning #{default_value} for feature #{feature}!"
         return default_value
@@ -56,19 +62,19 @@ module Unleash
       yield(blk) if is_enabled?(feature, context, default_value)
     end
 
-    def get_variant(feature, context = nil, fallback_variant = nil)
+    def get_variant(feature, context = Unleash::Context.new, fallback_variant = disabled_variant)
       Unleash.logger.debug "Unleash::Client.get_variant for feature: #{feature} with context #{context}"
 
       if Unleash.configuration.disable_client
         Unleash.logger.debug "unleash_client is disabled! Always returning #{fallback_variant} for feature #{feature}!"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
       if toggle_as_hash.nil?
         Unleash.logger.debug "Unleash::Client.get_variant feature: #{feature} not found"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       toggle = Unleash::FeatureToggle.new(toggle_as_hash)
@@ -76,7 +82,7 @@ module Unleash
 
       if variant.nil?
         Unleash.logger.debug "Unleash::Client.get_variant variants for feature: #{feature} not found"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       # TODO: Add to README: name, payload, enabled (bool)
@@ -88,7 +94,7 @@ module Unleash
     def shutdown
       unless Unleash.configuration.disable_client
         Unleash.toggle_fetcher.save!
-        Unleash.reporter.send unless Unleash.configuration.disable_metrics
+        Unleash.reporter.post unless Unleash.configuration.disable_metrics
         shutdown!
       end
     end
@@ -135,7 +141,7 @@ module Unleash
         Unleash.configuration.retry_limit
       )
       self.metrics_scheduled_executor.run do
-        Unleash.reporter.send
+        Unleash.reporter.post
       end
     end
 
@@ -144,12 +150,16 @@ module Unleash
 
       # Send the request, if possible
       begin
-        response = Unleash::Util::Http.post(Unleash.configuration.client_register_url, info.to_json)
+        response = Unleash::Util::Http.post(Unleash.configuration.client_register_uri, info.to_json)
       rescue StandardError => e
         Unleash.logger.error "unable to register client with unleash server due to exception #{e.class}:'#{e}'."
         Unleash.logger.error "stacktrace: #{e.backtrace}"
       end
       Unleash.logger.debug "client registered: #{response}"
     end
+
+    def disabled_variant
+      @disabled_variant ||= Unleash::FeatureToggle.disabled_variant
+    end
   end
 end

data/lib/unleash/configuration.rb

@@ -8,6 +8,7 @@ module Unleash
       :app_name,
       :environment,
       :instance_id,
+      :project_name,
       :custom_http_headers,
       :disable_client,
       :disable_metrics,
@@ -41,7 +42,7 @@ module Unleash
     end
 
     def refresh_backup_file!
-      self.backup_file = Dir.tmpdir + "/unleash-#{app_name}-repo.json" if self.backup_file.nil?
+      self.backup_file = File.join(Dir.tmpdir, "unleash-#{app_name}-repo.json")
     end
 
     def http_headers
@@ -51,16 +52,22 @@ module Unleash
       }.merge(custom_http_headers.dup)
     end
 
-    def fetch_toggles_url
-      self.url + '/client/features'
+    def fetch_toggles_uri
+      uri = URI("#{self.url_stripped_of_slash}/client/features")
+      uri.query = "project=#{self.project_name}" unless self.project_name.nil?
+      uri
     end
 
-    def client_metrics_url
-      self.url + '/client/metrics'
+    def client_metrics_uri
+      URI("#{self.url_stripped_of_slash}/client/metrics")
     end
 
-    def client_register_url
-      self.url + '/client/register'
+    def client_register_uri
+      URI("#{self.url_stripped_of_slash}/client/register")
+    end
+
+    def url_stripped_of_slash
+      self.url.delete_suffix '/'
     end
 
     private
@@ -76,6 +83,7 @@ module Unleash
       self.environment      = 'default'
       self.url              = nil
       self.instance_id      = SecureRandom.uuid
+      self.project_name     = nil
       self.disable_client   = false
       self.disable_metrics  = false
       self.refresh_interval = 10

data/lib/unleash/context.rb

@@ -28,7 +28,7 @@ module Unleash
       if ATTRS.include? normalized_name
         self.send(normalized_name)
       else
-        self.properties.fetch(normalized_name)
+        self.properties.fetch(normalized_name, nil) || self.properties.fetch(name.to_sym)
       end
     end
 

data/lib/unleash/feature_toggle.rb

@@ -32,23 +32,30 @@ module Unleash
       result
     end
 
-    def get_variant(context, fallback_variant = disabled_variant)
+    def get_variant(context, fallback_variant = Unleash::FeatureToggle.disabled_variant)
       raise ArgumentError, "Provided fallback_variant is not of type Unleash::Variant" if fallback_variant.class.name != 'Unleash::Variant'
 
       context = ensure_valid_context(context)
 
-      return disabled_variant unless self.enabled && am_enabled?(context, true)
-      return disabled_variant if sum_variant_defs_weights <= 0
+      return Unleash::FeatureToggle.disabled_variant unless self.enabled && am_enabled?(context, true)
+      return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights <= 0
 
-      variant = variant_from_override_match(context)
-      variant = variant_from_weights(context) if variant.nil?
+      variant = variant_from_override_match(context) || variant_from_weights(context, resolve_stickiness)
 
       Unleash.toggle_metrics.increment_variant(self.name, variant.name) unless Unleash.configuration.disable_metrics
       variant
     end
 
+    def self.disabled_variant
+      Unleash::Variant.new(name: 'disabled', enabled: false)
+    end
+
     private
 
+    def resolve_stickiness
+      self.variant_definitions&.map(&:stickiness)&.compact&.first || "default"
+    end
+
     # only check if it is enabled, do not do metrics
     def am_enabled?(context, default_result)
       result =
@@ -77,15 +84,12 @@ module Unleash
       strategy.constraints.empty? || strategy.constraints.all?{ |c| c.matches_context?(context) }
     end
 
-    def disabled_variant
-      Unleash::Variant.new(name: 'disabled', enabled: false)
-    end
-
     def sum_variant_defs_weights
       self.variant_definitions.map(&:weight).reduce(0, :+)
     end
 
-    def variant_salt(context)
+    def variant_salt(context, stickiness = "default")
+      return context.get_by_name(stickiness) unless stickiness == "default"
       return context.user_id unless context.user_id.to_s.empty?
       return context.session_id unless context.session_id.to_s.empty?
       return context.remote_address unless context.remote_address.to_s.empty?
@@ -100,8 +104,8 @@ module Unleash
       Unleash::Variant.new(name: variant.name, enabled: true, payload: variant.payload)
     end
 
-    def variant_from_weights(context)
-      variant_weight = Unleash::Strategy::Util.get_normalized_number(variant_salt(context), self.name, sum_variant_defs_weights)
+    def variant_from_weights(context, stickiness)
+      variant_weight = Unleash::Strategy::Util.get_normalized_number(variant_salt(context, stickiness), self.name, sum_variant_defs_weights)
       prev_weights = 0
 
       variant_definition = self.variant_definitions
@@ -110,7 +114,7 @@ module Unleash
           prev_weights += v.weight
           res
         end
-      return disabled_variant if variant_definition.nil?
+      return self.disabled_variant if variant_definition.nil?
 
       Unleash::Variant.new(name: variant_definition.name, enabled: true, payload: variant_definition.payload)
     end
@@ -150,6 +154,7 @@ module Unleash
             v.fetch('name', ''),
             v.fetch('weight', 0),
             v.fetch('payload', nil),
+            v.fetch('stickiness', nil),
             v.fetch('overrides', [])
           )
         end || []

data/lib/unleash/metrics_reporter.rb

@@ -6,6 +6,8 @@ require 'time'
 
 module Unleash
   class MetricsReporter
+    LONGEST_WITHOUT_A_REPORT = 600
+
     attr_accessor :last_time
 
     def initialize
@@ -33,16 +35,28 @@ module Unleash
       report
     end
 
-    def send
-      Unleash.logger.debug "send() Report"
+    def post
+      Unleash.logger.debug "post() Report"
+
+      if bucket_empty? && (Time.now - self.last_time < LONGEST_WITHOUT_A_REPORT) # and last time is less then 10 minutes...
+        Unleash.logger.debug "Report not posted to server, as it would have been empty. (and has been empty for up to 10 min)"
+
+        return
+      end
 
-      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_url, self.generate_report.to_json)
+      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, self.generate_report.to_json)
 
       if ['200', '202'].include? response.code
-        Unleash.logger.debug "Report sent to unleash server sucessfully. Server responded with http code #{response.code}"
+        Unleash.logger.debug "Report sent to unleash server successfully. Server responded with http code #{response.code}"
       else
         Unleash.logger.error "Error when sending report to unleash server. Server responded with http code #{response.code}."
       end
     end
+
+    private
+
+    def bucket_empty?
+      Unleash.toggle_metrics.features.empty?
+    end
   end
 end

data/lib/unleash/strategy/application_hostname.rb

@@ -4,6 +4,7 @@ module Unleash
   module Strategy
     class ApplicationHostname < Base
       attr_accessor :hostname
+
       PARAM = 'hostnames'.freeze
 
       def initialize

data/lib/unleash/strategy/flexible_rollout.rb

@@ -38,16 +38,16 @@ module Unleash
 
       def resolve_stickiness(stickiness, context)
         case stickiness
-        when 'userId'
-          context.user_id
-        when 'sessionId'
-          context.session_id
         when 'random'
           random
         when 'default'
           context.user_id || context.session_id || random
         else
-          nil
+          begin
+            context.get_by_name(stickiness)
+          rescue KeyError
+            nil
+          end
         end
       end
     end

data/lib/unleash/toggle_fetcher.rb

@@ -36,7 +36,7 @@ module Unleash
     # rename to refresh_from_server!  ??
     def fetch
       Unleash.logger.debug "fetch()"
-      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_url, etag)
+      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag)
 
       if response.code == '304'
         Unleash.logger.debug "No changes according to the unleash server, nothing to do."
@@ -106,10 +106,11 @@ module Unleash
 
     def read!
       Unleash.logger.debug "read!()"
-      return nil unless File.exist?(Unleash.configuration.backup_file)
+      backup_file = Unleash.configuration.backup_file
+      return nil unless File.exist?(backup_file)
 
       begin
-        file = File.new(Unleash.configuration.backup_file, "r")
+        file = File.new(backup_file, "r")
         file_content = file.read
 
         backup_as_hash = JSON.parse(file_content)

data/lib/unleash/util/http.rb

@@ -4,8 +4,7 @@ require 'uri'
 module Unleash
   module Util
     module Http
-      def self.get(url, etag = nil)
-        uri = URI(url)
+      def self.get(uri, etag = nil)
         http = http_connection(uri)
 
         request = Net::HTTP::Get.new(uri.request_uri, http_headers(etag))
@@ -13,8 +12,7 @@ module Unleash
         http.request(request)
       end
 
-      def self.post(url, body)
-        uri = URI(url)
+      def self.post(uri, body)
         http = http_connection(uri)
 
         request = Net::HTTP::Post.new(uri.request_uri, http_headers)

data/lib/unleash/variant_definition.rb

@@ -2,13 +2,13 @@ require 'unleash/variant_override'
 
 module Unleash
   class VariantDefinition
-    attr_accessor :name, :weight, :payload, :overrides
+    attr_accessor :name, :weight, :payload, :overrides, :stickiness
 
-    def initialize(name, weight = 0, payload = nil, overrides = [])
+    def initialize(name, weight = 0, payload = nil, stickiness = nil, overrides = [])
       self.name = name
       self.weight = weight
       self.payload = payload
-      # self.overrides = overrides
+      self.stickiness = stickiness
       self.overrides = (overrides || [])
         .select{ |v| v.is_a?(Hash) && v.has_key?('contextName') }
         .map{ |v| VariantOverride.new(v.fetch('contextName', ''), v.fetch('values', [])) } || []
@@ -19,7 +19,8 @@ module Unleash
     end
 
     def to_s
-      "<VariantDefinition: name=#{self.name},weight=#{self.weight},payload=#{self.payload},overrides=#{self.overrides}>"
+      "<VariantDefinition: name=#{self.name},weight=#{self.weight},payload=#{self.payload},stickiness=#{self.stickiness}" \
+          ",overrides=#{self.overrides}>"
     end
   end
 end

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "3.2.5".freeze
+  VERSION = "4.0.0".freeze
 end

data/lib/unleash.rb

@@ -24,11 +24,6 @@ module Unleash
     attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :logger
   end
 
-  def self.initialize
-    self.toggles = []
-    self.toggle_metrics = {}
-  end
-
   # Support for configuration via yield:
   def self.configure
     self.configuration ||= Unleash::Configuration.new

data/unleash-client.gemspec

@@ -31,6 +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 "coveralls", "~> 0.8"
   spec.add_development_dependency "rubocop", "~> 0.80"
+  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: 3.2.5
+  version: 4.0.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -95,33 +95,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: |-
   This is the ruby client for Unleash, a powerful feature toggle system
       that gives you a great overview over all feature toggles across all your applications and services.
@@ -132,10 +146,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- jruby
-- 3.0
-- 2.7
-- 2.6
-- 2.5
-before_install:
-- gem install bundler -v 2.1.4
-- git clone --depth 5 --branch v3.3.0 https://github.com/Unleash/client-specification.git client-specification
-
-notifications:
-  slack:
-    secure: x593zOjdl2yVB8uP54v8CmuCOat8GFHnK99NPvPHKvif5U7PGe0YOgYh4DC1+Jc9vfjn1ke+0++m+Gif4quowpeOaA/t45xpB494lyziXsBulYml245jRp9yzoUmIIt7KxHhv4rlo3Q1ztMJgh6a5yDCornKHW2bKTkLsvqVTwxBRatLOrt6K9O8FivO/NaqgcoXl7Rw0fOx/bsZtx2IAFueTCH19NoqW1mk9KFEZ96YqJSvuqmfDC0AO7siq03WKlB++nPlKe1QcrlPalCrcsSzrYNhYJ3akBTt/ZbE1v6YJv2L+zUqRnAPTY2H+qp8WejFQtdhIjfeJ/SWox0iWv/Wy/mTFfj+EhFO9Aq+xhMjJ1OOLtNAPoYJyatEVgJkILb6M26igTFcuI60xBbGNmh5ZYeyRdn5/xFb7G2zyJ2Swc3PvN1uLzMHfTF0R7WzGq4CRNGIOjrHTGncyB3IGAONOdJdM3iT9XKY6cdlRK0VkQjEsEMe0eNv2fxxLVSGna4sdJoTND6LhJ6qCfuS9DEDXwoRdLxAXxefycCh9VNp7gloMJx8IbHYxOW0BFZqc3hxNU9X2SwOj6j72DZMrdYDg2aPAW69HG0iMontQ37Di87JEW2F2Cpgb49+4twByrQNIx+st+DGNce1vpc0DN+KuJVdIcmha654lT7Ffe8=