kameleoon-client-ruby 2.1.0 → 2.2.0

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/browser'
+require 'kameleoon/version'
+
+module Kameleoon
+  # @api private
+  module Targeting
+
+    CHROME = 'CHROME'
+    INTERNET_EXPLORER = 'IE'
+    FIREFOX = 'FIREFOX'
+    SAFARI = 'SAFARI'
+    OPERA = 'OPERA'
+
+    # BrowserCondition is a condition for checking targeting with browser's type and version
+    class BrowserCondition < Condition
+      def initialize(json_condition)
+        super(json_condition)
+        @browser_type = browser_index_from_name(json_condition['browser'])
+        @version = json_condition['version']
+        @version_match_type = json_condition['versionMatchType']
+      end
+
+      def check(list_data)
+        browser = get_last_targeting_data(list_data, Kameleoon::DataType::BROWSER)
+        browser && check_targeting(browser)
+      end
+
+      private
+
+      def check_targeting(browser)
+        return false if @browser_type != browser.type
+
+        return true if @version.nil?
+
+        version_number = SdkVersion.get_float_version(@version)
+        return false if version_number.nan?
+
+        case @version_match_type
+        when Operator::EQUAL
+          browser.version == version_number
+        when Operator::GREATER
+          browser.version > version_number
+        when Operator::LOWER
+          browser.version < version_number
+        else
+          puts "Unexpected comparing operation for Browser condition: #{@version_match_type}"
+          false
+        end
+      end
+
+      def browser_index_from_name(name)
+        case name
+        when CHROME
+          BrowserType::CHROME
+        when INTERNET_EXPLORER
+          BrowserType::INTERNET_EXPLORER
+        when FIREFOX
+          BrowserType::FIREFOX
+        when SAFARI
+          BrowserType::SAFARI
+        when OPERA
+          BrowserType::OPERA
+        else
+          BrowserType::OTHER
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # ConversionCondition is a condition for checking targeting of conversions of visitor
+    class ConversionCondition < Condition
+      def initialize(json_condition)
+        super(json_condition)
+        @goal_id = json_condition['goalId']
+      end
+
+      def check(list_data)
+        conversion = get_last_targeting_data(list_data, Kameleoon::DataType::CONVERSION)
+        conversion && (@goal_id.nil? || @goal_id == conversion.goal_id)
+      end
+    end
+  end
+end

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

@@ -11,90 +11,85 @@ module Kameleoon
     class CustomDatum < Condition
       include Kameleoon::Exception
 
-      def initialize(json_condition)
-        super(json_condition)
-        @index = json_condition['customDataIndex']
-
-        if json_condition['valueMatchType'].nil?
-          raise Exception::NotFound.new('valueMatchType'), 'valueMatchType missed'
+      class << self
+        def op_match(values, value)
+          re = Regexp.new(value.to_s)
+          values.any? { |v| re.match(v) }
         end
 
-        @operator = json_condition['valueMatchType']
-
-        @value = json_condition['value']
-
-        @type = ConditionType::CUSTOM_DATUM
-
-        if json_condition['include'].nil? && json_condition['isInclude'].nil?
-          raise Exception::NotFound.new('include / isInclude missed'), 'include / isInclude missed'
+        def op_contains(values, value)
+          values.any? { |v| v.to_s.include? value.to_s }
         end
 
-        @include = json_condition['include'] || json_condition['isInclude']
-
-        @op = {
-          Operator::MATCH.to_s => method(:op_match),
-          Operator::CONTAINS.to_s => method(:op_contains),
-          Operator::EXACT.to_s => method(:op_exact),
-          Operator::EQUAL.to_s => method(:op_equal),
-          Operator::GREATER.to_s => method(:op_greater),
-          Operator::LOWER.to_s => method(:op_lower),
-          Operator::IS_TRUE.to_s => method(:op_is_true),
-          Operator::IS_FALSE.to_s => method(:op_is_false),
-          Operator::AMONG_VALUES.to_s => method(:op_among_values),
-        }[@operator]
-      end
+        def op_exact(values, value)
+          values.include? value.to_s
+        end
 
-      def check(datas)
-        is_targeted = false
-        custom_data = datas.select { |data| data.instance == DataType::CUSTOM && data.id == @index }.last
-        if custom_data.nil?
-          is_targeted = (@operator == Operator::UNDEFINED.to_s)
-        elsif @operator != Operator::UNDEFINED.to_s
-          raise KameleoonError.new("Undefined operator #{@operator}"), "Undefined operator #{@operator}" if @op.nil?
+        def op_equal(values, value)
+          values.any? { |v| v.to_f == value.to_f }
+        end
 
-          is_targeted = @op.call(custom_data.values)
+        def op_greater(values, value)
+          values.any? { |v| v.to_f > value.to_f }
         end
-        is_targeted
-      end
 
-      private
+        def op_lower(values, value)
+          values.any? { |v| v.to_f < value.to_f }
+        end
 
-      def op_match(values)
-        re = Regexp.new(@value.to_s)
-        values.any? { |v| re.match(v) }
-      end
+        def op_is_true(values, _value)
+          values.any? { |v| v.to_s == 'true' }
+        end
 
-      def op_contains(values)
-        values.any? { |v| v.to_s.include? @value.to_s }
-      end
+        def op_is_false(values, _value)
+          values.any? { |v| v.to_s == 'false' }
+        end
 
-      def op_exact(values)
-        values.include? @value.to_s
+        def op_among_values(values, value)
+          all_matches = JSON.parse(value.to_s).map(&:to_s).to_set
+          values.any? { |v| all_matches.include?(v) }
+        end
       end
 
-      def op_equal(values)
-        values.any? { |v| v.to_f == @value.to_f }
-      end
+      @@op = {
+        Operator::REGULAR_EXPRESSION => method(:op_match),
+        Operator::CONTAINS => method(:op_contains),
+        Operator::EXACT => method(:op_exact),
+        Operator::EQUAL => method(:op_equal),
+        Operator::GREATER => method(:op_greater),
+        Operator::LOWER => method(:op_lower),
+        Operator::IS_TRUE => method(:op_is_true),
+        Operator::IS_FALSE => method(:op_is_false),
+        Operator::AMONG_VALUES => method(:op_among_values)
+      }
 
-      def op_greater(values)
-        values.any? { |v| v.to_f > @value.to_f }
-      end
+      def initialize(json_condition)
+        super(json_condition)
 
-      def op_lower(values)
-        values.any? { |v| v.to_f < @value.to_f }
-      end
+        if json_condition['valueMatchType'].nil?
+          raise Exception::NotFound.new('valueMatchType'), 'valueMatchType missed'
+        end
 
-      def op_is_true(values)
-        values.any? { |v| v.to_s == 'true' }
+        @type = ConditionType::CUSTOM_DATUM
+        @index = json_condition['customDataIndex']
+        @operator = json_condition['valueMatchType']
+        @value = json_condition['value']
       end
 
-      def op_is_false(values)
-        values.any? { |v| v.to_s == 'false' }
-      end
+      def check(list_data)
+        is_targeted = false
+        custom_data = list_data.select { |data| data.instance == DataType::CUSTOM && data.id == @index }.last
+        if custom_data.nil?
+          is_targeted = (@operator == Operator::UNDEFINED.to_s)
+        elsif @operator != Operator::UNDEFINED.to_s
+          @operation = @@op[@operator]
+          unless @operation
+            raise KameleoonError.new("Undefined operator #{@operator}"), "Undefined operator #{@operator}"
+          end
 
-      def op_among_values(values)
-        all_matches = JSON.parse(@value.to_s).map(&:to_s).to_set
-        values.any? { |v| all_matches.include?(v) }
+          is_targeted = @operation.call(custom_data.values, @value)
+        end
+        is_targeted
       end
     end
   end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # DeviceCondition is a condition for checking device type
+    class DeviceCondition < Condition
+      def initialize(json_condition)
+        super(json_condition)
+        @device_type = json_condition['device']
+      end
+
+      def check(list_data)
+        device = get_last_targeting_data(list_data, Kameleoon::DataType::DEVICE)
+        device && @device_type == device.device_type
+      end
+    end
+  end
+end

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

@@ -1,24 +1,12 @@
 # frozen_string_literal: true
 
 require 'kameleoon/targeting/condition'
-require 'kameleoon/exceptions'
 
 module Kameleoon
   # @api private
   module Targeting
     # ExclusiveExperiment represents an instance of Exclusive Experiment condition in user account
     class ExclusiveExperiment < Condition
-      include Kameleoon::Exception
-
-      def initialize(json_condition)
-        if json_condition['targetingType'].nil?
-          raise Exception::NotFound.new('targetingType'), 'targetingType missed'
-        end
-
-        @type = json_condition['targetingType']
-        @include = true
-      end
-
       def check(data)
         experiment_id = data.experiment_id
         storage = data.storage

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+require_relative 'string_value_condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # PageTitleCondition is a condition for checking title of a page
+    class PageTitleCondition < StringValueCondition
+      def initialize(json_condition)
+        super(json_condition, json_condition['title'])
+      end
+
+      def check(list_data)
+        page_view = get_last_targeting_data(list_data, Kameleoon::DataType::PAGE_VIEW)
+        page_view && check_targeting(page_view.title)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+require_relative 'string_value_condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # PageUrlCondition is a condition for checking url of a page
+    class PageUrlCondition < StringValueCondition
+      def initialize(json_condition)
+        super(json_condition, json_condition['url'])
+      end
+
+      def check(list_data)
+        page_view = get_last_targeting_data(list_data, Kameleoon::DataType::PAGE_VIEW)
+        page_view && check_targeting(page_view.url)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+require 'kameleoon/version'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # Helper class for containing sdk information
+    class SdkInfo
+      attr_reader :language, :version
+
+      def initialize(language, version)
+        @language = language
+        @version = version
+      end
+    end
+
+    # SdkLanguageCondition is a condition for checking targeting sdk type and version
+    class SdkLanguageCondition < Condition
+      def initialize(json_condition)
+        super(json_condition)
+        @sdk_language = json_condition['sdkLanguage']
+        @version = json_condition['version']
+        @operator = json_condition['versionMatchType']
+      end
+
+      def check(data)
+        data.is_a?(SdkInfo) && check_targeting(data)
+      end
+
+      private
+
+      def check_targeting(sdk_info)
+        return false if @sdk_language != sdk_info.language
+
+        return true if @version.nil?
+
+        version_components_condition = SdkVersion.get_version_components(@version)
+        version_components_sdk_info = SdkVersion.get_version_components(sdk_info.version)
+
+        return false if version_components_condition.nil? || version_components_sdk_info.nil?
+
+        major_condition, minor_condition, patch_condition = version_components_condition
+        major_sdk, minor_sdk, patch_sdk = version_components_sdk_info
+
+        case @operator
+        when Operator::EQUAL
+          major_sdk == major_condition && minor_sdk == minor_condition && patch_sdk == patch_condition
+        when Operator::GREATER
+          major_sdk > major_condition ||
+            (major_sdk == major_condition && minor_sdk > minor_condition) ||
+            (major_sdk == major_condition && minor_sdk == minor_condition && patch_sdk > patch_condition)
+        when Operator::LOWER
+          major_sdk < major_condition ||
+            (major_sdk == major_condition && minor_sdk < minor_condition) ||
+            (major_sdk == major_condition && minor_sdk == minor_condition && patch_sdk < patch_condition)
+        else
+          puts "Unexpected comparing operation for SdkLanguage condition: #{@operator}"
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # StringValueCondition is a base class for all conditions where string comparison happens
+    class StringValueCondition < Condition
+      def initialize(json_condition, value)
+        super(json_condition)
+        @condition_value = value
+        @operator = json_condition['matchType']
+      end
+
+      def check(data)
+        data.is_a?(String) && check_targeting(data)
+      end
+
+      protected
+
+      def check_targeting(value)
+        return false if value.nil?
+
+        case @operator
+        when Operator::EXACT
+          value == @condition_value
+        when Operator::CONTAINS
+          value.include?(@condition_value)
+        when Operator::REGULAR_EXPRESSION
+          pattern = Regexp.new(@condition_value)
+          pattern.match?(value)
+        else
+          puts "Unexpected comparing operation for #{@type} condition: #{@operator}"
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -13,16 +13,12 @@ module Kameleoon
       def initialize(json_condition)
         super(json_condition)
 
-        if json_condition['experiment'].nil?
-          raise Exception::NotFound.new('experiment'), 'experiment missed'
-        end
-
-        @experiment = json_condition['experiment']
-
+        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
@@ -32,9 +28,9 @@ module Kameleoon
         variation_storage_exist = !variation_storage.nil? && !variation_storage.empty?
         saved_variation = variation_storage[@experiment] unless variation_storage.nil?
         case @operator
-        when Operator::EXACT.to_s
+        when Operator::EXACT
           is_targeted = variation_storage_exist && saved_variation == @variation
-        when Operator::ANY.to_s
+        when Operator::ANY
           is_targeted = variation_storage_exist
         end
         is_targeted

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # UnknownCondition represents not defined condition, always returns that visitor is targeted (true)
+    class UnknownCondition < Condition
+      def check(_data)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+require_relative 'string_value_condition'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # VisitorCodeCondition is a condition for checking of targeting by visitor code
+    class VisitorCodeCondition < StringValueCondition
+      def initialize(json_condition)
+        super(json_condition, json_condition['visitorCode'])
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/models.rb

@@ -133,29 +133,5 @@ module Kameleoon
         Marshal.load(Marshal.dump(is_targeted)) # Deep copy
       end
     end
-
-    module DataType
-      CUSTOM = 'CUSTOM'
-    end
-
-    module ConditionType
-      CUSTOM_DATUM = 'CUSTOM_DATUM'
-      TARGET_EXPERIMENT = 'TARGET_EXPERIMENT'
-      EXCLUSIVE_EXPERIMENT = 'EXCLUSIVE_EXPERIMENT'
-    end
-
-    module Operator
-      UNDEFINED = 'UNDEFINED'
-      CONTAINS = 'CONTAINS'
-      EXACT = 'EXACT'
-      MATCH = 'REGULAR_EXPRESSION'
-      LOWER = 'LOWER'
-      EQUAL = 'EQUAL'
-      GREATER = 'GREATER'
-      IS_TRUE = 'TRUE'
-      IS_FALSE = 'FALSE'
-      AMONG_VALUES = 'AMONG_VALUES'
-      ANY = 'ANY'
-    end
   end
 end

data/lib/kameleoon/utils.rb

@@ -3,7 +3,7 @@
 module Kameleoon
   # Utils is a helper module for project
   module Utils
-    ALPHA_NUMERIC_CHARS = 'abcdef0123456789'
+    ALPHA_NUMERIC_CHARS = 'ABCDEF0123456789'
 
     def self.in_seconds(days)
       days * 60 * 60 * 24

data/lib/kameleoon/version.rb

@@ -1,5 +1,32 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  VERSION = '2.1.0'
+  SDK_NAME = 'RUBY'
+  SDK_VERSION = '2.2.0'
+
+  # SdkManager is a helper method for fetching / obtaining version of SDK from string
+  class SdkVersion
+    def self.get_version_components(version_string)
+      versions = [0, 0, 0]
+
+      version_parts = version_string.split('.')
+      version_parts.each_with_index do |part, i|
+        versions[i] = Integer(part)
+      rescue ArgumentError
+        puts "Invalid version component, index: #{i}, value: #{part}"
+        return nil
+      end
+      versions
+    end
+
+    def self.get_float_version(version_string)
+      version_components = get_version_components(version_string)
+
+      return Float::NAN if version_components.nil?
+
+      major = version_components[0]
+      minor = version_components[1]
+      "#{major}.#{minor}".to_f
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -84,25 +84,49 @@ files:
 - lib/kameleoon/configuration/variation.rb
 - lib/kameleoon/configuration/variation_exposition.rb
 - lib/kameleoon/cookie.rb
-- lib/kameleoon/data.rb
+- lib/kameleoon/data/browser.rb
+- lib/kameleoon/data/conversion.rb
+- lib/kameleoon/data/custom_data.rb
+- lib/kameleoon/data/data.rb
+- lib/kameleoon/data/device.rb
+- lib/kameleoon/data/page_view.rb
+- lib/kameleoon/data/user_agent.rb
 - lib/kameleoon/exceptions.rb
 - lib/kameleoon/factory.rb
 - lib/kameleoon/hybrid/manager.rb
+- lib/kameleoon/network/activity_event.rb
+- lib/kameleoon/network/content_type.rb
+- lib/kameleoon/network/experiment_event.rb
+- lib/kameleoon/network/method.rb
+- lib/kameleoon/network/net_provider.rb
+- lib/kameleoon/network/network_manager.rb
+- lib/kameleoon/network/request.rb
+- lib/kameleoon/network/response.rb
+- lib/kameleoon/network/uri_helper.rb
+- lib/kameleoon/network/url_provider.rb
 - lib/kameleoon/real_time/real_time_configuration_service.rb
 - lib/kameleoon/real_time/real_time_event.rb
 - lib/kameleoon/real_time/sse_client.rb
 - lib/kameleoon/real_time/sse_message.rb
 - lib/kameleoon/real_time/sse_request.rb
-- lib/kameleoon/request.rb
 - lib/kameleoon/storage/cache.rb
 - lib/kameleoon/storage/cache_factory.rb
 - lib/kameleoon/storage/variation_storage.rb
 - lib/kameleoon/storage/visitor_variation.rb
 - lib/kameleoon/targeting/condition.rb
 - lib/kameleoon/targeting/condition_factory.rb
+- lib/kameleoon/targeting/conditions/browser_condition.rb
+- lib/kameleoon/targeting/conditions/conversion_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/page_title_condition.rb
+- lib/kameleoon/targeting/conditions/page_url_condition.rb
+- lib/kameleoon/targeting/conditions/sdk_language_condition.rb
+- lib/kameleoon/targeting/conditions/string_value_condition.rb
 - lib/kameleoon/targeting/conditions/target_experiment.rb
+- lib/kameleoon/targeting/conditions/unknown_condition.rb
+- lib/kameleoon/targeting/conditions/visitor_code_condition.rb
 - lib/kameleoon/targeting/models.rb
 - lib/kameleoon/targeting/tree_builder.rb
 - lib/kameleoon/utils.rb