kameleoon-client-ruby 2.1.0 → 2.1.1

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.1.1'
+
+  # 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.1.1
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -84,10 +84,20 @@ 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/experiment_event.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
@@ -100,9 +110,18 @@ files:
 - 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

data/lib/kameleoon/data.rb

@@ -1,175 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/exceptions'
-
-module Kameleoon
-  NONCE_LENGTH = 16
-
-  module DataType
-    CUSTOM = 'CUSTOM'
-    BROWSER = 'BROWSER'
-    CONVERSION = 'CONVERSION'
-    DEVICE = 'DEVICE'
-    PAGE_VIEW = 'PAGE_VIEW'
-  end
-
-  module BrowserType
-    CHROME = 0
-    INTERNET_EXPLORER = 1
-    FIREFOX = 2
-    SAFARI = 3
-    OPERA = 4
-    OTHER = 5
-  end
-
-  module DeviceType
-    PHONE = 'PHONE'
-    TABLET = 'TABLET'
-    DESKTOP = 'DESKTOP'
-  end
-
-  class Data
-    attr_accessor :instance, :sent
-
-    def initialize(*args)
-      raise KameleoonError.new("Cannot initialise interface.")
-    end
-
-    def obtain_full_post_text_line
-      raise KameleoonError.new("ToDo: implement this method.")
-    end
-
-    def encode(url)
-      encoded_url = CGI.escape(url)
-      encoded_url.gsub! "%27", "'"
-      encoded_url.gsub! "%21", "!"
-      encoded_url.gsub! "+", "%20"
-      encoded_url.gsub! "%2A", "*"
-      encoded_url.gsub! "%28", "("
-      encoded_url.gsub! "%29", ")"
-      encoded_url
-    end
-  end
-
-  class CustomData < Data
-    attr_reader :id, :values
-
-    # @param [Integer] id Id of the custom data
-    # @param [String] value Value of the custom data
-    #
-    # @overload
-    # @param [Hash] hash Json value encoded in a hash.
-    def initialize(arg0, *args)
-      @instance = DataType::CUSTOM
-      @sent = false
-      if arg0.is_a?(Hash)
-        hash = arg0
-        id = hash['id']
-        raise Kameleoon::Exception::NotFound.new('id') if id.nil?
-        @id = id.to_s
-        value = hash['value']
-        values = hash['values']
-        raise Kameleoon::Exception::NotFound.new('values') if values.nil? && value.nil?
-        if values.nil?
-          @values = [value]
-        else
-          @values = values.dup
-          @values.append(value) unless value.nil?
-        end
-      else
-        @id = arg0.to_s
-        @values = args
-      end
-    end
-
-    def obtain_full_post_text_line
-      return '' if @values.empty?
-      
-      str_values = "[[\"#{@values.join('",1],["')}\",1]]"
-      nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=customData&index=#{@id}&valueToCount=#{encode(str_values)}&overwrite=true&nonce=#{nonce}"
-    end
-  end
-
-  class Browser < Data
-    attr_accessor :browser
-
-    # @param [BrowserType] browser_type Browser type, can be: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER
-    def initialize(browser_type)
-      @instance = DataType::BROWSER
-      @sent = false
-      @browser = browser_type
-    end
-
-    def obtain_full_post_text_line
-      nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=staticData&browserIndex=" + @browser.to_s + "&nonce=" + nonce
-    end
-  end
-
-  class PageView < Data
-    attr_accessor :url, :title, :referrer
-
-    # @param [String] url Url of the page
-    # @param [String] title Title of the page
-    # @param [Array] referrers Optional field - Referrer ids
-    def initialize(url, title, referrers = nil)
-      @instance = DataType::PAGE_VIEW
-      @sent = false
-      @url = url
-      @title = title
-      @referrers = referrers
-    end
-
-    def obtain_full_post_text_line
-      nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      referrer_text = ''
-      unless @referrers.nil?
-        referrer_text = "&referrersIndices=" + @referrers.to_s
-      end
-      "eventType=page&href=" + encode(@url) + "&title=" + @title + referrer_text + "&nonce=" + nonce
-    end
-  end
-
-  class Conversion < Data
-    attr_accessor :goal_id, :revenue, :negative
-
-    # @param [Integer] goal_id Id of the goal associated to the conversion
-    # @param [Float] revenue Optional field - Revenue associated to the conversion.
-    # @param [Boolean] negative Optional field - If the revenue is negative. By default it's positive.
-    def initialize(goal_id, revenue = 0.0, negative = false)
-      @instance = DataType::CONVERSION
-      @sent = false
-      @goal_id = goal_id
-      @revenue = revenue
-      @negative = negative
-    end
-
-    def obtain_full_post_text_line
-      nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=conversion&goalId=" + @goal_id.to_s + "&revenue=" + @revenue.to_s + "&negative=" + @negative.to_s + "&nonce=" + nonce
-    end
-  end
-
-  # Device uses for sending deviceType parameter for tracking calls
-  class Device < Data
-    def initialize(device_type)
-      @instance = DataType::DEVICE
-      @sent = false
-      @device_type = device_type
-    end
-
-    def obtain_full_post_text_line
-      nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=staticData&deviceType=#{@device_type}&nonce=#{nonce}"
-    end
-  end
-
-  # UserAgent uses for changing User-Agent header for tracking calls
-  class UserAgent
-    attr_accessor :value
-    def initialize(value)
-      @value = value
-    end
-  end
-end