ff-ruby-server-sdk 0.0.2 → 1.0.0

data/lib/ff/ruby/server/sdk/api/evaluation.rb

@@ -0,0 +1,29 @@
+
+class Evaluation
+
+  def initialize
+    super
+
+    @tbi = "To be implemented"
+  end
+
+  def bool_variation(identifier, target, default_value, callback)
+
+    raise @tbi
+  end
+
+  def string_variation(identifier, target, default_value, callback)
+
+    raise @tbi
+  end
+
+  def number_variation(identifier, target, default_value, callback)
+
+    raise @tbi
+  end
+
+  def json_variation(identifier, target, default_value, callback)
+
+    raise @tbi
+  end
+end

data/lib/ff/ruby/server/sdk/api/evaluator.rb

@@ -0,0 +1,526 @@
+require "json"
+require "murmurhash3"
+
+require_relative "evaluation"
+require_relative "../common/repository"
+
+class Evaluator < Evaluation
+
+  def initialize(repository, logger = nil)
+
+    unless repository.kind_of?(Repository)
+
+      raise "The 'repository' parameter must be of '" + Repository.to_s + "' data type"
+    end
+
+    if logger != nil
+
+      @logger = logger
+    else
+
+      @logger = Logger.new(STDOUT)
+    end
+
+    @repository = repository
+  end
+
+  def bool_variation(identifier, target, default_value, callback)
+
+    variation = evaluate(identifier, target, "boolean", callback)
+
+    if variation != nil
+
+      return variation.value == "true"
+    end
+
+    default_value
+  end
+
+  def string_variation(identifier, target, default_value, callback)
+
+    variation = evaluate(identifier, target, "string", callback)
+
+    if variation != nil
+
+      return variation.value
+    end
+
+    default_value
+  end
+
+  def number_variation(identifier, target, default_value, callback)
+
+    variation = evaluate(identifier, target, "int", callback)
+
+    if variation != nil
+
+      return variation.value.to_i
+    end
+
+    default_value
+  end
+
+  def json_variation(identifier, target, default_value, callback)
+
+    variation = evaluate(identifier, target, "json", callback)
+
+    if variation != nil
+
+      return JSON.parse(variation.value)
+    end
+
+    default_value
+  end
+
+  def evaluate(identifier, target, expected, callback)
+
+    if callback != nil
+
+      unless callback.kind_of?(FlagEvaluateCallback)
+
+        raise "The 'callback' parameter must be of '" + FlagEvaluateCallback.to_s + "' data type"
+      end
+    end
+
+    flag = @repository.get_flag(identifier)
+
+    if flag != nil && flag.kind == expected
+
+      unless flag.prerequisites.empty?
+
+        pre_req = check_pre_requisite(flag, target)
+
+        unless pre_req
+
+          return find_variation(flag.variations, flag.off_variation)
+        end
+      end
+
+      variation = evaluate_flag(flag, target)
+
+      if variation != nil
+
+        if callback != nil
+
+          callback.process_evaluation(flag, target, variation)
+        end
+
+        return variation
+      end
+    end
+
+    nil
+  end
+
+  protected
+
+  def get_attr_value(target, attribute)
+
+    if attribute != nil && !attribute.empty?
+
+      if target.respond_to?(attribute, :include_private)
+
+        @logger.debug "The attribute " + attribute.to_s + " exists (1)"
+
+        return target.send(attribute)
+      else
+
+        result = target.attributes.key?(attribute)
+
+        if result == nil
+
+          @logger.debug "The attribute " + attribute.to_s + " does not exist"
+
+        else
+
+          @logger.debug "The attribute " + attribute.to_s + " exists (2)"
+        end
+
+        return result
+      end
+    end
+
+    @logger.debug "The passed attribute is empty"
+
+    nil
+  end
+
+  def find_variation(variations, identifier)
+
+    if identifier != nil && !identifier.empty?
+
+      variations.each do |v|
+
+        if v.identifier == identifier
+
+          return v
+        end
+      end
+    end
+
+    nil
+  end
+
+  def get_normalized_number(property, bucket_by)
+
+    joined = property.to_s + ":" + bucket_by.to_s
+    hash = MurmurHash3::V32.str_hash(joined, joined.length)
+    (hash % 100) + 1
+  end
+
+  def is_enabled(target, bucket_by, percentage)
+
+    property = get_attr_value(target, bucket_by)
+
+    if property != nil
+
+      bucket_id = get_normalized_number(property, bucket_by)
+
+      return percentage > 0 && bucket_id <= percentage
+    end
+
+    false
+  end
+
+  def evaluate_distribution(distribution, target)
+
+    if distribution != nil
+
+      variation = nil
+
+      distribution.variations.each do |weighted_variation|
+
+        variation = weighted_variation.variation
+
+        if is_enabled(target, distribution.bucket_by, weighted_variation.weight)
+
+          return variation
+        end
+      end
+
+      return variation
+    end
+
+    nil
+  end
+
+  def evaluate_clauses(clauses, target)
+
+    clauses.each do |clause|
+
+      unless evaluate_clause(clause, target)
+
+        return false
+      end
+    end
+
+    true
+  end
+
+  def evaluate_clause(clause, target)
+
+    if clause == nil
+
+      return false
+    end
+
+    operator = clause.op
+
+    if operator == nil || operator.empty?
+
+      return false
+    end
+
+    if operator == "segmentMatch"
+
+      return is_target_included_or_excluded_in_segment(clause.values, target)
+    end
+
+    if clause.values.empty?
+
+      return false
+    end
+
+    value = clause.values[0]
+    attr_value = get_attr_value(target, clause.attribute)
+
+    if attr_value == nil
+
+      return false
+    end
+
+    object = attr_value.to_s
+
+    if operator == "starts_with"
+
+      return object.start_with?(value)
+    end
+
+    if operator == "ends_with"
+
+      return object.end_with?(value)
+    end
+
+    if operator == "match"
+
+      match = object.match?(value)
+      return match != nil && !match.empty?
+    end
+
+    if operator == "contains"
+
+      return object.include?(value)
+    end
+
+    if operator == "equal"
+
+      return object.casecmp?(value)
+    end
+
+    if operator == "equal_sensitive"
+
+      return object == value
+    end
+
+    if operator == "in"
+
+      return object.include?(value)
+    end
+
+    if operator == "segmentMatch"
+
+      return is_target_included_or_excluded_in_segment(clause.values, target)
+    end
+
+    false
+  end
+
+  def is_target_included_or_excluded_in_segment(segment_list, target)
+
+    segment_list.each do |segment_identifier|
+
+      segment = @repository.get_segment(segment_identifier)
+
+      if segment != nil
+
+        if is_target_in_list(target, segment.excluded)
+
+          @logger.debug "Target " + target.name.to_s + " excluded from segment " + segment.name.to_s + " via exclude list"
+
+          return false
+        end
+
+        if is_target_in_list(target, segment.included)
+
+          @logger.debug "Target " + target.name.to_s + " included in segment " + segment.name.to_s + " via include list"
+
+          return true
+        end
+
+        rules = segment.rules
+
+        if rules != nil && !rules.empty? && evaluate_clauses(rules, target)
+
+          @logger.debug "Target " + target.name.to_s + " included in segment " + segment.name.to_s + " via rules"
+
+          return true
+        end
+      end
+    end
+
+    false
+  end
+
+  def evaluate_rules(serving_rules, target)
+
+    if target == nil || serving_rules == nil
+
+      return nil
+    end
+
+    sorted = serving_rules.sort do |a, b|
+
+      b.priority <=> a.priority
+    end
+
+    sorted.each do |rule|
+
+      next unless evaluate_rule(rule, target)
+
+      if rule.serve.distribution != nil
+
+        return evaluate_distribution(rule.serve.distribution, target)
+      end
+
+      if rule.serve.variation != nil
+
+        return rule.serve.variation
+      end
+    end
+
+    nil
+  end
+
+  def evaluate_rule(serving_rule, target)
+
+    evaluate_clauses(serving_rule.clauses, target)
+  end
+
+  def evaluate_variation_map(variation_maps, target)
+
+    if target == nil
+
+      return nil
+    end
+
+    variation_maps.each do |variation_map|
+
+      targets = variation_map.targets
+
+      if targets != nil
+
+        found = nil
+
+        targets.each do |t|
+
+          if t.identifier != nil && t.identifier == target.identifier
+
+            found = t
+            break
+          end
+        end
+
+        if found != nil
+
+          return variation_map.variation
+        end
+      end
+
+      segment_identifiers = variation_map.target_segments
+
+      if segment_identifiers != nil && is_target_included_or_excluded_in_segment(segment_identifiers, target)
+
+        return variation_map.variation
+      end
+    end
+
+    nil
+  end
+
+  def evaluate_flag(feature_config, target)
+
+    variation = feature_config.off_variation
+
+    if feature_config.state == OpenapiClient::FeatureState::ON
+
+      variation = nil
+
+      if feature_config.variation_to_target_map != nil
+
+        variation = evaluate_variation_map(feature_config.variation_to_target_map, target)
+      end
+
+      if variation == nil
+
+        variation = evaluate_rules(feature_config.rules, target)
+      end
+
+      if variation == nil
+
+        variation = evaluate_distribution(feature_config.default_serve.distribution, target)
+      end
+
+      if variation == nil
+
+        variation = feature_config.default_serve.variation
+      end
+    end
+
+    if variation != nil
+
+      return find_variation(feature_config.variations, variation)
+    end
+
+    nil
+  end
+
+  def check_pre_requisite(parent_feature_config, target)
+
+    prerequisites = parent_feature_config.prerequisites
+
+    if prerequisites != nil && !prerequisites.empty?
+
+      @logger.debug "Checking pre requisites " + prerequisites.to_s + " of parent feature " + parent_feature_config.feature.to_s
+
+      prerequisites.each do |pqs|
+
+        pre_req_feature = pqs.feature
+
+        pre_req_feature_config = @repository.get_flag(pre_req_feature)
+
+        if pre_req_feature_config == nil
+
+          @logger.debug "Could not retrieve the pre requisite details of feature flag: " + pre_req_feature.to_s
+
+          return true
+        end
+
+        pre_req_evaluated_variation = evaluate_flag(pre_req_feature_config, target)
+
+        if pre_req_evaluated_variation == nil
+
+          @logger.debug "Could not evaluate the prerequisite details of feature flag: " + pre_req_feature.to_s
+
+          return true
+        end
+
+        @logger.debug "Pre requisite flag " + pre_req_feature_config.feature + " has variation " +
+                        pre_req_evaluated_variation.to_s + " for target " + target.to_s
+
+        valid_pre_req_variations = pqs.variations
+
+        @logger.debug "Pre requisite flag " + pre_req_feature_config.to_s + " should have the variations " +
+                        valid_pre_req_variations.to_s
+
+        none_match = true
+
+        valid_pre_req_variations.each do |element|
+
+          if element.include?(pre_req_evaluated_variation.value)
+
+            none_match = false
+            break
+          end
+        end
+
+        if none_match
+
+          return false
+        else
+
+          return check_pre_requisite(pre_req_feature_config, target)
+        end
+      end
+    end
+
+    true
+  end
+
+  private
+
+  def is_target_in_list(target, list_of_targets)
+
+    if list_of_targets != nil
+
+      list_of_targets.each do |included_target|
+
+        if included_target.identifier.include?(target.identifier)
+
+          return true
+        end
+      end
+    end
+
+    false
+  end
+end

data/lib/ff/ruby/server/sdk/api/file_map_store.rb

@@ -0,0 +1,60 @@
+require "moneta"
+require_relative "../common/storage"
+
+class FileMapStore < Storage
+
+  def initialize
+
+    @keys = Set[]
+    @store = Moneta.new(:File, dir: "moneta")
+  end
+
+  def set(key, value)
+
+    check_init
+
+    @store[key] = value
+    keys.add(key)
+  end
+
+  def get(key)
+
+    check_init
+
+    @store[key]
+  end
+
+  def delete(key)
+
+    check_init
+
+    @store.delete(key)
+    keys.delete(key)
+  end
+
+  def keys
+
+    check_init
+
+    @keys
+  end
+
+  def close
+
+    if @store != nil
+
+      @store.close
+      @keys = Set[]
+    end
+  end
+
+  private
+
+  def check_init
+
+    if @store == nil
+
+      raise "Not initialized"
+    end
+  end
+end

data/lib/ff/ruby/server/sdk/api/flag_evaluate_callback.rb

@@ -0,0 +1,13 @@
+class FlagEvaluateCallback
+
+  def initialize
+    super
+
+    @tbi = "To be implemented"
+  end
+
+  def process_evaluation(feature_config, target, variation)
+
+    raise @tbi
+  end
+end