kameleoon-client-ruby 2.0.0 → 2.1.0

data/lib/kameleoon/configuration/rule.rb

@@ -14,25 +14,29 @@ module Kameleoon
 
     # Rule is a class for new rules of feature flags
     class Rule
-      attr_accessor :type, :exposition, :experiment_id, :variation_by_exposition, :targeting_segment
+      attr_reader :id, :order, :type, :exposition, :experiment_id, :variation_by_exposition, :respool_time
+      attr_accessor :targeting_segment
 
       def self.create_from_array(array)
         array&.map { |it| Rule.new(it) }
       end
 
       def initialize(hash)
+        @id = hash['id']
+        @order = hash['order']
         @type = hash['type']
         @exposition = hash['exposition']
         @experiment_id = hash['experimentId']
+        @respool_time = hash['respoolTime']
         @variation_by_exposition = VariationByExposition.create_from_array(hash['variationByExposition'])
         @targeting_segment = Kameleoon::Targeting::Segment.new((hash['segment'])) if hash['segment']
       end
 
-      def get_variation_key(hash_double)
+      def get_variation(hash_double)
         total = 0.0
-        variation_by_exposition.each do |element|
-          total += element.exposition
-          return element.variation_key if total >= hash_double
+        variation_by_exposition.each do |var_by_exp|
+          total += var_by_exp.exposition
+          return var_by_exp if total >= hash_double
         end
         nil
       end
@@ -40,6 +44,14 @@ module Kameleoon
       def get_variation_id_by_key(key)
         variation_by_exposition.select { |v| v.variation_key == key }.first&.variation_id
       end
+
+      def experiment_type?
+        @type == RuleType::EXPERIMENTATION
+      end
+
+      def targeted_delivery_type?
+        @type == RuleType::TARGETED_DELIVERY
+      end
     end
   end
 end

data/lib/kameleoon/configuration/settings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # KameleoonConfigurationSettings is used for saving setting's parameters, e.g
+    # state of real time update for site code and etc
+    class Settings
+      attr_accessor :real_time_update
+
+      def initialize
+        @real_time_update = false
+      end
+
+      def update(configuration)
+        @real_time_update = configuration['realTimeUpdate'] || false
+      end
+    end
+  end
+end

data/lib/kameleoon/cookie.rb

@@ -26,7 +26,7 @@ module Kameleoon
       obtain_hash_double_helper(visitor_code, respool_times, container_id, '')
     end
 
-    def obtain_hash_double_v2(visitor_code, container_id = '', suffix = '')
+    def obtain_hash_double_rule(visitor_code, container_id = '', suffix = '')
       obtain_hash_double_helper(visitor_code, {}, container_id, suffix)
     end
 
@@ -37,8 +37,8 @@ module Kameleoon
       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) 
+
+    def check_visitor_code(visitor_code)
       if visitor_code.nil?
         check_default_visitor_code('')
       elsif

data/lib/kameleoon/data.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'kameleoon/exceptions'
+
 module Kameleoon
   NONCE_LENGTH = 16
 
@@ -50,38 +52,42 @@ module Kameleoon
   end
 
   class CustomData < Data
-    attr_accessor :id, :value
+    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(*args)
+    def initialize(arg0, *args)
       @instance = DataType::CUSTOM
       @sent = false
-      unless args.empty?
-        if args.length == 1
-          hash = args.first
-          if hash["id"].nil?
-            raise NotFoundError.new("id")
-          end
-          @id = hash["id"].to_s
-          if hash["value"].nil?
-            raise NotFoundError.new(hash["value"])
-          end
-          @value = hash["value"]
-        elsif args.length == 2
-          @id = args[0].to_s
-          @value = args[1]
+      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
-      to_encode = "[[\"" + @value.to_s.gsub("\"", "\\\"") + "\",1]]"
+      return '' if @values.empty?
+      
+      str_values = "[[\"#{@values.join('",1],["')}\",1]]"
       nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=customData&index=" + @id.to_s + "&valueToCount=" + encode(to_encode) + "&overwrite=true&nonce=" + nonce
+      "eventType=customData&index=#{@id}&valueToCount=#{encode(str_values)}&overwrite=true&nonce=#{nonce}"
     end
   end
 

data/lib/kameleoon/hybrid/manager.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Hybrid
+    TC_INIT = 'window.kameleoonQueue=window.kameleoonQueue||[];'
+    TC_ASSIGN_VARIATION_FORMAT = "window.kameleoonQueue.push(['Experiments.assignVariation',%d,%d]);"
+    TC_TRIGGER_FORMAT = "window.kameleoonQueue.push(['Experiments.trigger',%d,true]);"
+    TC_ASSIGN_VARIATION_TRIGGER_FORMAT = TC_ASSIGN_VARIATION_FORMAT + TC_TRIGGER_FORMAT
+
+    # Will be useful for Ruby 3.0
+    # Abstract Manager class (interface)
+    class Manager
+      def add_variation(_visitor, _experiment_id, _variation_id)
+        raise 'Abstract method `add` called'
+      end
+
+      def get_engine_tracking_code(_visitor)
+        raise 'Abstract method `get_engine_tracking_code` called'
+      end
+    end
+
+    # Implementation of Cache with auto cleaning feature
+    class ManagerImpl < Manager
+      def initialize(expiration_time, cleaning_interval, cache_factory, log_func)
+        super()
+        # synchronization is necessary for adding same visitor_code from different threads
+        @mutex = Mutex.new
+        @expiration_time = expiration_time
+        @cache_factory = cache_factory
+        @log = log_func
+        # it's recommend to use cleaning_interval 3-4 times more than experiation_time for more performance
+        # in this case on every cleaning iteration storage will be cleaned 2/3 - 3/4 of volume
+        @cache = cache_factory.create(expiration_time, cleaning_interval)
+        @log.call('Hybrid Manager was successfully initialized')
+      end
+
+      def add_variation(visitor_code, experiment_id, variation_id)
+        @mutex.synchronize do
+          visitor_cache = @cache.get(visitor_code)
+          visitor_cache = @cache_factory.create(@expiration_time, 0) if visitor_cache.nil?
+          visitor_cache.set(experiment_id, variation_id)
+          @cache.set(visitor_code, visitor_cache)
+        end
+        @log.call("Hybrid Manager successfully added variation for visitor_code: #{visitor_code}, " \
+          "experiment: #{experiment_id}, variation: #{variation_id}")
+      end
+
+      def get_engine_tracking_code(visitor_code)
+        tracking_code = TC_INIT
+        visitor_cache = @cache.get(visitor_code)
+        return tracking_code if visitor_cache.nil?
+
+        visitor_cache.active_items.each_pair do |key, value|
+          tracking_code += format(TC_ASSIGN_VARIATION_TRIGGER_FORMAT, key, value, key)
+        end
+        tracking_code
+      end
+    end
+  end
+end

data/lib/kameleoon/real_time/real_time_configuration_service.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Kameleoon Real Time Configuration Service
+
+require 'json'
+require 'kameleoon/real_time/real_time_event'
+require 'kameleoon/real_time/sse_request'
+require 'kameleoon/real_time/sse_client'
+
+module Kameleoon
+  module RealTime
+    CONFIGURATION_UPDATE_EVENT = 'configuration-update-event'
+
+    ##
+    # RealTimeConfigurationService is used for fetching updates of configuration
+    # (experiments and feature flags) in real time.
+    class RealTimeConfigurationService
+      ##
+      # Parametrized initializer.
+      #
+      # @param url [String]
+      # @param update_handler [Callable[Kameleoon::RealTime::RealTimeEvent] | NilClass] Handler which
+      # is synchronously called for gotten RealTimeEvent objects.
+      # @param log_func [Callable[String] | NilClass] Callable object which synchronously called to log.
+      def initialize(url, update_handler, log_func, sse_request_source = nil)
+        @url = url
+        @update_handler = update_handler
+        @need_close = false
+        @headers = {
+          'Accept': 'text/event-stream',
+          'Cache-Control': 'no-cache',
+          'Connection': 'Keep-Alive'
+        }
+        @log_func = log_func
+        @sse_request_source = sse_request_source
+        @sse_thread = nil
+        @sse_client = nil
+        create_sse_client
+      end
+
+      ##
+      # Closes the connection to the server.
+      def close
+        return if @need_close
+
+        @log_func&.call('Real-time configuration service is shutting down')
+        @need_close = true
+        return if @sse_thread.nil?
+
+        @sse_thread.kill
+        @sse_thread = nil
+        @sse_client.call_close_handler
+      end
+
+      private
+
+      def create_sse_client
+        @sse_thread = Thread.new { run_sse_client } unless @need_close
+      end
+
+      def init_sse_client
+        message_handler = proc do |message|
+          @log_func&.call("Got SSE event: #{message.event}")
+          if message.event == CONFIGURATION_UPDATE_EVENT
+            event_dict = JSON.parse(message.data)
+            @update_handler&.call(RealTimeEvent.new(event_dict))
+          end
+        end
+        sse_request = make_sse_request
+        @sse_client = SseClient.new(sse_request, message_handler)
+        @log_func&.call('Created SSE client')
+      end
+
+      def make_sse_request
+        open_handler = proc { @log_func&.call('SSE connection open') }
+        close_handler = proc { @log_func&.call('SSE connection closed') }
+        unexpected_status_code_handler =
+          proc { |resp| @log_func&.call("Unexpected status code of SSE response: #{resp.code}") }
+        if @sse_request_source.nil?
+          return SseRequest.new(@url, @headers, open_handler, close_handler, unexpected_status_code_handler)
+        end
+
+        @sse_request_source.call(@url, @headers, open_handler, close_handler, unexpected_status_code_handler)
+      end
+
+      def run_sse_client
+        until @need_close
+          init_sse_client
+          begin
+            @sse_client.start
+          rescue StandardError => e
+            @log_func&.call("Error occurred within SSE client: #{e}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kameleoon/real_time/real_time_event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Kameleoon Real Time Event
+
+module Kameleoon
+  module RealTime
+    ##
+    # RealTimeEvent contains information about timestamp when configuration was updated.
+    # Timestamp parameter is used to fetch the latest configuration.
+    class RealTimeEvent
+      attr_reader :time_stamp
+
+      ##
+      # Parametrized initializer. Gets the new time stamp from a JSON message.
+      #
+      # @param event_dict [Hash] Hash of SSE message data.
+      def initialize(event_dict)
+        @time_stamp = event_dict['ts']
+      end
+    end
+  end
+end

data/lib/kameleoon/real_time/sse_client.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'kameleoon/real_time/sse_message'
+
+module Kameleoon
+  module RealTime
+    ##
+    # SseClient is used to interpret SSE event stream.
+    class SseClient
+      ##
+      # Parametrized initializer.
+      #
+      # @param sse_request [Kameleoon::RealTime::SseRequest] Used to access SSE event stream.
+      # @param message_handler [Callable[Kameleoon::RealTime::SseMessage] | NilClass] Callable object which
+      # is synchronously called for received SSE messages.
+      def initialize(sse_request, message_handler)
+        @sse_request = sse_request
+        @message_handler = message_handler
+
+        @cr_prev = nil
+        @buffer = nil
+        @data_buffer = nil
+        @event = nil
+        @id = nil
+        @reconnection_time = nil
+
+        @sse_request.resp_char_handler = method(:process_char)
+      end
+
+      ##
+      # Starts SSE connection and stay in the loop until close.
+      def start
+        @cr_prev = false
+        @data_buffer = []
+        @event = nil
+        @id = nil
+        @buffer = []
+        @sse_request.start
+      end
+
+      ##
+      # Calls @sse_request@close_handler if it is not nil.
+      def call_close_handler
+        @sse_request.call_close_handler
+      end
+
+      private
+
+      def process_char(ch)
+        if @cr_prev && (ch == "\n")
+          @cr_prev = false
+          return
+        end
+        @cr_prev = ch == "\r"
+        if @cr_prev || (ch == "\n")
+          line = @buffer.join
+          @buffer.clear
+          if line.empty?
+            dispatch_event
+          else
+            handle_line(line)
+          end
+          return
+        end
+        @buffer << ch
+      end
+
+      def handle_line(line)
+        field, value = parse_line(line)
+        return if field.nil?
+
+        case field
+        when 'event'
+          @event = value
+        when 'data'
+          @data_buffer << value
+        when 'id'
+          @id = value
+        when 'retry'
+          @reconnection_time = value.to_i # This does not affect anything
+        end
+      end
+
+      def parse_line(line)
+        colon_index = line.index(':')
+        return line, nil if colon_index.nil?
+        return nil, nil if colon_index.zero?
+
+        field = line[0, colon_index]
+        return field, '' if colon_index + 1 == line.length
+
+        value = if line[colon_index + 1] == ' '
+                  line[colon_index + 2..]
+                else
+                  line[colon_index + 1..]
+                end
+        [field, value]
+      end
+
+      def dispatch_event
+        return unless !@event.nil? || !@data_buffer.empty? # Ignoring empty events
+
+        data = @data_buffer.join("\n")
+        message = SseMessage.new(@event, @id, data)
+        @event = nil
+        @data_buffer.clear
+        @message_handler&.call(message)
+      end
+    end
+  end
+end

data/lib/kameleoon/real_time/sse_message.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module RealTime
+    ##
+    # SseMessage is a container for a received SSE message.
+    class SseMessage
+      attr_reader :event, :id, :data
+
+      ##
+      # Parametrized initializer.
+      #
+      # @param event [String]
+      # @param id [String]
+      # @param data [String]
+      def initialize(event, id, data)
+        @event = event
+        @id = id
+        @data = data
+      end
+    end
+  end
+end

data/lib/kameleoon/real_time/sse_request.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'restclient'
+
+module Kameleoon
+  module RealTime
+    ##
+    # SseRequest is used keep SSE connection and read from its stream.
+    class SseRequest
+      attr_writer :resp_char_handler
+
+      ##
+      # Parametrized initializer.
+      #
+      # @param url [String]
+      # @param headers [Hash]
+      # @param open_handler [Callable | NilClass] Handler which is synchronously called when SSE connection is open.
+      # @param close_handler [Callable | NilClass] Handler which is synchronously called when SSE connection is closed.
+      # @param unexpected_status_code_handler [Callable[Net::HTTPResponse] | NilClass] Handler whick
+      # is synchronously called for responses with not 200 status code.
+      def initialize(url, headers, open_handler, close_handler, unexpected_status_code_handler)
+        @url = url
+        @headers = headers
+        @open_handler = open_handler
+        @close_handler = close_handler
+        @unexpected_status_code_handler = unexpected_status_code_handler
+
+        @resp_char_handler = nil
+      end
+
+      ##
+      # Starts SSE connection and stay in the loop until close.
+      def start
+        RestClient::Request.execute(method: :get, url: @url, headers: @headers, read_timeout: nil,
+                                    block_response: method(:handle_resp))
+      end
+
+      ##
+      # Calls @close_handler if it is not nil.
+      def call_close_handler
+        @close_handler&.call
+      end
+
+      private
+
+      def handle_resp(resp)
+        @open_handler&.call
+        if resp.code == '200'
+          resp.read_body do |chunk|
+            chunk.each_char { |ch| @resp_char_handler&.call(ch) }
+          end
+        else
+          @unexpected_status_code_handler&.call(resp)
+        end
+        call_close_handler
+      end
+    end
+  end
+end

data/lib/kameleoon/storage/cache.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+module Kameleoon
+  module Storage
+    # Will be useful for Ruby 3.0
+    # Abstract Cache class (interface)
+    class Cache
+      def get(_key)
+        raise 'Abstract method `read` called'
+      end
+
+      def set(_key, _value)
+        raise 'Abstract method `write` called'
+      end
+
+      def active_items
+        raise 'Abstract method `active_items` called'
+      end
+    end
+
+    # Implementation of Cache with auto cleaning feature
+    class CacheImpl < Cache
+      def initialize(expiration_time, cleaning_interval)
+        super()
+        @mutex = Mutex.new
+        @expiration_time = expiration_time
+        @cleaning_interval = cleaning_interval
+        @cache = {}
+      end
+
+      def set(key, value)
+        @mutex.synchronize do
+          start_cleaner_timer if @cleaning_interval.positive? && @cleaner_timer.nil?
+          @cache[key] = { value: value, expired: Time.now + @expiration_time }
+        end
+      end
+
+      def get(key)
+        entry = @cache[key]
+        return entry[:value] unless entry.nil? || expired?(entry)
+
+        @mutex.synchronize { @cache.delete(key) }
+        nil
+      end
+
+      def active_items
+        active_items = {}
+        remove_expired_entries
+        @mutex.synchronize do
+          @cache.each_pair { |key, entry| active_items[key] = entry[:value] }
+        end
+        active_items
+      end
+
+      private
+
+      def start_cleaner_timer
+        @cleaner_timer = Concurrent::TimerTask.new(execution_interval: @cleaning_interval) do
+          remove_expired_entries
+        end
+        @cleaner_timer.execute
+      end
+
+      def stop_cleaner_timer
+        @cleaner_timer&.shutdown
+        @cleaner_timer = nil
+      end
+
+      def remove_expired_entries
+        time = Time.now
+        @mutex.synchronize do
+          @cache.delete_if { |_, entry| expired?(entry, time) }
+          stop_cleaner_timer if @cache.empty?
+        end
+      end
+
+      def expired?(entry, time = Time.now)
+        entry[:expired] <= time
+      end
+    end
+  end
+end

data/lib/kameleoon/storage/cache_factory.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+require_relative 'cache'
+
+module Kameleoon
+  module Storage
+    # Will be useful for Ruby 3.0
+    # Abstract CacheFactory class (interface)
+    class CacheFactory
+      def create(_experiration_time, _cleaning_time)
+        raise 'Abstract method `create` called'
+      end
+    end
+
+    # Implementation of CacheFactory with auto cleaning feature
+    class CacheFactoryImpl < CacheFactory
+      def create(expiration_time, cleaning_interval)
+        CacheImpl.new(expiration_time, cleaning_interval)
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/condition.rb

@@ -8,21 +8,21 @@ module Kameleoon
 
       def initialize(json_condition)
         if json_condition['targetingType'].nil?
-          raise Exception::NotFoundError.new('targetingType'), 'targetingType missed'
+          raise Exception::NotFound.new('targetingType'), 'targetingType missed'
         end
 
         @type = json_condition['targetingType']
 
         if json_condition['include'].nil? && json_condition['isInclude'].nil?
-          raise Exception::NotFoundError.new('include / isInclude missed'), 'include / isInclude missed'
+          raise Exception::NotFound.new('include / isInclude missed'), 'include / isInclude missed'
         end
 
         @include = json_condition['include'] || json_condition['isInclude']
       end
 
       def check(conditions)
-        raise "Todo: Implement check method in condition"
+        raise 'Abstract method `check` call'
       end
     end
   end
-end
+end