kameleoon-client-ruby 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6757ccb01117c020dd6e555554cd7d02ee6649a107e309f2998e8abbca17ea
-  data.tar.gz: 331997c2f44f3024d9080aff075462c48a6c013d4f939b79975ea1a6717748fc
+  metadata.gz: 1a893238d33ee61086e79cb093d442dfefb16fac9e757ea7353d60458869cd13
+  data.tar.gz: 8485bb0f875a2fa286a03fe872b88dea170477200fc1429d84b5d28711463885
 SHA512:
-  metadata.gz: ccba30fc711816db2aa401159c1b110f97dbd5dd36ca5108cfa88aa5a7aedd6beef39d912a2351cff3d98e6e6ffd8ee2d394bf6394b9b5d8d6a23c978cf09789
-  data.tar.gz: 3e1c47577cd4cc0889b26d9e5c38834f24c0bfc1b4c294b65ab57117a613204cc95f923caa4bafeb345245b860f37579cf0cbe51c4f034d0e79499f520449c2a
+  metadata.gz: 0ff7b4461c7c4bbf8a7c5399450db7920bae12e65ed9eb604718f9e51fd33a79f24c4803e144ba7260946b1f9c50e2832ff55459c190d33eb2a65658b5c0575e
+  data.tar.gz: f8e17afae3086d5b0402a30b7121febed07b16eb58a05e3082d73100c4e28d778746c353bce2bd50620b0dc267e8eb427b89e30dd066f9f951519cc5c67b77a4

data/lib/kameleoon/client.rb

@@ -116,16 +116,16 @@ module Kameleoon
         variation_id.to_i
       else
         visitor_data = @data.select { |key, value| key.to_s == visitor_code }.values.flatten! || []
-        if experiment['targetingSegment'].check_tree(visitor_data)
+        if experiment['targetingSegment'].nil? || experiment['targetingSegment'].check_tree(visitor_data)
           threshold = obtain_hash_double(visitor_code, experiment['respoolTime'], experiment['id'])
           experiment['deviations'].each do |key, value|
             threshold -= value
             if threshold < 0
-              post_beacon("experimentTracking", visitor_code, experiment_id, key)
+              track_experiment(visitor_code, experiment_id, key)
               return key.to_s.to_i
             end
           end
-          post_beacon("experimentTracking", visitor_code, experiment_id, REFERENCE, true)
+          track_experiment(visitor_code, experiment_id, REFERENCE, true)
           raise Exception::NotActivated.new(visitor_code)
         end
         raise Exception::NotTargeted.new(visitor_code)
@@ -182,7 +182,7 @@ module Kameleoon
     # @param [String] visitor_code Optional field - Visitor code, without visitor code it flush all of the data
     #
     def flush(visitor_code = nil)
-      post_beacon("dataTracking", visitor_code)
+      track_data(visitor_code)
     end
 
     ##
@@ -231,7 +231,7 @@ module Kameleoon
           connexion_options = { :connect_timeout => (timeout.to_f / 1000.0) }
           request_options = {
             :path => get_experiment_register_url(visitor_code, id),
-            :body => (select_data_to_sent(visitor_code).values.map { |data| data.obtain_full_post_text_line }.join("\n") || "").encode("UTF-8")
+            :body => (data_not_sent(visitor_code).values.map { |data| data.obtain_full_post_text_line }.join("\n") || "").encode("UTF-8")
           }
           log "Activate feature request: " + request_options.inspect
           log "Activate feature connexion:" + connexion_options.inspect
@@ -251,10 +251,10 @@ module Kameleoon
         if feature_flag['targetingSegment'].nil? || feature_flag['targetingSegment'].check_tree(visitor_data)
           threshold = obtain_hash_double(visitor_code, {}, id)
           if threshold <= feature_flag['expositionRate']
-            post_beacon("experimentTracking", visitor_code, id, feature_flag["variationsId"].first)
+            track_experiment(visitor_code, id, feature_flag["variationsId"].first)
             return true
           else
-            post_beacon("experimentTracking", visitor_code, id, REFERENCE, true)
+            track_experiment(visitor_code, id, REFERENCE, true)
             return false
           end
         else
@@ -401,7 +401,7 @@ module Kameleoon
       query_values = { 'perPage' => per_page }
       filters = [
         hash_filter('siteId', 'EQUAL', [site_id]),
-        hash_filter('status', 'EQUAL', ['ACTIVE']),
+        hash_filter('status', 'IN', ['ACTIVE', 'DEVIATED']),
         hash_filter('type', 'IN', ['SERVER_SIDE', 'HYBRID'])
       ]
       experiments = fetch_all('experiments', query_values, filters).map { |it| JSON.parse(it.response) }.flatten.map do |test|
@@ -472,6 +472,10 @@ module Kameleoon
       url
     end
 
+    def get_data_register_url(visitor_code)
+      "/dataTracking?" + URI.encode_www_form(get_common_ssx_parameters(visitor_code))
+    end
+
     def get_feature_flag(feature_key)
       if feature_key.is_a?(String)
         feature_flag = @feature_flags.select { |ff| ff['identificationKey'] == feature_key}.first
@@ -486,21 +490,48 @@ module Kameleoon
       feature_flag
     end
 
-    def post_beacon(type = "dataTracking", visitor_code = nil, experiment_id = nil, variation_id = nil, none_variation = false)
+    def track_experiment(visitor_code, experiment_id, variation_id = nil, none_variation = false)
+      data_not_sent = data_not_sent(visitor_code)
+      options = {
+        :path => get_experiment_register_url(visitor_code, experiment_id, variation_id, none_variation),
+        :body => ((data_not_sent.values[0] || []).map{ |it| it.obtain_full_post_text_line }.join("\n") || "").encode("UTF-8"),
+        :head => { "Content-Type" => "text/plain"}
+      }
+      trial = 0
+      log "Start post tracking experiment: " + data_not_sent.inspect
+      Thread.new do
+        EM.synchrony do
+          while trial < 10
+            request = EM::Synchrony.sync post(options, @tracking_url)
+            log "Request " + request.inspect
+            if is_successful(request)
+              (data_not_sent.values[0] || []).each { |it| it.sent = true }
+              EM.stop
+            end
+            trial += 1
+          end
+          EM.stop
+        end
+        log "Post to experiment tracking is done after " + trial.to_s + " trials"
+        Thread.exit
+      end
+    end
+
+    def track_data(visitor_code = nil)
       Thread.new do
         EM.synchrony do
-          entries = select_data_to_sent(visitor_code)
-          log "Start post to tracking: " + entries.inspect
           trials = 10
           concurrency = 1
-          while !entries.empty? && trials > 0
-            log "Trials amount left: " + trials.to_s
-            EM::Synchrony::Iterator.new(entries, concurrency).map do |entry, iter|
+          data_not_sent = data_not_sent(visitor_code)
+          log "Start post tracking data: " + data_not_sent.inspect
+          while trials > 0 && !data_not_sent.empty?
+            EM::Synchrony::Iterator.new(data_not_sent, concurrency).map do |entry, iter|
               options = {
-                :path => build_beacon_path(type, entry.first || visitor_code, experiment_id, variation_id, none_variation),
+                :path => get_data_register_url(entry.first),
                 :body => (entry.last.map { |data| data.obtain_full_post_text_line }.join("\n") || "").encode("UTF-8"),
                 :head => { "Content-Type" => "text/plain" }
               }
+              log "Post tracking data for visitor_code: " + entry.first + " with options: " + options.inspect
               request = post(options, @tracking_url)
               request.callback {
                 if is_successful(request)
@@ -510,17 +541,17 @@ module Kameleoon
               }
               request.errback { iter.return(request) }
             end
-            entries = select_data_to_sent(visitor_code)
+            data_not_sent = data_not_sent(visitor_code)
             trials -= 1
           end
-          log "Post to tracking done"
+          log "Post to data tracking is done."
           EM.stop
         end
         Thread.exit
       end
     end
 
-    def select_data_to_sent(visitor_code)
+    def data_not_sent(visitor_code = nil)
       if visitor_code.nil?
         @data.select {|key, values| values.any? {|data| !data.sent}}
       else
@@ -528,16 +559,6 @@ module Kameleoon
       end
     end
 
-    def build_beacon_path(type, visitor_code, experiment_id = nil, variation_id = nil, none_variation = nil)
-      if type == "dataTracking"
-        return "/dataTracking?" + URI.encode_www_form(get_common_ssx_parameters(visitor_code))
-      elsif type == "experimentTracking"
-        return get_experiment_register_url(visitor_code, experiment_id, variation_id, none_variation)
-      else
-        raise TypeError("Unknown type for post_beacon: " + type.to_s)
-      end
-    end
-
     def log(text)
       if @verbose_mode
         print "Kameleoon Log: " + text.to_s + "\n"

data/lib/kameleoon/cookie.rb

@@ -3,6 +3,7 @@ require 'em-http'
 require 'eventmachine'
 require 'bigdecimal'
 require 'kameleoon/utils'
+require 'kameleoon/exceptions'
 
 module Kameleoon
   # @api private
@@ -33,16 +34,22 @@ module Kameleoon
     private
 
     KAMELEOON_KEY_JS_COOKIE = "_js_"
+    KAMELEOON_VISITOR_CODE_LENGTH = 255
     KAMELEOON_COOKIE_VALUE_LENGTH = 16
-    KAMELEOON_VISITOR_CODE_LENGTH = 100
     KAMELEOON_COOKIE_NAME = 'kameleoonVisitorCode'
     EXPIRE_DAYS = 380
 
     def check_default_visitor_code(default_visitor_code)
       if default_visitor_code.nil?
-        return nil
+        return
+      end
+      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[0..(KAMELEOON_VISITOR_CODE_LENGTH - 1)]
+      default_visitor_code
     end
 
     def read(cookies)
@@ -54,10 +61,10 @@ module Kameleoon
         start_index = KAMELEOON_KEY_JS_COOKIE.length
         value = value[start_index..-1]
       end
-      if value.length < KAMELEOON_COOKIE_VALUE_LENGTH
-        return nil
+      if value.length == 0
+        nil
       end
-      value[0..(KAMELEOON_COOKIE_VALUE_LENGTH - 1)]
+      value[0..(KAMELEOON_VISITOR_CODE_LENGTH - 1)]
     end
   end
 end

data/lib/kameleoon/exceptions.rb

@@ -45,5 +45,10 @@ module Kameleoon
         super("Visitor " + visitor_code + " is not activated.")
       end
     end
+    class VisitorCodeNotValid < KameleoonError
+      def initialize(message = "")
+        super("Visitor code not valid: " + message)
+      end
+    end
   end
 end

data/lib/kameleoon/request.rb

@@ -42,9 +42,9 @@ module Kameleoon
 
     def add_user_agent(request_options)
       if request_options[:head].nil?
-        request_options[:head] = {'User-Agent' => 'kameleoon-client-ruby/' + Kameleoon::VERSION}
+        request_options[:head] = {'Kameleoon-Client' => 'sdk/ruby/' + Kameleoon::VERSION}
       else
-        request_options[:head].store('User-Agent', 'kameleoon-client-ruby/' + Kameleoon::VERSION)
+        request_options[:head].store('Kameleoon-Client', 'sdk/ruby/' + Kameleoon::VERSION)
       end
     end
   end

data/lib/kameleoon/version.rb

@@ -1,3 +1,3 @@
 module Kameleoon
-  VERSION = '1.0.3'
+  VERSION = '1.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - Kameleoon - Guillaume Grandjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request