kameleoon-client-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0d398647ef17fa8d33046f2f591973a57a00fde17fef994d955f23ea474538d
-  data.tar.gz: fc466cc6b762e1b4759dee2de2914c33ce27274b90bfe00394db5a80017f186e
+  metadata.gz: 1acddc80101273c13cdf39b6cf2fb497716e947981dbffcf4d31540ea1f62edc
+  data.tar.gz: c00f33ed4eb494f7b1f2b4009005e84492ccad9cc366ac8fd34888c6aa63e2eb
 SHA512:
-  metadata.gz: ad96e42e9c7b75436dca8a6529d2118693b94be8edc7a6d7ee35bfa5cd0909235885f383a313b306912bb79a43aac6b8aee0c6e44d55135c79cca158113fba50
-  data.tar.gz: d2e75d812cf12088420984120337be790c7b3c60574181572d995f9ac613cf5b884820fddc4e7e2b4938ed3444f27d298e883f1560da34d83150d4b71207077a
+  metadata.gz: 6b4a67c7e0f8315aaeb2e46c15c2961840099a40a874d56c821bfc5407aa4f506ea732cf90cad13abb406e1c2f6d98bea62fb07a9b7bf427798ad27a15ef11e3
+  data.tar.gz: a62a96d1a772835c9e4db7ad8c968c302339dae2b9937204c37bbd2d8f22f23d6c76dae15b8f8577a0e692e1a181d27177635e64fba0f1b090290c870c0f9034

data/README.md

@@ -6,7 +6,7 @@ This is the repository for the Kameleoon Ruby SDK.
 #### Prerequisite:
 * [Install ruby](https://www.ruby-lang.org/en/documentation/installation)
 
-#### Build and install:
+#### Build and install the gem:
 * Run `./buildAndInstallGem.sh`
 
 ### How to run tests
@@ -14,5 +14,9 @@ This is the repository for the Kameleoon Ruby SDK.
 * Build and install Kameleoon Gem locally (infos above).
 * Install rake: `gem install rake`
 
-#### Test:
-* Run `rake test`
+#### Run Tests:
+##### Unit
+* Run `./test.sh -u`
+##### Integration
+Make sure you kill manually the server test app after the tests are done.
+* Run `./test.sh -i`

data/lib/kameleoon.rb

@@ -2,4 +2,4 @@
 # Kameleoon Ruby Client SDK
 #
 require "kameleoon/factory"
-require "kameleoon/client"
+require "kameleoon/client"

data/lib/kameleoon/client.rb

@@ -19,16 +19,17 @@ module Kameleoon
 
     ##
     # You should create Client with the Client Factory only.
+    #
     def initialize(site_code, path_config_file, blocking, interval, default_timeout, client_id = nil, client_secret = nil)
       config = YAML.load_file(path_config_file)
       @site_code = site_code
       @blocking = blocking
-      @default_timeout = config['default_timeout'] || default_timeout
-      @interval = config['actions_configuration_refresh_interval'] || interval
+      @default_timeout = config['default_timeout'] || default_timeout # in ms
+      @interval = config['actions_configuration_refresh_interval'].to_s + 'm' || interval
       @tracking_url = config['tracking_url'] || "https://api-ssx.kameleoon.com"
       @client_id = client_id || config['client_id']
       @client_secret = client_secret || config['client_secret']
-      @data_maximum_size = config['visitor_data_maximum_size'] || 500
+      @data_maximum_size = config['visitor_data_maximum_size'] || 500 # mb
       @experiments = []
       @feature_flags = []
       @data = {}
@@ -37,7 +38,6 @@ module Kameleoon
     ##
     # Obtain a visitor code.
     #
-    #
     # This method should be called to obtain the Kameleoon visitor_code for the current visitor.
     # This is especially important when using Kameleoon in a mixed front-end and back-end environment,
     # where user identification consistency must be guaranteed.
@@ -51,10 +51,9 @@ module Kameleoon
     # In any case, the server-side (via HTTP header) kameleoonVisitorCode cookie is set with the value. Then this
     # identifier value is finally returned by the method.
     #
-    #
     # @param [Hash] cookies Cookies of the request.
     # @param [String] top_level_domain Top level domain of your website, settled while writing cookie.
-    # @param [String] default_visitor_vode - Optional - Define your default visitor_code (maximum length 100 chars).
+    # @param [String] default_visitor_code - Optional - Define your default visitor_code (maximum length 100 chars).
     #
     # @return [String] visitor code
     #
@@ -68,6 +67,7 @@ module Kameleoon
 
     ##
     # Trigger an experiment.
+    #
     # If such a visitor_code has never been associated with any variation, the SDK returns a randomly selected variation.
     # If a user with a given visitor_code is already registered with a variation, it will detect the previously
     # registered variation and return the variation_id.
@@ -77,20 +77,21 @@ module Kameleoon
     # @param [String] visitor_code Visitor code
     # @param [Integer] experiment_id Id of the experiment you want to trigger.
     #
-    # @return [Integer] Variation id
+    # @return [Integer] Id of the variation
     #
-    # @raise [Kameleoon::Exception::ExperimentNotFound] Raise when experiment configuration is not found
+    # @raise [Kameleoon::Exception::ExperimentConfigurationNotFound] Raise when experiment configuration is not found
     # @raise [Kameleoon::Exception::NotActivated] The visitor triggered the experiment, but did not activate it. Usually, this happens because the user has been associated with excluded traffic
     # @raise [Kameleoon::Exception::NotTargeted] The visitor is not targeted by the experiment, as the associated targeting segment conditions were not fulfilled. He should see the reference variation
+    #
     def trigger_experiment(visitor_code, experiment_id, timeout = @default_timeout)
       experiment = @experiments.find { |experiment| experiment['id'].to_s == experiment_id.to_s }
       if experiment.nil?
-        raise Exception::ExperimentNotFound.new(experiment_id)
+        raise Exception::ExperimentConfigurationNotFound.new(experiment_id)
       end
       if @blocking
         variation_id = nil
         EM.synchrony do
-          connexion_options = { :connect_timeout => timeout }
+          connexion_options = { :connect_timeout => (timeout.to_f / 1000.0) }
           body = @data.values.flatten.select { |data| !data.sent }.map { |data| data.obtain_full_post_text_line }
                       .join("\n") || ""
           path = get_experiment_register_url(visitor_code, experiment_id)
@@ -99,7 +100,7 @@ module Kameleoon
           if is_successful(request)
             variation_id = request.response
           else
-            raise Exception::ExperimentNotFound.new(experiment_id) if variation_id.nil?
+            raise Exception::ExperimentConfigurationNotFound.new(experiment_id) if variation_id.nil?
           end
           EM.stop
         end
@@ -128,7 +129,9 @@ module Kameleoon
     end
 
     ##
-    # Associate various data to a visitor. Note that this method doesn't return any value and doesn't interact with the
+    # Associate various data to a visitor.
+    #
+    # Note that this method doesn't return any value and doesn't interact with the
     # Kameleoon back-end servers by itself. Instead, the declared data is saved for future sending via the flush method.
     # This reduces the number of server calls made, as data is usually grouped into a single server call triggered by
     # the execution of the flush method.
@@ -151,13 +154,14 @@ module Kameleoon
 
     ##
     # Track conversions on a particular goal
+    #
     # This method requires visitor_code and goal_id to track conversion on this particular goal.
     # In addition, this method also accepts revenue as a third optional argument to track revenue. The visitor_code usually is identical to the one that was used when triggering the experiment.
     # The track_conversion method doesn't return any value. This method is non-blocking as the server call is made asynchronously.
     #
     # @param [String] visitor_code Visitor code
     # @param [Integer] goal_id Id of the goal
-    # @param [Float] revenue Revenue of the conversion. This field is optional
+    # @param [Float] revenue Optional - Revenue of the conversion.
     #
     def track_conversion(visitor_code, goal_id, revenue = 0.0)
       add_data(visitor_code, Conversion.new(goal_id, revenue))
@@ -166,6 +170,7 @@ module Kameleoon
 
     ##
     # Flush the associated data.
+    #
     # The data added with the method add_data, is not directly sent to the kameleoon servers.
     # It's stored and accumulated until it is sent automatically by the trigger_experiment or track_conversion methods.
     # With this method you can manually send it.
@@ -178,6 +183,7 @@ module Kameleoon
 
     ##
     # Obtain variation associated data.
+    #
     # To retrieve JSON data associated with a variation, call the obtain_variation_associated_data method of our SDK.
     # The JSON data usually represents some metadata of the variation, and can be configured on our web application
     # interface or via our Automation API.
@@ -186,20 +192,21 @@ module Kameleoon
     #
     # @param [Integer] variation_id
     #
-    # @return [String] json string of the variation data.
+    # @return [Hash] Hash object of the json object.
     #
     # @raise [Kameleoon::Exception::VariationNotFound] Raise exception if the variation is not found.
+    #
     def obtain_variation_associated_data(variation_id)
       variation = @experiments.map { |experiment| experiment['variations'] }.flatten.select { |variation| variation['id'].to_i == variation_id.to_i }.first
       if variation.nil?
         raise Exception::VariationNotFound.new(variation_id)
       else
-        variation['customJson'].to_json
+        variation['customJson']
       end
     end
 
     #
-    # Method to activate a feature toggle.
+    # Activate a feature toggle.
     #
     # This method takes a visitor_code and feature_key (or feature_id) as mandatory arguments to check if the specified feature will be active for a given user.
     # If such a user has never been associated with this feature flag, the SDK returns a boolean value randomly (true if the user should have this feature or false if not). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous featureFlag value.
@@ -208,15 +215,16 @@ module Kameleoon
     # @param [String] visitor_code
     # @param [String | Integer] feature_key
     #
-    # @raise [Kameleoon::Exception::FeatureFlagNotFound]
+    # @raise [Kameleoon::Exception::FeatureConfigurationNotFound]
     # @raise [Kameleoon::Exception::NotTargeted]
+    #
     def activate_feature(visitor_code, feature_key, timeout = @default_timeout)
       feature_flag = get_feature_flag(feature_key)
       id = feature_flag['id']
       if @blocking
         result = nil
         EM.synchrony do
-          connexion_options = { :connect_timeout => timeout }
+          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")
@@ -227,7 +235,7 @@ module Kameleoon
           end
           EM.stop
         end
-        raise Exception::FeatureFlagNotFound.new(id) if result.nil?
+        raise Exception::FeatureConfigurationNotFound.new(id) if result.nil?
         result.to_s != "null"
 
       else
@@ -248,17 +256,21 @@ module Kameleoon
     end
 
     ##
-    #  Method To retrieve a feature variable. A feature variable can be changed easily via our web application.
+    # Retrieve a feature variable.
+    #
+    # A feature variable can be changed easily via our web application.
     #
     # @param [String | Integer] feature_key
     # @param [String ] variable_key
     #
-    # @raise [Kameleoon::Exception::FeatureFlagNotFound]
+    # @raise [Kameleoon::Exception::FeatureConfigurationNotFound]
+    # @raise [Kameleoon::Exception::FeatureVariableNotFound]
+    #
     def obtain_feature_variable(feature_key, variable_key)
       feature_flag = get_feature_flag(feature_key)
       custom_json = feature_flag["variations"].first['customJson'][variable_key.to_s]
       if custom_json.nil?
-        raise Exception::FeatureFlagNotFound.new("Feature variable not found")
+        raise Exception::FeatureVariableNotFound.new("Feature variable not found")
       end
       case custom_json['type']
       when "Boolean"
@@ -268,9 +280,9 @@ module Kameleoon
       when "Number"
         return custom_json['value'].to_f
       when "Json"
-        return custom_json['value'].to_json
+        return custom_json['value']
       else
-        raise Exception::FeatureFlagNotFound.new("Unknown type for feature variable")
+        raise TypeError.new("Unknown type for feature variable")
       end
     end
 
@@ -300,8 +312,8 @@ module Kameleoon
           @feature_flags ||= []
         else
           site_id = site.first['id']
-          @experiments = obtain_tests(site_id)
-          @feature_flags = obtain_feature_flags(site_id)
+          @experiments = obtain_tests(site_id) || @experiments
+          @feature_flags = obtain_feature_flags(site_id) || @feature_flags
         end
         EM.stop
       end
@@ -446,7 +458,7 @@ module Kameleoon
         raise TypeError.new("Feature key should be a String or an Integer.")
       end
       if feature_flag.nil?
-        raise Exception::FeatureFlagNotFound.new(feature_key)
+        raise Exception::FeatureConfigurationNotFound.new(feature_key)
       end
       feature_flag
     end

data/lib/kameleoon/exceptions.rb

@@ -15,16 +15,21 @@ module Kameleoon
         super("Variation " + id.to_s)
       end
     end
-    class ExperimentNotFound < NotFound
+    class ExperimentConfigurationNotFound	 < NotFound
       def initialize(id = "")
         super("Experiment " + id.to_s)
       end
     end
-    class FeatureFlagNotFound < NotFound
+    class FeatureConfigurationNotFound < NotFound
       def initialize(id = "")
         super("Feature flag " + id.to_s)
       end
     end
+    class FeatureVariableNotFound < NotFound
+      def initialize(key = "")
+        super("Feature variable " + key.to_s)
+      end
+    end
     class CredentialsNotFound < NotFound
       def initialize
         super("Credentials")

data/lib/kameleoon/factory.rb

@@ -2,9 +2,9 @@ require 'kameleoon/client'
 
 module Kameleoon
   module ClientFactory
-    CONFIGURATION_UPDATE_INTERVAL= "60m"
+    CONFIGURATION_UPDATE_INTERVAL = '60m'
     CONFIG_PATH = "/etc/kameleoon/client-ruby.yaml"
-    DEFAULT_TIMEOUT = 2 #seconds
+    DEFAULT_TIMEOUT = 2000 #milli-seconds
 
     ##
     # Create a kameleoon client object, each call create a new client.

data/lib/kameleoon/request.rb

@@ -1,4 +1,5 @@
 require "em-synchrony/em-http"
+require "kameleoon/version"
 
 module Kameleoon
   # @api private
@@ -22,7 +23,8 @@ module Kameleoon
     private
 
     def request(method, request_options, url, connexion_options)
-      request_options[:tls] = {verify_peer: true}
+      #connexion_options[:tls] = {verify_peer: true}
+      add_user_agent(request_options)
       case method
         when Method::POST then
           return EventMachine::HttpRequest.new(url, connexion_options).apost request_options
@@ -37,6 +39,14 @@ module Kameleoon
     def is_successful(request)
       !request.nil? && request != false && /20\d/.match(request.response_header.status.to_s)
     end
+
+    def add_user_agent(request_options)
+      if request_options[:head].nil?
+        request_options[:head] = {'User-Agent' => 'kameleoon-client-ruby/' + Kameleoon::VERSION}
+      else
+        request_options[:head].store('User-Agent', 'kameleoon-client-ruby/' + Kameleoon::VERSION)
+      end
+    end
   end
 end
 

data/lib/kameleoon/version.rb

@@ -0,0 +1,3 @@
+module Kameleoon
+  VERSION = '1.0.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kameleoon - Guillaume Grandjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -73,6 +73,7 @@ files:
 - lib/kameleoon/targeting/models.rb
 - lib/kameleoon/targeting/tree_builder.rb
 - lib/kameleoon/utils.rb
+- lib/kameleoon/version.rb
 homepage: https://developers.kameleoon.com/ruby-sdk.html
 licenses:
 - GPL-3.0