ibm_appconfiguration_ruby_sdk 0.1.0.pre.rc.0

data/lib/ibm_appconfiguration_ruby_sdk/configurations/internal/websocket_client/websocket_client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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_relative "connection_manager"
+
+class WebSocketClient
+  def initialize(region:, guid:, apikey:, collection_id:, environment_id:, start_background_retry: false)
+    @manager =
+      ConnectionManager.new(
+        region: region,
+        guid: guid,
+        apikey: apikey,
+        collection_id: collection_id,
+        environment_id: environment_id,
+        start_background_retry: start_background_retry
+      )
+  end
+
+  def connect
+    @manager.connect
+  end
+
+  def disconnect
+    @manager.disconnect
+  end
+
+  def connected?
+    @manager.connected?
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/feature.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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_relative "../internal/constants"
+require_relative "../internal/logger"
+
+# Feature model for App Configuration service
+class Feature
+  attr_reader :name, :feature_id, :type, :format, :disabled_value, :enabled_value,
+              :enabled, :rollout_type, :rollout_percentage, :rollout_configuration,
+              :segment_rules, :experiment
+
+  # @param feature [Hash] Feature configuration hash
+  def initialize(feature)
+    @name = feature[:name]
+    @feature_id = feature[:feature_id]
+    @type = feature[:type]
+    @format = feature[:format]
+    @disabled_value = feature[:disabled_value]
+    @enabled_value = feature[:enabled_value]
+    @enabled = feature[:enabled]
+    @rollout_type = feature.key?(:rollout_type) ? feature[:rollout_type] : Constants::MANUAL
+
+    if feature[:rollout_configuration]
+      @rollout_configuration = feature[:rollout_configuration]
+    else
+      @rollout_percentage = feature.key?(:rollout_percentage) ? feature[:rollout_percentage] : 100
+    end
+
+    @segment_rules = feature[:segment_rules]
+    @experiment = feature[:experiment]
+  end
+
+  # @return [String] Feature name
+  def get_feature_name
+    @name || ""
+  end
+
+  # @return [String] Feature ID
+  def get_feature_id
+    @feature_id || ""
+  end
+
+  # @return [String] Feature data type (BOOLEAN/STRING/NUMERIC)
+  def get_feature_data_type
+    @type || ""
+  end
+
+  # @return [String, nil] Feature data format (TEXT/JSON/YAML)
+  def get_feature_data_format
+    @format = "TEXT" if @format.nil? && @type == "STRING"
+    @format
+  end
+
+  # @return [Boolean] Feature enabled state
+  def is_enabled?
+    @enabled
+  end
+
+  ##
+  # Evaluates and returns feature value for entity.
+  # Returns a hash containing evaluated value, enabled status & detailed reason.
+  #
+  # @param entity_id [String] Id of the Entity.
+  #   This will be a string identifier related to the Entity against which the feature is evaluated.
+  #   For example, an entity might be an instance of an app that runs on a mobile device, a microservice
+  #   that runs on the cloud, or a component of infrastructure that runs that microservice.
+  #   For any entity to interact with App Configuration, it must provide a unique entity ID.
+  #
+  # @param entity_attributes [Hash] A hash consisting of the attribute name and their values that defines
+  #   the specified entity. This is an optional parameter if the feature flag is not configured with any
+  #   targeting definition. If the targeting is configured, then entity_attributes should be provided for
+  #   the rule evaluation. An attribute is a parameter that is used to define a segment. The SDK uses the
+  #   attribute values to determine if the specified entity satisfies the targeting rules, and returns the
+  #   appropriate feature flag value.
+  #
+  # @return [Hash, nil] Returns a hash containing evaluated value, enabled status & detailed reason.
+  #   The evaluated value will be one of Enabled/Disabled/Overridden value based on the evaluation.
+  #   The data type of evaluated value matches that of feature flag.
+  #   Returns nil if entity_id is invalid.
+  #
+  # @example
+  #   feature = app_config_client.get_feature('discount')
+  #   if feature
+  #     result = feature.get_current_value(entity_id, entity_attributes)
+  #
+  #     # Access the evaluated value, enabled status & details as shown below
+  #     # result[:value]
+  #     # result[:is_enabled]
+  #     # result[:details]
+  #   end
+  #
+  #   # Note: While experiment is running, the `true` value of result[:is_enabled] indicates that
+  #   # given entity_id was part of experiment audience. The `false` value indicates the entity_id
+  #   # was not part of experiment audience.
+  #
+  def get_current_value(entity_id, entity_attributes = {})
+    if entity_id.nil? || entity_id.to_s.strip.empty?
+      logger = Logger.instance
+      logger.error("Feature flag evaluation: #{Constants::INVALID_ENTITY_ID} get_current_value")
+      return nil
+    end
+
+    require_relative "../configuration_handler"
+    configuration_handler_instance = ConfigurationHandler.instance
+    configuration_handler_instance.feature_evaluation(self, entity_id, entity_attributes)
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/property.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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_relative "../internal/constants"
+require_relative "../internal/logger"
+
+##
+# Defines the model of a Property defined in App Configuration service.
+class Property
+  attr_reader :name, :property_id, :type, :format, :value, :segment_rules
+
+  ##
+  # Initialize a new Property instance
+  # @param property [Hash] properties hash that contains all the properties
+  def initialize(property)
+    @name = property[:name]
+    @property_id = property[:property_id]
+    @type = property[:type]
+    @format = property[:format] # will be nil for boolean & numeric datatypes
+    @value = property[:value]
+    @segment_rules = property[:segment_rules]
+  end
+
+  ##
+  # Get the Property name
+  # @return [String] The Property name
+  def get_property_name
+    @name || ""
+  end
+
+  ##
+  # Get the Property id
+  # @return [String] The Property Id
+  def get_property_id
+    @property_id || ""
+  end
+
+  ##
+  # Get the Property data type
+  # @return [String] string named BOOLEAN/STRING/NUMERIC
+  def get_property_data_type
+    @type || ""
+  end
+
+  ##
+  # Get the Property data format
+  # applicable only for STRING datatype property.
+  #
+  # @return [String, nil] string named TEXT/JSON/YAML
+  def get_property_data_format
+    # Format will be `nil` for Boolean & Numeric properties
+    # If the Format is nil for a String type, we default it to TEXT
+    @format = "TEXT" if @format.nil? && @type == "STRING"
+    @format
+  end
+
+  ##
+  # Get the evaluated value of the property.
+  #
+  # @param entity_id [String] Id of the Entity.
+  # This will be a string identifier related to the Entity against which the property is evaluated.
+  # For example, an entity might be an instance of an app that runs on a mobile device, a microservice that runs on the cloud, or a component of infrastructure that runs that microservice.
+  # For any entity to interact with App Configuration, it must provide a unique entity ID.
+  #
+  # @param entity_attributes [Hash] A hash consisting of the attribute name and their values that defines the specified entity.
+  # This is an optional parameter if the property is not configured with any targeting definition. If the targeting is configured, then entity_attributes should be provided for the rule evaluation.
+  # An attribute is a parameter that is used to define a segment. The SDK uses the attribute values to determine if the
+  # specified entity satisfies the targeting rules, and returns the appropriate property value.
+  #
+  # @return [Hash, nil] Returns a hash containing evaluated value & detailed reason.
+  # The evaluated value will be either the default property value or its overridden value based on the evaluation. The data type of returned value matches that of property.
+  # Returns nil if entity_id is invalid.
+  #
+  # @example
+  #   property = app_config_client.get_property('discount')
+  #   if property
+  #     result = property.get_current_value(entity_id, entity_attributes)
+  #
+  #     # Access the evaluated value & details as shown below
+  #     # result[:value]
+  #     # result[:details]
+  #   end
+  def get_current_value(entity_id, entity_attributes = {})
+    if entity_id.nil? || entity_id.to_s.strip.empty?
+      logger = Logger.instance
+      logger.error("Property evaluation: #{Constants::INVALID_ENTITY_ID} get_current_value")
+      return nil
+    end
+
+    require_relative "../configuration_handler"
+    configuration_handler_instance = ConfigurationHandler.instance
+    configuration_handler_instance.property_evaluation(self, entity_id, entity_attributes)
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/rule.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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.
+
+# Rule model for segment evaluation
+class Rule
+  attr_reader :attribute_name, :operator, :values
+
+  # @param segment_rules [Hash] Rule configuration hash
+  def initialize(segment_rules)
+    @attribute_name = segment_rules[:attribute_name]
+    @operator = segment_rules[:operator]
+    @values = segment_rules[:values]
+  end
+
+  # @param key [Object] Attribute value to check
+  # @param value [Object] Value to compare against
+  # @return [Boolean] True if operator check passes
+  def operator_check(key, value)
+    return false if key.nil? || value.nil?
+
+    case @operator
+    when "endsWith"
+      /#{Regexp.escape(value.to_s)}$/i.match?(key.to_s)
+    when "notEndsWith"
+      !/#{Regexp.escape(value.to_s)}$/i.match?(key.to_s)
+    when "startsWith"
+      /^#{Regexp.escape(value.to_s)}/i.match?(key.to_s)
+    when "notStartsWith"
+      !/^#{Regexp.escape(value.to_s)}/i.match?(key.to_s)
+    when "contains"
+      key.to_s.include?(value.to_s)
+    when "notContains"
+      !key.to_s.include?(value.to_s)
+    when "is"
+      key.is_a?(Numeric) ? key.to_f == value.to_f : key.to_s == value.to_s
+    when "isNot"
+      key.is_a?(Numeric) ? key.to_f != value.to_f : key.to_s != value.to_s
+    when "greaterThan"
+      key.to_f > value.to_f
+    when "lesserThan"
+      key.to_f < value.to_f
+    when "greaterThanEquals"
+      key.to_f >= value.to_f
+    when "lesserThanEquals"
+      key.to_f <= value.to_f
+    else
+      false
+    end
+  end
+
+  # Evaluates rule against entity attributes
+  #
+  # @param entity_attributes [Hash] Entity attributes hash
+  # @return [Boolean] True if evaluation passes
+  def evaluate_rule(entity_attributes)
+    return false unless entity_attributes.is_a?(Hash)
+
+    # Support both string and symbol keys in entity_attributes
+    # Check for string key first, then symbol key
+    key = if entity_attributes.key?(@attribute_name)
+            entity_attributes[@attribute_name]
+          elsif entity_attributes.key?(@attribute_name.to_sym)
+            entity_attributes[@attribute_name.to_sym]
+          else
+            return false
+          end
+
+    if %w[isNot notContains notStartsWith notEndsWith].include?(@operator)
+      @values.all? { |value| operator_check(key, value) }
+    else
+      @values.any? { |value| operator_check(key, value) }
+    end
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/secret_property.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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_relative "../internal/constants"
+require_relative "../internal/logger"
+
+##
+# Defines the SecretProperty model.
+class SecretProperty
+  attr_reader :property_id
+
+  ##
+  # Initialize a new SecretProperty instance
+  # @param property_id [String] Property identifier
+  def initialize(property_id)
+    @property_id = property_id
+  end
+
+  ##
+  # Evaluate the value of the secret property.
+  #
+  # @param entity_id [String] Id of the Entity.
+  # @param entity_attributes [Hash] A hash consisting of the attribute name and their values that defines the specified entity.
+  #
+  # @return [Object, nil] returns the response from the secret manager or nil if entity_id is invalid.
+  # The returned value will be the actual secret value of the evaluated secret reference. The response contains the body, the headers, the status code, and the status text.
+  # If an error occurs, it will be raised as an exception.
+  def get_current_value(entity_id, entity_attributes = {})
+    logger = Logger.instance
+
+    if entity_id.nil? || entity_id.to_s.strip.empty?
+      logger.error("SecretProperty evaluation: #{Constants::INVALID_ENTITY_ID} get_current_value")
+      return nil
+    end
+
+    require_relative "../configuration_handler"
+    configuration_handler_instance = ConfigurationHandler.instance
+
+    # Get the property object
+    property_obj = configuration_handler_instance.get_property(@property_id)
+    return nil unless property_obj
+
+    # Get the current value of the property (which contains the secret reference)
+    property_current_val = property_obj.get_current_value(entity_id, entity_attributes)
+    return nil unless property_current_val
+
+    # Check if the property value contains a secret id
+    if property_current_val[:value].is_a?(Hash) && property_current_val[:value].key?(:id)
+      secret_id = property_current_val[:value][:id]
+
+      # Get the secrets map from configuration handler
+      secret_map = configuration_handler_instance.get_secrets_map
+      secret_manager_obj = secret_map[@property_id]
+
+      return secret_manager_obj.get_secret(id: secret_id) if secret_manager_obj
+
+      # Call the get_secret method on the secret manager object
+      # The caller is responsible for handling any exceptions
+
+      logger.error("SecretProperty Evaluation: Secret manager not configured for property: #{property_obj.get_property_name}")
+      return nil
+
+    end
+
+    logger.error("SecretProperty Evaluation: Secret Id is missing from the Property: #{property_obj.get_property_name}")
+    nil
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/segment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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_relative "rule"
+
+# Segment model for App Configuration service
+class Segment
+  attr_reader :name, :segment_id, :rules
+
+  # @param segment_list [Hash] Segment configuration hash
+  def initialize(segment_list)
+    @name = segment_list[:name]
+    @segment_id = segment_list[:segment_id]
+    @rules = segment_list[:rules] || []
+  end
+
+  # Evaluates all segment rules against entity attributes
+  #
+  # @param entity_attributes [Hash] Entity attributes hash
+  # @return [Boolean] True if all rules pass
+  def evaluate_rule(entity_attributes)
+    @rules.all? do |rule|
+      Rule.new(rule).evaluate_rule(entity_attributes)
+    end
+  end
+end

data/lib/ibm_appconfiguration_ruby_sdk/configurations/models/segment_rules.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2026 IBM Corp. All Rights Reserved.
+#
+# 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.
+
+# SegmentRules model for App Configuration service
+class SegmentRules
+  attr_reader :rules, :rule_id, :value, :order, :rollout_type, :rollout_percentage, :rollout_configuration
+
+  # @param segment_rules [Hash] Segment rules configuration hash
+  def initialize(segment_rules)
+    require_relative "../internal/constants"
+
+    @rules = segment_rules[:rules]
+    @rule_id = segment_rules[:rule_id]
+    @value = segment_rules[:value]
+    @order = segment_rules[:order]
+    @rollout_type = segment_rules.key?(:rollout_type) ? segment_rules[:rollout_type] : Constants::MANUAL
+
+    if segment_rules[:rollout_configuration]
+      @rollout_configuration = segment_rules[:rollout_configuration]
+    else
+      @rollout_percentage = segment_rules.key?(:rollout_percentage) ? segment_rules[:rollout_percentage] : 100
+    end
+  end
+
+  # @return [Array<Hash>] Rules array
+  def get_rules
+    @rules || []
+  end
+
+  # @return [Boolean, String, Numeric] Rule value
+  def get_value
+    @value || ""
+  end
+
+  # @return [Integer] Rule order
+  def get_order
+    @order
+  end
+
+  # @return [Integer] Rollout percentage
+  def get_rollout_percentage
+    @rollout_percentage
+  end
+end