wingify-fme-ruby-sdk 1.50.0

data/lib/wingify/utils/event_util.rb

@@ -0,0 +1,55 @@
+# Copyright 2024-2026 Wingify Software Pvt. Ltd.
+#
+# 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 './network_util'
+require_relative '../enums/event_enum'
+require_relative '../services/batch_event_queue'
+
+# Sends an init called event to VWO.
+# This event is triggered when the init function is called.
+# @param settings_fetch_time [Number] Time taken to fetch settings in milliseconds.
+# @param sdk_init_time [Number] Time taken to initialize the SDK in milliseconds.
+def send_sdk_init_event(settings_fetch_time, sdk_init_time)
+  # Get base properties for the event
+  properties = NetworkUtil.get_events_base_properties(EventEnum::INIT_CALLED)
+  payload = NetworkUtil.get_sdk_init_event_payload(EventEnum::INIT_CALLED, settings_fetch_time, sdk_init_time)
+
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # Send the constructed payload via POST request
+    NetworkUtil.send_event(properties, payload)
+  end
+end
+
+# Sends a usage stats event to VWO.
+# @param usage_stats_account_id - The account id for usage stats.
+def send_sdk_usage_stats_event(usage_stats_account_id)
+  # create query parameters
+  properties = NetworkUtil.get_events_base_properties(EventEnum::USAGE_STATS, nil, nil, true, usage_stats_account_id)
+
+  # create payload
+  payload = NetworkUtil.get_sdk_usage_stats_payload_data(EventEnum::USAGE_STATS, usage_stats_account_id)
+
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # send event
+    NetworkUtil.send_event(properties, payload)
+  end
+end

data/lib/wingify/utils/function_util.rb

@@ -0,0 +1,141 @@
+# Copyright 2024-2026 Wingify Software Pvt. Ltd.
+#
+# 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 '../enums/campaign_type_enum'
+require_relative '../models/campaign/campaign_model'
+require_relative '../models/campaign/feature_model'
+require_relative '../models/settings/settings_model'
+require_relative '../utils/data_type_util'
+require_relative '../services/logger_service'
+require_relative '../enums/log_level_enum'
+require_relative '../constants/constants'
+require_relative '../utils/data_type_util'
+
+# Clones an object deeply.
+# @param obj [Object] The object to clone.
+# @return [Object] The cloned object.
+def clone_object(obj)
+  return obj unless obj
+  Marshal.load(Marshal.dump(obj))
+end
+
+# Gets the current time in ISO string format.
+# @return [String] The current time in ISO string format.
+def get_current_time
+  Time.now.utc.iso8601
+end
+
+# Gets the current Unix timestamp in seconds.
+# @return [Integer] The current Unix timestamp.
+def get_current_unix_timestamp
+  Time.now.to_i
+end
+
+# Gets the current Unix timestamp in milliseconds.
+# @return [Integer] The current Unix timestamp in milliseconds.
+def get_current_unix_timestamp_in_millis
+  (Time.now.to_f * 1000).to_i
+end
+
+# Generates a random number between 0 and 1.
+# @return [Float] A random number.
+def get_random_number
+  rand
+end
+
+# Retrieves specific rules based on the type from a feature.
+# @param feature [FeatureModel] The feature object.
+# @param type [CampaignTypeEnum, nil] The type of the rules to retrieve.
+# @return [Array] An array of rules that match the type.
+def get_specific_rules_based_on_type(feature, type = nil)
+  return [] unless feature&.get_rules_linked_campaign
+
+  return feature.get_rules_linked_campaign if type.nil? || !DataTypeUtil.is_string(type)
+
+  feature.get_rules_linked_campaign.select do |rule|
+    rule_model = CampaignModel.new.model_from_dictionary(rule)
+    rule_model.get_type == type
+  end
+end
+
+# Retrieves all AB and Personalize rules from a feature.
+# @param feature [FeatureModel] The feature object.
+# @return [Array] An array of AB and Personalize rules.
+def get_all_experiment_rules(feature)
+  return [] unless feature
+
+  feature.get_rules_linked_campaign.select do |rule|
+    [CampaignTypeEnum::AB, CampaignTypeEnum::PERSONALIZE].include?(rule.get_type)
+  end
+end
+
+# Retrieves a feature by its key from the settings.
+# @param settings [SettingsModel] The settings containing features.
+# @param feature_key [String] The key of the feature to find.
+# @return [FeatureModel, nil] The feature if found, otherwise nil.
+def get_feature_from_key(settings, feature_key)
+  return nil unless settings&.get_features
+
+  settings.get_features.find { |feature| feature.get_key == feature_key }
+end
+
+# Checks if an event exists within any feature's metrics.
+# @param event_name [String] The name of the event to check.
+# @param settings [SettingsModel] The settings containing features.
+# @return [Boolean] True if the event exists, otherwise false.
+def does_event_belong_to_any_feature(event_name, settings)
+  settings.get_features.any? do |feature|
+    feature.get_metrics.any? { |metric| metric.get_identifier == event_name }
+  end
+end
+
+# Adds linked campaigns to each feature in the settings based on rules.
+# @param settings [SettingsModel] The settings file to modify.
+def add_linked_campaigns_to_settings(settings)
+  campaign_map = settings.get_campaigns.each_with_object({}) do |campaign, map|
+    map[campaign.get_id] = campaign
+  end
+
+  settings.get_features.each do |feature|
+    rules_linked_campaign = feature.get_rules.map do |rule|
+      campaign = campaign_map[rule.get_campaign_id]
+      next unless campaign
+
+      linked_campaign = campaign.clone
+      linked_campaign.set_rule_key(rule.get_rule_key)
+      if rule.get_variation_id
+        variation = campaign.get_variations.find { |v| v.get_id == rule.get_variation_id }
+        linked_campaign.set_variations([variation]) if variation
+      end
+
+      linked_campaign
+    end.compact
+
+    feature.set_rules_linked_campaign(rules_linked_campaign)
+  end
+end
+
+# Formats error messages for logging
+# @param error [Object] The error object (can be Error, String, Hash, etc.)
+# @return [String] The formatted error message
+def get_formatted_error_message(error)
+  if error.is_a?(StandardError)
+    error.message
+  elsif error.is_a?(String)
+    error
+  elsif error.is_a?(Hash) || error.is_a?(Array)
+    error.to_json
+  end
+  error
+end

data/lib/wingify/utils/gateway_service_util.rb

@@ -0,0 +1,101 @@
+# Copyright 2024-2026 Wingify Software Pvt. Ltd.
+#
+# 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 '../models/settings/settings_model'
+require_relative '../packages/network_layer/manager/network_manager'
+require_relative '../packages/network_layer/models/request_model'
+require_relative '../enums/http_method_enum'
+require_relative '../services/settings_service'
+require_relative '../enums/campaign_type_enum'
+require_relative '../services/logger_service'
+require_relative '../enums/log_level_enum'
+require_relative '../enums/api_enum'
+
+# Retrieves data from a web service using the specified query parameters and endpoint.
+# @param query_params [Hash] The parameters to be used in the query string of the request.
+# @param endpoint [String] The endpoint URL to which the request is sent.
+# @return [Hash, Boolean] The response data or false if an error occurs.
+def get_from_gateway_service(query_params, endpoint)
+  network_instance = NetworkManager.instance
+
+  unless SettingsService.instance.is_gateway_service_provided
+    LoggerService.log(LogLevelEnum::ERROR, "INVALID_GATEWAY_URL", { an: ApiEnum::GET_FLAG})
+    return false
+  end
+
+  begin
+    request = RequestModel.new(
+      SettingsService.instance.hostname,
+      HttpMethodEnum::GET,
+      SettingsService.instance.get_updated_endpoint_with_collection_prefix(endpoint, SettingsService.instance.is_gateway_service_provided),
+      query_params,
+      nil,
+      nil,
+      SettingsService.instance.protocol,
+      SettingsService.instance.port
+    )
+
+    response = network_instance.get(request)
+    return response.get_data
+  rescue StandardError => e
+    LoggerService.log(LogLevelEnum::ERROR, "ERROR_FETCHING_SETTINGS", { err: e.message, an: ApiEnum::GET_FLAG})
+    return false
+  end
+end
+
+# Encodes the query parameters to ensure they are URL-safe.
+# @param query_params [Hash] The query parameters to be encoded.
+# @return [Hash] An object containing the encoded query parameters.
+def get_query_params(query_params)
+  encoded_params = {}
+
+  query_params.each do |key, value|
+    encoded_params[key] = URI.encode_www_form_component(value.to_s)
+  end
+
+  encoded_params
+end
+
+# Adds isGatewayServiceRequired flag to each feature in the settings based on pre-segmentation.
+# @param settings [SettingsModel] The settings file to modify.
+def add_is_gateway_service_required_flag(settings)
+  pattern = /
+    (?!custom_variable\s*:\s*{\s*"name"\s*:\s*")   # Prevent matching inside custom_variable
+    \b(country|region|city|os|device|device_type|browser_string|ua|browser_version|os_version)\b
+    |
+    "custom_variable"\s*:\s*{\s*"name"\s*:\s*"inlist\([^)]*\)"
+  /x
+
+  settings.get_features.each do |feature|
+    feature.get_rules_linked_campaign.each do |rule|
+      segments = {}
+
+      if [CampaignTypeEnum::PERSONALIZE, CampaignTypeEnum::ROLLOUT].include?(rule.get_type)
+        segments = rule.get_variations[0].get_segments
+      else
+        segments = rule.get_segments
+      end
+
+      next unless segments
+
+      json_segments = segments.to_json
+      matches = json_segments.scan(pattern)
+
+      if matches.any?
+        feature.set_is_gateway_service_required(true)
+        break
+      end
+    end
+  end
+end

data/lib/wingify/utils/impression_util.rb

@@ -0,0 +1,66 @@
+# Copyright 2024-2026 Wingify Software Pvt. Ltd.
+#
+# 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 '../models/settings/settings_model'
+require_relative './network_util'
+require_relative '../models/user/context_model'
+require_relative '../enums/event_enum'
+require_relative '../services/batch_event_queue'
+require_relative '../utils/campaign_util'
+# Creates and sends an impression for a variation shown event.
+# This function constructs the necessary properties and payload for the event
+# and uses the NetworkUtil to send a POST API request.
+#
+# @param settings [SettingsModel] The settings model containing configuration.
+# @param campaign_id [Integer] The ID of the campaign.
+# @param variation_id [Integer] The ID of the variation shown to the user.
+# @param context [ContextModel] The user context model containing user-specific data.
+def create_and_send_impression_for_variation_shown(settings, campaign_id, variation_id, context, feature_key)
+  # Get base properties for the event
+  properties = NetworkUtil.get_events_base_properties(
+    EventEnum::VARIATION_SHOWN,
+    URI.encode_www_form_component(context.get_user_agent), # Encode user agent for URL safety
+    context.get_ip_address
+  )
+
+  # Construct payload data for tracking the user
+  payload = NetworkUtil.get_track_user_payload_data(
+    EventEnum::VARIATION_SHOWN,
+    campaign_id,
+    variation_id,
+    context
+  )
+
+  campaign_key_with_feature_name = CampaignUtil.get_campaign_key_from_campaign_id(settings, campaign_id)
+  variation_name = CampaignUtil.get_variation_name_from_campaign_id_and_variation_id(settings, campaign_id, variation_id)
+
+  campaign_key = ''
+
+  if feature_key == campaign_key_with_feature_name
+    campaign_key = Constants::IMPACT_ANALYSIS
+  else
+    campaign_key = campaign_key_with_feature_name.split("#{feature_key}_")[1]
+  end
+
+  campaign_type = CampaignUtil.get_campaign_type_from_campaign_id(settings, campaign_id)
+
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # Send the constructed payload via POST request
+    NetworkUtil.send_post_api_request(properties, payload, { campaign_type: campaign_type, feature_key: feature_key, campaign_key: campaign_key, variation_name: variation_name })
+  end
+end

data/lib/wingify/utils/log_message_util.rb

@@ -0,0 +1,42 @@
+# Copyright 2024-2026 Wingify Software Pvt. Ltd.
+#
+# 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.
+
+# Constructs a message by replacing placeholders in a template with corresponding values from a data hash.
+#
+# @param template [String] The message template containing placeholders in the format `{key}`.
+# @param data [Hash] An object containing keys and values used to replace the placeholders in the template.
+# @return [String] The constructed message with all placeholders replaced by their corresponding values from the data hash.
+def build_message(template, data = {})
+    begin
+      template.gsub(/\{([0-9a-zA-Z_]+)\}/) do |match|
+        key = match.tr('{}', '') # Extract the key from `{key}`
+        
+        # Check for escaped placeholders like `{{key}}`
+        if template[template.index(match) - 1] == '{' && template[template.index(match) + match.length] == '}'
+          key
+        else
+          value = data[key.to_sym] || data[key] # Support both string and symbol keys
+  
+          # Return empty string if key is missing
+          next '' if value.nil?
+  
+          # If value is a callable (Proc/Lambda), execute it
+          value.respond_to?(:call) ? value.call : value
+        end
+      end
+    rescue StandardError
+      template # Return the original template in case of an error
+    end
+  end
+