splitclient-rb 6.3.0 → 8.11.0

data/lib/splitclient-rb/helpers/util.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Helpers
+    class Util
+      def self.segment_names_by_object(object, matcher_type)
+        object[:conditions].each_with_object(Set.new) do |condition, names|
+          condition[:matcherGroup][:matchers].each do |matcher|
+            next if matcher[:userDefinedSegmentMatcherData].nil? || matcher[:matcherType] != matcher_type
+
+            names << matcher[:userDefinedSegmentMatcherData][:segmentName]
+          end
+        end
+      end
+
+      def self.segment_names_in_rb_segment(object, matcher_type)
+        names = Set.new
+        names.merge segment_names_by_object(object, matcher_type)
+        object[:excluded][:segments].each do |segment|
+          names.add(segment[:name]) if segment[:type] == SplitIoClient::Engine::Models::SegmentType::STANDARD
+        end
+        names
+      end
+    end
+  end
+end

data/lib/splitclient-rb/managers/split_manager.rb

@@ -3,13 +3,11 @@ module SplitIoClient
     #
     # Creates a new split manager instance that connects to split.io API.
     #
-    # @param api_key [String] the API key for your split account
-    #
     # @return [SplitIoManager] split.io client instance
-    def initialize(api_key, adapter = nil, splits_repository = nil)
-      @localhost_mode_features = []
+    def initialize(splits_repository = nil, status_manager, config)
       @splits_repository = splits_repository
-      @adapter = adapter
+      @status_manager = status_manager
+      @config = config
     end
 
     #
@@ -17,7 +15,12 @@ module SplitIoClient
     #
     # @returns [object] array of splits
     def splits
-      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
+      return [] if !@config.valid_mode || @splits_repository.nil?
+
+      if !ready?
+        @config.logger.error("splits: the SDK is not ready, the operation cannot be executed")
+        return []
+      end
 
       @splits_repository.splits.each_with_object([]) do |(name, split), memo|
         split_view = build_split_view(name, split)
@@ -33,7 +36,12 @@ module SplitIoClient
     #
     # @returns [object] array of split names (String)
     def split_names
-      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
+      return [] if !@config.valid_mode || @splits_repository.nil?
+
+      if !ready?
+        @config.logger.error("split_names: the SDK is not ready, the operation cannot be executed")
+        return []
+      end
 
       @splits_repository.split_names
     end
@@ -42,42 +50,72 @@ module SplitIoClient
     # method to get a split view
     #
     # @returns a split view
-    def split(split_name)
-      return unless SplitIoClient.configuration.valid_mode && @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+    def split(feature_flag_name)
+      return unless @config.valid_mode && @splits_repository && @config.split_validator.valid_split_parameters(feature_flag_name)
+
+      if !ready?
+        @config.logger.error("split: the SDK is not ready, the operation cannot be executed")
+        return
+      end
 
-      sanitized_split_name= split_name.to_s.strip
+      sanitized_feature_flag_name = feature_flag_name.to_s.strip
 
-      if split_name.to_s != sanitized_split_name
-        SplitIoClient.configuration.logger.warn("split: split_name #{split_name} has extra whitespace, trimming")
-        split_name = sanitized_split_name
+      if feature_flag_name.to_s != sanitized_feature_flag_name
+        @config.logger.warn("split: feature_flag_name #{feature_flag_name} has extra whitespace, trimming")
+        feature_flag_name = sanitized_feature_flag_name
       end
 
-      split = @splits_repository.get_split(split_name)
+      split = @splits_repository.get_split(feature_flag_name)
+
+      if ready? && split.nil?
+        @config.logger.warn("split: you passed #{feature_flag_name} " \
+          'that does not exist in this environment, please double check what feature flags exist in the Split user interface')
+      end
 
       return if split.nil? || Engine::Models::Split.archived?(split)
 
-      build_split_view(split_name, split)
+      build_split_view(feature_flag_name, split)
+    end
+
+    def block_until_ready(time = nil)
+      @status_manager.wait_until_ready(time) if @status_manager
     end
 
+    private
+
     def build_split_view(name, split)
       return {} unless split
 
       begin
-        treatments = split[:conditions]
-          .detect { |c| c[:conditionType] == 'ROLLOUT' }[:partitions]
-          .map { |partition| partition[:treatment] }
+        if @config.localhost_mode
+          treatments = split[:conditions]
+            .first[:partitions]
+            .map { |partition| partition[:treatment] }
+        else
+          treatments = split[:conditions]
+            .detect { |c| c[:conditionType] == 'ROLLOUT' }[:partitions]
+            .map { |partition| partition[:treatment] }
+        end
       rescue StandardError
         treatments = []
       end
-
         {
           name: name,
           traffic_type_name: split[:trafficTypeName],
           killed: split[:killed],
           treatments: treatments,
           change_number: split[:changeNumber],
-          configs: split[:configurations] || {}
+          configs: split[:configurations] || {},
+          sets: split[:sets] || [],
+          default_treatment: split[:defaultTreatment],
+          impressions_disabled: split[:impressionsDisabled]
         }
     end
+
+    # move to blocker, alongside block until ready to avoid duplication
+    def ready?
+      return @status_manager.ready? if @status_manager
+      true
+    end
   end
 end

data/lib/splitclient-rb/spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Spec
+    class FeatureFlags
+      SPEC_VERSION = "1.3"
+    end
+  end
+end