unleash 4.4.1 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e1d111b5560a8236c52c1b1744f32724fdd0b26d02af16da707efe2869be3e
-  data.tar.gz: 402580857880d3508ad7b46afbc47b74c696bb6ad5360a48e4254f35ecd48f05
+  metadata.gz: 910ddad70479cae68918b7400b4ddc6d0c71f9448d8524072c318d6c353c4f52
+  data.tar.gz: 1d75ed31736627ea30c2bbc9be7903c9dfa19dc4691c07de885dd87a8eb94c85
 SHA512:
-  metadata.gz: ed380682c17c90cea0d8b79ba7b05f20b053eb20fd3d293f93e3b2356a264ab386fcee3b91b6ec6507965fb23e922f1e9d50cae2bd880973d9111413abda0572
-  data.tar.gz: 0ba69ee86b9dc60e65aac73023e9e39c1a93d56579fee7c3f990d4e944259a879ba66058e8614cc41c9dc22a41cc4ab5bf8824e7db24d3e8a5cbc8b5c4fcb4cb
+  metadata.gz: aec46ef764fcb138d34baa7c6832ff1865be4dac1f6f004ab928e8447ecde701ec82bf2069c69e62b2404706bf029c1743a3dc2322b5e7409135aba498cdf80e
+  data.tar.gz: d1a529a53cbd934c4aae24919352fc670b27b8cb0a9ccb2bde20deafa3eb3adf679e7c49ced246258547f68a400a10a1da214bc07a19e153ffb0af60fcea8961

data/.github/workflows/pull_request.yml

@@ -10,11 +10,11 @@ jobs:
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "2.7"
+        ruby-version: "3.0"
         bundler-cache: true
     - name: Run RuboCop
       run: bundle exec rubocop
@@ -31,12 +31,15 @@ jobs:
           - jruby-9.4
           - jruby-9.3
           - jruby-9.2
+          - 3.2
           - 3.1
           - '3.0'
           - 2.7
           - 2.6
           - 2.5
 
+    needs:
+      - lint
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby-version }}

data/.rubocop.yml

@@ -6,10 +6,13 @@ AllCops:
 Naming/PredicateName:
   AllowedMethods:
     - is_enabled?
+    - is_disabled?
 
 
 Metrics/ClassLength:
   Max: 135
+  CountAsOne:
+    - 'method_call'
 Layout/LineLength:
   Max: 140
 Metrics/MethodLength:

data/README.md

@@ -10,6 +10,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
+  * MRI 3.2
   * MRI 3.1
   * MRI 3.0
   * MRI 2.7
@@ -85,12 +86,12 @@ Argument | Description | Required? |  Type |  Default Value|
 `url`      | Unleash server URL. | Y | String | N/A |
 `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` |
+`environment` | Unleash context option. Could be for example `prod` or `dev`. Not yet in use. **Not** the same as the SDK's [Unleash environment](https://docs.getunleash.io/reference/environments). | 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 | 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` |
+`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. Will also forcefully set `disable_metrics` to `true`. Defeats the entire purpose of using unleash, except when running tests. | N | Boolean | `false` |
+`disable_metrics` | Disables sending metrics to Unleash server. If the `disable_client` option is set to `true`, then this option will also be set to `true`, regardless of the value provided. | 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/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 |
@@ -124,6 +125,12 @@ if @unleash.is_enabled?(feature_name, unleash_context)
 else
   puts " #{feature_name} is disabled according to unleash"
 end
+
+if @unleash.is_disabled?(feature_name, unleash_context)
+  puts " #{feature_name} is disabled according to unleash"
+else
+  puts " #{feature_name} is enabled according to unleash"
+end
 ```
 
 ## Usage in a Rails Application
@@ -138,7 +145,6 @@ Unleash.configure do |config|
   config.url      = 'https://unleash.herokuapp.com/api'
   # config.instance_id = "#{Socket.gethostname}"
   config.logger   = Rails.logger
-  config.environment = Rails.env
 end
 
 UNLEASH = Unleash::Client.new
@@ -173,7 +179,6 @@ Then you may keep the client configuration still in `config/initializers/unleash
 ```ruby
 Unleash.configure do |config|
   config.app_name    = Rails.application.class.parent.to_s
-  config.environment = Rails.env
   config.url                 = 'https://unleash.herokuapp.com/api'
   config.custom_http_headers = {'Authorization': '<API token>'}
 end
@@ -221,7 +226,6 @@ on_worker_boot do
 
   ::UNLEASH = Unleash::Client.new(
     app_name: 'my_rails_app',
-    environment: 'development',
     url: 'https://unleash.herokuapp.com/api',
     custom_http_headers: {'Authorization': '<API token>'},
   )
@@ -247,7 +251,6 @@ PhusionPassenger.on_event(:starting_worker_process) do |forked|
       config.app_name    = Rails.application.class.parent.to_s
       # config.instance_id = "#{Socket.gethostname}"
       config.logger      = Rails.logger
-      config.environment = Rails.env
       config.url                 = 'https://unleash.herokuapp.com/api'
       config.custom_http_headers = {'Authorization': '<API token>'}
     end
@@ -313,13 +316,31 @@ if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
 end
 ```
 
+If you don't want to check a feature is disabled with `unless`, you can also use `is_disabled?`:
+
+```ruby
+# so instead of:
+unless UNLEASH.is_enabled? "AwesomeFeature", @unleash_context
+  puts "AwesomeFeature is disabled"
+end
+
+# it might be more intelligible:
+if UNLEASH.is_disabled? "AwesomeFeature", @unleash_context
+  puts "AwesomeFeature is disabled"
+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`:
+However, you can override that by setting the default return value to `true`:
 
 ```ruby
 if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context, true
   puts "AwesomeFeature is enabled by default"
 end
+# or
+if UNLEASH.is_disabled? "AwesomeFeature", @unleash_context, true
+  puts "AwesomeFeature is disabled by default"
+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)
@@ -342,7 +363,7 @@ 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"
+  puts "AwesomeFeature is enabled by default if both the user has a high enough coolness and the application has a high enough awesomeness"
 end
 ```
 
@@ -351,12 +372,12 @@ Note:
 - 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 `!!`.
+  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:
+Alternatively by using `if_enabled` (or `if_disabled`) you can send a code block to be executed as a parameter:
 
 ```ruby
 UNLEASH.if_enabled "AwesomeFeature", @unleash_context, true do
@@ -364,7 +385,7 @@ UNLEASH.if_enabled "AwesomeFeature", @unleash_context, true do
 end
 ```
 
-Note: `if_enabled` only supports `default_value`, but not `fallback_function`.
+Note: `if_enabled` (and `if_disabled`) only support `default_value`, but not `fallback_function`.
 
 ##### Variations
 
@@ -444,6 +465,9 @@ Method Name | Description | Return Type |
 `is_enabled?` | Check if feature toggle is to be enabled or not. | Boolean |
 `enabled?` | Alias to the `is_enabled?` method. But more ruby idiomatic. | Boolean |
 `if_enabled` | Run a code block, if a feature is enabled. | `yield` |
+`is_disabled?` | Check if feature toggle is to be enabled or not. | Boolean |
+`disabled?` | Alias to the `is_disabled?` method. But more ruby idiomatic. | Boolean |
+`if_disabled` | Run a code block, if a feature is disabled. | `yield` |
 `get_variant` | Get variant for a given feature | `Unleash::Variant` |
 `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 |
@@ -482,7 +506,7 @@ In order for strategy to work correctly it should support two methods `name` and
 ```ruby
 class MyCustomStrategy
   def name
-    'muCustomStrategy'
+    'myCustomStrategy'
   end
 
   def is_enabled?(params = {}, context = nil)
@@ -497,15 +521,19 @@ 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.
+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.
 
-This SDK is also built against the Unleash Client Specification tests. To run the Ruby SDK against this test suite, you'll need to have a copy on your machine, you can clone the repository directly using:
+This SDK is also built against the Unleash Client Specification tests.
+To run the Ruby SDK against this test suite, you'll need to have a copy on your machine, you can clone the repository directly using:
 
 `git clone --depth 5 --branch v4.2.2 https://github.com/Unleash/client-specification.git client-specification`
 
 After doing this, `rake spec` will also run the client specification tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
 ## Contributing

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "unleash"
 require "unleash/client"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/lib/unleash/client.rb

@@ -21,6 +21,8 @@ module Unleash
       Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
       if Unleash.configuration.disable_client
         Unleash.logger.warn "Unleash::Client is disabled! Will only return default (or bootstrapped if available) results!"
+        Unleash.logger.warn "Unleash::Client is disabled! Metrics and MetricsReporter are also disabled!"
+        Unleash.configuration.disable_metrics = true
         return
       end
 
@@ -50,22 +52,28 @@ module Unleash
       toggle.is_enabled?(context)
     end
 
+    def is_disabled?(feature, context = nil, default_value_param = true, &fallback_blk)
+      !is_enabled?(feature, context, !default_value_param, &fallback_blk)
+    end
+
     # enabled? is a more ruby idiomatic method name than is_enabled?
     alias enabled? is_enabled?
+    # disabled? is a more ruby idiomatic method name than is_disabled?
+    alias disabled? is_disabled?
 
     # execute a code block (passed as a parameter), if is_enabled? is true.
     def if_enabled(feature, context = nil, default_value = false, &blk)
       yield(blk) if is_enabled?(feature, context, default_value)
     end
 
+    # execute a code block (passed as a parameter), if is_disabled? is true.
+    def if_disabled(feature, context = nil, default_value = true, &blk)
+      yield(blk) if is_disabled?(feature, context, default_value)
+    end
+
     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
-      end
-
       toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
       if toggle_as_hash.nil?

data/lib/unleash/context.rb

@@ -23,6 +23,11 @@ module Unleash
         ",app_name=#{@app_name},environment=#{@environment}>"
     end
 
+    def to_h
+      ATTRS.map{ |attr| [attr, self.send(attr)] }.to_h.merge(properties: @properties)
+    end
+
+    # returns the value found for the key in the context, or raises a KeyError exception if not found.
     def get_by_name(name)
       normalized_name = underscore(name).to_sym
 

data/lib/unleash/feature_toggle.rb

@@ -97,10 +97,15 @@ module Unleash
     end
 
     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?
+      begin
+        return context.get_by_name(stickiness) if !context.nil? && stickiness != "default"
+      rescue KeyError
+        Unleash.logger.warn "Custom stickiness key (#{stickiness}) not found in the provided context #{context}. " \
+          "Falling back to default behavior."
+      end
+      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?
 
       SecureRandom.random_number
     end

data/lib/unleash/metrics.rb

@@ -26,9 +26,9 @@ module Unleash
       self.features_lock.synchronize do
         self.features[feature] = { yes: 0, no: 0 } unless self.features.include? feature
         self.features[feature][choice] += 1
-        self.features[feature]['variant'] = {}     unless self.features[feature].include? 'variant'
-        self.features[feature]['variant'][variant] = 0 unless self.features[feature]['variant'].include? variant
-        self.features[feature]['variant'][variant] += 1
+        self.features[feature]['variants'] = {}     unless self.features[feature].include? 'variants'
+        self.features[feature]['variants'][variant] = 0 unless self.features[feature]['variants'].include? variant
+        self.features[feature]['variants'][variant] += 1
       end
     end
 

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.4.1".freeze
+  VERSION = "4.4.3".freeze
 end

data/unleash-client.gemspec

@@ -23,15 +23,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.5"
 
-  spec.add_dependency "murmurhash3", "~> 0.1.6"
+  spec.add_dependency "murmurhash3", "~> 0.1.7"
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec", "~> 3.12"
   spec.add_development_dependency "rspec-json_expectations", "~> 2.2"
-  spec.add_development_dependency "webmock", "~> 3.8"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
+
+  # rubocop:disable Gemspec/RubyVersionGlobalsUsage, Style/IfUnlessModifier
+  if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3.0')
+    spec.add_development_dependency "rubocop", "~> 1.51.0"
+  end
+  # rubocop:enable Gemspec/RubyVersionGlobalsUsage, Style/IfUnlessModifier
 
-  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.4.1
+  version: 4.4.3
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.18.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.2
+        version: 1.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.2
+        version: 1.51.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Unleash feature toggle client.