vwo-fme-ruby-sdk 1.0.0 → 1.1.0

data/lib/vwo/models/campaign/variation_model.rb

@@ -0,0 +1,137 @@
+# Copyright 2025 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 'variable_model'
+
+class VariationModel
+  attr_accessor :id, :key, :rule_key, :weight, :segments, :start_range_variation,
+                :end_range_variation, :variables, :variations, :type, :salt
+
+  def initialize
+    @id = nil
+    @key = ''
+    @rule_key = ''
+    @weight = 0
+    @start_range_variation = 0
+    @end_range_variation = 0
+    @variables = []
+    @variations = []
+    @segments = {}
+    @type = ''
+    @salt = ''
+  end
+
+  # Creates a model instance from a hash (dictionary)
+  def model_from_dictionary(variation)
+    if variation.is_a?(Hash)
+      @id = variation["id"]
+      @key = variation["key"] || variation["name"]
+      @weight = variation["weight"]
+      @rule_key = variation["ruleKey"]
+      @salt = variation["salt"]
+      @type = variation["type"]
+      @start_range_variation = variation["start_range_variation"]
+      @end_range_variation = variation["end_range_variation"]
+      @segments = variation["segments"] if variation["segments"]
+
+      @variables = process_variables(variation["variables"])
+      @variations = process_variations(variation["variations"])
+    elsif variation.is_a?(VariationModel)
+      @id = variation.id
+      @key = variation.key
+      @weight = variation.weight
+      @rule_key = variation.rule_key
+      @salt = variation.salt
+      @type = variation.type
+      @start_range_variation = variation.start_range_variation
+      @end_range_variation = variation.end_range_variation
+      @segments = variation.segments
+      @variables = variation.variables
+      @variations = variation.variations
+    else
+      @id = variation.id
+      @key = variation.key
+      @rule_key = variation.rule_key
+      @salt = variation.salt
+      @type = variation.type
+      @segments = variation.segments
+      @variations = variation.variations
+    end
+    self
+  end
+
+  # Process variables list
+  def process_variables(variable_list)
+    return [] unless variable_list.is_a?(Array)
+    variable_list.map { |variable| VariableModel.new.model_from_dictionary(variable) }
+  end
+
+  # Process variations list
+  def process_variations(variation_list)
+    return [] unless variation_list.is_a?(Array)
+    variation_list.map { |variation| VariationModel.new.model_from_dictionary(variation) }
+  end
+
+  def get_id
+    @id
+  end
+
+  def get_key
+    @key
+  end
+
+  def get_rule_key
+    @rule_key
+  end
+
+  def get_weight
+    @weight
+  end
+
+  def get_start_range_variation
+    @start_range_variation
+  end
+
+  def set_start_range(start_range_variation)
+    @start_range_variation = start_range_variation
+  end
+
+  def get_end_range_variation
+    @end_range_variation
+  end
+
+  def set_end_range(end_range_variation)
+    @end_range_variation = end_range_variation
+  end
+
+  def get_variables
+    @variables
+  end
+
+  def get_variations
+    @variations
+  end
+
+  def get_segments
+    @segments
+  end
+
+  def get_type
+    @type
+  end
+
+  def get_salt
+    @salt
+  end
+end

data/lib/vwo/models/gateway_service_model.rb

@@ -0,0 +1,39 @@
+# Copyright 2025 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.
+
+class GatewayServiceModel
+    attr_accessor :url, :port
+  
+    def initialize(url = '', port = nil)
+      @url = url
+      @port = port
+    end
+  
+    # Creates a model instance from a hash (dictionary)
+    def model_from_dictionary(gateway_service_model)
+      @url = gateway_service_model[:url]
+      @port = gateway_service_model[:port]
+      self
+    end
+
+    def get_url
+        @url
+    end
+
+    def get_port
+        @port
+    end
+    
+  end
+  

data/lib/vwo/models/schemas/settings_schema_validation.rb

@@ -0,0 +1,102 @@
+# Copyright 2025 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 'dry-schema'
+
+class SettingsSchema
+  def initialize
+    initialize_schemas
+  end
+
+  def initialize_schemas
+    @campaign_metric_schema = Dry::Schema.Params do
+      required(:id).filled(:integer)
+      required(:type).filled(:string)
+      required(:identifier).filled(:string)
+      optional(:mca).maybe(:integer)
+      optional(:hasProps).maybe(:bool)
+      optional(:revenueProp).maybe(:string)
+    end
+
+    @variable_object_schema = Dry::Schema.Params do
+      required(:id).filled(:integer)
+      required(:type).filled(:string)
+      required(:key).filled(:string)
+      required(:value).filled(:string) # Ensuring consistent type
+    end
+
+    @campaign_variation_schema = Dry::Schema.Params do
+      required(:id).filled(:integer)
+      required(:name).filled(:string)
+      required(:weight).filled(:integer)
+      optional(:segments).maybe(:hash)
+      optional(:variables).array(:hash) # Ensuring it takes an array of hashes
+      optional(:startRangeVariation).maybe(:integer)
+      optional(:endRangeVariation).maybe(:integer)
+      optional(:salt).maybe(:string)
+    end
+
+    @campaign_object_schema = Dry::Schema.Params do
+      required(:id).filled(:integer)
+      required(:type).filled(:string)
+      required(:key).filled(:string)
+      optional(:percentTraffic).maybe(:integer)
+      required(:status).filled(:string)
+      required(:variations).array(:hash) # Referencing schema using array of hashes
+      required(:segments).filled(:hash)
+      optional(:isForcedVariationEnabled).maybe(:bool)
+      optional(:isAlwaysCheckSegment).maybe(:bool)
+      required(:name).filled(:string)
+      optional(:salt).maybe(:string)
+    end
+
+    @rule_schema = Dry::Schema.Params do
+      required(:type).filled(:string)
+      required(:ruleKey).filled(:string)
+      required(:campaignId).filled(:integer)
+      optional(:variationId).maybe(:integer)
+    end
+
+    @feature_schema = Dry::Schema.Params do
+      required(:id).filled(:integer)
+      required(:key).filled(:string)
+      required(:status).filled(:string)
+      required(:name).filled(:string)
+      required(:type).filled(:string)
+      required(:metrics).array(:hash)
+      optional(:impactCampaign).maybe(:hash)
+      optional(:rules).array(:hash)
+      optional(:variables).array(:hash)
+    end
+
+    @settings_schema = Dry::Schema.Params do
+      optional(:sdkKey).maybe(:string)
+      required(:version).filled(:integer)
+      required(:accountId).filled(:integer)
+      optional(:features).array(:hash)
+      required(:campaigns).array(:hash)
+      optional(:groups).maybe(:hash)
+      optional(:campaignGroups).maybe(:hash)
+      optional(:collectionPrefix).maybe(:string)
+    end
+  end
+
+  # Validate the settings model
+  def is_settings_valid(settings)
+    return false if settings.nil?
+
+    result = @settings_schema.call(settings)
+    result.errors.empty?
+  end
+end

data/lib/vwo/models/settings/settings_model.rb

@@ -0,0 +1,85 @@
+# Copyright 2025 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 '../campaign/campaign_model'
+require_relative '../campaign/feature_model'
+
+class SettingsModel
+  attr_reader :sdk_key, :account_id, :version, :collection_prefix,
+              :features, :campaigns, :campaign_groups, :groups
+
+  def initialize(settings)
+    @sdk_key = settings["sdkKey"]
+    @account_id = settings["accountId"]
+    @version = settings["version"]
+    @collection_prefix = settings["collectionPrefix"]
+    @features = []
+    @campaigns = []
+    @campaign_groups = settings["campaignGroups"] || {}
+    @groups = settings["groups"] || {}
+
+    process_features(settings)
+    process_campaigns(settings)
+  end
+
+  def get_campaigns
+    @campaigns
+  end
+
+  def get_features
+    @features
+  end
+
+  def get_campaign_groups
+    @campaign_groups
+  end
+
+  def get_groups
+    @groups
+  end
+
+  def get_sdk_key
+    @sdk_key
+  end
+
+  def get_account_id
+    @account_id
+  end
+
+  def get_version
+    @version
+  end
+
+  def get_collection_prefix
+    @collection_prefix
+  end
+
+  def process_features(settings)
+    feature_list = settings["features"]
+    return unless feature_list.is_a?(Array)
+
+    feature_list.each do |feature|
+      @features << FeatureModel.new.model_from_dictionary(feature)
+    end
+  end
+
+  def process_campaigns(settings)
+    campaign_list = settings["campaigns"]
+    return unless campaign_list.is_a?(Array)
+
+    campaign_list.each do |campaign|
+      @campaigns << CampaignModel.new.model_from_dictionary(campaign)
+    end
+  end
+end

data/lib/vwo/models/storage/storage_data_model.rb

@@ -0,0 +1,44 @@
+# Copyright 2025 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 '../user/context_model'
+
+class StorageDataModel
+  attr_accessor :feature_key, :context, :rollout_id, :rollout_key, :rollout_variation_id,
+                :experiment_id, :experiment_key, :experiment_variation_id
+
+  def initialize
+    @feature_key = ''
+    @context = nil
+    @rollout_id = nil
+    @rollout_key = ''
+    @rollout_variation_id = nil
+    @experiment_id = nil
+    @experiment_key = ''
+    @experiment_variation_id = nil
+  end
+
+  # Creates a model instance from a hash (dictionary)
+  def model_from_dictionary(storage_data)
+    @feature_key = storage_data[:feature_key]
+    @context = storage_data[:context]
+    @rollout_id = storage_data[:rollout_id]
+    @rollout_key = storage_data[:rollout_key]
+    @rollout_variation_id = storage_data[:rollout_variation_id]
+    @experiment_id = storage_data[:experiment_id]
+    @experiment_key = storage_data[:experiment_key]
+    @experiment_variation_id = storage_data[:experiment_variation_id]
+    self
+  end
+end

data/lib/vwo/models/user/context_model.rb

@@ -0,0 +1,100 @@
+# Copyright 2025 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 './context_vwo_model'
+
+class ContextModel
+  attr_accessor :id, :user_agent, :ip_address, :custom_variables, :variation_targeting_variables, :vwo
+
+  def initialize(id = nil, user_agent = nil, ip_address = nil, custom_variables = {}, variation_targeting_variables = {}, vwo = nil)
+    @id = id
+    @user_agent = user_agent
+    @ip_address = ip_address
+    @custom_variables = custom_variables || {}
+    @variation_targeting_variables = variation_targeting_variables || {}
+    @vwo = vwo
+  end
+
+  # Creates a model instance from a hash (dictionary)
+  def model_from_dictionary(context)
+    if context.key?(:customVariables) && !context[:customVariables].is_a?(Hash)
+      raise TypeError, 'Invalid context, customVariables should be a hash'
+    end
+
+    if context.key?(:userAgent) && !context[:userAgent].is_a?(String)
+      raise TypeError, 'Invalid context, userAgent should be a string'
+    end
+
+    if context.key?(:ipAddress) && !context[:ipAddress].is_a?(String)
+      raise TypeError, 'Invalid context, ipAddress should be a string'
+    end
+
+    @id = context[:id]
+    @user_agent = context[:userAgent]
+    @ip_address = context[:ipAddress]
+    @custom_variables = context[:customVariables] if context.key?(:customVariables)
+    @variation_targeting_variables = context[:variationTargetingVariables] if context.key?(:variationTargetingVariables)
+    @vwo = ContextVWOModel.new.model_from_dictionary(context[:_vwo]) if context.key?(:_vwo)
+
+    self
+  end
+
+  def get_id
+    @id
+  end
+
+  def set_id(id)
+    @id = id
+  end
+
+  def get_user_agent
+    @user_agent
+  end
+
+  def set_user_agent(user_agent)
+    @user_agent = user_agent
+  end
+
+  def get_ip_address
+    @ip_address
+  end
+
+  def set_ip_address(ip_address)
+    @ip_address = ip_address
+  end
+
+  def get_custom_variables
+    @custom_variables
+  end
+
+  def set_custom_variables(custom_variables)
+    @custom_variables = custom_variables
+  end
+
+  def get_variation_targeting_variables
+    @variation_targeting_variables
+  end
+
+  def set_variation_targeting_variables(variation_targeting_variables)
+    @variation_targeting_variables = variation_targeting_variables
+  end
+
+  def get_vwo
+    @vwo
+  end
+
+  def set_vwo(vwo)
+    @vwo = vwo
+  end
+end

data/lib/vwo/models/user/context_vwo_model.rb

@@ -0,0 +1,38 @@
+# Copyright 2025 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.
+
+class ContextVWOModel
+    attr_accessor :location, :user_agent
+  
+    def initialize(location = {}, user_agent = {})
+      @location = location
+      @user_agent = user_agent
+    end
+  
+    # Creates a model instance from a hash (dictionary)
+    def model_from_dictionary(context)
+      @location = context["location"] if context.key?("location")
+      @user_agent = context["userAgent"] if context.key?("userAgent")
+      self
+    end
+
+    def get_location
+        @location
+    end
+
+    def get_ua_info
+        @user_agent
+    end
+  end
+  

data/lib/vwo/{utils/feature_flag_response.rb → models/user/get_flag_response.rb}

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2025 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.
@@ -12,27 +12,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module VWO
-  class FeatureFlagResponse
+class GetFlagResponse
+    attr_reader :is_enabled, :get_variables, :get_variable
+  
     def initialize(is_enabled, variables = [])
       @is_enabled = is_enabled
       @variables = variables
     end
-
-    # Method to check if the flag is enabled
+  
+    # Define method for is_enabled
     def is_enabled
       @is_enabled
     end
-
-    # Method to get all variables
+  
+    # Define method for get_variables
     def get_variables
       @variables
     end
-
-    # Method to get a specific variable by key, with a fallback default value
-    def get_variable(key, default_value)
-      variable = @variables.find { |var| var['key'] == key }
-      variable ? variable['value'] : default_value
+  
+    # Define method for get_variable
+    def get_variable(key, default_value = nil)
+        variable = @variables.find { |var| var.key == key }
+        variable ? variable.value : default_value
     end
-  end
-end
+  end

data/lib/vwo/models/vwo_options_model.rb

@@ -0,0 +1,107 @@
+# Copyright 2025 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.
+
+class VWOOptionsModel
+  attr_accessor :account_id, :sdk_key, :is_development_mode, :storage, :gateway_service,
+                :poll_interval, :logger, :segmentation, :integrations, :network,
+                :should_wait_for_tracking_calls, :settings, :vwo_builder
+
+  def initialize(options = {})
+    @account_id = options[:account_id]
+    @sdk_key = options[:sdk_key]
+    @is_development_mode = options[:is_development_mode]
+    @storage = options[:storage]
+    @gateway_service = options[:gateway_service]
+    @poll_interval = options[:poll_interval]
+    @logger = options[:logger]
+    @segmentation = options[:segmentation]
+    @integrations = options[:integrations]
+    @network = options[:network]
+    @should_wait_for_tracking_calls = options[:should_wait_for_tracking_calls]
+    @settings = options[:settings]
+    @vwo_builder = options[:vwo_builder]
+  end
+
+  # Creates a model instance from a hash (dictionary)
+  def model_from_dictionary(options)
+    @account_id = options[:account_id]
+    @sdk_key = options[:sdk_key]
+    @vwo_builder = options[:vwo_builder]
+
+    @should_wait_for_tracking_calls = options[:should_wait_for_tracking_calls] if options.key?(:should_wait_for_tracking_calls)
+    @is_development_mode = options[:is_development_mode] if options.key?(:is_development_mode)
+    @storage = options[:storage] if options.key?(:storage)
+    @gateway_service = options[:gateway_service] if options.key?(:gateway_service)
+    @poll_interval = options[:poll_interval] if options.key?(:poll_interval)
+    @logger = options[:logger] if options.key?(:logger)
+    @segmentation = options[:segmentation] if options.key?(:segmentation)
+    @integrations = options[:integrations] if options.key?(:integrations)
+    @network = options[:network] if options.key?(:network)
+    @settings = options[:settings] if options.key?(:settings)
+
+    self
+  end
+
+  def get_account_id
+    @account_id
+  end
+
+  def get_sdk_key
+    @sdk_key
+  end
+
+  def get_is_development_mode
+    @is_development_mode
+  end
+
+  def get_storage
+    @storage
+  end
+
+  def get_gateway_service
+    @gateway_service
+  end
+
+  def get_poll_interval
+    @poll_interval
+  end
+
+  def get_logger
+    @logger
+  end
+
+  def get_segmentation
+    @segmentation
+  end
+
+  def get_integrations
+    @integrations
+  end
+
+  def get_network
+    @network
+  end
+
+  def get_should_wait_for_tracking_calls
+    @should_wait_for_tracking_calls
+  end
+
+  def get_settings
+    @settings
+  end
+
+  def get_vwo_builder
+    @vwo_builder
+  end
+end