kameleoon-client-ruby 2.3.0 → 3.0.0

data/lib/kameleoon/utils.rb

@@ -1,16 +1,53 @@
 # frozen_string_literal: true
 
+require 'fiber'
+require 'bigdecimal'
+require 'kameleoon/utils'
+require 'kameleoon/exceptions'
+
 module Kameleoon
   # Utils is a helper module for project
   module Utils
     ALPHA_NUMERIC_CHARS = 'ABCDEF0123456789'
 
-    def self.in_seconds(days)
-      days * 60 * 60 * 24
-    end
-
     def self.generate_random_string(length)
       (1..length).map { ALPHA_NUMERIC_CHARS[rand(ALPHA_NUMERIC_CHARS.length)] }.join
     end
+
+    module VisitorCode
+      VISITOR_CODE_MAX_LENGTH = 255
+      VISITOR_CODE_LENGTH = 16
+
+      def self.validate(visitor_code)
+        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"
+        end
+      end
+
+      def self.generate
+        Utils.generate_random_string(VISITOR_CODE_LENGTH)
+      end
+    end
+
+    module HashDouble
+      def self.obtain(visitor_code, respool_times = {}, container_id = '')
+        obtain_helper(visitor_code, respool_times, container_id, '')
+      end
+
+      def self.obtain_rule(visitor_code, container_id = '', suffix = '')
+        obtain_helper(visitor_code, {}, container_id, suffix)
+      end
+
+      private
+
+      def self.obtain_helper(visitor_code, respool_times, container_id, suffix)
+        identifier = visitor_code.to_s
+        identifier += container_id.to_s
+        identifier += suffix.to_s
+        identifier += respool_times.sort.to_h.values.join.to_s if !respool_times.nil? && !respool_times.empty?
+        (Digest::SHA256.hexdigest(identifier.encode('UTF-8')).to_i(16) / (BigDecimal('2')**BigDecimal('256'))).round(16)
+      end
+    end
   end
 end

data/lib/kameleoon/version.rb

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

data/lib/kameleoon.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
 # Kameleoon Ruby Client SDK
 #
-require "kameleoon/factory"
-require "kameleoon/client"
+require 'kameleoon/kameleoon_client_factory'
+require 'kameleoon/kameleoon_client'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -75,29 +75,35 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/kameleoon.rb
-- lib/kameleoon/client.rb
-- lib/kameleoon/client_config.rb
-- lib/kameleoon/configuration/experiment.rb
+- lib/kameleoon/client_readiness.rb
+- lib/kameleoon/configuration/data_file.rb
 - lib/kameleoon/configuration/feature_flag.rb
 - lib/kameleoon/configuration/rule.rb
 - lib/kameleoon/configuration/settings.rb
 - lib/kameleoon/configuration/variable.rb
 - lib/kameleoon/configuration/variation.rb
 - lib/kameleoon/configuration/variation_exposition.rb
-- lib/kameleoon/cookie.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/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/page_view.rb
 - lib/kameleoon/data/user_agent.rb
 - lib/kameleoon/exceptions.rb
-- lib/kameleoon/factory.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/network/activity_event.rb
 - lib/kameleoon/network/content_type.rb
-- lib/kameleoon/network/experiment_event.rb
+- lib/kameleoon/network/cookie/cookie_manager.rb
 - lib/kameleoon/network/method.rb
 - lib/kameleoon/network/net_provider.rb
 - lib/kameleoon/network/network_manager.rb
@@ -112,8 +118,6 @@ files:
 - lib/kameleoon/real_time/sse_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

data/lib/kameleoon/client_config.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Kameleoon
-  # Client configuration which can be used instead of an external configuration file
-  class ClientConfig
-    CONFIGURATION_UPDATE_INTERVAL = 60
-    VISITOR_DATA_MAXIMUM_SIZE = 500
-    DEFAULT_TIMEOUT = 2000 # milli-seconds
-
-    attr_reader :client_id, :client_secret, :data_refresh_interval, :default_timeout, :configuration_refresh_interval,
-                :visitor_data_maximum_size, :environment, :verbose_mode
-
-    def initialize(
-      client_id: nil,
-      client_secret: nil,
-      configuration_refresh_interval: CONFIGURATION_UPDATE_INTERVAL,
-      default_timeout: DEFAULT_TIMEOUT,
-      visitor_data_maximum_size: VISITOR_DATA_MAXIMUM_SIZE,
-      environment: nil,
-      verbose_mode: false
-    )
-      @client_id = client_id
-      @client_secret = client_secret
-      @configuration_refresh_interval = configuration_refresh_interval || CONFIGURATION_UPDATE_INTERVAL
-      @default_timeout = default_timeout || DEFAULT_TIMEOUT
-      @visitor_data_maximum_size = visitor_data_maximum_size || VISITOR_DATA_MAXIMUM_SIZE
-      @environment = environment
-      @verbose_mode = verbose_mode || false
-    end
-
-    def self.make_from_yaml(yaml)
-      yaml ||= {}
-      ClientConfig.new(
-        client_id: yaml['client_id'],
-        client_secret: yaml['client_secret'],
-        configuration_refresh_interval: yaml['actions_configuration_refresh_interval'],
-        default_timeout: yaml['default_timeout'],
-        visitor_data_maximum_size: yaml['visitor_data_maximum_size'],
-        environment: yaml['environment'],
-        verbose_mode: yaml['verbose_mode']
-      )
-    end
-  end
-end

data/lib/kameleoon/configuration/experiment.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/targeting/models'
-
-module Kameleoon
-  # Module which contains all internal data of SDK
-  module Configuration
-    # Class for manage all experiments and old feature flags
-    class Experiment
-      attr_accessor :id, :status, :site_enabled, :deviations, :respool_time, :variations, :targeting_segment
-
-      def self.create_from_array(array)
-        array&.map { |it| Experiment.new(it) }
-      end
-
-      def initialize(experiment_hash)
-        @id = experiment_hash['id']
-        @status = experiment_hash['status']
-        @site_enabled = experiment_hash['siteEnabled']
-        unless experiment_hash['deviations'].nil?
-          @deviations =
-            Hash[*experiment_hash['deviations'].map do |it|
-              [it['variationId'] == 'origin' ? '0' : it['variationId'], it['value']]
-            end.flatten]
-        end
-        unless experiment_hash['respoolTime'].nil?
-          @respool_time =
-            Hash[*experiment_hash['respoolTime'].map do |it|
-              [it['variationId'] == 'origin' ? '0' : it['variationId'], it['value']]
-            end.flatten]
-        end
-        unless experiment_hash['variations'].nil?
-          @variations =
-          experiment_hash['variations'].map do |it|
-              { 'id' => it['id'].to_i, 'customJson' => it['customJson'] }
-            end
-        end
-        @targeting_segment = Kameleoon::Targeting::Segment.new((experiment_hash['segment'])) if experiment_hash['segment']
-      end
-    end
-  end
-end

data/lib/kameleoon/cookie.rb

@@ -1,88 +0,0 @@
-require 'fiber'
-require 'em-http'
-require 'eventmachine'
-require 'bigdecimal'
-require 'kameleoon/utils'
-require 'kameleoon/exceptions'
-
-module Kameleoon
-  # @api private
-  module Cookie
-    # @return [String] visitor code
-    def read_and_write(request_cookies, top_level_domain, response_cookies, default_visitor_code = nil)
-      kameleoon_visitor_code = read(request_cookies)
-      if kameleoon_visitor_code.nil?
-        kameleoon_visitor_code = check_default_visitor_code(default_visitor_code) || Kameleoon::Utils.generate_random_string(KAMELEOON_COOKIE_VALUE_LENGTH)
-      end
-      cookie = { :value => kameleoon_visitor_code, :expires => Time.now + Kameleoon::Utils.in_seconds(EXPIRE_DAYS), :path => '/' }
-      unless top_level_domain.nil?
-        cookie[:domain] = top_level_domain
-      end
-      response_cookies[KAMELEOON_COOKIE_NAME] = cookie
-      kameleoon_visitor_code
-    end
-
-    def obtain_hash_double(visitor_code, respool_times = {}, container_id = '')
-      obtain_hash_double_helper(visitor_code, respool_times, container_id, '')
-    end
-
-    def obtain_hash_double_rule(visitor_code, container_id = '', suffix = '')
-      obtain_hash_double_helper(visitor_code, {}, container_id, suffix)
-    end
-
-    def obtain_hash_double_helper(visitor_code, respool_times, container_id, suffix)
-      identifier = visitor_code.to_s
-      identifier += container_id.to_s
-      identifier += suffix.to_s
-      identifier += respool_times.sort.to_h.values.join.to_s if !respool_times.nil? && !respool_times.empty?
-      (Digest::SHA256.hexdigest(identifier.encode('UTF-8')).to_i(16) / (BigDecimal('2')**BigDecimal('256'))).round(16)
-    end
-
-    def check_visitor_code(visitor_code)
-      if visitor_code.nil?
-        check_default_visitor_code('')
-      elsif
-        check_default_visitor_code(visitor_code)
-      end
-    end
-
-    private
-
-    KAMELEOON_KEY_JS_COOKIE = "_js_"
-    KAMELEOON_VISITOR_CODE_LENGTH = 255
-    KAMELEOON_COOKIE_VALUE_LENGTH = 16
-    KAMELEOON_COOKIE_NAME = 'kameleoonVisitorCode'
-    EXPIRE_DAYS = 380
-
-    def check_default_visitor_code(default_visitor_code)
-      if default_visitor_code.nil?
-        return
-      end
-      default_visitor_code = default_visitor_code.to_s
-      if default_visitor_code.length == 0
-        raise Kameleoon::Exception::VisitorCodeNotValid.new("Empty visitor Code")
-      end
-      if default_visitor_code.length > KAMELEOON_VISITOR_CODE_LENGTH
-        raise Kameleoon::Exception::VisitorCodeNotValid.new("Visitor Code is longer than 255 chars.")
-      end
-      default_visitor_code
-    end
-
-    def read(cookies)
-      value = cookies[KAMELEOON_COOKIE_NAME]
-      if value.nil?
-        return
-      end
-      if value.start_with?(KAMELEOON_KEY_JS_COOKIE)
-        start_index = KAMELEOON_KEY_JS_COOKIE.length
-        value = value[start_index..-1]
-      end
-      if value.length == 0
-        nil
-      end
-      value[0..(KAMELEOON_VISITOR_CODE_LENGTH - 1)]
-    end
-  end
-end
-
-

data/lib/kameleoon/factory.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/client'
-require 'kameleoon/client_config'
-
-module Kameleoon
-  # A Factory class for creating kameleoon clients
-  module ClientFactory
-    CONFIG_PATH = '/etc/kameleoon/client-ruby.yaml'
-
-    @clients = {}
-
-    def self.create(site_code, config_path = CONFIG_PATH, config: nil)
-      if config.nil?
-        config_yaml = YAML.load_file(config_path) if File.exist?(config_path)
-        if config_yaml.nil?
-          warn "Kameleoon SDK: Configuration file with path #{config_path} does not exist" if config_yaml.nil?
-          config_yaml = {}
-        end
-      end
-      environment = config&.environment || (config_yaml || {})['environment']
-      client = @clients[get_client_key(site_code, environment)]
-      if client.nil?
-        config = ClientConfig.make_from_yaml(config_yaml) if config.nil?
-        client = Client.new(site_code, config)
-        client.send(:log, "Client created with site code: #{site_code}")
-        client.send(:fetch_configuration)
-        @clients.store(site_code, client)
-      end
-      client
-    end
-
-    def self.forget(site_code, environment = '')
-      @clients.delete(get_client_key(site_code, environment))
-    end
-
-    private_class_method
-
-    def self.get_client_key(site_code, environment)
-      site_code + (environment || '')
-    end
-  end
-end

data/lib/kameleoon/network/experiment_event.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'kameleoon/data/data'
-require 'kameleoon/utils'
-require 'kameleoon/network/uri_helper'
-
-module Kameleoon
-  module Network
-    ##
-    # ExperimentEvent represents an experiment tracking event.
-    class ExperimentEvent
-      EVENT_TYPE = 'experiment'
-
-      attr_accessor :sent
-
-      def initialize(experiment_id, variation_id)
-        @sent = false
-        @experiment_id = experiment_id
-        @variation_id = variation_id
-        @nonce = Kameleoon::Utils.generate_random_string(Kameleoon::NONCE_LENGTH)
-      end
-
-      def obtain_full_post_text_line
-        params = {
-          eventType: EVENT_TYPE,
-          id: @experiment_id,
-          variationId: @variation_id,
-          nonce: @nonce
-        }
-        UriHelper.encode_query(params)
-      end
-    end
-  end
-end

data/lib/kameleoon/storage/variation_storage.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'kameleoon/storage/visitor_variation'
-
-module Kameleoon
-  module Storage
-    # VariationStorage is a container for saved variations associated with a visitor
-    class VariationStorage
-      def initialize
-        @storage = {}
-      end
-
-      def get_variation_id(visitor_code, experiment_id)
-        variation_valid?(visitor_code, experiment_id, nil)
-      end
-
-      def variation_valid?(visitor_code, experiment_id, respool_time)
-        return nil if @storage[visitor_code].nil? || @storage[visitor_code][experiment_id].nil?
-
-        variation = @storage[visitor_code][experiment_id]
-        return nil unless variation.valid?(respool_time)
-
-        variation.variation_id
-      end
-
-      def update_variation(visitor_code, experiment_id, variation_id)
-        @storage[visitor_code] = {} if @storage[visitor_code].nil?
-        @storage[visitor_code][experiment_id] = Kameleoon::Storage::VisitorVariation.new(variation_id)
-      end
-
-      def get_hash_saved_variation_id(visitor_code)
-        return nil if @storage[visitor_code].nil?
-
-        map_variations = {}
-        @storage[visitor_code].each do |key, value|
-          map_variations[key] = value.variation_id
-        end
-        map_variations
-      end
-    end
-  end
-end

data/lib/kameleoon/storage/visitor_variation.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Kameleoon
-  module Storage
-    # VisitorVariation contains a saved variation id associated with a visitor
-    # and time when it was associated.
-    class VisitorVariation
-      attr_accessor :variation_id
-
-      def initialize(variation_id)
-        @variation_id = variation_id
-        @assignment_date = Time.now.to_i
-      end
-
-      def valid?(respool_time)
-        respool_time.nil? || @assignment_date > respool_time
-      end
-    end
-  end
-end