kameleoon-client-ruby 3.1.1 → 3.3.0

data/lib/kameleoon/targeting/conditions/time_elapsed_since_visit_condition.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/conditions/number_condition'
+require 'kameleoon/data/visitor_visits'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    class TimeElapsedSinceVisitCondition < NumberCondition
+      def initialize(json_condition)
+        count_in_millis = json_condition['countInMillis']
+        super(json_condition, count_in_millis)
+        @is_first_visit = @type == Kameleoon::Targeting::ConditionType::FIRST_VISIT
+      end
+
+      def check(data)
+        return false unless data.is_a?(Kameleoon::VisitorVisits) && !@condition_value.nil?
+
+        previous_visits_count = data.previous_visit_timestamps.count
+        if previous_visits_count >= 1
+          now = (Time.now.to_f * 1000).to_i # ... * 1000 for convert seconds to milliseconds
+          visit_time = data.previous_visit_timestamps[@is_first_visit ? previous_visits_count - 1 : 0]
+          return check_targeting(now - visit_time)
+        end
+        false
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/conditions/visit_number_today_condition.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/visitor_visits'
+require 'time'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    class VisitNumberTodayCondition < NumberCondition
+      def initialize(json_condition)
+        visit_count = json_condition['visitCount']
+        super(json_condition, visit_count)
+      end
+
+      def check(data)
+        return false unless VisitorVisits.visitor_visits?(data) && !@condition_value.nil?
+
+        number_of_visits_today = 0
+        start_of_day = (Time.new.to_date.to_time.to_f * 1000).to_i # ... * 1000 to convert seconds to milliseconds
+        for timestamp in VisitorVisits.get_previous_visit_timestamps(data)
+          break if timestamp < start_of_day
+          number_of_visits_today += 1
+        end
+        check_targeting(number_of_visits_today + 1) # +1 for current visit
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/conditions/visit_number_total_condition.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/visitor_visits'
+require 'kameleoon/targeting/conditions/number_condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    class VisitNumberTotalCondition < NumberCondition
+      def initialize(json_condition)
+        visit_count = json_condition['visitCount']
+        super(json_condition, visit_count)
+      end
+
+      def check(data)
+        return false unless VisitorVisits.visitor_visits?(data) && !@condition_value.nil?
+
+        previous_visit_timestamps = VisitorVisits.get_previous_visit_timestamps(data)
+        check_targeting(previous_visit_timestamps.size + 1) # +1 for current visit
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/conditions/visitor_new_return_condition.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/visitor_visits'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    module VisitorType
+      NEW = 'NEW'
+      RETURNING = 'RETURNING'
+    end
+
+    class VisitorNewReturnCondition < Condition
+      def initialize(json_condition)
+        super(json_condition)
+        @visitor_type = json_condition['visitorType']
+      end
+
+      def check(data)
+        return false unless VisitorVisits.visitor_visits?(data)
+
+        previous_visit_timestamps = VisitorVisits.get_previous_visit_timestamps(data)
+        case @visitor_type
+        when VisitorType::NEW
+          previous_visit_timestamps.empty?
+        when VisitorType::RETURNING
+          !previous_visit_timestamps.empty?
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/targeting_manager.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/conditions/segment_condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    class TargetingManager
+      def initialize(visitor_manager, data_file)
+        @visitor_manager = visitor_manager
+        @data_file = data_file
+      end
+
+      def check_targeting(visitor_code, campaign_id, exp_ff_rule)
+        segment = exp_ff_rule.targeting_segment
+        return true if segment.nil?
+
+        visitor = @visitor_manager.get_visitor(visitor_code)
+        segment.check_tree(->(type) { get_condition_data(type, visitor, visitor_code, campaign_id) })
+      end
+
+      def get_condition_data(type, visitor, visitor_code, campaign_id)
+        condition_data = nil
+        case type
+        when Kameleoon::Targeting::ConditionType::CUSTOM_DATUM
+          condition_data = visitor.custom_data unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::PAGE_VIEWS,
+          Kameleoon::Targeting::ConditionType::PREVIOUS_PAGE,
+          Kameleoon::Targeting::ConditionType::PAGE_TITLE,
+          Kameleoon::Targeting::ConditionType::PAGE_URL
+          condition_data = visitor.page_view_visits unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::DEVICE_TYPE
+          condition_data = visitor.device unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::BROWSER
+          condition_data = visitor.browser unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::COOKIE
+          condition_data = visitor.cookie unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::GEOLOCATION
+          condition_data = visitor.geolocation unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::OPERATING_SYSTEM
+          condition_data = visitor.operating_system unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::SEGMENT
+          condition_data = SegmentInfo.new(
+            @data_file,
+            lambda { |type|
+              get_condition_data(type, visitor, visitor_code, campaign_id)
+            }
+          )
+        when Kameleoon::Targeting::ConditionType::CONVERSIONS
+          condition_data = visitor.conversions unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::SDK_LANGUAGE
+          condition_data = Kameleoon::Targeting::SdkInfo.new(Kameleoon::SDK_NAME, Kameleoon::SDK_VERSION)
+        when Kameleoon::Targeting::ConditionType::VISITOR_CODE
+          condition_data = visitor_code
+        when Kameleoon::Targeting::ConditionType::TARGET_FEATURE_FLAG
+          condition_data = TargetFeatureFlagInfo.new(@data_file, visitor.variations) unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::EXCLUSIVE_FEATURE_FLAG
+          condition_data = ExclusiveFeatureFlagInfo.new(campaign_id, visitor&.variations)
+        when ConditionType::FIRST_VISIT, ConditionType::LAST_VISIT, ConditionType::VISITS, ConditionType::SAME_DAY_VISITS, ConditionType::NEW_VISITORS
+          condition_data = visitor.visitor_visits unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::HEAT_SLICE
+          condition_data = visitor&.kcs_heat
+        end
+        condition_data
+      end
+    end
+  end
+end

data/lib/kameleoon/types/remote_visitor_data_filter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Types
+    class RemoteVisitorDataFilter
+      attr_reader :previous_visit_amount, :current_visit, :custom_data, :page_views, :geolocation, :device, :browser,
+                  :operating_system, :conversions, :experiments, :kcs
+
+      def initialize(
+        previous_visit_amount: 1, current_visit: true, custom_data: true, page_views: false,
+        geolocation: false, device: false, browser: false, operating_system: false, conversions: false,
+        experiments: false, kcs: false
+      )
+        @previous_visit_amount = previous_visit_amount
+        @current_visit = current_visit
+        @custom_data = custom_data
+        @page_views = page_views
+        @geolocation = geolocation
+        @device = device
+        @browser = browser
+        @operating_system = operating_system
+        @conversions = conversions
+        @experiments = experiments
+        @kcs = kcs
+      end
+    end
+  end
+end

data/lib/kameleoon/types/variable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Types
+    # Variable
+    class Variable
+      attr_reader :key, :type, :value
+
+      def initialize(key, type, value)
+        @key = key
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/kameleoon/types/variation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Types
+    # Variation
+    class Variation
+      attr_reader :key, :id, :experiment_id, :variables
+
+      def initialize(key, id, experiment_id, variables)
+        @key = key
+        @id = id
+        @experiment_id = experiment_id
+        @variables = variables
+      end
+    end
+  end
+end

data/lib/kameleoon/utils.rb

@@ -19,6 +19,7 @@ module Kameleoon
       VISITOR_CODE_LENGTH = 16
 
       def self.validate(visitor_code)
+        raise Kameleoon::Exception::VisitorCodeInvalid, 'Visitor Code is nil or invalidate type' unless visitor_code.is_a?(String)
         raise Kameleoon::Exception::VisitorCodeInvalid, 'Empty visitor Code' if visitor_code&.empty?
         if visitor_code.size > VISITOR_CODE_MAX_LENGTH
           raise Kameleoon::Exception::VisitorCodeInvalid, "Visitor Code is longer than #{VISITOR_CODE_MAX_LENGTH} chars"

data/lib/kameleoon/version.rb

@@ -2,7 +2,7 @@
 
 module Kameleoon
   SDK_NAME = 'RUBY'
-  SDK_VERSION = '3.1.1'
+  SDK_VERSION = '3.3.0'
 
   # SdkManager is a helper method for fetching / obtaining version of SDK from string
   class SdkVersion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -76,6 +76,7 @@ files:
 - README.md
 - lib/kameleoon.rb
 - lib/kameleoon/client_readiness.rb
+- lib/kameleoon/configuration/custom_data_info.rb
 - lib/kameleoon/configuration/data_file.rb
 - lib/kameleoon/configuration/feature_flag.rb
 - lib/kameleoon/configuration/rule.rb
@@ -85,22 +86,29 @@ files:
 - lib/kameleoon/configuration/variation_exposition.rb
 - lib/kameleoon/data/browser.rb
 - lib/kameleoon/data/conversion.rb
+- lib/kameleoon/data/cookie.rb
 - lib/kameleoon/data/custom_data.rb
 - lib/kameleoon/data/data.rb
 - lib/kameleoon/data/device.rb
+- lib/kameleoon/data/geolocation.rb
+- lib/kameleoon/data/kcs_heat.rb
 - lib/kameleoon/data/manager/assigned_variation.rb
 - lib/kameleoon/data/manager/data_array_storage.rb
 - lib/kameleoon/data/manager/data_map_storage.rb
 - lib/kameleoon/data/manager/page_view_visit.rb
 - lib/kameleoon/data/manager/visitor.rb
 - lib/kameleoon/data/manager/visitor_manager.rb
+- lib/kameleoon/data/operating_system.rb
 - lib/kameleoon/data/page_view.rb
 - lib/kameleoon/data/user_agent.rb
+- lib/kameleoon/data/visitor_visits.rb
 - lib/kameleoon/exceptions.rb
 - lib/kameleoon/hybrid/manager.rb
 - lib/kameleoon/kameleoon_client.rb
 - lib/kameleoon/kameleoon_client_config.rb
 - lib/kameleoon/kameleoon_client_factory.rb
+- lib/kameleoon/managers/remote_data/remote_data_manager.rb
+- lib/kameleoon/managers/remote_data/remote_visitor_data.rb
 - lib/kameleoon/managers/warehouse/warehouse_manager.rb
 - lib/kameleoon/network/access_token_source.rb
 - lib/kameleoon/network/activity_event.rb
@@ -124,18 +132,34 @@ files:
 - lib/kameleoon/targeting/condition_factory.rb
 - lib/kameleoon/targeting/conditions/browser_condition.rb
 - lib/kameleoon/targeting/conditions/conversion_condition.rb
+- lib/kameleoon/targeting/conditions/cookie_condition.rb
 - lib/kameleoon/targeting/conditions/custom_datum.rb
 - lib/kameleoon/targeting/conditions/device_condition.rb
-- lib/kameleoon/targeting/conditions/exclusive_experiment.rb
+- lib/kameleoon/targeting/conditions/exclusive_feature_flag_condition.rb
+- lib/kameleoon/targeting/conditions/geolocation_condition.rb
+- lib/kameleoon/targeting/conditions/kcs_heat_range_condition.rb
+- lib/kameleoon/targeting/conditions/number_condition.rb
+- lib/kameleoon/targeting/conditions/operating_system_condition.rb
 - lib/kameleoon/targeting/conditions/page_title_condition.rb
 - lib/kameleoon/targeting/conditions/page_url_condition.rb
+- lib/kameleoon/targeting/conditions/page_view_number_condition.rb
+- lib/kameleoon/targeting/conditions/previous_page_condition.rb
 - lib/kameleoon/targeting/conditions/sdk_language_condition.rb
+- lib/kameleoon/targeting/conditions/segment_condition.rb
 - lib/kameleoon/targeting/conditions/string_value_condition.rb
-- lib/kameleoon/targeting/conditions/target_experiment.rb
+- lib/kameleoon/targeting/conditions/target_feature_flag_condition.rb
+- lib/kameleoon/targeting/conditions/time_elapsed_since_visit_condition.rb
 - lib/kameleoon/targeting/conditions/unknown_condition.rb
+- lib/kameleoon/targeting/conditions/visit_number_today_condition.rb
+- lib/kameleoon/targeting/conditions/visit_number_total_condition.rb
 - lib/kameleoon/targeting/conditions/visitor_code_condition.rb
+- lib/kameleoon/targeting/conditions/visitor_new_return_condition.rb
 - lib/kameleoon/targeting/models.rb
+- lib/kameleoon/targeting/targeting_manager.rb
 - lib/kameleoon/targeting/tree_builder.rb
+- lib/kameleoon/types/remote_visitor_data_filter.rb
+- lib/kameleoon/types/variable.rb
+- lib/kameleoon/types/variation.rb
 - lib/kameleoon/utils.rb
 - lib/kameleoon/version.rb
 homepage: https://developers.kameleoon.com/ruby-sdk.html

data/lib/kameleoon/targeting/conditions/exclusive_experiment.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/targeting/condition'
-
-module Kameleoon
-  # @api private
-  module Targeting
-    # ExclusiveExperiment represents an instance of Exclusive Experiment condition in user account
-    class ExclusiveExperiment < Condition
-      def check(data)
-        experiment_id = data.experiment_id
-        storage = data.storage
-        storage.is_a?(Kameleoon::DataManager::DataMapStorage) &&
-          (storage.size.zero? || ((storage.size == 1) && !storage.get(experiment_id).nil?))
-      end
-    end
-  end
-end

data/lib/kameleoon/targeting/conditions/target_experiment.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/targeting/condition'
-require 'kameleoon/exceptions'
-
-module Kameleoon
-  # @api private
-  module Targeting
-    # TargetExperiment represents an instance of Experiment condition in user account
-    class TargetExperiment < Condition
-      include Kameleoon::Exception
-
-      def initialize(json_condition)
-        super(json_condition)
-
-        raise Exception::NotFound.new('experiment'), 'experiment missed' if json_condition['experiment'].nil?
-        if json_condition['variationMatchType'].nil?
-          raise Exception::NotFound.new('variationMatchType'), 'variationMatchType missed'
-        end
-
-        @experiment = json_condition['experiment']
-        @operator = json_condition['variationMatchType']
-        @variation = json_condition['variation']
-      end
-
-      def check(variation_storage)
-        return false unless variation_storage.is_a?(Kameleoon::DataManager::DataMapStorage) &&
-                            variation_storage.size.positive?
-
-        variation = variation_storage.get(@experiment)
-        return false unless variation.is_a?(Kameleoon::DataManager::AssignedVariation)
-
-        case @operator
-        when Operator::EXACT
-          variation = variation_storage.get(@experiment)
-          variation.variation_id == @variation
-        when Operator::ANY
-          true
-        else
-          false
-        end
-      end
-    end
-  end
-end