unleash 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f398d199ef891fbd322726d73702101bd22e78827c258d90861558662c7c26
-  data.tar.gz: a6166d04ac912a1766d6f905f1bc86a6ed41bca15cf23f420feb93c8ca81a6e7
+  metadata.gz: da9995687fc28b71318711bd1575d9f5493fb9514cc3f276966323e4a73e15f8
+  data.tar.gz: e4a29a197e0faeaeaf093bb5a67103ed36aba352facf9633a6845739b17ff58c
 SHA512:
-  metadata.gz: 4a4cbbdfd1f5cfef172b7afc4c4ee4e3fd850dadedec443b4b571b74ff8a9aa7cc76b48fe768fef0c9f4ea990876254e86b0650fce7d063aa6dbc172831c8884
-  data.tar.gz: 7a247e76361465b7716db8dea33e065ad4064eaa3f8b6ac553d6cdb40caf0fcf7a4ae71873a0d7dc6e756514609d3aefb1989973fd3d83dcd7f2abf18536e000
+  metadata.gz: a7831894183515cbe05fb10520542b93d8a8cd521eab6ff33e9c7a4f88540519b479a76fb360a085b4f1ee059be1d03d0b531eb0daa4ff3db0147380b6f5db52
+  data.tar.gz: 93ce839564b8ef8af502ca148bd3e369f5463d32cd42af1d947be5d751dda88c52d8da71ee5a456658de899afe7fff159655f7f8579cf8030c81ff62655f1804

data/.rubocop.yml

@@ -1,7 +1,7 @@
 # inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 Naming/PredicateName:
   AllowedMethods:
@@ -9,7 +9,7 @@ Naming/PredicateName:
 
 Metrics/ClassLength:
   Max: 120
-Metrics/LineLength:
+Layout/LineLength:
   Max: 140
 Metrics/MethodLength:
   Max: 20
@@ -22,9 +22,9 @@ Metrics/BlockLength:
 Metrics/AbcSize:
   Max: 25
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 9
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 9
 
 Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -2,14 +2,13 @@ sudo: false
 language: ruby
 rvm:
 - jruby
+- 3.0
 - 2.7
 - 2.6
 - 2.5
-- 2.4
 before_install:
 - gem install bundler -v 2.1.4
-- git clone --depth 5 --branch v3.2.0 https://github.com/Unleash/client-specification.git
-  client-specification
+- git clone --depth 5 --branch v3.3.0 https://github.com/Unleash/client-specification.git client-specification
 
 notifications:
   slack:

data/README.md

@@ -10,10 +10,10 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
+  * MRI 3.0
   * MRI 2.7
   * MRI 2.6
   * MRI 2.5
-  * MRI 2.4
   * jruby
 
 ## Installation
@@ -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.1'
+gem 'unleash', '~> 3.2.2'
 ```
 
 And then execute:

data/lib/unleash.rb

@@ -5,7 +5,7 @@ require 'unleash/context'
 require 'unleash/client'
 require 'logger'
 
-Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path }
+Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path unless path.end_with? '_spec.rb' }
 
 module Unleash
   TIME_RESOLUTION = 3

data/lib/unleash/activation_strategy.rb

@@ -1,16 +1,29 @@
 module Unleash
   class ActivationStrategy
-    attr_accessor :name, :params
+    attr_accessor :name, :params, :constraints
 
-    def initialize(name, params)
+    def initialize(name, params, constraints = [])
       self.name = name
 
       if params.is_a?(Hash)
         self.params = params
+      elsif params.nil?
+        self.params = {}
       else
-        Unleash.logger.warn "Invalid params provided for ActivationStrategy #{params}"
+        Unleash.logger.warn "Invalid params provided for ActivationStrategy (params:#{params})"
         self.params = {}
       end
+
+      if constraints.is_a?(Array) && constraints.each{ |c| c.is_a?(Constraint) }
+        self.constraints = constraints
+      else
+        Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (contraints: #{constraints})"
+        self.constraints = []
+      end
+    end
+
+    def matches_context?(context)
+      self.constraints.any?{ |c| c.matches_context? context }
     end
   end
 end

data/lib/unleash/constraint.rb

@@ -0,0 +1,26 @@
+module Unleash
+  class Constraint
+    attr_accessor :context_name, :operator, :values
+
+    VALID_OPERATORS = ['IN', 'NOT_IN'].freeze
+
+    def initialize(context_name, operator, values = [])
+      raise ArgumentError, "context_name is not a String" unless context_name.is_a?(String)
+      raise ArgumentError, "operator does not hold a valid value:" + VALID_OPERATORS unless VALID_OPERATORS.include? operator
+      raise ArgumentError, "values does not hold an Array" unless values.is_a?(Array)
+
+      self.context_name = context_name
+      self.operator = operator
+      self.values = values
+    end
+
+    def matches_context?(context)
+      Unleash.logger.debug "Unleash::Constraint matches_context? values: #{self.values} context.get_by_name(#{self.context_name})" \
+        " #{context.get_by_name(self.context_name)} "
+
+      is_included = self.values.include? context.get_by_name(self.context_name)
+
+      operator == 'IN' ? is_included : !is_included
+    end
+  end
+end

data/lib/unleash/context.rb

@@ -1,6 +1,8 @@
 module Unleash
   class Context
-    attr_accessor :app_name, :environment, :user_id, :session_id, :remote_address, :properties
+    ATTRS = [:app_name, :environment, :user_id, :session_id, :remote_address].freeze
+
+    attr_accessor(*[ATTRS, :properties].flatten)
 
     def initialize(params = {})
       raise ArgumentError, "Unleash::Context must be initialized with a hash." unless params.is_a?(Hash)
@@ -12,18 +14,29 @@ module Unleash
       self.remote_address = value_for('remoteAddress', params)
 
       properties = value_for('properties', params)
-      self.properties = properties.is_a?(Hash) ? properties : {}
+      self.properties = properties.is_a?(Hash) ? properties.transform_keys(&:to_sym) : {}
     end
 
     def to_s
-      "<Context: user_id=#{self.user_id},session_id=#{self.session_id},remote_address=#{self.remote_address},properties=#{self.properties}>"
+      "<Context: user_id=#{@user_id},session_id=#{@session_id},remote_address=#{@remote_address},properties=#{@properties}" \
+        ",app_name=#{@app_name},environment=#{@environment}>"
+    end
+
+    def get_by_name(name)
+      normalized_name = underscore(name).to_sym
+
+      if ATTRS.include? normalized_name
+        self.send(normalized_name)
+      else
+        self.properties.fetch(normalized_name)
+      end
     end
 
     private
 
     # Method to fetch values from hash for two types of keys: string in camelCase and symbol in snake_case
-    def value_for(key, params, default_value = '')
-      params.values_at(key, underscore(key).to_sym).compact.first || default_value
+    def value_for(key, params, default_value = nil)
+      params.values_at(key, key.to_sym, underscore(key), underscore(key).to_sym).compact.first || default_value
     end
 
     # converts CamelCase to snake_case

data/lib/unleash/feature_toggle.rb

@@ -1,4 +1,5 @@
 require 'unleash/activation_strategy'
+require 'unleash/constraint'
 require 'unleash/variant_definition'
 require 'unleash/variant'
 require 'unleash/strategy/util'
@@ -13,20 +14,9 @@ module Unleash
 
       self.name       = params.fetch('name', nil)
       self.enabled    = params.fetch('enabled', false)
-      self.strategies = params.fetch('strategies', [])
-        .select{ |s| s.has_key?('name') && Unleash::STRATEGIES.has_key?(s['name'].to_sym) }
-        .map{ |s| ActivationStrategy.new(s['name'], s['parameters'] || {}) } || []
 
-      self.variant_definitions = (params.fetch('variants', []) || [])
-        .select{ |v| v.is_a?(Hash) && v.has_key?('name') }
-        .map do |v|
-          VariantDefinition.new(
-            v.fetch('name', ''),
-            v.fetch('weight', 0),
-            v.fetch('payload', nil),
-            v.fetch('overrides', [])
-          )
-        end || []
+      self.strategies = initialize_strategies(params)
+      self.variant_definitions = initialize_variant_definitions(params)
     end
 
     def to_s
@@ -64,23 +54,29 @@ module Unleash
       result =
         if self.enabled
           self.strategies.empty? ||
-            self.strategies.any?{ |s| strategy_enabled?(s, context) }
+            self.strategies.any? do |s|
+              strategy_enabled?(s, context) && strategy_constraint_matches?(s, context)
+            end
         else
           default_result
         end
 
-      Unleash.logger.debug "FeatureToggle (enabled:#{self.enabled} default_result:#{default_result} " \
-        "and Strategies combined returned #{result})"
+      Unleash.logger.debug "Unleash::FeatureToggle (enabled:#{self.enabled} default_result:#{default_result} " \
+        "and Strategies combined with contraints returned #{result})"
 
       result
     end
 
     def strategy_enabled?(strategy, context)
       r = Unleash::STRATEGIES.fetch(strategy.name.to_sym, :unknown).is_enabled?(strategy.params, context)
-      Unleash.logger.debug "Strategy #{strategy.name} returned #{r} with context: #{context}" # "for params #{strategy.params} "
+      Unleash.logger.debug "Unleash::FeatureToggle.strategy_enabled? Strategy #{strategy.name} returned #{r} with context: #{context}"
       r
     end
 
+    def strategy_constraint_matches?(strategy, context)
+      strategy.constraints.empty? || strategy.constraints.all?{ |c| c.matches_context?(context) }
+    end
+
     def disabled_variant
       Unleash::Variant.new(name: 'disabled', enabled: false)
     end
@@ -127,5 +123,36 @@ module Unleash
       end
       context
     end
+
+    def initialize_strategies(params)
+      params.fetch('strategies', [])
+        .select{ |s| s.has_key?('name') && Unleash::STRATEGIES.has_key?(s['name'].to_sym) }
+        .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')
+              )
+            end
+          )
+        end || []
+    end
+
+    def initialize_variant_definitions(params)
+      (params.fetch('variants', []) || [])
+        .select{ |v| v.is_a?(Hash) && v.has_key?('name') }
+        .map do |v|
+          VariantDefinition.new(
+            v.fetch('name', ''),
+            v.fetch('weight', 0),
+            v.fetch('payload', nil),
+            v.fetch('overrides', [])
+          )
+        end || []
+    end
   end
 end

data/lib/unleash/strategy/flexible_rollout.rb

@@ -0,0 +1,55 @@
+require 'unleash/strategy/util'
+
+module Unleash
+  module Strategy
+    class FlexibleRollout < Base
+      def name
+        'flexibleRollout'
+      end
+
+      # need: params['percentage']
+      def is_enabled?(params = {}, context = nil)
+        return false unless params.is_a?(Hash)
+        return false unless context.class.name == 'Unleash::Context'
+
+        stickiness = params.fetch('stickiness', 'default')
+        stickiness_id = resolve_stickiness(stickiness, context)
+
+        begin
+          percentage = Integer(params.fetch('rollout', 0))
+          percentage = 0 if percentage > 100 || percentage.negative?
+        rescue ArgumentError
+          return false
+        end
+
+        group_id = params.fetch('groupId', '')
+        normalized_number = Util.get_normalized_number(stickiness_id, group_id)
+
+        return false if stickiness_id.nil?
+
+        (percentage.positive? && normalized_number <= percentage)
+      end
+
+      private
+
+      def random
+        Random.rand(0..100)
+      end
+
+      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
+        end
+      end
+    end
+  end
+end

data/lib/unleash/strategy/gradual_rollout_sessionid.rb

@@ -11,7 +11,7 @@ module Unleash
       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 if context.session_id.empty?
+        return false if context.session_id.nil? || context.session_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
         (percentage.positive? && Util.get_normalized_number(context.session_id, params['groupId'] || "") <= percentage)

data/lib/unleash/strategy/gradual_rollout_userid.rb

@@ -8,10 +8,10 @@ module Unleash
       end
 
       # need: params['percentage'], params['groupId'], context.user_id,
-      def is_enabled?(params = {}, context = nil)
+      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 if context.user_id.empty?
+        return false if context.user_id.nil? || context.user_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
         (percentage.positive? && Util.get_normalized_number(context.user_id, params['groupId'] || "") <= percentage)

data/lib/unleash/toggle_fetcher.rb

@@ -71,6 +71,7 @@ module Unleash
         self.toggle_lock.synchronize do
           file = File.open(backup_file_tmp, "w")
           file.write(self.toggle_cache.to_json)
+          file.close
           File.rename(backup_file_tmp, backup_file)
         end
       rescue StandardError => e

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "3.2.1".freeze
+  VERSION = "3.2.2".freeze
 end

data/unleash-client.gemspec

@@ -21,14 +21,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/unleash}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = "~> 2.4"
+  spec.required_ruby_version = ">= 2.5"
 
   spec.add_dependency "murmurhash3", "~> 0.1.6"
 
   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-json_expectations", "~> 2.1"
+  spec.add_development_dependency "rspec-json_expectations", "~> 2.2"
   spec.add_development_dependency "webmock", "~> 3.8"
 
   spec.add_development_dependency "coveralls", "~> 0.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Renato Arruda
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ files:
 - lib/unleash/activation_strategy.rb
 - lib/unleash/client.rb
 - lib/unleash/configuration.rb
+- lib/unleash/constraint.rb
 - lib/unleash/context.rb
 - lib/unleash/feature_toggle.rb
 - lib/unleash/metrics.rb
@@ -156,6 +157,7 @@ files:
 - lib/unleash/strategy/application_hostname.rb
 - lib/unleash/strategy/base.rb
 - lib/unleash/strategy/default.rb
+- lib/unleash/strategy/flexible_rollout.rb
 - lib/unleash/strategy/gradual_rollout_random.rb
 - lib/unleash/strategy/gradual_rollout_sessionid.rb
 - lib/unleash/strategy/gradual_rollout_userid.rb
@@ -173,23 +175,23 @@ homepage: https://github.com/unleash/unleash-client-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Unleash feature toggle client.
 test_files: []