optimizely-sdk 3.9.0 → 4.0.0

data/lib/optimizely/optimizely_user_context.rb

@@ -1,107 +1,204 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2020, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-
-require 'json'
-
-module Optimizely
-  class OptimizelyUserContext
-    # Representation of an Optimizely User Context using which APIs are to be called.
-
-    attr_reader :user_id
-
-    def initialize(optimizely_client, user_id, user_attributes)
-      @attr_mutex = Mutex.new
-      @optimizely_client = optimizely_client
-      @user_id = user_id
-      @user_attributes = user_attributes.nil? ? {} : user_attributes.clone
-    end
-
-    def clone
-      OptimizelyUserContext.new(@optimizely_client, @user_id, user_attributes)
-    end
-
-    def user_attributes
-      @attr_mutex.synchronize { @user_attributes.clone }
-    end
-
-    # Set an attribute for a given key
-    #
-    # @param key - An attribute key
-    # @param value - An attribute value
-
-    def set_attribute(attribute_key, attribute_value)
-      @attr_mutex.synchronize { @user_attributes[attribute_key] = attribute_value }
-    end
-
-    # Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
-    #
-    # If the SDK finds an error, it'll return a `decision` with nil for `variation_key`. The decision will include an error message in `reasons`
-    #
-    # @param key -A flag key for which a decision will be made
-    # @param options - A list of options for decision making.
-    #
-    # @return [OptimizelyDecision] A decision result
-
-    def decide(key, options = nil)
-      @optimizely_client&.decide(clone, key, options)
-    end
-
-    # Returns a hash of decision results (OptimizelyDecision) for multiple flag keys and a user context.
-    #
-    # If the SDK finds an error for a key, the response will include a decision for the key showing `reasons` for the error.
-    # The SDK will always return hash of decisions. When it can not process requests, it'll return an empty hash after logging the errors.
-    #
-    # @param keys - A list of flag keys for which the decisions will be made.
-    # @param options - A list of options for decision making.
-    #
-    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
-
-    def decide_for_keys(keys, options = nil)
-      @optimizely_client&.decide_for_keys(clone, keys, options)
-    end
-
-    # Returns a hash of decision results (OptimizelyDecision) for all active flag keys.
-    #
-    # @param options - A list of options for decision making.
-    #
-    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
-
-    def decide_all(options = nil)
-      @optimizely_client&.decide_all(clone, options)
-    end
-
-    # Track an event
-    #
-    # @param event_key - Event key representing the event which needs to be recorded.
-
-    def track_event(event_key, event_tags = nil)
-      @optimizely_client&.track(event_key, @user_id, user_attributes, event_tags)
-    end
-
-    def as_json
-      {
-        user_id: @user_id,
-        attributes: @user_attributes
-      }
-    end
-
-    def to_json(*args)
-      as_json.to_json(*args)
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2020-2022, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+require 'json'
+
+module Optimizely
+  class OptimizelyUserContext
+    # Representation of an Optimizely User Context using which APIs are to be called.
+
+    attr_reader :user_id, :forced_decisions, :optimizely_client
+
+    OptimizelyDecisionContext = Struct.new(:flag_key, :rule_key)
+    OptimizelyForcedDecision = Struct.new(:variation_key)
+    def initialize(optimizely_client, user_id, user_attributes)
+      @attr_mutex = Mutex.new
+      @forced_decision_mutex = Mutex.new
+      @qualified_segment_mutex = Mutex.new
+      @optimizely_client = optimizely_client
+      @user_id = user_id
+      @user_attributes = user_attributes.nil? ? {} : user_attributes.clone
+      @forced_decisions = {}
+      @qualified_segments = []
+    end
+
+    def clone
+      user_context = OptimizelyUserContext.new(@optimizely_client, @user_id, user_attributes)
+      @forced_decision_mutex.synchronize { user_context.instance_variable_set('@forced_decisions', @forced_decisions.dup) unless @forced_decisions.empty? }
+      @qualified_segment_mutex.synchronize { user_context.instance_variable_set('@qualified_segments', @qualified_segments.dup) unless @qualified_segments.empty? }
+      user_context
+    end
+
+    def user_attributes
+      @attr_mutex.synchronize { @user_attributes.clone }
+    end
+
+    # Set an attribute for a given key
+    #
+    # @param key - An attribute key
+    # @param value - An attribute value
+
+    def set_attribute(attribute_key, attribute_value)
+      @attr_mutex.synchronize { @user_attributes[attribute_key] = attribute_value }
+    end
+
+    # Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
+    #
+    # If the SDK finds an error, it'll return a `decision` with nil for `variation_key`. The decision will include an error message in `reasons`
+    #
+    # @param key -A flag key for which a decision will be made
+    # @param options - A list of options for decision making.
+    #
+    # @return [OptimizelyDecision] A decision result
+
+    def decide(key, options = nil)
+      @optimizely_client&.decide(clone, key, options)
+    end
+
+    # Returns a hash of decision results (OptimizelyDecision) for multiple flag keys and a user context.
+    #
+    # If the SDK finds an error for a key, the response will include a decision for the key showing `reasons` for the error.
+    # The SDK will always return hash of decisions. When it can not process requests, it'll return an empty hash after logging the errors.
+    #
+    # @param keys - A list of flag keys for which the decisions will be made.
+    # @param options - A list of options for decision making.
+    #
+    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
+
+    def decide_for_keys(keys, options = nil)
+      @optimizely_client&.decide_for_keys(clone, keys, options)
+    end
+
+    # Returns a hash of decision results (OptimizelyDecision) for all active flag keys.
+    #
+    # @param options - A list of options for decision making.
+    #
+    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
+
+    def decide_all(options = nil)
+      @optimizely_client&.decide_all(clone, options)
+    end
+
+    # Sets the forced decision (variation key) for a given flag and an optional rule.
+    #
+    # @param context - An OptimizelyDecisionContext object containg flag key and rule key.
+    # @param decision - An OptimizelyForcedDecision object containing variation key
+    #
+    # @return - true if the forced decision has been set successfully.
+
+    def set_forced_decision(context, decision)
+      flag_key = context[:flag_key]
+      return false if flag_key.nil?
+
+      @forced_decision_mutex.synchronize { @forced_decisions[context] = decision }
+
+      true
+    end
+
+    def find_forced_decision(context)
+      return nil if @forced_decisions.empty?
+
+      decision = nil
+      @forced_decision_mutex.synchronize { decision = @forced_decisions[context] }
+      decision
+    end
+
+    # Returns the forced decision for a given flag and an optional rule.
+    #
+    # @param context - An OptimizelyDecisionContext object containg flag key and rule key.
+    #
+    # @return - A variation key or nil if forced decisions are not set for the parameters.
+
+    def get_forced_decision(context)
+      find_forced_decision(context)
+    end
+
+    # Removes the forced decision for a given flag and an optional rule.
+    #
+    # @param context - An OptimizelyDecisionContext object containg flag key and rule key.
+    #
+    # @return - true if the forced decision has been removed successfully.
+
+    def remove_forced_decision(context)
+      deleted = false
+      @forced_decision_mutex.synchronize do
+        if @forced_decisions.key?(context)
+          @forced_decisions.delete(context)
+          deleted = true
+        end
+      end
+      deleted
+    end
+
+    # Removes all forced decisions bound to this user context.
+    #
+    # @return - true if forced decisions have been removed successfully.
+
+    def remove_all_forced_decisions
+      return false if @optimizely_client&.get_optimizely_config.nil?
+
+      @forced_decision_mutex.synchronize { @forced_decisions.clear }
+      true
+    end
+
+    # Track an event
+    #
+    # @param event_key - Event key representing the event which needs to be recorded.
+
+    def track_event(event_key, event_tags = nil)
+      @optimizely_client&.track(event_key, @user_id, user_attributes, event_tags)
+    end
+
+    def as_json
+      {
+        user_id: @user_id,
+        attributes: @user_attributes
+      }
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
+    # Returns An array of qualified segments for this user
+    #
+    # @return - An array of segments names.
+
+    def qualified_segments
+      @qualified_segment_mutex.synchronize { @qualified_segments.clone }
+    end
+
+    # Replace qualified segments with provided segments
+    #
+    # @param segments - An array of segment names
+
+    def qualified_segments=(segments)
+      @qualified_segment_mutex.synchronize { @qualified_segments = segments.clone }
+    end
+
+    # Checks if user is qualified for the provided segment.
+    #
+    # @param segment - A segment name
+
+    def qualified_for?(segment)
+      return false if @qualified_segments.empty?
+
+      @qualified_segment_mutex.synchronize { @qualified_segments.include?(segment) }
+    end
+  end
+end

data/lib/optimizely/params.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2017, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-module Optimizely
-  class Params
-    ACCOUNT_ID = 'd'
-    PROJECT_ID = 'a'
-    EXPERIMENT_PREFIX = 'x'
-    GOAL_ID = 'g'
-    GOAL_NAME = 'n'
-    SEGMENT_PREFIX = 's'
-    END_USER_ID = 'u'
-    EVENT_VALUE = 'v'
-    SOURCE = 'src'
-    TIME = 'time'
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2017, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+module Optimizely
+  class Params
+    ACCOUNT_ID = 'd'
+    PROJECT_ID = 'a'
+    EXPERIMENT_PREFIX = 'x'
+    GOAL_ID = 'g'
+    GOAL_NAME = 'n'
+    SEGMENT_PREFIX = 's'
+    END_USER_ID = 'u'
+    EVENT_VALUE = 'v'
+    SOURCE = 'src'
+    TIME = 'time'
+  end
+end

data/lib/optimizely/project_config.rb

@@ -1,91 +1,99 @@
-# frozen_string_literal: true
-
-#    Copyright 2016-2021, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-
-module Optimizely
-  class ProjectConfig
-    # ProjectConfig is an interface capturing the experiment, variation and feature definitions.
-    # The default implementation of ProjectConfig can be found in DatafileProjectConfig.
-
-    def datafile; end
-
-    def account_id; end
-
-    def attributes; end
-
-    def audiences; end
-
-    def typed_audiences; end
-
-    def events; end
-
-    def experiments; end
-
-    def feature_flags; end
-
-    def groups; end
-
-    def project_id; end
-
-    def anonymize_ip; end
-
-    def bot_filtering; end
-
-    def revision; end
-
-    def sdk_key; end
-
-    def environment_key; end
-
-    def send_flag_decisions; end
-
-    def rollouts; end
-
-    def experiment_running?(experiment); end
-
-    def get_experiment_from_key(experiment_key); end
-
-    def get_experiment_from_id(experiment_id); end
-
-    def get_experiment_key(experiment_id); end
-
-    def get_event_from_key(event_key); end
-
-    def get_audience_from_id(audience_id); end
-
-    def get_variation_from_id(experiment_key, variation_id); end
-
-    def get_variation_from_id_by_experiment_id(experiment_id, variation_id); end
-
-    def get_variation_id_from_key_by_experiment_id(experiment_id, variation_key); end
-
-    def get_variation_id_from_key(experiment_key, variation_key); end
-
-    def get_whitelisted_variations(experiment_id); end
-
-    def get_attribute_id(attribute_key); end
-
-    def variation_id_exists?(experiment_id, variation_id); end
-
-    def get_feature_flag_from_key(feature_flag_key); end
-
-    def get_feature_variable(feature_flag, variable_key); end
-
-    def get_rollout_from_id(rollout_id); end
-
-    def feature_experiment?(experiment_id); end
-  end
-end
+# frozen_string_literal: true
+
+#    Copyright 2016-2021, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+module Optimizely
+  class ProjectConfig
+    # ProjectConfig is an interface capturing the experiment, variation and feature definitions.
+    # The default implementation of ProjectConfig can be found in DatafileProjectConfig.
+
+    def datafile; end
+
+    def account_id; end
+
+    def attributes; end
+
+    def audiences; end
+
+    def typed_audiences; end
+
+    def events; end
+
+    def experiments; end
+
+    def feature_flags; end
+
+    def groups; end
+
+    def project_id; end
+
+    def anonymize_ip; end
+
+    def bot_filtering; end
+
+    def revision; end
+
+    def sdk_key; end
+
+    def environment_key; end
+
+    def send_flag_decisions; end
+
+    def rollouts; end
+
+    def integrations; end
+
+    def public_key_for_odp; end
+
+    def host_for_odp; end
+
+    def all_segments; end
+
+    def experiment_running?(experiment); end
+
+    def get_experiment_from_key(experiment_key); end
+
+    def get_experiment_from_id(experiment_id); end
+
+    def get_experiment_key(experiment_id); end
+
+    def get_event_from_key(event_key); end
+
+    def get_audience_from_id(audience_id); end
+
+    def get_variation_from_id(experiment_key, variation_id); end
+
+    def get_variation_from_id_by_experiment_id(experiment_id, variation_id); end
+
+    def get_variation_id_from_key_by_experiment_id(experiment_id, variation_key); end
+
+    def get_variation_id_from_key(experiment_key, variation_key); end
+
+    def get_whitelisted_variations(experiment_id); end
+
+    def get_attribute_id(attribute_key); end
+
+    def variation_id_exists?(experiment_id, variation_id); end
+
+    def get_feature_flag_from_key(feature_flag_key); end
+
+    def get_feature_variable(feature_flag, variable_key); end
+
+    def get_rollout_from_id(rollout_id); end
+
+    def feature_experiment?(experiment_id); end
+  end
+end