kameleoon-client-ruby 1.1.2 → 2.1.0

data/lib/kameleoon/targeting/conditions/custom_datum.rb

@@ -1,35 +1,47 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'json'
 require 'kameleoon/targeting/condition'
 require 'kameleoon/exceptions'
 
 module Kameleoon
-  #@api private
   module Targeting
+    # CustomDatum represents an instance of Custom Data condition from back office
     class CustomDatum < Condition
       include Kameleoon::Exception
 
-      attr_accessor :index, :operator, :value
       def initialize(json_condition)
-        if json_condition['customDataIndex'].nil?
-          raise Exception::NotFoundError.new('customDataIndex')
-        end
+        super(json_condition)
         @index = json_condition['customDataIndex']
 
         if json_condition['valueMatchType'].nil?
-          raise Exception::NotFoundError.new('valueMatchType')
+          raise Exception::NotFound.new('valueMatchType'), 'valueMatchType missed'
         end
+
         @operator = json_condition['valueMatchType']
 
-        # if json_condition['value'].nil?
-        #   raise Exception::NotFoundError.new('value')
-        # end
         @value = json_condition['value']
 
         @type = ConditionType::CUSTOM_DATUM
 
         if json_condition['include'].nil? && json_condition['isInclude'].nil?
-          raise Exception::NotFoundError.new('include / isInclude missed')
+          raise Exception::NotFound.new('include / isInclude missed'), 'include / isInclude missed'
         end
+
         @include = json_condition['include'] || json_condition['isInclude']
+
+        @op = {
+          Operator::MATCH.to_s => method(:op_match),
+          Operator::CONTAINS.to_s => method(:op_contains),
+          Operator::EXACT.to_s => method(:op_exact),
+          Operator::EQUAL.to_s => method(:op_equal),
+          Operator::GREATER.to_s => method(:op_greater),
+          Operator::LOWER.to_s => method(:op_lower),
+          Operator::IS_TRUE.to_s => method(:op_is_true),
+          Operator::IS_FALSE.to_s => method(:op_is_false),
+          Operator::AMONG_VALUES.to_s => method(:op_among_values),
+        }[@operator]
       end
 
       def check(datas)
@@ -37,46 +49,53 @@ module Kameleoon
         custom_data = datas.select { |data| data.instance == DataType::CUSTOM && data.id == @index }.last
         if custom_data.nil?
           is_targeted = (@operator == Operator::UNDEFINED.to_s)
-        else
-          case @operator
-          when Operator::MATCH.to_s
-            if Regexp.new(@value.to_s).match(custom_data.value.to_s)
-              is_targeted = true
-            end
-          when Operator::CONTAINS.to_s
-            if custom_data.value.to_s.include? @value
-              is_targeted = true
-            end
-          when Operator::EXACT.to_s
-            if custom_data.value.to_s == @value.to_s
-              is_targeted = true
-            end
-          when Operator::EQUAL.to_s
-            if custom_data.value.to_f == @value.to_f
-              is_targeted = true
-            end
-          when Operator::GREATER.to_s
-            if custom_data.value.to_f > @value.to_f
-              is_targeted = true
-            end
-          when Operator::LOWER.to_s
-            if custom_data.value.to_f < @value.to_f
-              is_targeted = true
-            end
-          when Operator::IS_TRUE.to_s
-            if custom_data.value == 'true'
-              is_targeted = true
-            end
-          when Operator::IS_FALSE.to_s
-            if custom_data.value == 'false'
-              is_targeted = true
-            end
-          else
-            raise KameleoonError.new("Undefined operator " + @operator.to_s)
-          end
+        elsif @operator != Operator::UNDEFINED.to_s
+          raise KameleoonError.new("Undefined operator #{@operator}"), "Undefined operator #{@operator}" if @op.nil?
+
+          is_targeted = @op.call(custom_data.values)
         end
         is_targeted
       end
+
+      private
+
+      def op_match(values)
+        re = Regexp.new(@value.to_s)
+        values.any? { |v| re.match(v) }
+      end
+
+      def op_contains(values)
+        values.any? { |v| v.to_s.include? @value.to_s }
+      end
+
+      def op_exact(values)
+        values.include? @value.to_s
+      end
+
+      def op_equal(values)
+        values.any? { |v| v.to_f == @value.to_f }
+      end
+
+      def op_greater(values)
+        values.any? { |v| v.to_f > @value.to_f }
+      end
+
+      def op_lower(values)
+        values.any? { |v| v.to_f < @value.to_f }
+      end
+
+      def op_is_true(values)
+        values.any? { |v| v.to_s == 'true' }
+      end
+
+      def op_is_false(values)
+        values.any? { |v| v.to_s == 'false' }
+      end
+
+      def op_among_values(values)
+        all_matches = JSON.parse(@value.to_s).map(&:to_s).to_set
+        values.any? { |v| all_matches.include?(v) }
+      end
     end
   end
-end
+end

data/lib/kameleoon/targeting/conditions/exclusive_experiment.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/condition'
+require 'kameleoon/exceptions'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # ExclusiveExperiment represents an instance of Exclusive Experiment condition in user account
+    class ExclusiveExperiment < Condition
+      include Kameleoon::Exception
+
+      def initialize(json_condition)
+        if json_condition['targetingType'].nil?
+          raise Exception::NotFound.new('targetingType'), 'targetingType missed'
+        end
+
+        @type = json_condition['targetingType']
+        @include = true
+      end
+
+      def check(data)
+        experiment_id = data.experiment_id
+        storage = data.storage
+        storage.nil? || storage.empty? || (storage.length == 1 && !storage[experiment_id].nil?)
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/conditions/target_experiment.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/condition'
+require 'kameleoon/exceptions'
+
+module Kameleoon
+  # @api private
+  module Targeting
+    # TargetExperiment represents an instance of Experiment condition in user account
+    class TargetExperiment < Condition
+      include Kameleoon::Exception
+
+      def initialize(json_condition)
+        super(json_condition)
+
+        if json_condition['experiment'].nil?
+          raise Exception::NotFound.new('experiment'), 'experiment missed'
+        end
+
+        @experiment = json_condition['experiment']
+
+        if json_condition['variationMatchType'].nil?
+          raise Exception::NotFound.new('variationMatchType'), 'variationMatchType missed'
+        end
+
+        @operator = json_condition['variationMatchType']
+        @variation = json_condition['variation']
+      end
+
+      def check(variation_storage)
+        is_targeted = false
+        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
+          is_targeted = variation_storage_exist && saved_variation == @variation
+        when Operator::ANY.to_s
+          is_targeted = variation_storage_exist
+        end
+        is_targeted
+      end
+    end
+  end
+end

data/lib/kameleoon/targeting/models.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 require 'kameleoon/targeting/tree_builder'
 require 'kameleoon/exceptions'
 
 module Kameleoon
-  #@api private
+  # @api private
   module Targeting
     class Segment
       include TreeBuilder
       attr_accessor :id, :tree
       def to_s
-        print("\nSegment id: " + @id.to_s)
-        print("\n")
+        print("\nSegment id: #{@id}\n")
         @tree.to_s
       end
 
@@ -18,16 +19,16 @@ module Kameleoon
           if args.length == 1
             hash = args.first
             if hash.nil?
-              raise Kameleoon::Exception::NotFound.new("arguments for segment")
+              raise Kameleoon::Exception::NotFound.new('arguments for segment'), 'arguments for segment'
             end
-            if hash["id"].nil?
-              raise Kameleoon::Exception::NotFound.new("id")
+            if hash['id'].nil?
+              raise Kameleoon::Exception::NotFound.new('id'), 'id'
             end
-            @id = hash["id"].to_i
-            if hash["conditionsData"].nil?
-              raise Kameleoon::Exception::NotFound.new(hash["conditionsData"])
+            @id = hash['id'].to_i
+            if hash['conditionsData'].nil?
+              raise Kameleoon::Exception::NotFound.new(hash['conditionsData']), 'hash[\'conditionsData\']'
             end
-            @tree = create_tree(hash["conditionsData"])
+            @tree = create_tree(hash['conditionsData'])
           elsif args.length == 2
             @id = args[0]
             @tree = args[1]
@@ -49,17 +50,14 @@ module Kameleoon
       attr_accessor :or_operator, :left_child, :right_child, :condition
 
       def to_s
-        print("or_operator: " + @or_operator.to_s)
-        print("\n")
-        print("condition: " + @condition.to_s)
+        print("or_operator: #{@or_operator}\n")
+        print("condition: #{@condition}")
         unless @left_child.nil?
-          print("\n")
-          print("Left child:\n    ")
+          print('\nLeft child:\n    ')
           @left_child.to_s
         end
         unless @right_child.nil?
-          print("\n")
-          print("right child:\n    ")
+          print('\nright child:\n    ')
           @right_child.to_s
         end
       end
@@ -125,37 +123,39 @@ module Kameleoon
         if condition.nil?
           is_targeted = true
         else
-          is_targeted = condition.check(datas)
+          is_targeted = condition.check(datas.call(condition.type))
           unless condition.include
-            if is_targeted.nil?
-              is_targeted = true
-            else
-              is_targeted = !is_targeted
-            end
+            return true if is_targeted.nil?
+
+            is_targeted = !is_targeted
           end
         end
-        Marshal.load(Marshal.dump(is_targeted)) #Deep copy
+        Marshal.load(Marshal.dump(is_targeted)) # Deep copy
       end
     end
 
     module DataType
-      CUSTOM = "CUSTOM"
+      CUSTOM = 'CUSTOM'
     end
 
     module ConditionType
-      CUSTOM_DATUM = "CUSTOM_DATUM"
+      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"
+      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
+end

data/lib/kameleoon/utils.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Kameleoon
+  # Utils is a helper module for project
   module Utils
     ALPHA_NUMERIC_CHARS = 'abcdef0123456789'
 
@@ -10,4 +13,4 @@ module Kameleoon
       (1..length).map { ALPHA_NUMERIC_CHARS[rand(ALPHA_NUMERIC_CHARS.length)] }.join
     end
   end
-end
+end

data/lib/kameleoon/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kameleoon
-  VERSION = '1.1.2'
-end
+  VERSION = '2.1.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Kameleoon Client Ruby Software Development Kit
 email:
 - sdk@kameleoon.com
@@ -62,15 +76,33 @@ files:
 - README.md
 - lib/kameleoon.rb
 - lib/kameleoon/client.rb
+- lib/kameleoon/configuration/experiment.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.rb
 - lib/kameleoon/exceptions.rb
 - lib/kameleoon/factory.rb
-- lib/kameleoon/query_graphql.rb
+- lib/kameleoon/hybrid/manager.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
+- lib/kameleoon/real_time/sse_message.rb
+- lib/kameleoon/real_time/sse_request.rb
 - lib/kameleoon/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/custom_datum.rb
+- lib/kameleoon/targeting/conditions/exclusive_experiment.rb
+- lib/kameleoon/targeting/conditions/target_experiment.rb
 - lib/kameleoon/targeting/models.rb
 - lib/kameleoon/targeting/tree_builder.rb
 - lib/kameleoon/utils.rb

data/lib/kameleoon/query_graphql.rb

@@ -1,76 +0,0 @@
-module Kameleoon
-  module Query
-    
-    def self.query_experiments(site_code)
-      '{
-          "operationName": "getExperiments",
-          "query": "query getExperiments($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { experiments(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name type site { id code isKameleoonEnabled } status variations { id customJson } deviations { variationId value } respoolTime {variationId value } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
-          "variables": {
-              "filter": {
-                  "and": [{
-                      "condition": {
-                          "field": "status",
-                          "operator": "IN",
-                          "parameters": ["ACTIVE", "DEVIATED", "USED_AS_PERSONALIZATION"]
-                      }
-                  }, 
-                  {
-                      "condition": {
-                          "field": "type",
-                          "operator": "IN",
-                          "parameters": ["SERVER_SIDE", "HYBRID"]
-                      }
-                  }, 
-                  {
-                      "condition": {
-                          "field": "siteCode",
-                          "operator": "IN",
-                          "parameters": ["' + site_code + '"]
-                      }
-                  }]
-              },
-              "sort": [{
-                  "field": "id",
-                  "direction": "ASC"
-              }]
-          }
-      }'
-    end
-    
-    def self.query_feature_flags(site_code, environment)
-      '{
-          "operationName": "getFeatureFlags",
-          "query": "query getFeatureFlags($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { featureFlags(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name site { id code isKameleoonEnabled } bypassDeviation status variations { id customJson } respoolTime { variationId value } expositionRate identificationKey featureFlagSdkLanguageType featureStatus schedules { dateStart dateEnd } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
-          "variables": {
-              "filter": {
-                  "and": [{
-                      "condition": {
-                          "field": "featureStatus",
-                          "operator": "IN",
-                          "parameters": ["ACTIVATED", "SCHEDULED", "DEACTIVATED"]
-                      }
-                  }, 
-                  {
-                      "condition": {
-                          "field": "siteCode",
-                          "operator": "IN",
-                          "parameters": ["' + site_code + '"]
-                      }
-                  }, 
-                  {
-                    "condition": {
-                        "field": "environment.key",
-                        "operator": "IN",
-                        "parameters": ["' + environment + '"]
-                    }
-                }]
-              },
-              "sort": [{
-                  "field": "id",
-                  "direction": "ASC"
-              }]
-          }
-      }'
-    end
-  end
-end